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

This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: MedicationSupplyOrder - Detailed Descriptions

Draft as of 2024-05-18

Definitions for the MedicationSupplyOrder logical model.

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

0. Supply
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-repeatNumber: SHOULD contain repeatNumber (repeatNumber.exists())
should-quantity: SHOULD contain quantity (quantity.exists())
2. Supply.templateId
Control1..?
SlicingThis element introduces a set of slices on Supply.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Supply.templateId:med-supplyOrder
    Slice Namemed-supplyOrder
    Control1..1
    6. Supply.templateId:med-supplyOrder.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.17
    8. Supply.templateId:med-supplyOrder.extension
    Control1..?
    Pattern Value2014-06-09
    10. Supply.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7427).

    12. Supply.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7428).

    Fixed ValueINT
    14. Supply.id
    Comments

    SHALL contain at least one [1..*] id (CONF:1098-7430).

    Control1..?
    16. Supply.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    18. Supply.text.reference
    Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
    20. Supply.statusCode
    Comments

    SHALL contain exactly one [1..1] statusCode (CONF:1098-7432).

    Control1..?
    22. Supply.statusCode.nullFlavor
    Control0..0
    24. Supply.statusCode.code
    Control1..?
    BindingThe codes SHALL be taken from ActStatus .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933)
    26. Supply.effectiveTime
    SlicingThis element introduces a set of slices on Supply.effectiveTime. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • exists @ high
    • 28. Supply.effectiveTime:when
      Slice Namewhen
      Comments

      SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15143) such that it

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
      30. Supply.effectiveTime:when.high
      Comments

      SHALL contain exactly one [1..1] high (CONF:1098-15144).

      Control1..?
      32. Supply.repeatNumber
      ShortIn "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
      Comments

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

      34. Supply.quantity
      Comments

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

      36. Supply.product
      Comments

      MAY contain zero or one [0..1] product (CONF:1098-7439).

      38. Supply.product.manufacturedProduct
      Comments

      The product, if present, SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-16093).

      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
      40. Supply.author
      Comments

      MAY contain zero or one [0..1] author (CONF:1098-7438).

      Control0..1
      42. Supply.entryRelationship
      Comments

      MAY contain zero or one [0..1] entryRelationship (CONF:1098-7442).

      Control0..1
      44. Supply.entryRelationship.typeCode
      Comments

      The entryRelationship, if present, SHALL contain exactly one [1..1] @typeCode="SUBJ" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7444).

      Fixed ValueSUBJ
      46. Supply.entryRelationship.inversionInd
      Comments

      The entryRelationship, if present, SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7445).

      Control1..?
      Fixed Valuetrue
      48. Supply.entryRelationship.act
      Comments

      The entryRelationship, if present, SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-31391).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)

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

      0. Supply
      Definition

      Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.


      Base definition for all types defined in FHIR type system.

      ShortBase for all types and resources
      Control10..1*
      Is Modifierfalse
      Logical ContainerClinicalDocument (CDA Class)
      ValidationInstance of this type are validated by templateId
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
      Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
      should-repeatNumber: SHOULD contain repeatNumber (repeatNumber.exists())
      should-quantity: SHOULD contain quantity (quantity.exists())
      2. Supply.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 Supply.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ root
      • value @ extension
      • 4. Supply.templateId:med-supplyOrder
        Slice Namemed-supplyOrder
        Definition

        When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        6. Supply.templateId:med-supplyOrder.root
        Definition

        A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Pattern Value2.16.840.1.113883.10.20.22.4.17
        8. Supply.templateId:med-supplyOrder.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        Pattern Value2014-06-09
        10. Supply.classCode
        Comments

        SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7427).

        Control1..1
        BindingThe codes SHALL be taken from ActClassSupply
        (required to http://terminology.hl7.org/ValueSet/v3-ActClassSupply)
        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 ValueSPLY
        Fixed ValueSPLY
        12. Supply.moodCode
        Comments

        SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7428).

        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(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 ValueINT
        14. Supply.id
        Comments

        SHALL contain at least one [1..*] id (CONF:1098-7430).

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        16. Supply.text
        ShortSHOULD reference the portion of section narrative text corresponding to this entry
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        18. Supply.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.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        LabelReference
        Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
        20. Supply.statusCode
        Comments

        SHALL contain exactly one [1..1] statusCode (CONF:1098-7432).

        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
        22. Supply.statusCode.nullFlavor
        Definition

        If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

        Control0..0
        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. Supply.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.

        Control1..1
        BindingThe codes SHALL be taken from ActStatus .
        (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933)
        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
        26. Supply.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. Supply.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. Supply.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. Supply.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. Supply.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. Supply.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. Supply.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. Supply.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.
        SlicingThis element introduces a set of slices on Supply.effectiveTime. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • exists @ high
        • 42. Supply.effectiveTime:when
          Slice Namewhen
          Comments

          SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15143) such that it

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
          Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
          XML FormatThe type of this property is determined using the " xsi:typeattribute.
          44. Supply.effectiveTime:when.high
          Definition

          This is the high limit of the interval.

          Comments

          SHALL contain exactly one [1..1] high (CONF:1098-15144).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
          LabelHigh Boundary
          46. Supply.repeatNumber
          ShortIn "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
          Comments

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
          48. Supply.quantity
          Comments

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
          50. Supply.product
          Comments

          MAY contain zero or one [0..1] product (CONF:1098-7439).

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
          52. Supply.product.manufacturedProduct
          Definition

          Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

          ShortBase for all types and resources
          Comments

          The product, if present, SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-16093).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
          Is Modifierfalse
          Invariantsproduct-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) ((manufacturedLabeledDrug | manufacturedMaterial).count() = 1)
          54. Supply.author
          Comments

          MAY contain zero or one [0..1] author (CONF:1098-7438).

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
          56. Supply.entryRelationship
          Comments

          MAY contain zero or one [0..1] entryRelationship (CONF:1098-7442).

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          58. Supply.entryRelationship.typeCode
          Comments

          The entryRelationship, if present, SHALL contain exactly one [1..1] @typeCode="SUBJ" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7444).

          Control1..1
          BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
          (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
          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 ValueSUBJ
          60. Supply.entryRelationship.inversionInd
          Definition

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

          Comments

          The entryRelationship, if present, SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7445).

          Control1..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.
          Fixed Valuetrue
          62. Supply.entryRelationship.act
          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
          Comments

          The entryRelationship, if present, SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-31391).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())

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

          0. Supply
          Definition

          Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

          ShortBase for all types and resources
          Control1..1
          Is Modifierfalse
          Logical ContainerClinicalDocument (CDA Class)
          ValidationInstance of this type are validated by templateId
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          should-repeatNumber: SHOULD contain repeatNumber (repeatNumber.exists())
          should-quantity: SHOULD contain quantity (quantity.exists())
          2. Supply.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. Supply.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. Supply.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. Supply.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. Supply.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. Supply.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. Supply.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. Supply.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. Supply.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 Supply.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ root
          • value @ extension
          • 20. Supply.templateId:med-supplyOrder
            Slice Namemed-supplyOrder
            Definition

            When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            22. Supply.templateId:med-supplyOrder.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. Supply.templateId:med-supplyOrder.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. Supply.templateId:med-supplyOrder.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. Supply.templateId:med-supplyOrder.root
            Definition

            A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

            Control1..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelRoot
            Pattern Value2.16.840.1.113883.10.20.22.4.17
            30. Supply.templateId:med-supplyOrder.extension
            Definition

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

            Control1..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExtension
            Pattern Value2014-06-09
            32. Supply.classCode
            Comments

            SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7427).

            Control1..1
            BindingThe codes SHALL be taken from ActClassSupply
            (required to http://terminology.hl7.org/ValueSet/v3-ActClassSupply)
            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 ValueSPLY
            Fixed ValueSPLY
            34. Supply.moodCode
            Comments

            SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7428).

            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(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 ValueINT
            36. Supply.id
            Comments

            SHALL contain at least one [1..*] id (CONF:1098-7430).

            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            38. Supply.code
            Control0..1
            BindingFor example codes, see v3 Code System ActCode
            (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
            40. Supply.text
            ShortSHOULD reference the portion of section narrative text corresponding to this entry
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
            42. Supply.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
            44. Supply.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
            46. Supply.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
            48. Supply.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
            50. Supply.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
            52. Supply.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
            54. Supply.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.
            56. Supply.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.
            58. Supply.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.

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
            LabelReference
            Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
            60. Supply.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
            62. Supply.statusCode
            Comments

            SHALL contain exactly one [1..1] statusCode (CONF:1098-7432).

            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
            64. Supply.statusCode.nullFlavor
            Definition

            If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

            Control0..0
            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
            66. Supply.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.

            Control1..1
            BindingThe codes SHALL be taken from ActStatus .
            (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933)
            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
            68. Supply.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
            70. Supply.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
            72. Supply.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
            74. Supply.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
            76. Supply.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.
            78. Supply.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.
            80. Supply.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
            82. Supply.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
            84. Supply.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
            86. Supply.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.
            SlicingThis element introduces a set of slices on Supply.effectiveTime. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • exists @ high
            • 88. Supply.effectiveTime:when
              Slice Namewhen
              Comments

              SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15143) such that it

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
              Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
              XML FormatThe type of this property is determined using the " xsi:typeattribute.
              90. Supply.effectiveTime:when.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. Supply.effectiveTime:when.value
              Definition

              A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

              Control0..1
              TypedateTime(ts: Point in Time)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
              XML FormatIn the XML format, this property is represented as an attribute.
              94. Supply.effectiveTime:when.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
              96. Supply.effectiveTime:when.low
              Definition

              This is the low limit of the interval.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
              LabelLow Boundary
              98. Supply.effectiveTime:when.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/TS
              LabelCentral Value
              100. Supply.effectiveTime:when.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
              102. Supply.effectiveTime:when.high
              Definition

              This is the high limit of the interval.

              Comments

              SHALL contain exactly one [1..1] high (CONF:1098-15144).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
              LabelHigh Boundary
              104. Supply.priorityCode
              Control0..*
              BindingFor example codes, see ActPriority
              (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              106. Supply.repeatNumber
              ShortIn "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
              Comments

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

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
              108. Supply.independentInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              110. Supply.quantity
              Comments

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

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
              112. Supply.expectedUseTime
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
              114. Supply.product
              Comments

              MAY contain zero or one [0..1] product (CONF:1098-7439).

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
              116. Supply.product.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. Supply.product.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. Supply.product.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. Supply.product.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. Supply.product.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. Supply.product.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. Supply.product.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. Supply.product.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. Supply.product.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. Supply.product.typeCode
              Control0..1
              BindingThe codes SHALL be taken from ParticipationTargetDirect
              (required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect)
              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 ValuePRD
              136. Supply.product.manufacturedProduct
              Definition

              Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

              ShortBase for all types and resources
              Comments

              The product, if present, SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-16093).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
              Is Modifierfalse
              Invariantsproduct-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) ((manufacturedLabeledDrug | manufacturedMaterial).count() = 1)
              138. Supply.subject
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
              140. Supply.specimen
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
              142. Supply.performer
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
              144. Supply.author
              Comments

              MAY contain zero or one [0..1] author (CONF:1098-7438).

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
              146. Supply.informant
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
              148. Supply.participant
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
              150. Supply.entryRelationship
              Comments

              MAY contain zero or one [0..1] entryRelationship (CONF:1098-7442).

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              152. Supply.entryRelationship.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
              154. Supply.entryRelationship.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
              156. Supply.entryRelationship.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
              158. Supply.entryRelationship.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
              160. Supply.entryRelationship.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
              162. Supply.entryRelationship.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
              164. Supply.entryRelationship.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
              166. Supply.entryRelationship.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
              168. Supply.entryRelationship.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
              170. Supply.entryRelationship.typeCode
              Comments

              The entryRelationship, if present, SHALL contain exactly one [1..1] @typeCode="SUBJ" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7444).

              Control1..1
              BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
              (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
              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 ValueSUBJ
              172. Supply.entryRelationship.inversionInd
              Definition

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

              Comments

              The entryRelationship, if present, SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7445).

              Control1..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.
              Fixed Valuetrue
              174. Supply.entryRelationship.contextConductionInd
              Definition

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

              Control0..1
              Typeboolean(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Default Valuetrue
              176. Supply.entryRelationship.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.
              178. Supply.entryRelationship.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              180. Supply.entryRelationship.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              182. Supply.entryRelationship.act
              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
              Comments

              The entryRelationship, if present, SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-31391).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              184. Supply.entryRelationship.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              186. Supply.entryRelationship.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              188. Supply.entryRelationship.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              190. Supply.entryRelationship.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              192. Supply.entryRelationship.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              194. Supply.entryRelationship.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              196. Supply.entryRelationship.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              198. Supply.entryRelationship.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              200. Supply.reference
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
              202. Supply.precondition
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
              204. Supply.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.