Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Draft as of 2023-09-29 |
Definitions for the MedicationDispense logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. Supply | |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | 4537-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). () |
| 2. Supply.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-7451). |
| 4. Supply.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-7452). |
| Fixed Value | EVN |
| 6. Supply.templateId | |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-7453) such that it |
| Control | 1..? |
| Slicing | This element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 8. Supply.templateId:templateId1 | |
| Slice Name | templateId1 |
| Short | templateId |
| Control | 1..1 |
| 10. Supply.templateId:templateId1.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.18" (CONF:4537-10505). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.18 |
| 12. Supply.templateId:templateId1.extension | |
| Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32580). |
| Control | 1..? |
| Pattern Value | 2023-05-01 |
| 14. Supply.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:4537-7454). |
| Control | 1..? |
| 16. Supply.code | |
| Comments | SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet MedicationDispense Status Codes urn:oid:2.16.840.1.113883.4.642.3.1312 DYNAMIC (CONF:4537-32974). |
| Control | 1..? |
| Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.4.642.3.1312 |
| 18. Supply.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-7455). |
| Control | 1..? |
| 20. Supply.statusCode.code | |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:4537-32361). |
| Control | 1..? |
| Fixed Value | completed |
| 22. Supply.effectiveTime | |
| Comments | SHOULD contain zero or one [0..1] effectiveTime (CONF:4537-7456). |
| Control | 0..1 |
| 24. Supply.repeatNumber | |
| Comments | SHOULD contain zero or one [0..1] repeatNumber (CONF:4537-7457). |
| 26. Supply.quantity | |
| Comments | SHOULD contain zero or one [0..1] quantity (CONF:4537-7458). |
| 28. Supply.product | |
| Comments | MAY contain zero or one [0..1] product (CONF:4537-7459). |
| 30. Supply.product.manufacturedProduct | |
| Comments | The product, if present, SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:4537-15607). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information) |
| 32. Supply.performer | |
| Comments | MAY contain zero or one [0..1] performer (CONF:4537-7461). |
| Control | 0..1 |
| 34. Supply.performer.assignedEntity | |
| Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-7467). |
| 36. Supply.performer.assignedEntity.addr | |
| Comments | This assignedEntity SHOULD contain zero or one [0..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-7468). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED)) |
| Invariants | 4537-10565: The content of addr **SHALL** be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) (CONF:4537-10565). () |
| 38. Supply.entryRelationship | |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:4537-7473) such that it |
| Slicing | This element introduces a set of slices on Supply.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 40. Supply.entryRelationship:entryRelationship1 | |
| Slice Name | entryRelationship1 |
| Short | entryRelationship |
| Control | 0..1 |
| 42. Supply.entryRelationship:entryRelationship1.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:4537-7474). |
| Fixed Value | REFR |
| 44. Supply.entryRelationship:entryRelationship1.supply | |
| Comments | SHALL contain exactly one [1..1] Medication Supply Order (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09) (CONF:4537-15606). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply(Medication Supply Order) |
Guidance on how to interpret the contents of this table can be found here
| 0. Supply | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 4537-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). () |
| 2. Supply.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-7451). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassSupply |
| 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. |
| Default Value | SPLY |
| Fixed Value | SPLY |
| 4. Supply.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-7452). |
| Control | 1..1 |
| 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 | EVN |
| 6. 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-7453) such that it |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 8. Supply.templateId:templateId1 | |
| Slice Name | templateId1 |
| 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 |
| Short | templateId |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 10. Supply.templateId:templateId1.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.18" (CONF:4537-10505). |
| 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 | 2.16.840.1.113883.10.20.22.4.18 |
| 12. Supply.templateId:templateId1.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32580). |
| 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 |
| Pattern Value | 2023-05-01 |
| 14. Supply.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:4537-7454). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 16. Supply.code | |
| Comments | SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet MedicationDispense Status Codes urn:oid:2.16.840.1.113883.4.642.3.1312 DYNAMIC (CONF:4537-32974). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.4.642.3.1312 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 18. Supply.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-7455). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 20. Supply.statusCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:4537-32361). |
| Control | 1..1 |
| 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 | Code |
| Fixed Value | completed |
| 22. Supply.statusCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| 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 | Code System |
| 24. Supply.statusCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| 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 | Code System Name |
| 26. Supply.statusCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| 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 | Code System Version |
| 28. Supply.statusCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| 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 | Display Name |
| 30. Supply.statusCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 32. Supply.statusCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 34. Supply.statusCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 36. Supply.effectiveTime | |
| Comments | SHOULD contain zero or one [0..1] effectiveTime (CONF:4537-7456). |
| Control | 0..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 |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| 38. Supply.repeatNumber | |
| Comments | SHOULD contain zero or one [0..1] repeatNumber (CONF:4537-7457). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
| 40. Supply.quantity | |
| Comments | SHOULD contain zero or one [0..1] quantity (CONF:4537-7458). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| 42. Supply.product | |
| Comments | MAY contain zero or one [0..1] product (CONF:4537-7459). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. Supply.product.manufacturedProduct | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | The product, if present, SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:4537-15607). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. Supply.performer | |
| Comments | MAY contain zero or one [0..1] performer (CONF:4537-7461). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 48. Supply.performer.assignedEntity | |
| Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-7467). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity |
| 50. Supply.performer.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 52. Supply.performer.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Short | Base for all types and resources |
| Comments | This assignedEntity SHOULD contain zero or one [0..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-7468). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). () 4537-10565: The content of addr **SHALL** be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) (CONF:4537-10565). () |
| 54. Supply.entryRelationship | |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:4537-7473) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| Slicing | This element introduces a set of slices on Supply.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 56. Supply.entryRelationship:entryRelationship1 | |
| Slice Name | entryRelationship1 |
| Short | entryRelationship |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 58. Supply.entryRelationship:entryRelationship1.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:4537-7474). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship |
| 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 | REFR |
| 60. Supply.entryRelationship:entryRelationship1.supply | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Medication Supply Order (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09) (CONF:4537-15606). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply(Medication Supply Order) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
| 0. Supply | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))4537-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). () |
| 2. Supply.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-7451). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassSupply |
| 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. |
| Default Value | SPLY |
| Fixed Value | SPLY |
| 4. Supply.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-7452). |
| Control | 1..1 |
| 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 | EVN |
| 6. Supply.realmCode | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 8. Supply.typeId | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 10. 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-7453) such that it |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 12. Supply.templateId:templateId1 | |
| Slice Name | templateId1 |
| 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 |
| Short | templateId |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 14. Supply.templateId:templateId1.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 NullFlavor |
| 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 |
| 16. Supply.templateId:templateId1.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 |
| 18. Supply.templateId:templateId1.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 |
| 20. Supply.templateId:templateId1.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.18" (CONF:4537-10505). |
| 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 | 2.16.840.1.113883.10.20.22.4.18 |
| 22. Supply.templateId:templateId1.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32580). |
| 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 |
| Pattern Value | 2023-05-01 |
| 24. Supply.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:4537-7454). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 26. Supply.code | |
| Comments | SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet MedicationDispense Status Codes urn:oid:2.16.840.1.113883.4.642.3.1312 DYNAMIC (CONF:4537-32974). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.4.642.3.1312 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 28. Supply.text | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 30. Supply.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-7455). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 32. Supply.statusCode.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 NullFlavor |
| 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 |
| 34. Supply.statusCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:4537-32361). |
| Control | 1..1 |
| 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 | Code |
| Fixed Value | completed |
| 36. Supply.statusCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| 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 | Code System |
| 38. Supply.statusCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| 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 | Code System Name |
| 40. Supply.statusCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| 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 | Code System Version |
| 42. Supply.statusCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| 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 | Display Name |
| 44. Supply.statusCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| 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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 46. Supply.statusCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| 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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion. |
| 48. Supply.statusCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 50. Supply.statusCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 52. Supply.statusCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 54. Supply.effectiveTime | |
| Comments | SHOULD contain zero or one [0..1] effectiveTime (CONF:4537-7456). |
| Control | 0..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 |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| 56. Supply.priorityCode | |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from ActPriority |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 58. Supply.repeatNumber | |
| Comments | SHOULD contain zero or one [0..1] repeatNumber (CONF:4537-7457). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
| 60. Supply.independentInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 62. Supply.quantity | |
| Comments | SHOULD contain zero or one [0..1] quantity (CONF:4537-7458). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| 64. Supply.expectedUseTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 66. Supply.product | |
| Comments | MAY contain zero or one [0..1] product (CONF:4537-7459). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 68. 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 NullFlavor |
| 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 |
| 70. 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 |
| 72. 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 |
| 74. 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 |
| 76. Supply.product.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationTargetDirect |
| 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 |
| 78. Supply.product.manufacturedProduct | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | The product, if present, SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:4537-15607). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. Supply.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 82. Supply.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 84. Supply.performer | |
| Comments | MAY contain zero or one [0..1] performer (CONF:4537-7461). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 86. Supply.performer.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 NullFlavor |
| 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 |
| 88. Supply.performer.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationPhysicalPerformer |
| 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 | PRF |
| 90. Supply.performer.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 |
| 92. Supply.performer.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 |
| 94. Supply.performer.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 |
| 96. Supply.performer.sdtcFunctionCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namefunctionCode. |
| 98. Supply.performer.time | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 100. Supply.performer.modeCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 102. Supply.performer.assignedEntity | |
| Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-7467). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity |
| 104. Supply.performer.assignedEntity.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| 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 | ASSIGNED |
| 106. Supply.performer.assignedEntity.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 |
| 108. Supply.performer.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 110. Supply.performer.assignedEntity.sdtcIdentifiedBy | |
| Definition | Element AssignedEntity.sdtcIdentifiedBy |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy. |
| 112. Supply.performer.assignedEntity.code | |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 114. Supply.performer.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Short | Base for all types and resources |
| Comments | This assignedEntity SHOULD contain zero or one [0..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-7468). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). () 4537-10565: The content of addr **SHALL** be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) (CONF:4537-10565). () |
| 116. Supply.performer.assignedEntity.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 118. Supply.performer.assignedEntity.assignedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
| 120. Supply.performer.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 122. Supply.author | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 124. Supply.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 126. Supply.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 128. Supply.entryRelationship | |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:4537-7473) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| Slicing | This element introduces a set of slices on Supply.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 130. Supply.entryRelationship:entryRelationship1 | |
| Slice Name | entryRelationship1 |
| Short | entryRelationship |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 132. Supply.entryRelationship:entryRelationship1.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 NullFlavor |
| 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 |
| 134. Supply.entryRelationship:entryRelationship1.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 |
| 136. Supply.entryRelationship:entryRelationship1.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 |
| 138. Supply.entryRelationship:entryRelationship1.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 |
| 140. Supply.entryRelationship:entryRelationship1.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:4537-7474). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship |
| 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 | REFR |
| 142. Supply.entryRelationship:entryRelationship1.inversionInd | |
| Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
| 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. |
| 144. Supply.entryRelationship:entryRelationship1.contextConductionInd | |
| Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context. |
| 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. |
| Default Value | true |
| 146. Supply.entryRelationship:entryRelationship1.negationInd | |
| 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. |
| 148. Supply.entryRelationship:entryRelationship1.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 150. Supply.entryRelationship:entryRelationship1.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 152. Supply.entryRelationship:entryRelationship1.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 154. Supply.entryRelationship:entryRelationship1.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 156. Supply.entryRelationship:entryRelationship1.observation | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
| 158. Supply.entryRelationship:entryRelationship1.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 160. Supply.entryRelationship:entryRelationship1.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 162. Supply.entryRelationship:entryRelationship1.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 164. Supply.entryRelationship:entryRelationship1.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 166. Supply.entryRelationship:entryRelationship1.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 168. Supply.entryRelationship:entryRelationship1.supply | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Medication Supply Order (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09) (CONF:4537-15606). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply(Medication Supply Order) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 170. Supply.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 172. Supply.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change