This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Draft as of 2024-05-18 |
Definitions for the ImmunizationMedicationInformation logical model.
Guidance on how to interpret the contents of this table can be found here
0. ManufacturedProduct | |
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 . |
Invariants | should-manufacturerOrganization: SHOULD contain manufacturerOrganization (manufacturerOrganization.exists() ) |
2. ManufacturedProduct.templateId | |
Control | 1..? |
Slicing | This element introduces a set of slices on ManufacturedProduct.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. ManufacturedProduct.templateId:immunization-med-info | |
Slice Name | immunization-med-info |
Control | 1..1 |
6. ManufacturedProduct.templateId:immunization-med-info.root | |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.10.20.22.4.54 |
8. ManufacturedProduct.templateId:immunization-med-info.extension | |
Control | 1..? |
Pattern Value | 2014-06-09 |
10. 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..? |
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..? |
Invariants | should-lotNumberText: SHOULD contain lotNumberText (lotNumberText.exists() ) |
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 (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 ) |
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 | 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 . |
Invariants | product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) ((manufacturedLabeledDrug | manufacturedMaterial).count() = 1 )should-manufacturerOrganization: SHOULD contain manufacturerOrganization ( manufacturerOrganization.exists() ) |
2. 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 areUnordered and Open, and can be differentiated using the following discriminators: |
4. ManufacturedProduct.templateId:immunization-med-info | |
Slice Name | immunization-med-info |
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..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
6. ManufacturedProduct.templateId:immunization-med-info.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 | 2.16.840.1.113883.10.20.22.4.54 |
8. ManufacturedProduct.templateId:immunization-med-info.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 |
Pattern Value | 2014-06-09 |
10. 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 (required to http://terminology.hl7.org/ValueSet/v3-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 |
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 |
Invariants | should-lotNumberText: SHOULD contain lotNumberText (lotNumberText.exists() ) |
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 (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 ) |
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 | 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 . |
Invariants | product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) ((manufacturedLabeledDrug | manufacturedMaterial).count() = 1 )should-manufacturerOrganization: SHOULD contain manufacturerOrganization ( manufacturerOrganization.exists() ) |
2. ManufacturedProduct.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 (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
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. ManufacturedProduct.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. ManufacturedProduct.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 |
8. ManufacturedProduct.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 (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
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.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. ManufacturedProduct.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. ManufacturedProduct.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. ManufacturedProduct.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. 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 areUnordered and Open, and can be differentiated using the following discriminators: |
20. ManufacturedProduct.templateId:immunization-med-info | |
Slice Name | immunization-med-info |
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..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
22. ManufacturedProduct.templateId:immunization-med-info.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 (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
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. ManufacturedProduct.templateId:immunization-med-info.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. ManufacturedProduct.templateId:immunization-med-info.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. ManufacturedProduct.templateId:immunization-med-info.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 | 2.16.840.1.113883.10.20.22.4.54 |
30. ManufacturedProduct.templateId:immunization-med-info.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 |
Pattern Value | 2014-06-09 |
32. 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 (required to http://terminology.hl7.org/ValueSet/v3-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 |
34. ManufacturedProduct.id | |
Comments | MAY contain zero or more [0..*] id (CONF:1098-9005). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
36. 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 . |
38. ManufacturedProduct.manufacturedLabeledDrug | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug |
40. 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 |
Invariants | should-lotNumberText: SHOULD contain lotNumberText (lotNumberText.exists() ) |
42. 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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
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 |
44. ManufacturedProduct.manufacturedMaterial.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 |
46. ManufacturedProduct.manufacturedMaterial.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 |
48. ManufacturedProduct.manufacturedMaterial.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 (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
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 |
50. ManufacturedProduct.manufacturedMaterial.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 |
52. ManufacturedProduct.manufacturedMaterial.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 |
54. ManufacturedProduct.manufacturedMaterial.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 |
56. ManufacturedProduct.manufacturedMaterial.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 |
58. 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 |
60. ManufacturedProduct.manufacturedMaterial.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityClassManufacturedMaterial (required to http://terminology.hl7.org/ValueSet/v3-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 |
62. ManufacturedProduct.manufacturedMaterial.determinerCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityDeterminerDetermined (required to http://terminology.hl7.org/ValueSet/v3-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 |
64. 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 (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
66. ManufacturedProduct.manufacturedMaterial.name | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN |
68. 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 |
70. 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 |