Consolidated CDA (C-CDA)
5.0.0-ballot - STU5 Ballot 1 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 5.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: PlannedMedicationActivity - Detailed Descriptions

Draft as of 2025-12-12

Definitions for the PlannedMedicationActivity logical model.

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

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())
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
should-author: SHOULD contain author (author.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..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
8. SubstanceAdministration.typeId.nullFlavor
Definition

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

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

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

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

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
14. SubstanceAdministration.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
16. SubstanceAdministration.typeId.extension
Definition

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
18. SubstanceAdministration.templateId
Definition

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 20. SubstanceAdministration.templateId:planned-med-activity
    Slice Nameplanned-med-activity
    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. SubstanceAdministration.templateId:planned-med-activity.nullFlavor
    Definition

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

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

    A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    26. SubstanceAdministration.templateId:planned-med-activity.displayable
    Definition

    Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

    Control0..1
    Typeboolean(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    28. SubstanceAdministration.templateId:planned-med-activity.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.42
    30. SubstanceAdministration.templateId:planned-med-activity.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. SubstanceAdministration.classCode
    Comments

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

    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
    34. SubstanceAdministration.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8573).

    Control1..1
    BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply) .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24)
    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.
    36. SubstanceAdministration.id
    Comments

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

    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    38. SubstanceAdministration.code
    Control0..1
    BindingFor example codes, see CDAActSubstanceAdministrationCode
    (example to http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
    40. SubstanceAdministration.negationInd
    Control0..1
    Typeboolean(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    42. SubstanceAdministration.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    Control0..1
    This element is affected by the following invariants: should-text-ref-value
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
    44. SubstanceAdministration.text.nullFlavor
    Definition

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    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('#'))
    62. 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
    InvariantsED-1: Thumbnails cannot contain their own thumbnails (thumbnail.empty())
    64. SubstanceAdministration.statusCode
    Comments

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

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

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

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

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

    Comments

    This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32088).

    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
    Fixed Valueactive
    70. SubstanceAdministration.statusCode.codeSystem
    Definition

    Specifies the code system that defines the code.

    Control0..0
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelCode System
    72. SubstanceAdministration.statusCode.codeSystemName
    Definition

    The common name of the coding system.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Control0..0
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    LabelTranslation
    88. SubstanceAdministration.effectiveTime
    Control1..*
    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 SubstanceAdministration.effectiveTime. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 90. SubstanceAdministration.effectiveTime:duration
      Slice Nameduration
      ShortThe effectiveTime in a planned medication activity represents the time that the medication activity should occur.
      Comments

      SHALL contain exactly one [1..1] effectiveTime (CONF:1098-30468) such that it

      Control1..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.
      Invariants1098-32890: This effectiveTime **SHALL** contain either a low or a @value but not both (CONF:1098-32890). ((value.exists() or low.exists()) and ((value.exists() and low.exists()).not()))
      should-value-att: SHOULD contain @value (value.exists())
      should-low: SHOULD contain low (low.exists())
      92. SubstanceAdministration.effectiveTime:duration.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
      94. SubstanceAdministration.effectiveTime:duration.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.

      Shortindicates a single-administration timestamp
      Comments

      SHOULD contain zero or one [0..1] @value (CONF:1098-32775).

      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.
      96. SubstanceAdministration.effectiveTime:duration.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
      98. SubstanceAdministration.effectiveTime:duration.low
      Definition

      This is the low limit of the interval.

      Shortindicates when medication started
      Comments

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

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
      LabelLow Boundary
      100. SubstanceAdministration.effectiveTime:duration.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
      102. SubstanceAdministration.effectiveTime:duration.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
      104. SubstanceAdministration.effectiveTime:duration.high
      Definition

      This is the high limit of the interval.

      Shortindicates when medication stopped
      Comments

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

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
      LabelHigh Boundary
      106. SubstanceAdministration.effectiveTime:periodicFrequency
      Slice NameperiodicFrequency
      ShortThis effectiveTime represents a periodic medication frequency (e.g., administration times per day).
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS
      Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
      XML FormatThe type of this property is determined using the xsi:typeattribute.
      108. SubstanceAdministration.effectiveTime:periodicFrequency.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
      110. SubstanceAdministration.effectiveTime:periodicFrequency.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..0
      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.
      112. SubstanceAdministration.effectiveTime:periodicFrequency.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.

      Comments

      SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106).

      Control1..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
      Pattern ValueA
      114. SubstanceAdministration.effectiveTime:periodicFrequency.event
      Definition

      A code for a common (periodical) activity of daily living based on which the event related periodic interval is specified.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CV
      LabelEvent
      116. SubstanceAdministration.effectiveTime:periodicFrequency.event.nullFlavor
      Definition

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

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

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

      Control0..1
      BindingThe codes SHALL be taken from CDATimingEvent
      (required to http://hl7.org/cda/stds/core/ValueSet/CDATimingEvent)
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode
      120. SubstanceAdministration.effectiveTime:periodicFrequency.event.codeSystem
      Definition

      Specifies the code system that defines the code.

      Control0..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode System
      Fixed Value2.16.840.1.113883.5.139
      122. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
      Fixed ValueTimingEvent
      124. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
      126. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
      128. SubstanceAdministration.effectiveTime:periodicFrequency.event.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.
      130. SubstanceAdministration.effectiveTime:periodicFrequency.event.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.
      132. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
      134. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
      136. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
      138. SubstanceAdministration.effectiveTime:periodicFrequency.offset
      Definition

      An interval of elapsed time (duration, not absolute point in time) that marks the offsets for the beginning, width and end of the event-related periodic interval measured from the time each such event actually occurred.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
      LabelOffset
      140. SubstanceAdministration.effectiveTime:eventFrequency
      Slice NameeventFrequency
      ShortThis effectiveTime represents an event-based medication frequency (e.g., administration at bedtime).
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS
      Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
      XML FormatThe type of this property is determined using the xsi:typeattribute.
      142. SubstanceAdministration.effectiveTime:eventFrequency.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
      144. SubstanceAdministration.effectiveTime:eventFrequency.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..0
      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.
      146. SubstanceAdministration.effectiveTime:eventFrequency.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.

      Comments

      SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106).

      Control1..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
      Pattern ValueA
      148. SubstanceAdministration.effectiveTime:eventFrequency.phase
      Definition

      A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
      LabelPhase
      150. SubstanceAdministration.effectiveTime:eventFrequency.period
      Definition

      A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
      LabelPeriod
      152. SubstanceAdministration.effectiveTime:eventFrequency.alignment
      Definition

      Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from "the 5th of every month".) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar.

      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.
      LabelAlignment to the Calendar
      154. SubstanceAdministration.effectiveTime:eventFrequency.institutionSpecified
      Definition

      Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish "every 8 hours" from "3 times a day".)

      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.
      LabelInstitution Specified Timing
      156. SubstanceAdministration.priorityCode
      Control0..1
      BindingFor example codes, see ActPriority
      (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      158. SubstanceAdministration.repeatNumber
      ShortIn a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
      Comments

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

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
      160. SubstanceAdministration.routeCode
      Comments

      MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32067).

      Control0..1
      BindingThe codes SHALL be taken from SPL Drug Route of Administration Terminology .
      (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      Invariantsshould-translation: SHOULD contain translation (translation.exists())
      162. SubstanceAdministration.routeCode.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
      164. SubstanceAdministration.routeCode.code
      Definition

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

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

      Specifies the code system that defines the code.

      Control0..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode System
      168. SubstanceAdministration.routeCode.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
      170. SubstanceAdministration.routeCode.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
      172. SubstanceAdministration.routeCode.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
      174. SubstanceAdministration.routeCode.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.
      176. SubstanceAdministration.routeCode.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.
      178. SubstanceAdministration.routeCode.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
      180. SubstanceAdministration.routeCode.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
      182. SubstanceAdministration.routeCode.translation
      Definition

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

      Comments

      The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952).

      Control0..*
      BindingThe codes SHOULD be taken from Medication Route .
      (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
      XML FormatThe type of this property is determined using the xsi:typeattribute.
      LabelTranslation
      184. SubstanceAdministration.approachSiteCode
      Comments

      MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32078).

      Control0..*
      BindingThe codes SHALL be taken from Body Site Value Set .
      (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
      186. SubstanceAdministration.doseQuantity
      Comments

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

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
      Invariantsshould-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists())
      188. SubstanceAdministration.doseQuantity.nullFlavor
      Definition

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

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

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

      ShortNOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
      Comments

      The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32133).

      Control0..1
      BindingThe codes SHOULD be taken from UnitsOfMeasureCaseSensitive
      (preferred to http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive)
      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.
      LabelUnit of Measure
      Default Value1
      192. SubstanceAdministration.doseQuantity.value
      Definition

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

      Control0..1
      Typedecimal(real: Real Number)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelMaginitude Value
      194. SubstanceAdministration.doseQuantity.translation
      Definition

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

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

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

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

      This is the low limit of the interval.

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

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

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

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

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

      This is the high limit of the interval.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
      LabelHigh Boundary
      206. SubstanceAdministration.rateQuantity
      Comments

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

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
      Invariantsshould-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists())
      208. SubstanceAdministration.rateQuantity.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
      210. SubstanceAdministration.rateQuantity.unit
      Definition

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

      ShortNOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
      Comments

      The rateQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32134).

      Control0..1
      BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
      (required to http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive)
      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.
      LabelUnit of Measure
      Default Value1
      212. SubstanceAdministration.rateQuantity.value
      Definition

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

      Control0..1
      Typedecimal(real: Real Number)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelMaginitude Value
      214. SubstanceAdministration.rateQuantity.translation
      Definition

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

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQR
      LabelTranslation
      216. SubstanceAdministration.rateQuantity.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
      218. SubstanceAdministration.rateQuantity.low
      Definition

      This is the low limit of the interval.

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

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

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
      LabelCentral Value
      222. SubstanceAdministration.rateQuantity.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
      224. SubstanceAdministration.rateQuantity.high
      Definition

      This is the high limit of the interval.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
      LabelHigh Boundary
      226. SubstanceAdministration.maxDoseQuantity
      Comments

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

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
      228. SubstanceAdministration.administrationUnitCode
      Comments

      MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1098-32081).

      Control0..1
      BindingThe codes SHALL be taken from AdministrationUnitDoseForm .
      (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      230. 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:1098-32082).

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
      232. 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
      234. 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
      236. 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
      InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
      238. 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
      240. 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
      242. 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
      244. 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
      246. 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
      248. 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
      250. 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
      252. SubstanceAdministration.consumable.manufacturedProduct
      Comments

      This consumable 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-32083).

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information)
      254. SubstanceAdministration.subject
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
      256. SubstanceAdministration.specimen
      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
      258. SubstanceAdministration.performer
      ShortThe clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer.
      Comments

      MAY contain zero or more [0..*] performer (CONF:1098-30470).

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
      260. SubstanceAdministration.author
      ShortThe author in a planned medication activity represents the clinician who is requesting or planning the medication activity.
      Comments

      SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32046).

      Control0..1
      This element is affected by the following invariants: should-author
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
      262. SubstanceAdministration.informant
      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
      264. SubstanceAdministration.participant
      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
      266. SubstanceAdministration.entryRelationship
      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
      SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • profile @ observation
      • 268. SubstanceAdministration.entryRelationship:priorityPreference
        Slice NamepriorityPreference
        ShortThe following entryRelationship represents the priority that a patient or a provider places on the planned medication activity.
        Comments

        MAY contain zero or more [0..*] entryRelationship (CONF:1098-31104) such that it

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        270. SubstanceAdministration.entryRelationship:priorityPreference.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
        272. SubstanceAdministration.entryRelationship:priorityPreference.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
        274. SubstanceAdministration.entryRelationship:priorityPreference.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
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        276. SubstanceAdministration.entryRelationship:priorityPreference.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
        278. SubstanceAdministration.entryRelationship:priorityPreference.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
        280. SubstanceAdministration.entryRelationship:priorityPreference.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
        282. SubstanceAdministration.entryRelationship:priorityPreference.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
        284. SubstanceAdministration.entryRelationship:priorityPreference.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
        286. SubstanceAdministration.entryRelationship:priorityPreference.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
        288. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
        Comments

        SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31105).

        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 ValueREFR
        290. SubstanceAdministration.entryRelationship:priorityPreference.inversionInd
        Definition

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

        Control0..1
        Typeboolean(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        292. SubstanceAdministration.entryRelationship:priorityPreference.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
        294. SubstanceAdministration.entryRelationship:priorityPreference.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.
        296. SubstanceAdministration.entryRelationship:priorityPreference.sequenceNumber
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
        298. SubstanceAdministration.entryRelationship:priorityPreference.seperatableInd
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
        300. SubstanceAdministration.entryRelationship:priorityPreference.act
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
        302. SubstanceAdministration.entryRelationship:priorityPreference.encounter
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
        304. SubstanceAdministration.entryRelationship:priorityPreference.observation
        Comments

        SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31106).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
        306. SubstanceAdministration.entryRelationship:priorityPreference.observationMedia
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
        308. SubstanceAdministration.entryRelationship:priorityPreference.organizer
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
        310. SubstanceAdministration.entryRelationship:priorityPreference.procedure
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
        312. SubstanceAdministration.entryRelationship:priorityPreference.regionOfInterest
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
        314. SubstanceAdministration.entryRelationship:priorityPreference.substanceAdministration
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
        316. SubstanceAdministration.entryRelationship:priorityPreference.supply
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
        318. SubstanceAdministration.entryRelationship:indication
        Slice Nameindication
        ShortThe following entryRelationship represents the indication for the planned medication activity.
        Comments

        MAY contain zero or more [0..*] entryRelationship (CONF:1098-32069) such that it

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        320. SubstanceAdministration.entryRelationship:indication.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
        322. SubstanceAdministration.entryRelationship:indication.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
        324. SubstanceAdministration.entryRelationship:indication.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
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        326. SubstanceAdministration.entryRelationship:indication.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
        328. SubstanceAdministration.entryRelationship:indication.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
        330. SubstanceAdministration.entryRelationship:indication.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
        332. SubstanceAdministration.entryRelationship:indication.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
        334. SubstanceAdministration.entryRelationship:indication.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
        336. SubstanceAdministration.entryRelationship:indication.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
        338. SubstanceAdministration.entryRelationship:indication.typeCode
        Comments

        SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32070).

        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 ValueRSON
        340. SubstanceAdministration.entryRelationship:indication.inversionInd
        Definition

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

        Control0..1
        Typeboolean(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        342. SubstanceAdministration.entryRelationship:indication.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
        344. SubstanceAdministration.entryRelationship:indication.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.
        346. SubstanceAdministration.entryRelationship:indication.sequenceNumber
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
        348. SubstanceAdministration.entryRelationship:indication.seperatableInd
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
        350. SubstanceAdministration.entryRelationship:indication.act
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
        352. SubstanceAdministration.entryRelationship:indication.encounter
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
        354. SubstanceAdministration.entryRelationship:indication.observation
        Comments

        SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32071).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
        356. SubstanceAdministration.entryRelationship:indication.observationMedia
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
        358. SubstanceAdministration.entryRelationship:indication.organizer
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
        360. SubstanceAdministration.entryRelationship:indication.procedure
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
        362. SubstanceAdministration.entryRelationship:indication.regionOfInterest
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
        364. SubstanceAdministration.entryRelationship:indication.substanceAdministration
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
        366. SubstanceAdministration.entryRelationship:indication.supply
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
        368. SubstanceAdministration.entryRelationship:instruction
        Slice Nameinstruction
        ShortThe following entryRelationship captures any instructions associated with the planned medication activity.
        Comments

        MAY contain zero or more [0..*] entryRelationship (CONF:1098-32072) such that it

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        370. SubstanceAdministration.entryRelationship:instruction.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
        372. SubstanceAdministration.entryRelationship:instruction.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
        374. SubstanceAdministration.entryRelationship:instruction.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
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        376. SubstanceAdministration.entryRelationship:instruction.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
        378. SubstanceAdministration.entryRelationship:instruction.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
        380. SubstanceAdministration.entryRelationship:instruction.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
        382. SubstanceAdministration.entryRelationship:instruction.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
        384. SubstanceAdministration.entryRelationship:instruction.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
        386. SubstanceAdministration.entryRelationship:instruction.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
        388. SubstanceAdministration.entryRelationship:instruction.typeCode
        Comments

        SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32073).

        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
        390. SubstanceAdministration.entryRelationship:instruction.inversionInd
        Definition

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

        Control0..1
        Typeboolean(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        392. SubstanceAdministration.entryRelationship:instruction.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
        394. SubstanceAdministration.entryRelationship:instruction.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.
        396. SubstanceAdministration.entryRelationship:instruction.sequenceNumber
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
        398. SubstanceAdministration.entryRelationship:instruction.seperatableInd
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
        400. SubstanceAdministration.entryRelationship:instruction.act
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
        402. SubstanceAdministration.entryRelationship:instruction.encounter
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
        404. SubstanceAdministration.entryRelationship:instruction.observation
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Instruction Observation)
        406. SubstanceAdministration.entryRelationship:instruction.observationMedia
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
        408. SubstanceAdministration.entryRelationship:instruction.organizer
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
        410. SubstanceAdministration.entryRelationship:instruction.procedure
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
        412. SubstanceAdministration.entryRelationship:instruction.regionOfInterest
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
        414. SubstanceAdministration.entryRelationship:instruction.substanceAdministration
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
        416. SubstanceAdministration.entryRelationship:instruction.supply
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
        418. SubstanceAdministration.reference
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
        420. SubstanceAdministration.precondition
        Comments

        MAY contain zero or more [0..*] precondition (CONF:1098-32084).

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
        422. SubstanceAdministration.precondition.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
        424. SubstanceAdministration.precondition.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
        426. SubstanceAdministration.precondition.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
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        428. SubstanceAdministration.precondition.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
        430. SubstanceAdministration.precondition.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
        432. SubstanceAdministration.precondition.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
        434. SubstanceAdministration.precondition.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
        436. SubstanceAdministration.precondition.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
        438. SubstanceAdministration.precondition.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
        440. SubstanceAdministration.precondition.typeCode
        Comments

        The precondition, if present, SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32085).

        Control1..1
        BindingThe codes SHALL be taken from CDAActRelationshipType
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType)
        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 ValuePRCN
        442. SubstanceAdministration.precondition.criterion
        Comments

        The precondition, if present, SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32086).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Criterion(Precondition for Substance Administration)
        444. 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.

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

        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())
        dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
        should-author: SHOULD contain author (author.exists())
        2. SubstanceAdministration.templateId
        Control1..?
        SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ root
        • value @ extension
        • 4. SubstanceAdministration.templateId:planned-med-activity
          Slice Nameplanned-med-activity
          Control1..1
          6. SubstanceAdministration.templateId:planned-med-activity.root
          Control1..?
          Pattern Value2.16.840.1.113883.10.20.22.4.42
          8. SubstanceAdministration.templateId:planned-med-activity.extension
          Control1..?
          Pattern Value2014-06-09
          10. SubstanceAdministration.classCode
          Comments

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

          12. SubstanceAdministration.moodCode
          Comments

          SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8573).

          BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply) .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24)
          14. SubstanceAdministration.id
          Comments

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

          Control1..?
          16. SubstanceAdministration.text
          ShortSHOULD reference the portion of section narrative text corresponding to this entry
          18. SubstanceAdministration.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. SubstanceAdministration.statusCode
          Comments

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

          Control1..?
          22. SubstanceAdministration.statusCode.code
          Comments

          This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32088).

          Control1..?
          Fixed Valueactive
          24. SubstanceAdministration.effectiveTime
          Control1..?
          SlicingThis element introduces a set of slices on SubstanceAdministration.effectiveTime. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • type @ $this
          • 26. SubstanceAdministration.effectiveTime:duration
            Slice Nameduration
            ShortThe effectiveTime in a planned medication activity represents the time that the medication activity should occur.
            Comments

            SHALL contain exactly one [1..1] effectiveTime (CONF:1098-30468) such that it

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
            Invariants1098-32890: This effectiveTime **SHALL** contain either a low or a @value but not both (CONF:1098-32890). ((value.exists() or low.exists()) and ((value.exists() and low.exists()).not()))
            should-value-att: SHOULD contain @value (value.exists())
            should-low: SHOULD contain low (low.exists())
            28. SubstanceAdministration.effectiveTime:duration.value
            Shortindicates a single-administration timestamp
            Comments

            SHOULD contain zero or one [0..1] @value (CONF:1098-32775).

            30. SubstanceAdministration.effectiveTime:duration.low
            Shortindicates when medication started
            Comments

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

            32. SubstanceAdministration.effectiveTime:duration.high
            Shortindicates when medication stopped
            Comments

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

            34. SubstanceAdministration.effectiveTime:periodicFrequency
            Slice NameperiodicFrequency
            ShortThis effectiveTime represents a periodic medication frequency (e.g., administration times per day).
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS
            36. SubstanceAdministration.effectiveTime:periodicFrequency.operator
            Comments

            SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106).

            Control1..?
            Pattern ValueA
            38. SubstanceAdministration.effectiveTime:eventFrequency
            Slice NameeventFrequency
            ShortThis effectiveTime represents an event-based medication frequency (e.g., administration at bedtime).
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS
            40. SubstanceAdministration.effectiveTime:eventFrequency.operator
            Comments

            SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106).

            Control1..?
            Pattern ValueA
            42. SubstanceAdministration.repeatNumber
            ShortIn a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
            Comments

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

            44. SubstanceAdministration.routeCode
            Comments

            MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32067).

            BindingThe codes SHALL be taken from SPL Drug Route of Administration Terminology .
            (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7)
            Invariantsshould-translation: SHOULD contain translation (translation.exists())
            46. SubstanceAdministration.routeCode.translation
            Comments

            The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952).

            BindingThe codes SHOULD be taken from Medication Route .
            (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12)
            48. SubstanceAdministration.approachSiteCode
            Comments

            MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32078).

            BindingThe codes SHALL be taken from Body Site Value Set .
            (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9)
            50. SubstanceAdministration.doseQuantity
            Comments

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

            Invariantsshould-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists())
            52. SubstanceAdministration.doseQuantity.unit
            ShortNOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
            Comments

            The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32133).

            BindingThe codes SHOULD be taken from UnitsOfMeasureCaseSensitive
            (preferred to http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive)
            54. SubstanceAdministration.rateQuantity
            Comments

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

            Invariantsshould-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists())
            56. SubstanceAdministration.rateQuantity.unit
            ShortNOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
            Comments

            The rateQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32134).

            BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
            (required to http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive)
            58. SubstanceAdministration.maxDoseQuantity
            Comments

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

            60. SubstanceAdministration.administrationUnitCode
            Comments

            MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1098-32081).

            BindingThe codes SHALL be taken from AdministrationUnitDoseForm .
            (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30)
            62. SubstanceAdministration.consumable
            Comments

            SHALL contain exactly one [1..1] consumable (CONF:1098-32082).

            64. SubstanceAdministration.consumable.manufacturedProduct
            Comments

            This consumable 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-32083).

            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information)
            66. SubstanceAdministration.performer
            ShortThe clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer.
            Comments

            MAY contain zero or more [0..*] performer (CONF:1098-30470).

            68. SubstanceAdministration.author
            ShortThe author in a planned medication activity represents the clinician who is requesting or planning the medication activity.
            Comments

            SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32046).

            Control0..1
            This element is affected by the following invariants: should-author
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
            70. SubstanceAdministration.entryRelationship
            SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • profile @ observation
            • 72. SubstanceAdministration.entryRelationship:priorityPreference
              Slice NamepriorityPreference
              ShortThe following entryRelationship represents the priority that a patient or a provider places on the planned medication activity.
              Comments

              MAY contain zero or more [0..*] entryRelationship (CONF:1098-31104) such that it

              Control0..*
              74. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
              Comments

              SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31105).

              Fixed ValueREFR
              76. SubstanceAdministration.entryRelationship:priorityPreference.observation
              Comments

              SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31106).

              Control1..?
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
              78. SubstanceAdministration.entryRelationship:indication
              Slice Nameindication
              ShortThe following entryRelationship represents the indication for the planned medication activity.
              Comments

              MAY contain zero or more [0..*] entryRelationship (CONF:1098-32069) such that it

              Control0..*
              80. SubstanceAdministration.entryRelationship:indication.typeCode
              Comments

              SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32070).

              Fixed ValueRSON
              82. SubstanceAdministration.entryRelationship:indication.observation
              Comments

              SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32071).

              Control1..?
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
              84. SubstanceAdministration.entryRelationship:instruction
              Slice Nameinstruction
              ShortThe following entryRelationship captures any instructions associated with the planned medication activity.
              Comments

              MAY contain zero or more [0..*] entryRelationship (CONF:1098-32072) such that it

              Control0..*
              86. SubstanceAdministration.entryRelationship:instruction.typeCode
              Comments

              SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32073).

              Fixed ValueSUBJ
              88. SubstanceAdministration.entryRelationship:instruction.observation
              Control1..?
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Instruction Observation)
              90. SubstanceAdministration.precondition
              Comments

              MAY contain zero or more [0..*] precondition (CONF:1098-32084).

              92. SubstanceAdministration.precondition.typeCode
              Comments

              The precondition, if present, SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32085).

              Control1..?
              94. SubstanceAdministration.precondition.criterion
              Comments

              The precondition, if present, SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32086).

              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Criterion(Precondition for Substance Administration)

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

              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())
              dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
              should-author: SHOULD contain author (author.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..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              8. SubstanceAdministration.typeId.nullFlavor
              Definition

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

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

              A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

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

              Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

              Control0..1
              Typeboolean(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              14. SubstanceAdministration.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              16. SubstanceAdministration.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              18. SubstanceAdministration.templateId
              Definition

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ root
              • value @ extension
              • 20. SubstanceAdministration.templateId:planned-med-activity
                Slice Nameplanned-med-activity
                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. SubstanceAdministration.templateId:planned-med-activity.nullFlavor
                Definition

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

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

                A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

                Control0..1
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelAssigning Authority Name
                26. SubstanceAdministration.templateId:planned-med-activity.displayable
                Definition

                Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

                Control0..1
                Typeboolean(bl: Boolean)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelDisplayable
                28. SubstanceAdministration.templateId:planned-med-activity.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.42
                30. SubstanceAdministration.templateId:planned-med-activity.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. SubstanceAdministration.classCode
                Comments

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

                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
                34. SubstanceAdministration.moodCode
                Comments

                SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8573).

                Control1..1
                BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply) .
                (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24)
                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.
                36. SubstanceAdministration.id
                Comments

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

                Control1..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                38. SubstanceAdministration.code
                Control0..1
                BindingFor example codes, see CDAActSubstanceAdministrationCode
                (example to http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                40. SubstanceAdministration.negationInd
                Control0..1
                Typeboolean(bl: Boolean)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                42. SubstanceAdministration.text
                ShortSHOULD reference the portion of section narrative text corresponding to this entry
                Control0..1
                This element is affected by the following invariants: should-text-ref-value
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                44. SubstanceAdministration.text.nullFlavor
                Definition

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                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('#'))
                62. 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
                InvariantsED-1: Thumbnails cannot contain their own thumbnails (thumbnail.empty())
                64. SubstanceAdministration.statusCode
                Comments

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

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

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

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

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

                Comments

                This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32088).

                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
                Fixed Valueactive
                70. SubstanceAdministration.statusCode.codeSystem
                Definition

                Specifies the code system that defines the code.

                Control0..0
                Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelCode System
                72. SubstanceAdministration.statusCode.codeSystemName
                Definition

                The common name of the coding system.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                Control0..0
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                XML FormatThe type of this property is determined using the xsi:typeattribute.
                LabelTranslation
                88. SubstanceAdministration.effectiveTime
                Control1..*
                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 SubstanceAdministration.effectiveTime. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • type @ $this
                • 90. SubstanceAdministration.effectiveTime:duration
                  Slice Nameduration
                  ShortThe effectiveTime in a planned medication activity represents the time that the medication activity should occur.
                  Comments

                  SHALL contain exactly one [1..1] effectiveTime (CONF:1098-30468) such that it

                  Control1..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.
                  Invariants1098-32890: This effectiveTime **SHALL** contain either a low or a @value but not both (CONF:1098-32890). ((value.exists() or low.exists()) and ((value.exists() and low.exists()).not()))
                  should-value-att: SHOULD contain @value (value.exists())
                  should-low: SHOULD contain low (low.exists())
                  92. SubstanceAdministration.effectiveTime:duration.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
                  94. SubstanceAdministration.effectiveTime:duration.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.

                  Shortindicates a single-administration timestamp
                  Comments

                  SHOULD contain zero or one [0..1] @value (CONF:1098-32775).

                  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.
                  96. SubstanceAdministration.effectiveTime:duration.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
                  98. SubstanceAdministration.effectiveTime:duration.low
                  Definition

                  This is the low limit of the interval.

                  Shortindicates when medication started
                  Comments

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

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
                  LabelLow Boundary
                  100. SubstanceAdministration.effectiveTime:duration.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
                  102. SubstanceAdministration.effectiveTime:duration.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
                  104. SubstanceAdministration.effectiveTime:duration.high
                  Definition

                  This is the high limit of the interval.

                  Shortindicates when medication stopped
                  Comments

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

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
                  LabelHigh Boundary
                  106. SubstanceAdministration.effectiveTime:periodicFrequency
                  Slice NameperiodicFrequency
                  ShortThis effectiveTime represents a periodic medication frequency (e.g., administration times per day).
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS
                  Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
                  XML FormatThe type of this property is determined using the xsi:typeattribute.
                  108. SubstanceAdministration.effectiveTime:periodicFrequency.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
                  110. SubstanceAdministration.effectiveTime:periodicFrequency.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..0
                  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.
                  112. SubstanceAdministration.effectiveTime:periodicFrequency.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.

                  Comments

                  SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106).

                  Control1..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
                  Pattern ValueA
                  114. SubstanceAdministration.effectiveTime:periodicFrequency.event
                  Definition

                  A code for a common (periodical) activity of daily living based on which the event related periodic interval is specified.

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CV
                  LabelEvent
                  116. SubstanceAdministration.effectiveTime:periodicFrequency.event.nullFlavor
                  Definition

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

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

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

                  Control0..1
                  BindingThe codes SHALL be taken from CDATimingEvent
                  (required to http://hl7.org/cda/stds/core/ValueSet/CDATimingEvent)
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelCode
                  120. SubstanceAdministration.effectiveTime:periodicFrequency.event.codeSystem
                  Definition

                  Specifies the code system that defines the code.

                  Control0..1
                  Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelCode System
                  Fixed Value2.16.840.1.113883.5.139
                  122. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
                  Fixed ValueTimingEvent
                  124. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
                  126. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
                  128. SubstanceAdministration.effectiveTime:periodicFrequency.event.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.
                  130. SubstanceAdministration.effectiveTime:periodicFrequency.event.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.
                  132. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
                  134. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
                  136. SubstanceAdministration.effectiveTime:periodicFrequency.event.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
                  138. SubstanceAdministration.effectiveTime:periodicFrequency.offset
                  Definition

                  An interval of elapsed time (duration, not absolute point in time) that marks the offsets for the beginning, width and end of the event-related periodic interval measured from the time each such event actually occurred.

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
                  LabelOffset
                  140. SubstanceAdministration.effectiveTime:eventFrequency
                  Slice NameeventFrequency
                  ShortThis effectiveTime represents an event-based medication frequency (e.g., administration at bedtime).
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS
                  Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
                  XML FormatThe type of this property is determined using the xsi:typeattribute.
                  142. SubstanceAdministration.effectiveTime:eventFrequency.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
                  144. SubstanceAdministration.effectiveTime:eventFrequency.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..0
                  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.
                  146. SubstanceAdministration.effectiveTime:eventFrequency.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.

                  Comments

                  SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106).

                  Control1..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
                  Pattern ValueA
                  148. SubstanceAdministration.effectiveTime:eventFrequency.phase
                  Definition

                  A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time.

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
                  LabelPhase
                  150. SubstanceAdministration.effectiveTime:eventFrequency.period
                  Definition

                  A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
                  LabelPeriod
                  152. SubstanceAdministration.effectiveTime:eventFrequency.alignment
                  Definition

                  Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from "the 5th of every month".) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar.

                  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.
                  LabelAlignment to the Calendar
                  154. SubstanceAdministration.effectiveTime:eventFrequency.institutionSpecified
                  Definition

                  Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish "every 8 hours" from "3 times a day".)

                  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.
                  LabelInstitution Specified Timing
                  156. SubstanceAdministration.priorityCode
                  Control0..1
                  BindingFor example codes, see ActPriority
                  (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                  158. SubstanceAdministration.repeatNumber
                  ShortIn a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
                  Comments

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

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
                  160. SubstanceAdministration.routeCode
                  Comments

                  MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32067).

                  Control0..1
                  BindingThe codes SHALL be taken from SPL Drug Route of Administration Terminology .
                  (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7)
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                  Invariantsshould-translation: SHOULD contain translation (translation.exists())
                  162. SubstanceAdministration.routeCode.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
                  164. SubstanceAdministration.routeCode.code
                  Definition

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

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

                  Specifies the code system that defines the code.

                  Control0..1
                  Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelCode System
                  168. SubstanceAdministration.routeCode.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
                  170. SubstanceAdministration.routeCode.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
                  172. SubstanceAdministration.routeCode.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
                  174. SubstanceAdministration.routeCode.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.
                  176. SubstanceAdministration.routeCode.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.
                  178. SubstanceAdministration.routeCode.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
                  180. SubstanceAdministration.routeCode.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
                  182. SubstanceAdministration.routeCode.translation
                  Definition

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

                  Comments

                  The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952).

                  Control0..*
                  BindingThe codes SHOULD be taken from Medication Route .
                  (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12)
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                  XML FormatThe type of this property is determined using the xsi:typeattribute.
                  LabelTranslation
                  184. SubstanceAdministration.approachSiteCode
                  Comments

                  MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32078).

                  Control0..*
                  BindingThe codes SHALL be taken from Body Site Value Set .
                  (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9)
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                  186. SubstanceAdministration.doseQuantity
                  Comments

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

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
                  Invariantsshould-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists())
                  188. SubstanceAdministration.doseQuantity.nullFlavor
                  Definition

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

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

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

                  ShortNOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
                  Comments

                  The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32133).

                  Control0..1
                  BindingThe codes SHOULD be taken from UnitsOfMeasureCaseSensitive
                  (preferred to http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive)
                  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.
                  LabelUnit of Measure
                  Default Value1
                  192. SubstanceAdministration.doseQuantity.value
                  Definition

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

                  Control0..1
                  Typedecimal(real: Real Number)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelMaginitude Value
                  194. SubstanceAdministration.doseQuantity.translation
                  Definition

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

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

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

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

                  This is the low limit of the interval.

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

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

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

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

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

                  This is the high limit of the interval.

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
                  LabelHigh Boundary
                  206. SubstanceAdministration.rateQuantity
                  Comments

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

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
                  Invariantsshould-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists())
                  208. SubstanceAdministration.rateQuantity.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
                  210. SubstanceAdministration.rateQuantity.unit
                  Definition

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

                  ShortNOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
                  Comments

                  The rateQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32134).

                  Control0..1
                  BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
                  (required to http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive)
                  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.
                  LabelUnit of Measure
                  Default Value1
                  212. SubstanceAdministration.rateQuantity.value
                  Definition

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

                  Control0..1
                  Typedecimal(real: Real Number)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelMaginitude Value
                  214. SubstanceAdministration.rateQuantity.translation
                  Definition

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

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQR
                  LabelTranslation
                  216. SubstanceAdministration.rateQuantity.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
                  218. SubstanceAdministration.rateQuantity.low
                  Definition

                  This is the low limit of the interval.

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

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

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
                  LabelCentral Value
                  222. SubstanceAdministration.rateQuantity.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
                  224. SubstanceAdministration.rateQuantity.high
                  Definition

                  This is the high limit of the interval.

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
                  LabelHigh Boundary
                  226. SubstanceAdministration.maxDoseQuantity
                  Comments

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

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
                  228. SubstanceAdministration.administrationUnitCode
                  Comments

                  MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1098-32081).

                  Control0..1
                  BindingThe codes SHALL be taken from AdministrationUnitDoseForm .
                  (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30)
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                  230. 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:1098-32082).

                  Control1..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
                  232. 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
                  234. 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
                  236. 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
                  InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
                  238. 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
                  240. 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
                  242. 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
                  244. 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
                  246. 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
                  248. 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
                  250. 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
                  252. SubstanceAdministration.consumable.manufacturedProduct
                  Comments

                  This consumable 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-32083).

                  Control1..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information)
                  254. SubstanceAdministration.subject
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
                  256. SubstanceAdministration.specimen
                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
                  258. SubstanceAdministration.performer
                  ShortThe clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer.
                  Comments

                  MAY contain zero or more [0..*] performer (CONF:1098-30470).

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
                  260. SubstanceAdministration.author
                  ShortThe author in a planned medication activity represents the clinician who is requesting or planning the medication activity.
                  Comments

                  SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32046).

                  Control0..1
                  This element is affected by the following invariants: should-author
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
                  262. SubstanceAdministration.informant
                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
                  264. SubstanceAdministration.participant
                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
                  266. SubstanceAdministration.entryRelationship
                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                  SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • profile @ observation
                  • 268. SubstanceAdministration.entryRelationship:priorityPreference
                    Slice NamepriorityPreference
                    ShortThe following entryRelationship represents the priority that a patient or a provider places on the planned medication activity.
                    Comments

                    MAY contain zero or more [0..*] entryRelationship (CONF:1098-31104) such that it

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                    270. SubstanceAdministration.entryRelationship:priorityPreference.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
                    272. SubstanceAdministration.entryRelationship:priorityPreference.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
                    274. SubstanceAdministration.entryRelationship:priorityPreference.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
                    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
                    276. SubstanceAdministration.entryRelationship:priorityPreference.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
                    278. SubstanceAdministration.entryRelationship:priorityPreference.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
                    280. SubstanceAdministration.entryRelationship:priorityPreference.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
                    282. SubstanceAdministration.entryRelationship:priorityPreference.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
                    284. SubstanceAdministration.entryRelationship:priorityPreference.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
                    286. SubstanceAdministration.entryRelationship:priorityPreference.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
                    288. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
                    Comments

                    SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31105).

                    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 ValueREFR
                    290. SubstanceAdministration.entryRelationship:priorityPreference.inversionInd
                    Definition

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

                    Control0..1
                    Typeboolean(bl: Boolean)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    292. SubstanceAdministration.entryRelationship:priorityPreference.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
                    294. SubstanceAdministration.entryRelationship:priorityPreference.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.
                    296. SubstanceAdministration.entryRelationship:priorityPreference.sequenceNumber
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                    298. SubstanceAdministration.entryRelationship:priorityPreference.seperatableInd
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                    300. SubstanceAdministration.entryRelationship:priorityPreference.act
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
                    302. SubstanceAdministration.entryRelationship:priorityPreference.encounter
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                    304. SubstanceAdministration.entryRelationship:priorityPreference.observation
                    Comments

                    SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31106).

                    Control1..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
                    306. SubstanceAdministration.entryRelationship:priorityPreference.observationMedia
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                    308. SubstanceAdministration.entryRelationship:priorityPreference.organizer
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                    310. SubstanceAdministration.entryRelationship:priorityPreference.procedure
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                    312. SubstanceAdministration.entryRelationship:priorityPreference.regionOfInterest
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                    314. SubstanceAdministration.entryRelationship:priorityPreference.substanceAdministration
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                    316. SubstanceAdministration.entryRelationship:priorityPreference.supply
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                    318. SubstanceAdministration.entryRelationship:indication
                    Slice Nameindication
                    ShortThe following entryRelationship represents the indication for the planned medication activity.
                    Comments

                    MAY contain zero or more [0..*] entryRelationship (CONF:1098-32069) such that it

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                    320. SubstanceAdministration.entryRelationship:indication.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
                    322. SubstanceAdministration.entryRelationship:indication.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
                    324. SubstanceAdministration.entryRelationship:indication.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
                    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
                    326. SubstanceAdministration.entryRelationship:indication.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
                    328. SubstanceAdministration.entryRelationship:indication.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
                    330. SubstanceAdministration.entryRelationship:indication.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
                    332. SubstanceAdministration.entryRelationship:indication.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
                    334. SubstanceAdministration.entryRelationship:indication.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
                    336. SubstanceAdministration.entryRelationship:indication.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
                    338. SubstanceAdministration.entryRelationship:indication.typeCode
                    Comments

                    SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32070).

                    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 ValueRSON
                    340. SubstanceAdministration.entryRelationship:indication.inversionInd
                    Definition

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

                    Control0..1
                    Typeboolean(bl: Boolean)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    342. SubstanceAdministration.entryRelationship:indication.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
                    344. SubstanceAdministration.entryRelationship:indication.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.
                    346. SubstanceAdministration.entryRelationship:indication.sequenceNumber
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                    348. SubstanceAdministration.entryRelationship:indication.seperatableInd
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                    350. SubstanceAdministration.entryRelationship:indication.act
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
                    352. SubstanceAdministration.entryRelationship:indication.encounter
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                    354. SubstanceAdministration.entryRelationship:indication.observation
                    Comments

                    SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32071).

                    Control1..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
                    356. SubstanceAdministration.entryRelationship:indication.observationMedia
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                    358. SubstanceAdministration.entryRelationship:indication.organizer
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                    360. SubstanceAdministration.entryRelationship:indication.procedure
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                    362. SubstanceAdministration.entryRelationship:indication.regionOfInterest
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                    364. SubstanceAdministration.entryRelationship:indication.substanceAdministration
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                    366. SubstanceAdministration.entryRelationship:indication.supply
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                    368. SubstanceAdministration.entryRelationship:instruction
                    Slice Nameinstruction
                    ShortThe following entryRelationship captures any instructions associated with the planned medication activity.
                    Comments

                    MAY contain zero or more [0..*] entryRelationship (CONF:1098-32072) such that it

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                    370. SubstanceAdministration.entryRelationship:instruction.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
                    372. SubstanceAdministration.entryRelationship:instruction.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
                    374. SubstanceAdministration.entryRelationship:instruction.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
                    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
                    376. SubstanceAdministration.entryRelationship:instruction.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
                    378. SubstanceAdministration.entryRelationship:instruction.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
                    380. SubstanceAdministration.entryRelationship:instruction.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
                    382. SubstanceAdministration.entryRelationship:instruction.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
                    384. SubstanceAdministration.entryRelationship:instruction.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
                    386. SubstanceAdministration.entryRelationship:instruction.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
                    388. SubstanceAdministration.entryRelationship:instruction.typeCode
                    Comments

                    SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32073).

                    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
                    390. SubstanceAdministration.entryRelationship:instruction.inversionInd
                    Definition

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

                    Control0..1
                    Typeboolean(bl: Boolean)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    392. SubstanceAdministration.entryRelationship:instruction.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
                    394. SubstanceAdministration.entryRelationship:instruction.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.
                    396. SubstanceAdministration.entryRelationship:instruction.sequenceNumber
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                    398. SubstanceAdministration.entryRelationship:instruction.seperatableInd
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                    400. SubstanceAdministration.entryRelationship:instruction.act
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
                    402. SubstanceAdministration.entryRelationship:instruction.encounter
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                    404. SubstanceAdministration.entryRelationship:instruction.observation
                    Control1..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Instruction Observation)
                    406. SubstanceAdministration.entryRelationship:instruction.observationMedia
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                    408. SubstanceAdministration.entryRelationship:instruction.organizer
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                    410. SubstanceAdministration.entryRelationship:instruction.procedure
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                    412. SubstanceAdministration.entryRelationship:instruction.regionOfInterest
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                    414. SubstanceAdministration.entryRelationship:instruction.substanceAdministration
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                    416. SubstanceAdministration.entryRelationship:instruction.supply
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                    418. SubstanceAdministration.reference
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
                    420. SubstanceAdministration.precondition
                    Comments

                    MAY contain zero or more [0..*] precondition (CONF:1098-32084).

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
                    422. SubstanceAdministration.precondition.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
                    424. SubstanceAdministration.precondition.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
                    426. SubstanceAdministration.precondition.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
                    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
                    428. SubstanceAdministration.precondition.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
                    430. SubstanceAdministration.precondition.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
                    432. SubstanceAdministration.precondition.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
                    434. SubstanceAdministration.precondition.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
                    436. SubstanceAdministration.precondition.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
                    438. SubstanceAdministration.precondition.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
                    440. SubstanceAdministration.precondition.typeCode
                    Comments

                    The precondition, if present, SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32085).

                    Control1..1
                    BindingThe codes SHALL be taken from CDAActRelationshipType
                    (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType)
                    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 ValuePRCN
                    442. SubstanceAdministration.precondition.criterion
                    Comments

                    The precondition, if present, SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32086).

                    Control1..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Criterion(Precondition for Substance Administration)
                    444. 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.