Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v4.0.0: CCDA 4.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

Logical Model: Immunization Medication Information

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationMedicationInformation Version: 4.0.0
Draft as of 2025-06-20 Computable Name: ImmunizationMedicationInformation
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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.

Usages:

Changes since version 3.0.0:

  • No changes

    • Formal Views of Template Content

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

    This structure is derived from ManufacturedProduct

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ManufacturedProduct C 1..1 ManufacturedProduct XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-manufacturerOrganization
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:immunization-med-info 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.54
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs
    ... id 0..* II
    .... code 1..1 CE Binding: CVX Vaccines Administered Vaccine Set . (required)
    .... lotNumberText 0..1 ST 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
    ... manufacturerOrganization 0..1 Organization

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    ManufacturedProduct.manufacturedMaterial.coderequiredCVXVaccinesAdministeredVaccineSet .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6

    Constraints

    IdGradePath(s)DetailsRequirements
    should-lotNumberTextwarningManufacturedProduct.manufacturedMaterialSHOULD contain lotNumberText
    : lotNumberText.exists()
    should-manufacturerOrganizationwarningManufacturedProductSHOULD contain manufacturerOrganization
    : manufacturerOrganization.exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ManufacturedProduct C 1..1 ManufacturedProduct XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: product-choice, should-manufacturerOrganization
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:immunization-med-info 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.54
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: RoleClassManufacturedProduct (required)
    Fixed Value: MANU
    ... id 0..* II
    ... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ... (Choice of one) 1..1
    .... manufacturedLabeledDrug 0..1 LabeledDrug
    .... manufacturedMaterial C 1..1 Material Constraints: should-lotNumberText
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassManufacturedMaterial (required)
    Fixed Value: MMAT
    ..... @determinerCode 0..1 cs Binding: EntityDeterminerDetermined (required)
    Fixed Value: KIND
    ..... code 1..1 CE Binding: CVX Vaccines Administered Vaccine Set . (required)
    ..... name 0..1 EN
    ..... lotNumberText 0..1 ST 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
    ... manufacturerOrganization 0..1 Organization

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    ManufacturedProduct.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.templateId:immunization-med-info.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.classCoderequiredFixed Value: MANU
    http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
    ManufacturedProduct.manufacturedMaterial.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.manufacturedMaterial.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
    http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
    ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
    ManufacturedProduct.manufacturedMaterial.coderequiredCVXVaccinesAdministeredVaccineSet .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorManufacturedProduct.typeId, ManufacturedProduct.manufacturedMaterial.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    product-choiceerrorManufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
    : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
    should-lotNumberTextwarningManufacturedProduct.manufacturedMaterialSHOULD contain lotNumberText
    : lotNumberText.exists()
    should-manufacturerOrganizationwarningManufacturedProductSHOULD contain manufacturerOrganization
    : manufacturerOrganization.exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ManufacturedProduct C 1..1 ManufacturedProduct XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: product-choice, should-manufacturerOrganization
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:immunization-med-info 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.54
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: RoleClassManufacturedProduct (required)
    Fixed Value: MANU
    ... id 0..* II
    ... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ... (Choice of one) 1..1
    .... manufacturedLabeledDrug 0..1 LabeledDrug
    .... manufacturedMaterial C 1..1 Material Constraints: should-lotNumberText
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassManufacturedMaterial (required)
    Fixed Value: MMAT
    ..... @determinerCode 0..1 cs Binding: EntityDeterminerDetermined (required)
    Fixed Value: KIND
    ..... code 1..1 CE Binding: CVX Vaccines Administered Vaccine Set . (required)
    ..... name 0..1 EN
    ..... lotNumberText 0..1 ST 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
    ... manufacturerOrganization 0..1 Organization

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    ManufacturedProduct.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.templateId:immunization-med-info.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.classCoderequiredFixed Value: MANU
    http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
    ManufacturedProduct.manufacturedMaterial.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.manufacturedMaterial.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
    http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
    ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
    ManufacturedProduct.manufacturedMaterial.coderequiredCVXVaccinesAdministeredVaccineSet .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorManufacturedProduct.typeId, ManufacturedProduct.manufacturedMaterial.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    product-choiceerrorManufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
    : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
    should-lotNumberTextwarningManufacturedProduct.manufacturedMaterialSHOULD contain lotNumberText
    : lotNumberText.exists()
    should-manufacturerOrganizationwarningManufacturedProductSHOULD contain manufacturerOrganization
    : manufacturerOrganization.exists()

    This structure is derived from ManufacturedProduct

    Summary

    Mandatory: 7 elements

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of ManufacturedProduct.templateId

    Differential View

    This structure is derived from ManufacturedProduct

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ManufacturedProduct C 1..1 ManufacturedProduct XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-manufacturerOrganization
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:immunization-med-info 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.54
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs
    ... id 0..* II
    .... code 1..1 CE Binding: CVX Vaccines Administered Vaccine Set . (required)
    .... lotNumberText 0..1 ST 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
    ... manufacturerOrganization 0..1 Organization

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    ManufacturedProduct.manufacturedMaterial.coderequiredCVXVaccinesAdministeredVaccineSet .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6

    Constraints

    IdGradePath(s)DetailsRequirements
    should-lotNumberTextwarningManufacturedProduct.manufacturedMaterialSHOULD contain lotNumberText
    : lotNumberText.exists()
    should-manufacturerOrganizationwarningManufacturedProductSHOULD contain manufacturerOrganization
    : manufacturerOrganization.exists()

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ManufacturedProduct C 1..1 ManufacturedProduct XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: product-choice, should-manufacturerOrganization
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:immunization-med-info 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.54
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: RoleClassManufacturedProduct (required)
    Fixed Value: MANU
    ... id 0..* II
    ... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ... (Choice of one) 1..1
    .... manufacturedLabeledDrug 0..1 LabeledDrug
    .... manufacturedMaterial C 1..1 Material Constraints: should-lotNumberText
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassManufacturedMaterial (required)
    Fixed Value: MMAT
    ..... @determinerCode 0..1 cs Binding: EntityDeterminerDetermined (required)
    Fixed Value: KIND
    ..... code 1..1 CE Binding: CVX Vaccines Administered Vaccine Set . (required)
    ..... name 0..1 EN
    ..... lotNumberText 0..1 ST 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
    ... manufacturerOrganization 0..1 Organization

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    ManufacturedProduct.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.templateId:immunization-med-info.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.classCoderequiredFixed Value: MANU
    http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
    ManufacturedProduct.manufacturedMaterial.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.manufacturedMaterial.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
    http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
    ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
    ManufacturedProduct.manufacturedMaterial.coderequiredCVXVaccinesAdministeredVaccineSet .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorManufacturedProduct.typeId, ManufacturedProduct.manufacturedMaterial.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    product-choiceerrorManufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
    : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
    should-lotNumberTextwarningManufacturedProduct.manufacturedMaterialSHOULD contain lotNumberText
    : lotNumberText.exists()
    should-manufacturerOrganizationwarningManufacturedProductSHOULD contain manufacturerOrganization
    : manufacturerOrganization.exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ManufacturedProduct C 1..1 ManufacturedProduct XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: product-choice, should-manufacturerOrganization
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:immunization-med-info 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.54
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: RoleClassManufacturedProduct (required)
    Fixed Value: MANU
    ... id 0..* II
    ... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ... (Choice of one) 1..1
    .... manufacturedLabeledDrug 0..1 LabeledDrug
    .... manufacturedMaterial C 1..1 Material Constraints: should-lotNumberText
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassManufacturedMaterial (required)
    Fixed Value: MMAT
    ..... @determinerCode 0..1 cs Binding: EntityDeterminerDetermined (required)
    Fixed Value: KIND
    ..... code 1..1 CE Binding: CVX Vaccines Administered Vaccine Set . (required)
    ..... name 0..1 EN
    ..... lotNumberText 0..1 ST 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations.
    ... manufacturerOrganization 0..1 Organization

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    ManufacturedProduct.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.templateId:immunization-med-info.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.classCoderequiredFixed Value: MANU
    http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
    ManufacturedProduct.manufacturedMaterial.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.manufacturedMaterial.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ManufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
    http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
    ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
    ManufacturedProduct.manufacturedMaterial.coderequiredCVXVaccinesAdministeredVaccineSet .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorManufacturedProduct.typeId, ManufacturedProduct.manufacturedMaterial.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    product-choiceerrorManufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
    : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
    should-lotNumberTextwarningManufacturedProduct.manufacturedMaterialSHOULD contain lotNumberText
    : lotNumberText.exists()
    should-manufacturerOrganizationwarningManufacturedProductSHOULD contain manufacturerOrganization
    : manufacturerOrganization.exists()

    This structure is derived from ManufacturedProduct

    Summary

    Mandatory: 7 elements

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of ManufacturedProduct.templateId

     

    Other representations of profile: CSV, Excel