Consolidated CDA (C-CDA)
3.0.0 - STU3 United States of America flag

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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: ImmunizationMedicationInformation - Detailed Descriptions

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 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
    ShortlotNumberText 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.

    ShortBase for all types and resources
    Control10..1*
    Is Modifierfalse
    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.
    Invariantsproduct-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

    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    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
      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

      Control1..1
      Typehttp://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.

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Pattern Value2.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.

      Control1..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      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..1
      BindingThe codes SHALL be taken from RoleClassManufacturedProduct
      (required to http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueMANU
      12. ManufacturedProduct.id
      Comments

      MAY contain zero or more [0..*] id (CONF:1098-9005).

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      14. ManufacturedProduct.manufacturedMaterial
      Comments

      SHALL contain exactly one [1..1] manufacturedMaterial (CONF:1098-9006).

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Material
      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..1
      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)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      18. ManufacturedProduct.manufacturedMaterial.lotNumberText
      ShortlotNumberText 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).

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
      20. ManufacturedProduct.manufacturerOrganization
      Comments

      SHOULD contain zero or one [0..1] manufacturerOrganization (CONF:1098-9012).

      Control0..1
      Typehttp://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.

      ShortBase for all types and resources
      Control1..1
      Is Modifierfalse
      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.
      Invariantsproduct-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.

      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional 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

      Control0..*
      Typehttp://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.

      Control0..1
      Typehttp://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.

      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional 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.

      Control0..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning 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).

      Control0..1
      Typeboolean(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      14. ManufacturedProduct.typeId.root
      Definition

      Identifies the type as an HL7 Registered model

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Fixed Value2.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.

      Control1..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      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

      Control1..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      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
      • 20. ManufacturedProduct.templateId:immunization-med-info
        Slice Nameimmunization-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

        Control1..1
        Typehttp://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.

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional 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.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning 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).

        Control0..1
        Typeboolean(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        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.

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Pattern Value2.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.

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        Pattern Value2014-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).

        Control1..1
        BindingThe codes SHALL be taken from RoleClassManufacturedProduct
        (required to http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueMANU
        34. ManufacturedProduct.id
        Comments

        MAY contain zero or more [0..*] id (CONF:1098-9005).

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        36. ManufacturedProduct.sdtcIdentifiedBy
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
        XML FormatIn 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
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug
        40. ManufacturedProduct.manufacturedMaterial
        Comments

        SHALL contain exactly one [1..1] manufacturedMaterial (CONF:1098-9006).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Material
        Invariantsshould-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.

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional 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

        Control0..*
        Typehttp://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.

        Control0..1
        Typehttp://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.

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional 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.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning 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).

        Control0..1
        Typeboolean(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        54. ManufacturedProduct.manufacturedMaterial.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.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.

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        60. ManufacturedProduct.manufacturedMaterial.classCode
        Control0..1
        BindingThe codes SHALL be taken from EntityClassManufacturedMaterial
        (required to http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueMMAT
        62. ManufacturedProduct.manufacturedMaterial.determinerCode
        Control0..1
        BindingThe codes SHALL be taken from EntityDeterminerDetermined
        (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueKIND
        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).

        Control1..1
        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)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        66. ManufacturedProduct.manufacturedMaterial.name
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EN
        68. ManufacturedProduct.manufacturedMaterial.lotNumberText
        ShortlotNumberText 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).

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
        70. ManufacturedProduct.manufacturerOrganization
        Comments

        SHOULD contain zero or one [0..1] manufacturerOrganization (CONF:1098-9012).

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization