Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.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-ccda/ and changes regularly. See the Directory of published versions

Logical Model: MedicationFreeTextSig - Detailed Descriptions

Draft as of 2024-11-24

Definitions for the MedicationFreeTextSig logical model.

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

0. SubstanceAdministration
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())
2. SubstanceAdministration.typeId
Control0..0
4. 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
  • 6. SubstanceAdministration.templateId:med-freeTextSig
    Slice Namemed-freeTextSig
    Control1..1
    8. SubstanceAdministration.templateId:med-freeTextSig.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.147
    10. SubstanceAdministration.templateId:med-freeTextSig.extension
    Control0..0
    12. SubstanceAdministration.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-32770).

    14. SubstanceAdministration.moodCode
    ShortmoodCode must match the parent substanceAdministration EVN or INT
    Comments

    SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:81-32771).

    BindingThe codes SHALL be taken from MoodCodeEvnInt .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18)
    16. SubstanceAdministration.code
    ShortInstructions Medication Narrative
    Comments

    SHALL contain exactly one [1..1] code (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-32775).

    Control1..?
    18. SubstanceAdministration.code.code
    Control1..?
    Pattern Value76662-6
    20. SubstanceAdministration.code.codeSystem
    ShortLOINC
    Control1..?
    Pattern Value2.16.840.1.113883.6.1
    22. SubstanceAdministration.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    Comments

    SHALL contain exactly one [1..1] text (CONF:81-32754).

    Control1..?
    24. SubstanceAdministration.text.reference
    ShortReference into the section/text to a tag that only contains free text sig.
    Comments

    This text SHALL contain exactly one [1..1] reference (CONF:81-32755).

    Control1..?
    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('#'))
    26. SubstanceAdministration.text.reference.value
    Comments

    This reference SHOULD contain zero or one [0..1] @value (CONF:81-32756).

    28. SubstanceAdministration.statusCode
    Control0..0
    30. SubstanceAdministration.effectiveTime
    Control0..0
    32. SubstanceAdministration.priorityCode
    Control0..0
    34. SubstanceAdministration.repeatNumber
    Control0..0
    36. SubstanceAdministration.routeCode
    Control0..0
    38. SubstanceAdministration.approachSiteCode
    Control0..0
    40. SubstanceAdministration.doseQuantity
    Control0..0
    42. SubstanceAdministration.rateQuantity
    Control0..0
    44. SubstanceAdministration.maxDoseQuantity
    Control0..0
    46. SubstanceAdministration.administrationUnitCode
    Control0..0
    48. SubstanceAdministration.consumable
    Comments

    SHALL contain exactly one [1..1] consumable (CONF:81-32776).

    50. SubstanceAdministration.consumable.manufacturedProduct
    Comments

    This consumable SHALL contain exactly one [1..1] manufacturedProduct (CONF:81-32777).

    52. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug
    Comments

    This manufacturedProduct SHALL contain exactly one [1..1] manufacturedLabeledDrug (CONF:81-32778).

    Control1..?
    54. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.nullFlavor
    Comments

    This manufacturedLabeledDrug SHALL contain exactly one [1..1] @nullFlavor="NA" Not Applicable (CONF:81-32779).

    Control1..?
    Fixed ValueNA
    56. SubstanceAdministration.subject
    Control0..0
    58. SubstanceAdministration.specimen
    Control0..0
    60. SubstanceAdministration.performer
    Control0..0
    62. SubstanceAdministration.informant
    Control0..0
    64. SubstanceAdministration.participant
    Control0..0
    66. SubstanceAdministration.entryRelationship
    Control0..0
    68. SubstanceAdministration.precondition
    Control0..0

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

    0. SubstanceAdministration
    Definition

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


    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())
    2. 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..0
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    6. 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
    • 8. SubstanceAdministration.templateId:med-freeTextSig
      Slice Namemed-freeTextSig
      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
      10. SubstanceAdministration.templateId:med-freeTextSig.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.147
      12. SubstanceAdministration.templateId:med-freeTextSig.extension
      Definition

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

      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.
      LabelExtension
      14. SubstanceAdministration.classCode
      Comments

      SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-32770).

      Control1..1
      BindingThe codes SHALL be taken from CDAActClass
      (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
      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 ValueSBADM
      16. SubstanceAdministration.moodCode
      ShortmoodCode must match the parent substanceAdministration EVN or INT
      Comments

      SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:81-32771).

      Control1..1
      BindingThe codes SHALL be taken from MoodCodeEvnInt .
      (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18)
      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.
      18. SubstanceAdministration.code
      ShortInstructions Medication Narrative
      Comments

      SHALL contain exactly one [1..1] code (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-32775).

      Control1..1
      BindingFor example codes, see CDAActSubstanceAdministrationCode
      (example to http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
      20. SubstanceAdministration.code.code
      Definition

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

      Control1..1
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode
      Pattern Value76662-6
      22. SubstanceAdministration.code.codeSystem
      Definition

      Specifies the code system that defines the code.

      ShortLOINC
      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.
      LabelCode System
      Pattern Value2.16.840.1.113883.6.1
      24. SubstanceAdministration.text
      ShortSHOULD reference the portion of section narrative text corresponding to this entry
      Comments

      SHALL contain exactly one [1..1] text (CONF:81-32754).

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
      26. SubstanceAdministration.text.reference
      Definition

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

      ShortReference into the section/text to a tag that only contains free text sig.
      Comments

      This text SHALL contain exactly one [1..1] reference (CONF:81-32755).

      Control1..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('#'))
      28. SubstanceAdministration.text.reference.value
      Comments

      This reference SHOULD contain zero or one [0..1] @value (CONF:81-32756).

      Control0..1
      Typeurl(url: Universal Resource Locator)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      30. SubstanceAdministration.statusCode
      Control0..0
      BindingThe codes SHALL be taken from ActStatus
      (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
      32. SubstanceAdministration.effectiveTime
      Control0..0
      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.
      34. SubstanceAdministration.priorityCode
      Control0..0
      BindingFor example codes, see ActPriority
      (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      36. SubstanceAdministration.repeatNumber
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
      38. SubstanceAdministration.routeCode
      Control0..0
      BindingFor example codes, see RouteOfAdministration
      (example to http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      40. SubstanceAdministration.approachSiteCode
      Control0..0
      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
      42. SubstanceAdministration.doseQuantity
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
      44. SubstanceAdministration.rateQuantity
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
      46. SubstanceAdministration.maxDoseQuantity
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
      48. SubstanceAdministration.administrationUnitCode
      Control0..0
      BindingFor example codes, see AdministrableDrugForm
      (example to http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      50. 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.

      Comments

      SHALL contain exactly one [1..1] consumable (CONF:81-32776).

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
      52. SubstanceAdministration.consumable.manufacturedProduct
      Comments

      This consumable SHALL contain exactly one [1..1] manufacturedProduct (CONF:81-32777).

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
      54. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug
      Comments

      This manufacturedProduct SHALL contain exactly one [1..1] manufacturedLabeledDrug (CONF:81-32778).

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug
      56. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.nullFlavor
      Definition

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

      Comments

      This manufacturedLabeledDrug SHALL contain exactly one [1..1] @nullFlavor="NA" Not Applicable (CONF:81-32779).

      Control1..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
      Fixed ValueNA
      58. SubstanceAdministration.subject
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
      60. SubstanceAdministration.specimen
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
      62. SubstanceAdministration.performer
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
      64. SubstanceAdministration.informant
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
      66. SubstanceAdministration.participant
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
      68. SubstanceAdministration.entryRelationship
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
      70. SubstanceAdministration.precondition
      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition

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

      0. SubstanceAdministration
      Definition

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

      ShortBase for all types and resources
      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())
      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..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      13. 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
      • 15. SubstanceAdministration.templateId:med-freeTextSig
        Slice Namemed-freeTextSig
        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
        17. SubstanceAdministration.templateId:med-freeTextSig.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
        19. SubstanceAdministration.templateId:med-freeTextSig.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
        21. SubstanceAdministration.templateId:med-freeTextSig.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
        23. SubstanceAdministration.templateId:med-freeTextSig.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.147
        25. SubstanceAdministration.templateId:med-freeTextSig.extension
        Definition

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

        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.
        LabelExtension
        27. SubstanceAdministration.classCode
        Comments

        SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-32770).

        Control1..1
        BindingThe codes SHALL be taken from CDAActClass
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
        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 ValueSBADM
        29. SubstanceAdministration.moodCode
        ShortmoodCode must match the parent substanceAdministration EVN or INT
        Comments

        SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:81-32771).

        Control1..1
        BindingThe codes SHALL be taken from MoodCodeEvnInt .
        (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18)
        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.
        31. SubstanceAdministration.id
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        33. SubstanceAdministration.code
        ShortInstructions Medication Narrative
        Comments

        SHALL contain exactly one [1..1] code (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-32775).

        Control1..1
        BindingFor example codes, see CDAActSubstanceAdministrationCode
        (example to http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        35. SubstanceAdministration.code.nullFlavor
        Definition

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

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

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

        Control1..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        Pattern Value76662-6
        39. SubstanceAdministration.code.codeSystem
        Definition

        Specifies the code system that defines the code.

        ShortLOINC
        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.
        LabelCode System
        Pattern Value2.16.840.1.113883.6.1
        41. SubstanceAdministration.code.codeSystemName
        Definition

        The common name of the coding system.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        43. SubstanceAdministration.code.codeSystemVersion
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        45. SubstanceAdministration.code.displayName
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        47. SubstanceAdministration.code.sdtcValueSet
        Definition

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

        Control0..1
        Typestring(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
        49. SubstanceAdministration.code.sdtcValueSetVersion
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
        51. SubstanceAdministration.code.originalText
        Definition

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        53. SubstanceAdministration.code.qualifier
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        55. SubstanceAdministration.code.translation
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        57. 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.
        59. SubstanceAdministration.text
        ShortSHOULD reference the portion of section narrative text corresponding to this entry
        Comments

        SHALL contain exactly one [1..1] text (CONF:81-32754).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        61. SubstanceAdministration.text.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        63. SubstanceAdministration.text.compression
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDACompressionAlgorithm
        (required to http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCompression
        65. SubstanceAdministration.text.integrityCheck
        Definition

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

        Control0..1
        Typebase64Binary(bin: Binary Data)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelIntegrity Check
        67. SubstanceAdministration.text.integrityCheckAlgorithm
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0)
        (required to http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelIntegrity Check Algorithm
        69. SubstanceAdministration.text.language
        Definition

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

        Control0..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelLanguage
        71. SubstanceAdministration.text.mediaType
        Definition

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

        Control0..1
        BindingFor example codes, see MediaType
        (example to http://terminology.hl7.org/ValueSet/v3-MediaType)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelMedia Type
        73. SubstanceAdministration.text.representation
        Control0..1
        BindingThe codes SHALL be taken from CDABinaryDataEncoding
        (required to http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        75. SubstanceAdministration.text.xmlText
        Definition

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

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

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as unadorned text.
        77. SubstanceAdministration.text.reference
        Definition

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

        ShortReference into the section/text to a tag that only contains free text sig.
        Comments

        This text SHALL contain exactly one [1..1] reference (CONF:81-32755).

        Control1..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('#'))
        79. SubstanceAdministration.text.reference.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        81. SubstanceAdministration.text.reference.value
        Comments

        This reference SHOULD contain zero or one [0..1] @value (CONF:81-32756).

        Control0..1
        Typeurl(url: Universal Resource Locator)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        83. SubstanceAdministration.text.reference.useablePeriod
        Definition

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

        Control0..*
        TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
        Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelUseable Period
        85. SubstanceAdministration.text.reference.use
        Definition

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

        Control0..*
        BindingThe codes SHALL be taken from TelecommunicationAddressUse (2.0.0)
        (required to http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelUse Code
        87. SubstanceAdministration.text.thumbnail
        Definition

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelThumbnail
        89. SubstanceAdministration.statusCode
        Control0..0
        BindingThe codes SHALL be taken from ActStatus
        (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        91. SubstanceAdministration.effectiveTime
        Control0..0
        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.
        93. SubstanceAdministration.priorityCode
        Control0..0
        BindingFor example codes, see ActPriority
        (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        95. SubstanceAdministration.repeatNumber
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
        97. SubstanceAdministration.routeCode
        Control0..0
        BindingFor example codes, see RouteOfAdministration
        (example to http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        99. SubstanceAdministration.approachSiteCode
        Control0..0
        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
        101. SubstanceAdministration.doseQuantity
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
        103. SubstanceAdministration.rateQuantity
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
        105. SubstanceAdministration.maxDoseQuantity
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
        107. SubstanceAdministration.administrationUnitCode
        Control0..0
        BindingFor example codes, see AdministrableDrugForm
        (example to http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        109. 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.

        Comments

        SHALL contain exactly one [1..1] consumable (CONF:81-32776).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
        111. 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
        113. 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
        115. 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
        117. 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
        119. 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
        121. 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
        123. 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
        125. 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
        127. 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
        129. 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
        131. SubstanceAdministration.consumable.manufacturedProduct
        Comments

        This consumable SHALL contain exactly one [1..1] manufacturedProduct (CONF:81-32777).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
        133. 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
        135. 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
        137. 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
        139. 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
        141. 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
        143. 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
        145. 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
        147. 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
        149. 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
        151. 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
        153. SubstanceAdministration.consumable.manufacturedProduct.id
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        155. 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.
        157. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug
        Comments

        This manufacturedProduct SHALL contain exactly one [1..1] manufacturedLabeledDrug (CONF:81-32778).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug
        159. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.nullFlavor
        Definition

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

        Comments

        This manufacturedLabeledDrug SHALL contain exactly one [1..1] @nullFlavor="NA" Not Applicable (CONF:81-32779).

        Control1..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
        Fixed ValueNA
        161. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
        163. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
        165. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
        167. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
        169. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
        171. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
        173. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
        175. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
        177. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
        179. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
        181. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.code
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        183. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.name
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EN
        185. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Material
        187. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
        189. SubstanceAdministration.subject
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
        191. SubstanceAdministration.specimen
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
        193. SubstanceAdministration.performer
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
        195. SubstanceAdministration.author
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
        197. SubstanceAdministration.informant
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
        199. SubstanceAdministration.participant
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
        201. SubstanceAdministration.entryRelationship
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        203. SubstanceAdministration.reference
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
        205. SubstanceAdministration.precondition
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
        207. 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.