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

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: ImmunizationMedicationInformation - Detailed Descriptions

Draft as of 2024-12-19

Definitions for the ImmunizationMedicationInformation logical model.

Guidance on how to interpret the contents of this table can be found here

0. ManufacturedProduct
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-manufacturerOrganization: SHOULD contain manufacturerOrganization (manufacturerOrganization.exists())
2. ManufacturedProduct.templateId
Control1..?
SlicingThis element introduces a set of slices on ManufacturedProduct.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. ManufacturedProduct.templateId:immunization-med-info
    Slice Nameimmunization-med-info
    Control1..1
    6. ManufacturedProduct.templateId:immunization-med-info.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.54
    8. ManufacturedProduct.templateId:immunization-med-info.extension
    Control1..?
    Pattern Value2014-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).

    Control1..?
    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).

    Control1..?
    Invariantsshould-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).

    Control1..?
    BindingThe 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𝗨𝗦𝗖𝗗𝗜: Lot Number Text - 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).