Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Immunization Medication Information

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.54 Version: 2.1.0-draft1
Active as of 2023-01-16 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 1..1CDAR2.ManufacturedProductBase for all types and resources
... classCode 1..1code
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..*II
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
..... Slices for translation 0..*CDSlice: Unordered, Open by value:$this
...... translation:vaccine 0..*CDBinding: Vaccine Clinical Drug (example)
...... translation:specificVaccine 0..*CDBinding: VSAC 2.16.840.1.113762.1.4.1010.10 (example)
.... lotNumberText 0..1EDlotNumberText 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
ManufacturedProduct.manufacturedMaterial.code.translation:vaccineexampleVaccine Clinical Drug
ManufacturedProduct.manufacturedMaterial.code.translation:specificVaccineexamplehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.10
NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProductBase for all types and resources
... classCode 1..1codeBinding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..*II
.... classCode 1..1codeBinding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
.... determinerCode 1..1codeBinding: EntityDeterminerDetermined (required)
Fixed Value: KIND
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
..... Slices for translation 0..*CDSlice: Unordered, Open by value:$this
...... translation:vaccine 0..*CDBinding: Vaccine Clinical Drug (example)
...... translation:specificVaccine 0..*CDBinding: VSAC 2.16.840.1.113762.1.4.1010.10 (example)
.... lotNumberText 0..1EDlotNumberText 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.classCoderequiredFixed Value: MMAT
ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
ManufacturedProduct.manufacturedMaterial.coderequiredCVX Vaccines Administered Vaccine Set
ManufacturedProduct.manufacturedMaterial.code.translation:vaccineexampleVaccine Clinical Drug
ManufacturedProduct.manufacturedMaterial.code.translation:specificVaccineexamplehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.10

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.ManufacturedProductBase for all types and resources
... classCode 1..1codeBinding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..*II
... manufacturedLabeledDrug 0..1LabeledDrug
... manufacturedMaterial 1..1Material
.... classCode 1..1codeBinding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
.... determinerCode 1..1codeBinding: EntityDeterminerDetermined (required)
Fixed Value: KIND
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... templateId 0..*II
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... code 0..1string
..... codeSystem 0..1string
..... codeSystemName 0..1string
..... codeSystemVersion 0..1string
..... displayName 0..1string
..... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
..... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
..... originalText 0..1ED
..... Slices for translation 0..*CDSlice: Unordered, Open by value:$this
...... translation:vaccine 0..*CDBinding: Vaccine Clinical Drug (example)
...... translation:specificVaccine 0..*CDBinding: VSAC 2.16.840.1.113762.1.4.1010.10 (example)
.... name 0..1EN
.... lotNumberText 0..1EDlotNumberText 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
ManufacturedProduct.manufacturedMaterial.code.nullFlavorrequiredNullFlavor
ManufacturedProduct.manufacturedMaterial.code.translation:vaccineexampleVaccine Clinical Drug
ManufacturedProduct.manufacturedMaterial.code.translation:specificVaccineexamplehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.10

This structure is derived from CDAR2.ManufacturedProduct

Summary

Mandatory: 6 elements

Slices

This structure defines the following Slices:

  • The element ManufacturedProduct.templateId is sliced based on the values of value:root, value:extension
  • The element ManufacturedProduct.manufacturedMaterial.code.translation is sliced based on the value of value:$this

Differential View

This structure is derived from CDAR2.ManufacturedProduct

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProductBase for all types and resources
... classCode 1..1code
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..*II
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
..... Slices for translation 0..*CDSlice: Unordered, Open by value:$this
...... translation:vaccine 0..*CDBinding: Vaccine Clinical Drug (example)
...... translation:specificVaccine 0..*CDBinding: VSAC 2.16.840.1.113762.1.4.1010.10 (example)
.... lotNumberText 0..1EDlotNumberText 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
ManufacturedProduct.manufacturedMaterial.code.translation:vaccineexampleVaccine Clinical Drug
ManufacturedProduct.manufacturedMaterial.code.translation:specificVaccineexamplehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.10

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProductBase for all types and resources
... classCode 1..1codeBinding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..*II
.... classCode 1..1codeBinding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
.... determinerCode 1..1codeBinding: EntityDeterminerDetermined (required)
Fixed Value: KIND
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
..... Slices for translation 0..*CDSlice: Unordered, Open by value:$this
...... translation:vaccine 0..*CDBinding: Vaccine Clinical Drug (example)
...... translation:specificVaccine 0..*CDBinding: VSAC 2.16.840.1.113762.1.4.1010.10 (example)
.... lotNumberText 0..1EDlotNumberText 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.classCoderequiredFixed Value: MMAT
ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
ManufacturedProduct.manufacturedMaterial.coderequiredCVX Vaccines Administered Vaccine Set
ManufacturedProduct.manufacturedMaterial.code.translation:vaccineexampleVaccine Clinical Drug
ManufacturedProduct.manufacturedMaterial.code.translation:specificVaccineexamplehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.10

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.ManufacturedProductBase for all types and resources
... classCode 1..1codeBinding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.54
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..*II
... manufacturedLabeledDrug 0..1LabeledDrug
... manufacturedMaterial 1..1Material
.... classCode 1..1codeBinding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
.... determinerCode 1..1codeBinding: EntityDeterminerDetermined (required)
Fixed Value: KIND
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... templateId 0..*II
.... code 1..1CEBinding: CVX Vaccines Administered Vaccine Set (required)
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... code 0..1string
..... codeSystem 0..1string
..... codeSystemName 0..1string
..... codeSystemVersion 0..1string
..... displayName 0..1string
..... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
..... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
..... originalText 0..1ED
..... Slices for translation 0..*CDSlice: Unordered, Open by value:$this
...... translation:vaccine 0..*CDBinding: Vaccine Clinical Drug (example)
...... translation:specificVaccine 0..*CDBinding: VSAC 2.16.840.1.113762.1.4.1010.10 (example)
.... name 0..1EN
.... lotNumberText 0..1EDlotNumberText 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
ManufacturedProduct.manufacturedMaterial.code.nullFlavorrequiredNullFlavor
ManufacturedProduct.manufacturedMaterial.code.translation:vaccineexampleVaccine Clinical Drug
ManufacturedProduct.manufacturedMaterial.code.translation:specificVaccineexamplehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.10

This structure is derived from CDAR2.ManufacturedProduct

Summary

Mandatory: 6 elements

Slices

This structure defines the following Slices:

  • The element ManufacturedProduct.templateId is sliced based on the values of value:root, value:extension
  • The element ManufacturedProduct.manufacturedMaterial.code.translation is sliced based on the value of value:$this

 

​Other representations of profile: CSV, Excel, Schematron