Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

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

Logical Model: Immunization Medication Information

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationMedicationInformation Version: 2.1
Draft as of 2023-09-29 Computable Name: ImmunizationMedicationInformation
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.54:2014-06-09

The Immunization Medication Information represents product information about the immunization substance. The vaccine manufacturer and vaccine lot number are typically recorded in the medical record and should be included if known.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CDAR2.ManufacturedProduct

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct CDAR2.ManufacturedProductXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
... classCode 1..1cs
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... extension 1..1stRequired Pattern: 2014-06-09
... id 0..*II
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
.... lotNumberText 0..1STlotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
... manufacturerOrganization 0..1Organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ManufacturedProduct.manufacturedMaterial.coderequiredCVX Vaccines Administered Vaccine Set
NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProductXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
Base for all types and resources
... @classCode 1..1csBinding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 0..*II
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
.... lotNumberText 0..1STlotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
... manufacturerOrganization 0..1Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ManufacturedProduct.classCoderequiredFixed Value: MANU
ManufacturedProduct.manufacturedMaterial.coderequiredCVX Vaccines Administered Vaccine Set

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProductXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
Base for all types and resources
... @classCode 1..1csBinding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 0..*II
... manufacturedLabeledDrug 0..1LabeledDrug
... manufacturedMaterial 1..1Material
.... @classCode 0..1csBinding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
.... @determinerCode 0..1csBinding: EntityDeterminerDetermined (required)
Fixed Value: KIND
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... templateId 0..*II
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
.... name 0..1EN
.... lotNumberText 0..1STlotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
... manufacturerOrganization 0..1Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ManufacturedProduct.classCoderequiredFixed Value: MANU
ManufacturedProduct.templateId:primary.nullFlavorrequiredNullFlavor
ManufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
ManufacturedProduct.manufacturedMaterial.nullFlavorrequiredNullFlavor
ManufacturedProduct.manufacturedMaterial.coderequiredCVX Vaccines Administered Vaccine Set

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.ManufacturedProduct

Summary

Mandatory: 7 elements

Slices

This structure defines the following Slices:

  • The element ManufacturedProduct.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from CDAR2.ManufacturedProduct

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct CDAR2.ManufacturedProductXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
... classCode 1..1cs
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... extension 1..1stRequired Pattern: 2014-06-09
... id 0..*II
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
.... lotNumberText 0..1STlotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
... manufacturerOrganization 0..1Organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ManufacturedProduct.manufacturedMaterial.coderequiredCVX Vaccines Administered Vaccine Set

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProductXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
Base for all types and resources
... @classCode 1..1csBinding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 0..*II
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
.... lotNumberText 0..1STlotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
... manufacturerOrganization 0..1Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ManufacturedProduct.classCoderequiredFixed Value: MANU
ManufacturedProduct.manufacturedMaterial.coderequiredCVX Vaccines Administered Vaccine Set

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProductXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
Base for all types and resources
... @classCode 1..1csBinding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 0..*II
... manufacturedLabeledDrug 0..1LabeledDrug
... manufacturedMaterial 1..1Material
.... @classCode 0..1csBinding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
.... @determinerCode 0..1csBinding: EntityDeterminerDetermined (required)
Fixed Value: KIND
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... templateId 0..*II
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
.... name 0..1EN
.... lotNumberText 0..1STlotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
... manufacturerOrganization 0..1Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ManufacturedProduct.classCoderequiredFixed Value: MANU
ManufacturedProduct.templateId:primary.nullFlavorrequiredNullFlavor
ManufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
ManufacturedProduct.manufacturedMaterial.nullFlavorrequiredNullFlavor
ManufacturedProduct.manufacturedMaterial.coderequiredCVX Vaccines Administered Vaccine Set

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.ManufacturedProduct

Summary

Mandatory: 7 elements

Slices

This structure defines the following Slices:

  • The element ManufacturedProduct.templateId is sliced based on the values of value:root, value:extension

 

Other representations of profile: CSV, Excel