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 ImmunizationMedicationInformation logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. ManufacturedProduct | |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. ManufacturedProduct.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-9002). |
| Control | 1..? |
| 4. ManufacturedProduct.templateId | |
| Control | 1..? |
| Slicing | This element introduces a set of slices on ManufacturedProduct.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 6. ManufacturedProduct.templateId:primary | |
| Slice Name | primary |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-9004) such that it |
| Control | 1..1 |
| 8. ManufacturedProduct.templateId:primary.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.54" (CONF:1098-10499). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.54 |
| 10. ManufacturedProduct.templateId:primary.extension | |
| Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32602). |
| Control | 1..? |
| Pattern Value | 2014-06-09 |
| 12. ManufacturedProduct.id | |
| Comments | MAY contain zero or more [0..*] id (CONF:1098-9005). |
| 14. ManufacturedProduct.manufacturedMaterial | |
| Comments | SHALL contain exactly one [1..1] manufacturedMaterial (CONF:1098-9006). |
| Control | 1..? |
| 16. ManufacturedProduct.manufacturedMaterial.code | |
| Comments | This manufacturedMaterial SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet CVX Vaccines Administered Vaccine Set urn:oid:2.16.840.1.113762.1.4.1010.6 DYNAMIC (CONF:1098-9007). |
| Control | 1..? |
| Binding | The codes SHALL be taken from CVX Vaccines Administered Vaccine Set |
| 18. ManufacturedProduct.manufacturedMaterial.lotNumberText | |
| Short | lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations. |
| Comments | This manufacturedMaterial SHOULD contain zero or one [0..1] lotNumberText (CONF:1098-9014). |
| 20. ManufacturedProduct.manufacturerOrganization | |
| Comments | SHOULD contain zero or one [0..1] manufacturerOrganization (CONF:1098-9012). |
Guidance on how to interpret the contents of this table can be found here
| 0. ManufacturedProduct | |
| 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())) |
| 2. ManufacturedProduct.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-9002). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassManufacturedProduct |
| 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 | MANU |
| 4. ManufacturedProduct.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 | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on ManufacturedProduct.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 6. ManufacturedProduct.templateId:primary | |
| Slice Name | primary |
| 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:1098-9004) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 8. ManufacturedProduct.templateId:primary.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.54" (CONF:1098-10499). |
| 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.54 |
| 10. ManufacturedProduct.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32602). |
| 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 | 2014-06-09 |
| 12. ManufacturedProduct.id | |
| Comments | MAY contain zero or more [0..*] id (CONF:1098-9005). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 14. ManufacturedProduct.manufacturedMaterial | |
| Comments | SHALL contain exactly one [1..1] manufacturedMaterial (CONF:1098-9006). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Material |
| 16. ManufacturedProduct.manufacturedMaterial.code | |
| Comments | This manufacturedMaterial SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet CVX Vaccines Administered Vaccine Set urn:oid:2.16.840.1.113762.1.4.1010.6 DYNAMIC (CONF:1098-9007). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CVX Vaccines Administered Vaccine Set |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 18. ManufacturedProduct.manufacturedMaterial.lotNumberText | |
| Short | lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations. |
| Comments | This manufacturedMaterial SHOULD contain zero or one [0..1] lotNumberText (CONF:1098-9014). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
| 20. ManufacturedProduct.manufacturerOrganization | |
| Comments | SHOULD contain zero or one [0..1] manufacturerOrganization (CONF:1098-9012). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
Guidance on how to interpret the contents of this table can be found here
| 0. ManufacturedProduct | |
| 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())) |
| 2. ManufacturedProduct.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-9002). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassManufacturedProduct |
| 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 | MANU |
| 4. ManufacturedProduct.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 | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on ManufacturedProduct.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 6. ManufacturedProduct.templateId:primary | |
| Slice Name | primary |
| 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:1098-9004) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 8. ManufacturedProduct.templateId:primary.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 |
| 10. ManufacturedProduct.templateId:primary.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. ManufacturedProduct.templateId:primary.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. ManufacturedProduct.templateId:primary.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.54" (CONF:1098-10499). |
| 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.54 |
| 16. ManufacturedProduct.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32602). |
| 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 | 2014-06-09 |
| 18. ManufacturedProduct.id | |
| Comments | MAY contain zero or more [0..*] id (CONF:1098-9005). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 20. ManufacturedProduct.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. |
| 22. ManufacturedProduct.manufacturedLabeledDrug | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug |
| 24. ManufacturedProduct.manufacturedMaterial | |
| Comments | SHALL contain exactly one [1..1] manufacturedMaterial (CONF:1098-9006). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Material |
| 26. ManufacturedProduct.manufacturedMaterial.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassManufacturedMaterial |
| 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 | MMAT |
| 28. ManufacturedProduct.manufacturedMaterial.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminerDetermined |
| 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 | KIND |
| 30. ManufacturedProduct.manufacturedMaterial.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 |
| 32. ManufacturedProduct.manufacturedMaterial.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 |
| 34. ManufacturedProduct.manufacturedMaterial.code | |
| Comments | This manufacturedMaterial SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet CVX Vaccines Administered Vaccine Set urn:oid:2.16.840.1.113762.1.4.1010.6 DYNAMIC (CONF:1098-9007). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CVX Vaccines Administered Vaccine Set |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 36. ManufacturedProduct.manufacturedMaterial.name | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EN |
| 38. ManufacturedProduct.manufacturedMaterial.lotNumberText | |
| Short | lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations. |
| Comments | This manufacturedMaterial SHOULD contain zero or one [0..1] lotNumberText (CONF:1098-9014). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
| 40. ManufacturedProduct.manufacturerOrganization | |
| Comments | SHOULD contain zero or one [0..1] manufacturerOrganization (CONF:1098-9012). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
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