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

Draft as of 2023-01-30

Definitions for the 2.16.840.1.113883.10.21.4.6--20230130093600 logical model.

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

0. SubstanceAdministration
Definition

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

Control1..1
Must Supporttrue
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.event
Control0..1
4. SubstanceAdministration.event.code
Control0..1
BindingThe codes SHALL be taken from TimingEvent
(required to http://terminology.hl7.org/ValueSet/v3-TimingEvent)

TimingEvent

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.
6. 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
  • 8. SubstanceAdministration.templateId:primary
    Slice Nameprimary
    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    Must Supporttrue
    10. 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.21.4.6
    12. 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
    14. SubstanceAdministration.moodCode
    Definition

    If the subordinate substance administration refers to Medication Order then a substance administration request (moodCode is 'RQO') is used. If it refers to a Medication Statement, the moodCode shall be set to event/intent (moodCode is 'EVN' or 'INT').

    Control1..1
    BindingThe codes SHALL be taken from http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
    (required to http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000)

    Mood Code Evn Int Rqo

    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.
    16. SubstanceAdministration.statusCode
    Definition

    The statusCode of this subordinate substance administration SHALL be the same of that of the parent substance administration.

    Control1..1
    BindingThe codes SHALL be taken from http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
    (required to http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000)

    ActStatusActiveCompletedAbortedSuspended

    Must Supporttrue
    18. SubstanceAdministration.doseQuantity
    Definition

    The doseQuantity describes the amount of the medication given (the dosage).

    If a dose range is given (e.g., 1-2 tablets, or 325-750mg), then the <low> and <high> bounds are specified in their respective elements; otherwise only one physical quantity is specified (e.g. 2 drops)

    The dose can be in some known and measurable unit, such as grams, milligrams,or described in "administration" units (unit of presentation, such as capsules).

    If the dose is in countable items (tablets, caplets, "eaches"), then the unit could be omitted or valorized using the UCUM annotations for describing the type of countable items (e.g. .{tablet}, {puff},..).

    The unit attribute – when expresses unit of measures- shall be derived from the UCUM code system. The used elements should contain a <translation> element that provides a reference to the originalText found in the narrative body of the document.

    Control0..1
    Must Supporttrue
    20. SubstanceAdministration.doseQuantity.unit
    Control0..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.
    22. SubstanceAdministration.rateQuantity
    Control0..1
    24. SubstanceAdministration.maxDoseQuantity
    Control0..1
    26. SubstanceAdministration.administrationUnitCode
    Control0..1
    BindingThe codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.14570
    (required to urn:oid:2.16.840.1.113883.1.11.14570)

    AdministrableDrugForm

    28. SubstanceAdministration.consumable
    Control1..1
    Must Supporttrue
    30. SubstanceAdministration.consumable.manufacturedProduct
    Control1..1
    Must Supporttrue
    32. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
    Control1..1
    Must Supporttrue
    34. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.nullFlavor
    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 ValueNA

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

    0. SubstanceAdministration
    Definition

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

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

      If the subordinate substance administration refers to Medication Order then a substance administration request (moodCode is 'RQO') is used. If it refers to a Medication Statement, the moodCode shall be set to event/intent (moodCode is 'EVN' or 'INT').

      Control1..1
      BindingThe codes SHALL be taken from http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
      (required to http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000)

      Mood Code Evn Int Rqo

      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.
      12. SubstanceAdministration.statusCode
      Definition

      The statusCode of this subordinate substance administration SHALL be the same of that of the parent substance administration.

      Control1..1
      BindingThe codes SHALL be taken from http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
      (required to http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000)

      ActStatusActiveCompletedAbortedSuspended

      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
      Must Supporttrue
      14. SubstanceAdministration.doseQuantity
      Definition

      The doseQuantity describes the amount of the medication given (the dosage).

      If a dose range is given (e.g., 1-2 tablets, or 325-750mg), then the <low> and <high> bounds are specified in their respective elements; otherwise only one physical quantity is specified (e.g. 2 drops)

      The dose can be in some known and measurable unit, such as grams, milligrams,or described in "administration" units (unit of presentation, such as capsules).

      If the dose is in countable items (tablets, caplets, "eaches"), then the unit could be omitted or valorized using the UCUM annotations for describing the type of countable items (e.g. .{tablet}, {puff},..).

      The unit attribute – when expresses unit of measures- shall be derived from the UCUM code system. The used elements should contain a <translation> element that provides a reference to the originalText found in the narrative body of the document.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
      Must Supporttrue
      16. SubstanceAdministration.doseQuantity.unit
      Definition

      The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].

      Control0..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.
      LabelUnit of Measure
      Default Value1
      18. SubstanceAdministration.rateQuantity
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
      20. SubstanceAdministration.maxDoseQuantity
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
      22. SubstanceAdministration.administrationUnitCode
      Control0..1
      BindingThe codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.14570
      (required to urn:oid:2.16.840.1.113883.1.11.14570)

      AdministrableDrugForm

      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      24. 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
      26. SubstanceAdministration.consumable.manufacturedProduct
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
      Must Supporttrue
      28. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Material
      Must Supporttrue
      30. 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.

      Control1..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      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.
      LabelExceptional Value Detail
      Fixed ValueNA

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

      0. SubstanceAdministration
      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
      Is Modifierfalse
      Must Supporttrue
      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.21.4.6
        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
        Definition

        If the subordinate substance administration refers to Medication Order then a substance administration request (moodCode is 'RQO') is used. If it refers to a Medication Statement, the moodCode shall be set to event/intent (moodCode is 'EVN' or 'INT').

        Control1..1
        BindingThe codes SHALL be taken from http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
        (required to http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000)

        Mood Code Evn Int Rqo

        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.
        36. SubstanceAdministration.id
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        38. SubstanceAdministration.code
        Control0..1
        BindingFor example codes, see CDAActSubstanceAdministrationCode
        (example to http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        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
        Definition

        The statusCode of this subordinate substance administration SHALL be the same of that of the parent substance administration.

        Control1..1
        BindingThe codes SHALL be taken from http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
        (required to http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000)

        ActStatusActiveCompletedAbortedSuspended

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        Must Supporttrue
        46. SubstanceAdministration.effectiveTime
        Control0..*
        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
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        48. 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
        50. SubstanceAdministration.repeatNumber
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
        52. 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
        54. 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
        56. SubstanceAdministration.doseQuantity
        Definition

        The doseQuantity describes the amount of the medication given (the dosage).

        If a dose range is given (e.g., 1-2 tablets, or 325-750mg), then the <low> and <high> bounds are specified in their respective elements; otherwise only one physical quantity is specified (e.g. 2 drops)

        The dose can be in some known and measurable unit, such as grams, milligrams,or described in "administration" units (unit of presentation, such as capsules).

        If the dose is in countable items (tablets, caplets, "eaches"), then the unit could be omitted or valorized using the UCUM annotations for describing the type of countable items (e.g. .{tablet}, {puff},..).

        The unit attribute – when expresses unit of measures- shall be derived from the UCUM code system. The used elements should contain a <translation> element that provides a reference to the originalText found in the narrative body of the document.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
        Must Supporttrue
        58. SubstanceAdministration.doseQuantity.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
        60. SubstanceAdministration.doseQuantity.unit
        Definition

        The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].

        Control0..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.
        LabelUnit of Measure
        Default Value1
        62. SubstanceAdministration.doseQuantity.value
        Definition

        The magnitude of the quantity measured in terms of the unit.

        Control0..1
        Typedecimal(real: Real Number)
        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.
        LabelMaginitude Value
        64. SubstanceAdministration.doseQuantity.translation
        Definition

        An alternative representation of the same physical quantity expressed in a different unit, of a different unit code system and possibly with a different value.

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQR
        LabelTranslation
        66. SubstanceAdministration.doseQuantity.operator
        Definition

        A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

        Control0..1
        BindingThe codes SHALL be taken from CDASetOperator
        (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator)
        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.
        Default ValueI
        68. SubstanceAdministration.doseQuantity.low
        Definition

        This is the low limit of the interval.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
        LabelLow Boundary
        70. SubstanceAdministration.doseQuantity.center
        Definition

        The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
        LabelCentral Value
        72. SubstanceAdministration.doseQuantity.width
        Definition

        The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
        LabelWidth
        74. SubstanceAdministration.doseQuantity.high
        Definition

        This is the high limit of the interval.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
        LabelHigh Boundary
        76. SubstanceAdministration.rateQuantity
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
        78. SubstanceAdministration.maxDoseQuantity
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
        80. SubstanceAdministration.administrationUnitCode
        Control0..1
        BindingThe codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.14570
        (required to urn:oid:2.16.840.1.113883.1.11.14570)

        AdministrableDrugForm

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        82. 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
        84. 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
        86. 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
        88. 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
        90. 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
        92. 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
        94. 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
        96. 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
        98. 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
        100. 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
        102. 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
        104. SubstanceAdministration.consumable.manufacturedProduct
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
        Must Supporttrue
        106. 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
        108. 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
        110. 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
        112. 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
        114. 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
        116. 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
        118. 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
        120. 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
        122. 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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        124. 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
        126. SubstanceAdministration.consumable.manufacturedProduct.id
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        128. 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.
        130. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug
        132. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Material
        Must Supporttrue
        134. 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.

        Control1..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        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.
        LabelExceptional Value Detail
        Fixed ValueNA
        136. 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
        138. 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
        140. 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
        142. 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
        144. 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
        146. 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
        148. 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
        150. 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
        152. 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
        154. 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
        156. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code
        Control0..1
        BindingFor example codes, see CDAMaterialEntityClassType
        (example to http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        158. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.name
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EN
        160. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.lotNumberText
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
        162. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
        164. SubstanceAdministration.subject
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
        166. SubstanceAdministration.specimen
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
        168. SubstanceAdministration.performer
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
        170. SubstanceAdministration.author
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
        172. SubstanceAdministration.informant
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
        174. SubstanceAdministration.participant
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
        176. SubstanceAdministration.entryRelationship
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        178. SubstanceAdministration.reference
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
        180. SubstanceAdministration.precondition
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
        182. 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.