FR Document Core (CDA)
0.1.0 - ci-build
FR Document Core (CDA)
0.1.0 - ci-build
FR Document Core (CDA) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-08-28 |
Definitions for the fr-cda-periode-de-renouvellement logical model
Guidance on how to interpret the contents of this table can be foundhere
| 0. Supply | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instance of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Supply.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 4. Supply.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 6. Supply.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 8. Supply.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 10. Supply.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 12. Supply.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 14. Supply.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 16. Supply.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 18. Supply.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 2..2 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Supply.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. Supply.templateId:iheRenewalPeriod | |
| Slice Name | iheRenewalPeriod |
| Definition | Conformité Renewal Period (IHE PRE) |
| Short | Conformité Renewal Period (IHE PRE) |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 22. Supply.templateId:iheRenewalPeriod.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 24. Supply.templateId:iheRenewalPeriod.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 26. Supply.templateId:iheRenewalPeriod.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 28. Supply.templateId:iheRenewalPeriod.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 1.3.6.1.4.1.19376.1.9.1.3.15 |
| 30. Supply.templateId:iheRenewalPeriod.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 32. Supply.templateId:frPeriodeDeRenouvellement | |
| Slice Name | frPeriodeDeRenouvellement |
| Definition | Conformité FR-periode-de-renouvellement (CI-SIS) |
| Short | Conformité FR-periode-de-renouvellement (CI-SIS) |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 34. Supply.templateId:frPeriodeDeRenouvellement.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 36. Supply.templateId:frPeriodeDeRenouvellement.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 38. Supply.templateId:frPeriodeDeRenouvellement.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 40. Supply.templateId:frPeriodeDeRenouvellement.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 1.2.250.1.213.1.1.3.88 |
| 42. Supply.templateId:frPeriodeDeRenouvellement.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 44. Supply.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassSupply (3.0.0) (required to http://terminology.hl7.org/ValueSet/v3-ActClassSupply|3.0.0) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | SPLY |
| Fixed Value | SPLY |
| 46. Supply.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from XDocumentSubstanceMood (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| XML Format | In the XML format, this property is represented as an attribute. |
| Pattern Value | RQO |
| 48. Supply.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 50. Supply.code | |
| Control | 0..1 |
| Binding | For example codes, see ActCode (3.0.0) (example to http://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 52. Supply.text | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 54. Supply.statusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActStatus (3.0.0) (required to http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 56. Supply.effectiveTime | |
| Definition | Période de renouvellement |
| Short | - Si la période de renouvellement est définie à partir d'une date précise, utiliser les éléments <low> et <high> avec l'élément <high> (date de fin) obligatoire et l'élément <low> (date de début) facultatif. - Si la période de renouvellement est définie par une durée, utiliser les éléments <low> et <width> avec l'élément <width> (période de temps) obligatoire et l'élément <low> (date de début) facultatif. |
| Control | 1..1 |
| Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS|2.0.3-sd |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Invariants | fr-effectiveTime-type: La durée doit être IVL-TS (is(IVL_TS))fr-inv-effectiveTime: Soit high, soit width doit être présent, mais pas les deux ( (high.exists() xor width.exists())) |
| 58. Supply.priorityCode | |
| Control | 0..* |
| Binding | For example codes, see ActPriority (3.0.0) (example to http://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 60. Supply.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
| 62. Supply.independentInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 64. Supply.quantity | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| 66. Supply.expectedUseTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 68. Supply.product | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| 70. Supply.product.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 72. Supply.product.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 74. Supply.product.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 76. Supply.product.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 78. Supply.product.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 80. Supply.product.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 82. Supply.product.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 84. Supply.product.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 86. Supply.product.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 88. Supply.product.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationTargetDirect (3.0.0) (required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect|3.0.0) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | PRD |
| 90. Supply.product.manufacturedProduct | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct |
| 92. Supply.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 94. Supply.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 96. Supply.performer | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 98. Supply.author | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 100. Supply.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 102. Supply.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 104. Supply.entryRelationship | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 106. Supply.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 108. Supply.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 110. Supply.sdtcInFulfillmentOf1 | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1 |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1. |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Supply | |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instance of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Supply.templateId | |
| Control | 2..2 |
| Slicing | This element introduces a set of slices on Supply.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Supply.templateId:iheRenewalPeriod | |
| Slice Name | iheRenewalPeriod |
| Definition | Conformité Renewal Period (IHE PRE) |
| Short | Conformité Renewal Period (IHE PRE) |
| Control | 1..1 |
| 6. Supply.templateId:iheRenewalPeriod.root | |
| Control | 1..? |
| Pattern Value | 1.3.6.1.4.1.19376.1.9.1.3.15 |
| 8. Supply.templateId:frPeriodeDeRenouvellement | |
| Slice Name | frPeriodeDeRenouvellement |
| Definition | Conformité FR-periode-de-renouvellement (CI-SIS) |
| Short | Conformité FR-periode-de-renouvellement (CI-SIS) |
| Control | 1..1 |
| 10. Supply.templateId:frPeriodeDeRenouvellement.root | |
| Control | 1..? |
| Pattern Value | 1.2.250.1.213.1.1.3.88 |
| 12. Supply.classCode | |
| Must Support | true |
| 14. Supply.moodCode | |
| Must Support | true |
| Pattern Value | RQO |
| 16. Supply.effectiveTime | |
| Definition | Période de renouvellement |
| Short | - Si la période de renouvellement est définie à partir d'une date précise, utiliser les éléments <low> et <high> avec l'élément <high> (date de fin) obligatoire et l'élément <low> (date de début) facultatif. - Si la période de renouvellement est définie par une durée, utiliser les éléments <low> et <width> avec l'élément <width> (période de temps) obligatoire et l'élément <low> (date de début) facultatif. |
| Control | 1..1 |
| Must Support | true |
| Invariants | fr-effectiveTime-type: La durée doit être IVL-TS (is(IVL_TS))fr-inv-effectiveTime: Soit high, soit width doit être présent, mais pas les deux ( (high.exists() xor width.exists())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Supply | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instance of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Supply.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 4. Supply.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 6. Supply.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 8. Supply.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 10. Supply.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 12. Supply.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 14. Supply.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 16. Supply.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 18. Supply.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 2..2 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Supply.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. Supply.templateId:iheRenewalPeriod | |
| Slice Name | iheRenewalPeriod |
| Definition | Conformité Renewal Period (IHE PRE) |
| Short | Conformité Renewal Period (IHE PRE) |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 22. Supply.templateId:iheRenewalPeriod.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 24. Supply.templateId:iheRenewalPeriod.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 26. Supply.templateId:iheRenewalPeriod.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 28. Supply.templateId:iheRenewalPeriod.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 1.3.6.1.4.1.19376.1.9.1.3.15 |
| 30. Supply.templateId:iheRenewalPeriod.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 32. Supply.templateId:frPeriodeDeRenouvellement | |
| Slice Name | frPeriodeDeRenouvellement |
| Definition | Conformité FR-periode-de-renouvellement (CI-SIS) |
| Short | Conformité FR-periode-de-renouvellement (CI-SIS) |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 34. Supply.templateId:frPeriodeDeRenouvellement.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 36. Supply.templateId:frPeriodeDeRenouvellement.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 38. Supply.templateId:frPeriodeDeRenouvellement.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 40. Supply.templateId:frPeriodeDeRenouvellement.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 1.2.250.1.213.1.1.3.88 |
| 42. Supply.templateId:frPeriodeDeRenouvellement.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 44. Supply.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassSupply (3.0.0) (required to http://terminology.hl7.org/ValueSet/v3-ActClassSupply|3.0.0) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | SPLY |
| Fixed Value | SPLY |
| 46. Supply.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from XDocumentSubstanceMood (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| XML Format | In the XML format, this property is represented as an attribute. |
| Pattern Value | RQO |
| 48. Supply.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 50. Supply.code | |
| Control | 0..1 |
| Binding | For example codes, see ActCode (3.0.0) (example to http://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 52. Supply.text | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 54. Supply.statusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActStatus (3.0.0) (required to http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 56. Supply.effectiveTime | |
| Definition | Période de renouvellement |
| Short | - Si la période de renouvellement est définie à partir d'une date précise, utiliser les éléments <low> et <high> avec l'élément <high> (date de fin) obligatoire et l'élément <low> (date de début) facultatif. - Si la période de renouvellement est définie par une durée, utiliser les éléments <low> et <width> avec l'élément <width> (période de temps) obligatoire et l'élément <low> (date de début) facultatif. |
| Control | 1..1 |
| Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS|2.0.3-sd |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Invariants | fr-effectiveTime-type: La durée doit être IVL-TS (is(IVL_TS))fr-inv-effectiveTime: Soit high, soit width doit être présent, mais pas les deux ( (high.exists() xor width.exists())) |
| 58. Supply.priorityCode | |
| Control | 0..* |
| Binding | For example codes, see ActPriority (3.0.0) (example to http://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 60. Supply.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
| 62. Supply.independentInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 64. Supply.quantity | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| 66. Supply.expectedUseTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 68. Supply.product | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| 70. Supply.product.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 72. Supply.product.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 74. Supply.product.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 76. Supply.product.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (2.0.3-sd) (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 78. Supply.product.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 80. Supply.product.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 82. Supply.product.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 84. Supply.product.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 86. Supply.product.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 88. Supply.product.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationTargetDirect (3.0.0) (required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect|3.0.0) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | PRD |
| 90. Supply.product.manufacturedProduct | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct |
| 92. Supply.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 94. Supply.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 96. Supply.performer | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 98. Supply.author | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 100. Supply.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 102. Supply.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 104. Supply.entryRelationship | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 106. Supply.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 108. Supply.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 110. Supply.sdtcInFulfillmentOf1 | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1 |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1. |