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: IPSPlannedImmunization - Detailed Descriptions

Draft as of 2020-05-08

Definitions for the 2.16.840.1.113883.10.22.4.47--20200508172918 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.47
    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.
    Pattern ValuePRP
    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.text
    Definition

    The element if present points to the text describing the problem being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the problem in the document that is being described.

    Control0..1
    Must Supporttrue
    18. SubstanceAdministration.text.reference
    Control1..1
    Must Supporttrue
    20. SubstanceAdministration.text.reference.value
    Definition

    When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

    Control1..1
    Typeurl
    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.
    22. SubstanceAdministration.statusCode
    Control1..1
    Must Supporttrue
    24. SubstanceAdministration.statusCode.code
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuecompleted
    26. SubstanceAdministration.effectiveTime
    Control0..1
    Must Supporttrue
    28. SubstanceAdministration.consumable
    Control1..1
    Must Supporttrue
    30. SubstanceAdministration.consumable.manufacturedProduct
    Control0..*
    32. 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
    34. 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
    • 36. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary
      Slice Nameprimary
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      Must Supporttrue
      38. 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
      40. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
      Control1..1
      Must Supporttrue
      42. 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
      44. 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
      • 46. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:primary
        Slice Nameprimary
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        48. 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
        50. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.lotNumberText
        Control0..1
        52. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization
        Control0..1
        Must Supporttrue
        54. SubstanceAdministration.author
        Control0..*
        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.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.47
          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.
          Pattern ValuePRP
          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.text
          Definition

          The element if present points to the text describing the problem being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the problem in the document that is being described.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
          Must Supporttrue
          18. SubstanceAdministration.text.reference
          Definition

          A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
          Must Supporttrue
          LabelReference
          20. SubstanceAdministration.text.reference.value
          Definition

          When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

          Control1..1
          Typeurl
          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.
          22. 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
          24. 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
          26. 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
          28. 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
          30. 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
          32. 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
          34. 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
          36. 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
          38. 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
          40. SubstanceAdministration.effectiveTime
          Control0..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.
          42. 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
          44. SubstanceAdministration.consumable.manufacturedProduct
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
          46. 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
          • 48. 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
            50. 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
            52. 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
            54. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Material
            Must Supporttrue
            56. 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
            58. 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
            60. 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
            • 62. 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
              64. 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
              66. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.lotNumberText
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
              68. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
              Must Supporttrue
              70. SubstanceAdministration.author
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
              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.47
                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.
                Pattern ValuePRP
                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
                Definition

                The element if present points to the text describing the problem being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the problem in the document that is being described.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                Must Supporttrue
                44. SubstanceAdministration.text.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
                46. SubstanceAdministration.text.compression
                Definition

                Indicates whether the raw byte data is compressed, and what compression algorithm was used.

                Control0..1
                BindingThe codes SHALL be taken from CDACompressionAlgorithm
                (required to http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm)
                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.
                LabelCompression
                48. SubstanceAdministration.text.integrityCheck
                Definition

                The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

                Control0..1
                Typebase64Binary(bin: Binary Data)
                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.
                LabelIntegrity Check
                50. SubstanceAdministration.text.integrityCheckAlgorithm
                Definition

                Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

                Control0..1
                BindingThe codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0)
                (required to http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0)
                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.
                LabelIntegrity Check Algorithm
                52. SubstanceAdministration.text.language
                Definition

                For character based information the language property specifies the human language of the text.

                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.
                LabelLanguage
                54. SubstanceAdministration.text.mediaType
                Definition

                Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

                Control0..1
                BindingFor example codes, see MediaType
                (example to http://terminology.hl7.org/ValueSet/v3-MediaType)
                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.
                LabelMedia Type
                56. SubstanceAdministration.text.representation
                Control0..1
                BindingThe codes SHALL be taken from CDABinaryDataEncoding
                (required to http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding)
                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.
                58. SubstanceAdministration.text.xmlText
                Definition

                Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

                ShortAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
                Comments

                This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

                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 unadorned text.
                60. SubstanceAdministration.text.reference
                Definition

                A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

                Control1..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
                Must Supporttrue
                LabelReference
                62. SubstanceAdministration.text.reference.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
                64. SubstanceAdministration.text.reference.value
                Definition

                When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

                Control1..1
                Typeurl
                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.
                66. SubstanceAdministration.text.reference.useablePeriod
                Definition

                Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

                Control0..*
                TypeChoice of: 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/SXPR-TS
                XML FormatThe type of this property is determined using the xsi:typeattribute.
                LabelUseable Period
                68. SubstanceAdministration.text.reference.use
                Definition

                One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

                Control0..*
                BindingThe codes SHALL be taken from TelecommunicationAddressUse (2.0.0)
                (required to http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0)
                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.
                LabelUse Code
                70. SubstanceAdministration.text.thumbnail
                Definition

                An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                LabelThumbnail
                72. 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
                74. 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
                76. 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
                78. 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
                80. 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
                82. 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
                84. 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
                86. 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.
                88. 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.
                90. 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
                92. 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
                94. 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
                96. SubstanceAdministration.effectiveTime
                Control0..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.
                98. 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
                100. SubstanceAdministration.repeatNumber
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
                102. 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
                104. 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
                106. SubstanceAdministration.doseQuantity
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
                108. SubstanceAdministration.rateQuantity
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
                110. SubstanceAdministration.maxDoseQuantity
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
                112. 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
                114. 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
                116. 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
                118. 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
                120. 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
                122. 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
                124. 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
                126. 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
                128. 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
                130. 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
                132. 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
                134. 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
                136. SubstanceAdministration.consumable.manufacturedProduct
                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
                138. 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
                140. 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
                142. 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
                144. 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
                146. 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
                148. 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
                150. 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
                152. 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
                154. 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
                • 156. 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
                  158. 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
                  160. 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
                  162. 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
                  164. 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
                  166. 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
                  168. 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
                  170. SubstanceAdministration.consumable.manufacturedProduct.id
                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                  172. 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.
                  174. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug
                  176. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
                  Control1..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Material
                  Must Supporttrue
                  178. 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
                  180. 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
                  182. 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
                  184. 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
                  186. 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
                  188. 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
                  190. 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
                  192. 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
                  194. 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
                  196. 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
                  198. 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
                  200. 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
                  202. 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
                  204. 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
                  206. 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
                  208. 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
                  210. 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
                  212. 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
                  214. 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.
                  216. 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.
                  218. 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
                  220. 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
                  222. 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
                  • 224. 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
                    226. 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
                    228. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.name
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/EN
                    230. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.lotNumberText
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
                    232. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
                    Must Supporttrue
                    234. SubstanceAdministration.subject
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
                    236. SubstanceAdministration.specimen
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
                    238. SubstanceAdministration.performer
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
                    240. SubstanceAdministration.author
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
                    Must Supporttrue
                    242. SubstanceAdministration.informant
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
                    244. SubstanceAdministration.participant
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
                    246. SubstanceAdministration.entryRelationship
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                    248. SubstanceAdministration.reference
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
                    250. SubstanceAdministration.precondition
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
                    252. 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.