International Patient Summary (IPS)
1.1.0-ballot - CI Build

International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.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-IPS/ and changes regularly. See the Directory of published versions

Logical Model: IPSImmunization - Detailed Descriptions

Draft as of 2024-08-04

Definitions for the 2.16.840.1.113883.10.22.4.15--20240804212024 logical model.

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

0. SubstanceAdministration
Control0..*
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.
2. SubstanceAdministration.templateId
Control1..?
SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. SubstanceAdministration.templateId:primary
    Slice Nameprimary
    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    Must Supporttrue
    6. SubstanceAdministration.templateId:primary.root
    Control1..1
    Typestring
    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 Value2.16.840.1.113883.10.22.4.15
    8. SubstanceAdministration.classCode
    Control1..1
    Typecode
    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 ValueSBADM
    10. SubstanceAdministration.moodCode
    Control1..1
    Typecode
    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 ValueEVN
    12. SubstanceAdministration.id
    Control0..*
    14. SubstanceAdministration.code
    Control1..1
    BindingThe codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.19709
    (required to urn:oid:2.16.840.1.113883.1.11.19709)

    ActSubstanceAdministrationImmunizationCode

    Must Supporttrue
    16. SubstanceAdministration.statusCode
    Control1..1
    Must Supporttrue
    18. SubstanceAdministration.statusCode.code
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuecompleted
    20. SubstanceAdministration.effectiveTime
    Control1..1
    Must Supporttrue
    22. SubstanceAdministration.consumable
    Control1..1
    Must Supporttrue
    24. SubstanceAdministration.consumable.manufacturedProduct
    Control0..*
    26. SubstanceAdministration.consumable.manufacturedProduct.classCode
    Control1..1
    Typecode
    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
    28. SubstanceAdministration.consumable.manufacturedProduct.templateId
    Control1..?
    SlicingThis element introduces a set of slices on SubstanceAdministration.consumable.manufacturedProduct.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ root
    • value @ extension
    • 30. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary
      Slice Nameprimary
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      Must Supporttrue
      32. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.root
      Control1..1
      Typestring
      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 Value2.16.840.1.113883.10.22.4.16
      34. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
      Control1..1
      Must Supporttrue
      36. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code
      Control1..1
      BindingThe codes SHOULD be taken from IPS Vaccines WHO ATC
      (preferred to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips)

      IPS Vaccines

      Must Supporttrue
      38. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation
      Control1..?
      SlicingThis element introduces a set of slices on SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ code
      • 40. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:primary
        Slice Nameprimary
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        42. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondary
        Slice Namesecondary
        Definition

        candidate: for when WHO ATC code system is preferred

        Control1..1
        BindingThe codes SHALL be taken from IPS Vaccines WHO ATC
        (required to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips)

        IPS Vaccines WHO ATC

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        44. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.lotNumberText
        Control0..1
        46. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization
        Control0..1
        Must Supporttrue
        48. SubstanceAdministration.author
        Control0..*
        Must Supporttrue
        50. SubstanceAdministration.entryRelationship
        Control1..?
        SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ profile
        • 52. SubstanceAdministration.entryRelationship:entryRelationship-1
          Slice NameentryRelationship-1
          Control0..*
          InvariantsentryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30) ()
          54. SubstanceAdministration.entryRelationship:entryRelationship-1.typeCode
          Control1..1
          Typecode
          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 ValueRSON
          56. SubstanceAdministration.entryRelationship:entryRelationship-1.substanceAdministration:entryRelationship-1
          Slice NameentryRelationship-1
          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(UV Subordinate Substance Administration)

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

          0. SubstanceAdministration
          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
          Control0..*
          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.
          2. SubstanceAdministration.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 SubstanceAdministration.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ root
          • value @ extension
          • 4. SubstanceAdministration.templateId:primary
            Slice Nameprimary
            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
            Must Supporttrue
            6. SubstanceAdministration.templateId:primary.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
            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.10.22.4.15
            8. SubstanceAdministration.classCode
            Control1..1
            BindingThe codes SHALL be taken from CDAActClass
            (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
            Typecode
            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 ValueSBADM
            10. SubstanceAdministration.moodCode
            Control1..1
            BindingThe codes SHALL be taken from XDocumentSubstanceMood (2.0.0)
            (required to http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0)
            Typecode
            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 ValueEVN
            12. SubstanceAdministration.id
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            14. SubstanceAdministration.code
            Control1..1
            BindingThe codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.19709
            (required to urn:oid:2.16.840.1.113883.1.11.19709)

            ActSubstanceAdministrationImmunizationCode

            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
            Must Supporttrue
            16. SubstanceAdministration.statusCode
            Control1..1
            BindingThe codes SHALL be taken from ActStatus
            (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
            Must Supporttrue
            18. SubstanceAdministration.statusCode.code
            Definition

            The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

            Control0..1
            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.
            LabelCode
            Fixed Valuecompleted
            20. SubstanceAdministration.statusCode.codeSystem
            Definition

            Specifies the code system that defines the code.

            Control0..0
            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.
            LabelCode System
            22. SubstanceAdministration.statusCode.codeSystemName
            Definition

            The common name of the coding system.

            Control0..0
            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.
            LabelCode System Name
            24. SubstanceAdministration.statusCode.codeSystemVersion
            Definition

            If applicable, a version descriptor defined specifically for the given code system.

            Control0..0
            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.
            LabelCode System Version
            26. SubstanceAdministration.statusCode.displayName
            Definition

            A name or title for the code, under which the sending system shows the code value to its users.

            Control0..0
            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.
            LabelDisplay Name
            28. SubstanceAdministration.statusCode.originalText
            Definition

            The text or phrase used as the basis for the coding.

            Control0..0
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
            LabelOriginal Text
            30. SubstanceAdministration.statusCode.qualifier
            Definition

            Specifies additional codes that increase the specificity of the the primary code.

            Control0..0
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
            LabelQualifier
            32. SubstanceAdministration.statusCode.translation
            Definition

            A set of other concept descriptors that translate this concept descriptor into other code systems.

            Control0..0
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
            XML FormatThe type of this property is determined using the xsi:typeattribute.
            LabelTranslation
            34. SubstanceAdministration.effectiveTime
            Control1..1
            TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
            Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
            Must Supporttrue
            Must Support TypesNo must-support rules about the choice of types/profiles
            XML FormatThe type of this property is determined using the xsi:typeattribute.
            36. SubstanceAdministration.consumable
            Definition

            The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
            Must Supporttrue
            38. SubstanceAdministration.consumable.manufacturedProduct
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
            40. SubstanceAdministration.consumable.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 SubstanceAdministration.consumable.manufacturedProduct.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ root
            • value @ extension
            • 42. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary
              Slice Nameprimary
              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
              Must Supporttrue
              44. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.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
              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.10.22.4.16
              46. SubstanceAdministration.consumable.manufacturedProduct.classCode
              Control0..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
              48. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Material
              Must Supporttrue
              50. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code
              Control1..1
              BindingThe codes SHOULD be taken from IPS Vaccines WHO ATC
              (preferred to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips)

              IPS Vaccines

              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              Must Supporttrue
              52. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.qualifier
              Definition

              Specifies additional codes that increase the specificity of the the primary code.

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
              LabelQualifier
              54. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation
              Definition

              A set of other concept descriptors that translate this concept descriptor into other code systems.

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelTranslation
              SlicingThis element introduces a set of slices on SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ code
              • 56. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:primary
                Slice Nameprimary
                Definition

                A set of other concept descriptors that translate this concept descriptor into other code systems.

                Control1..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                XML FormatThe type of this property is determined using the xsi:typeattribute.
                LabelTranslation
                58. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondary
                Slice Namesecondary
                Definition

                candidate: for when WHO ATC code system is preferred

                Control1..1
                BindingThe codes SHALL be taken from IPS Vaccines WHO ATC
                (required to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips)

                IPS Vaccines WHO ATC

                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                XML FormatThe type of this property is determined using the xsi:typeattribute.
                LabelTranslation
                60. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.lotNumberText
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
                62. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
                Must Supporttrue
                64. SubstanceAdministration.author
                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
                Must Supporttrue
                66. SubstanceAdministration.entryRelationship
                Control1..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ profile
                • 68. SubstanceAdministration.entryRelationship:entryRelationship-1
                  Slice NameentryRelationship-1
                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                  InvariantsentryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30) ()
                  70. SubstanceAdministration.entryRelationship:entryRelationship-1.typeCode
                  Control1..1
                  BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
                  (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
                  Typecode
                  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 ValueRSON
                  72. SubstanceAdministration.entryRelationship:entryRelationship-1.substanceAdministration:entryRelationship-1
                  Slice NameentryRelationship-1
                  Definition

                  The moodCode of this subordinate substance administration SHALL be the same of the parent substance administration

                  ShortBase for all types and resources
                  Control1..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(UV Subordinate Substance Administration)
                  Is Modifierfalse
                  Must Supporttrue

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

                  0. SubstanceAdministration
                  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
                  Control0..*
                  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.
                  2. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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 SubstanceAdministration.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ root
                  • value @ extension
                  • 20. SubstanceAdministration.templateId:primary
                    Slice Nameprimary
                    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
                    Must Supporttrue
                    22. SubstanceAdministration.templateId:primary.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. SubstanceAdministration.templateId:primary.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. SubstanceAdministration.templateId:primary.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. SubstanceAdministration.templateId:primary.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
                    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.10.22.4.15
                    30. SubstanceAdministration.templateId:primary.extension
                    Definition

                    A character string as a unique identifier within the scope of the identifier root.

                    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.
                    LabelExtension
                    32. SubstanceAdministration.classCode
                    Control1..1
                    BindingThe codes SHALL be taken from CDAActClass
                    (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
                    Typecode
                    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 ValueSBADM
                    34. SubstanceAdministration.moodCode
                    Control1..1
                    BindingThe codes SHALL be taken from XDocumentSubstanceMood (2.0.0)
                    (required to http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0)
                    Typecode
                    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 ValueEVN
                    36. SubstanceAdministration.id
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                    38. SubstanceAdministration.code
                    Control1..1
                    BindingThe codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.19709
                    (required to urn:oid:2.16.840.1.113883.1.11.19709)

                    ActSubstanceAdministrationImmunizationCode

                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                    Must Supporttrue
                    40. SubstanceAdministration.negationInd
                    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.
                    42. SubstanceAdministration.text
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                    44. SubstanceAdministration.statusCode
                    Control1..1
                    BindingThe codes SHALL be taken from ActStatus
                    (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
                    Must Supporttrue
                    46. SubstanceAdministration.statusCode.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
                    48. SubstanceAdministration.statusCode.code
                    Definition

                    The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

                    Control0..1
                    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.
                    LabelCode
                    Fixed Valuecompleted
                    50. SubstanceAdministration.statusCode.codeSystem
                    Definition

                    Specifies the code system that defines the code.

                    Control0..0
                    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.
                    LabelCode System
                    52. SubstanceAdministration.statusCode.codeSystemName
                    Definition

                    The common name of the coding system.

                    Control0..0
                    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.
                    LabelCode System Name
                    54. SubstanceAdministration.statusCode.codeSystemVersion
                    Definition

                    If applicable, a version descriptor defined specifically for the given code system.

                    Control0..0
                    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.
                    LabelCode System Version
                    56. SubstanceAdministration.statusCode.displayName
                    Definition

                    A name or title for the code, under which the sending system shows the code value to its users.

                    Control0..0
                    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.
                    LabelDisplay Name
                    58. SubstanceAdministration.statusCode.sdtcValueSet
                    Definition

                    The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

                    Control0..1
                    Typestring(oid: ISO Object Identifier)
                    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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
                    60. SubstanceAdministration.statusCode.sdtcValueSetVersion
                    Definition

                    The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

                    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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
                    62. SubstanceAdministration.statusCode.originalText
                    Definition

                    The text or phrase used as the basis for the coding.

                    Control0..0
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                    LabelOriginal Text
                    64. SubstanceAdministration.statusCode.qualifier
                    Definition

                    Specifies additional codes that increase the specificity of the the primary code.

                    Control0..0
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
                    LabelQualifier
                    66. SubstanceAdministration.statusCode.translation
                    Definition

                    A set of other concept descriptors that translate this concept descriptor into other code systems.

                    Control0..0
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                    XML FormatThe type of this property is determined using the xsi:typeattribute.
                    LabelTranslation
                    68. SubstanceAdministration.effectiveTime
                    Control1..1
                    TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
                    Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
                    Must Supporttrue
                    Must Support TypesNo must-support rules about the choice of types/profiles
                    XML FormatThe type of this property is determined using the xsi:typeattribute.
                    70. SubstanceAdministration.priorityCode
                    Control0..1
                    BindingFor example codes, see ActPriority
                    (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                    72. SubstanceAdministration.repeatNumber
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
                    74. SubstanceAdministration.routeCode
                    Control0..1
                    BindingFor example codes, see RouteOfAdministration
                    (example to http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration)
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                    76. SubstanceAdministration.approachSiteCode
                    Control0..*
                    BindingFor example codes, see v3 Value Set ActSite
                    (example to http://terminology.hl7.org/ValueSet/v3-ActSite)
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                    78. SubstanceAdministration.doseQuantity
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
                    80. SubstanceAdministration.rateQuantity
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
                    82. SubstanceAdministration.maxDoseQuantity
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
                    84. SubstanceAdministration.administrationUnitCode
                    Control0..1
                    BindingFor example codes, see AdministrableDrugForm
                    (example to http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm)
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                    86. SubstanceAdministration.consumable
                    Definition

                    The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.

                    Control1..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
                    Must Supporttrue
                    88. SubstanceAdministration.consumable.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
                    90. SubstanceAdministration.consumable.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
                    92. SubstanceAdministration.consumable.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
                    94. SubstanceAdministration.consumable.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
                    96. SubstanceAdministration.consumable.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
                    98. SubstanceAdministration.consumable.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
                    100. SubstanceAdministration.consumable.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
                    102. SubstanceAdministration.consumable.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
                    104. SubstanceAdministration.consumable.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
                    106. SubstanceAdministration.consumable.typeCode
                    Control0..1
                    BindingThe codes SHALL be taken from CDAParticipationType
                    (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
                    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 ValueCSM
                    108. SubstanceAdministration.consumable.manufacturedProduct
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
                    110. SubstanceAdministration.consumable.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
                    112. SubstanceAdministration.consumable.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
                    114. SubstanceAdministration.consumable.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
                    116. SubstanceAdministration.consumable.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
                    118. SubstanceAdministration.consumable.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
                    120. SubstanceAdministration.consumable.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
                    122. SubstanceAdministration.consumable.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
                    124. SubstanceAdministration.consumable.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
                    126. SubstanceAdministration.consumable.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 SubstanceAdministration.consumable.manufacturedProduct.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ root
                    • value @ extension
                    • 128. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary
                      Slice Nameprimary
                      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
                      Must Supporttrue
                      130. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.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
                      132. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.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
                      134. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.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
                      136. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.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
                      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.10.22.4.16
                      138. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.extension
                      Definition

                      A character string as a unique identifier within the scope of the identifier root.

                      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.
                      LabelExtension
                      140. SubstanceAdministration.consumable.manufacturedProduct.classCode
                      Control0..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
                      142. SubstanceAdministration.consumable.manufacturedProduct.id
                      Control0..*
                      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                      144. SubstanceAdministration.consumable.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.
                      146. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug
                      Control0..1
                      Typehttp://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug
                      148. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
                      Control1..1
                      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Material
                      Must Supporttrue
                      150. SubstanceAdministration.consumable.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
                      152. SubstanceAdministration.consumable.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
                      154. SubstanceAdministration.consumable.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
                      156. SubstanceAdministration.consumable.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
                      158. SubstanceAdministration.consumable.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
                      160. SubstanceAdministration.consumable.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
                      162. SubstanceAdministration.consumable.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
                      164. SubstanceAdministration.consumable.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
                      166. SubstanceAdministration.consumable.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
                      168. SubstanceAdministration.consumable.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
                      170. SubstanceAdministration.consumable.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
                      172. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code
                      Control1..1
                      BindingThe codes SHOULD be taken from IPS Vaccines WHO ATC
                      (preferred to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips)

                      IPS Vaccines

                      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                      Must Supporttrue
                      174. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.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
                      176. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.code
                      Definition

                      The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

                      Control0..1
                      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.
                      LabelCode
                      178. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.codeSystem
                      Definition

                      Specifies the code system that defines the code.

                      Control0..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.
                      LabelCode System
                      180. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.codeSystemName
                      Definition

                      The common name of the coding system.

                      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.
                      LabelCode System Name
                      182. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.codeSystemVersion
                      Definition

                      If applicable, a version descriptor defined specifically for the given code system.

                      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.
                      LabelCode System Version
                      184. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.displayName
                      Definition

                      A name or title for the code, under which the sending system shows the code value to its users.

                      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.
                      LabelDisplay Name
                      186. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.sdtcValueSet
                      Definition

                      The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

                      Control0..1
                      Typestring(oid: ISO Object Identifier)
                      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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
                      188. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.sdtcValueSetVersion
                      Definition

                      The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

                      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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
                      190. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.originalText
                      Definition

                      The text or phrase used as the basis for the coding.

                      Control0..1
                      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                      LabelOriginal Text
                      192. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.qualifier
                      Definition

                      Specifies additional codes that increase the specificity of the the primary code.

                      Control0..0
                      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
                      LabelQualifier
                      194. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation
                      Definition

                      A set of other concept descriptors that translate this concept descriptor into other code systems.

                      Control1..*
                      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                      XML FormatThe type of this property is determined using the xsi:typeattribute.
                      LabelTranslation
                      SlicingThis element introduces a set of slices on SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ code
                      • 196. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:primary
                        Slice Nameprimary
                        Definition

                        A set of other concept descriptors that translate this concept descriptor into other code systems.

                        Control1..1
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                        XML FormatThe type of this property is determined using the xsi:typeattribute.
                        LabelTranslation
                        198. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondary
                        Slice Namesecondary
                        Definition

                        candidate: for when WHO ATC code system is preferred

                        Control1..1
                        BindingThe codes SHALL be taken from IPS Vaccines WHO ATC
                        (required to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips)

                        IPS Vaccines WHO ATC

                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                        XML FormatThe type of this property is determined using the xsi:typeattribute.
                        LabelTranslation
                        200. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.name
                        Control0..1
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EN
                        202. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.lotNumberText
                        Control0..1
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
                        204. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization
                        Control0..1
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
                        Must Supporttrue
                        206. SubstanceAdministration.subject
                        Control0..1
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
                        208. SubstanceAdministration.specimen
                        Control0..*
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
                        210. SubstanceAdministration.performer
                        Control0..*
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
                        212. SubstanceAdministration.author
                        Control0..*
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
                        Must Supporttrue
                        214. SubstanceAdministration.informant
                        Control0..*
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
                        216. SubstanceAdministration.participant
                        Control0..*
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
                        218. SubstanceAdministration.entryRelationship
                        Control1..*
                        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                        SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ profile
                        • 220. SubstanceAdministration.entryRelationship:entryRelationship-1
                          Slice NameentryRelationship-1
                          Control0..*
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                          InvariantsentryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30) ()
                          222. SubstanceAdministration.entryRelationship:entryRelationship-1.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
                          224. SubstanceAdministration.entryRelationship:entryRelationship-1.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
                          226. SubstanceAdministration.entryRelationship:entryRelationship-1.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
                          228. SubstanceAdministration.entryRelationship:entryRelationship-1.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
                          230. SubstanceAdministration.entryRelationship:entryRelationship-1.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
                          232. SubstanceAdministration.entryRelationship:entryRelationship-1.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
                          234. SubstanceAdministration.entryRelationship:entryRelationship-1.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
                          236. SubstanceAdministration.entryRelationship:entryRelationship-1.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
                          238. SubstanceAdministration.entryRelationship:entryRelationship-1.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
                          240. SubstanceAdministration.entryRelationship:entryRelationship-1.typeCode
                          Control1..1
                          BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
                          (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
                          Typecode
                          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 ValueRSON
                          242. SubstanceAdministration.entryRelationship:entryRelationship-1.inversionInd
                          Definition

                          The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.

                          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.
                          244. SubstanceAdministration.entryRelationship:entryRelationship-1.contextConductionInd
                          Definition

                          The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.

                          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.
                          Default Valuetrue
                          246. SubstanceAdministration.entryRelationship:entryRelationship-1.negationInd
                          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.
                          248. SubstanceAdministration.entryRelationship:entryRelationship-1.sequenceNumber
                          Control0..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                          250. SubstanceAdministration.entryRelationship:entryRelationship-1.seperatableInd
                          Control0..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                          252. SubstanceAdministration.entryRelationship:entryRelationship-1.act
                          Control0..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
                          254. SubstanceAdministration.entryRelationship:entryRelationship-1.encounter
                          Control0..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                          256. SubstanceAdministration.entryRelationship:entryRelationship-1.observation
                          Control0..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
                          258. SubstanceAdministration.entryRelationship:entryRelationship-1.observationMedia
                          Control0..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                          260. SubstanceAdministration.entryRelationship:entryRelationship-1.organizer
                          Control0..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                          262. SubstanceAdministration.entryRelationship:entryRelationship-1.procedure
                          Control0..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                          264. SubstanceAdministration.entryRelationship:entryRelationship-1.regionOfInterest
                          Control0..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                          266. SubstanceAdministration.entryRelationship:entryRelationship-1.substanceAdministration:entryRelationship-1
                          Slice NameentryRelationship-1
                          Definition

                          The moodCode of this subordinate substance administration SHALL be the same of the parent substance administration

                          ShortBase for all types and resources
                          Control1..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(UV Subordinate Substance Administration)
                          Is Modifierfalse
                          Must Supporttrue
                          268. SubstanceAdministration.entryRelationship:entryRelationship-1.supply
                          Control0..1
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                          270. SubstanceAdministration.reference
                          Control0..*
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
                          272. SubstanceAdministration.precondition
                          Control0..*
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
                          274. SubstanceAdministration.sdtcInFulfillmentOf1
                          Control0..*
                          Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
                          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.