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

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

Logical Model: PlannedSupply - Detailed Descriptions

Draft as of 2025-06-20

Definitions for the PlannedSupply logical model.

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

0. Supply
Definition

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


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') ((product | participant.where(typeCode='DEV')).count() = 1)
should-author: SHOULD contain author (author.exists())
2. Supply.nullFlavor
Definition

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

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

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
6. Supply.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
8. Supply.typeId.nullFlavor
Definition

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

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

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

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

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

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

Identifies the type as an HL7 Registered model

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

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

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

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on Supply.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 20. Supply.templateId:planned-supply
    Slice Nameplanned-supply
    Definition

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    22. Supply.templateId:planned-supply.nullFlavor
    Definition

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

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

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

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

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

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

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

    Control1..1
    BindingThe codes SHALL be taken from ActClassSupply
    (required to http://terminology.hl7.org/ValueSet/v3-ActClassSupply)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Default ValueSPLY
    Fixed ValueSPLY
    34. Supply.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode, 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-8578).

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

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

    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    38. Supply.code
    Control0..1
    BindingFor example codes, see v3 Code System ActCode
    (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
    40. Supply.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
    42. Supply.text.nullFlavor
    Definition

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
    LabelThumbnail
    62. Supply.statusCode
    Comments

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

    Control1..1
    BindingThe codes SHALL be taken from ActStatus
    (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
    64. Supply.statusCode.nullFlavor
    Definition

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

    Control0..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
    66. Supply.statusCode.code
    Definition

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

    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-32047).

    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
    68. Supply.statusCode.codeSystem
    Definition

    Specifies the code system that defines the code.

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

    The common name of the coding system.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Control0..0
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    LabelTranslation
    86. Supply.effectiveTime
    ShortThe effectiveTime in a planned supply represents the time that the supply should occur.
    Comments

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

    Control0..1
    TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    88. Supply.priorityCode
    Control0..*
    BindingFor example codes, see ActPriority
    (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    90. Supply.repeatNumber
    ShortIn a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4.
    Comments

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

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

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
    96. Supply.expectedUseTime
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
    98. Supply.product
    ShortRepresents either a medication or an immunization supply
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    100. Supply.product.nullFlavor
    Definition

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

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

    When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
    104. Supply.product.typeId
    Definition

    When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    106. Supply.product.typeId.nullFlavor
    Definition

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

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

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

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

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

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

    Identifies the type as an HL7 Registered model

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

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

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

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

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    118. Supply.product.typeCode
    Control0..1
    BindingThe codes SHALL be taken from ParticipationTargetDirect
    (required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValuePRD
    120. Supply.product.manufacturedProduct
    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
    122. Supply.subject
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
    124. Supply.specimen
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
    126. Supply.performer
    ShortThe clinician who is expected to perform the supply could be identified using supply/performer.
    Comments

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

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
    128. Supply.author
    ShortThe author in a supply represents the clinician who is requesting or planning the supply.
    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-31129).

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
    130. Supply.informant
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
    132. Supply.participant
    ShortThis participant represents a device that is ordered, requested or intended for the patient.
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
    SlicingThis element introduces a set of slices on Supply.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ typeCode
    • 134. Supply.participant:productInstance
      Slice NameproductInstance
      Comments

      MAY contain zero or one [0..1] participant (CONF:1098-32094) such that it

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
      136. Supply.participant:productInstance.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
      138. Supply.participant:productInstance.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
      140. Supply.participant:productInstance.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())
      142. Supply.participant:productInstance.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
      144. Supply.participant:productInstance.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
      146. Supply.participant:productInstance.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
      148. Supply.participant:productInstance.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
      150. Supply.participant:productInstance.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
      152. Supply.participant:productInstance.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
      154. Supply.participant:productInstance.typeCode
      Control1..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.
      Pattern ValueDEV
      156. Supply.participant:productInstance.contextControlCode
      Control0..1
      BindingThe codes SHALL be taken from CDAContextControl
      (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
      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 ValueOP
      158. Supply.participant:productInstance.sdtcFunctionCode
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namefunctionCode.
      160. Supply.participant:productInstance.time
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
      162. Supply.participant:productInstance.awarenessCode
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      164. Supply.participant:productInstance.participantRole
      Comments

      SHALL contain exactly one [1..1] Product Instance (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.37) (CONF:1098-32095).

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole(Product Instance)
      166. Supply.entryRelationship
      ShortThe following entryRelationship represents the insurance coverage the patient may have for the supply.
      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
      SlicingThis element introduces a set of slices on Supply.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • profile @ act
      • profile @ observation
      • 168. Supply.entryRelationship:priorityPreference
        Slice NamepriorityPreference
        ShortThe following entryRelationship represents the priority that a patient or a provider places on the supply.
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        170. Supply.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
        172. Supply.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
        174. Supply.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())
        176. Supply.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
        178. Supply.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
        180. Supply.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
        182. Supply.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
        184. Supply.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
        186. Supply.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
        188. Supply.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-31111).

        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
        190. Supply.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.
        192. Supply.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
        194. Supply.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.
        196. Supply.entryRelationship:priorityPreference.sequenceNumber
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
        198. Supply.entryRelationship:priorityPreference.seperatableInd
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
        200. Supply.entryRelationship:priorityPreference.act
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
        202. Supply.entryRelationship:priorityPreference.encounter
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
        204. Supply.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-31112).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
        206. Supply.entryRelationship:priorityPreference.observationMedia
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
        208. Supply.entryRelationship:priorityPreference.organizer
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
        210. Supply.entryRelationship:priorityPreference.procedure
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
        212. Supply.entryRelationship:priorityPreference.regionOfInterest
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
        214. Supply.entryRelationship:priorityPreference.substanceAdministration
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
        216. Supply.entryRelationship:priorityPreference.supply
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
        218. Supply.entryRelationship:indication
        Slice Nameindication
        ShortThe following entryRelationship represents the indication for the supply.
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        220. Supply.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
        222. Supply.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
        224. Supply.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())
        226. Supply.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
        228. Supply.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
        230. Supply.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
        232. Supply.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
        234. Supply.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
        236. Supply.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
        238. Supply.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-32055).

        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
        240. Supply.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.
        242. Supply.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
        244. Supply.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.
        246. Supply.entryRelationship:indication.sequenceNumber
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
        248. Supply.entryRelationship:indication.seperatableInd
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
        250. Supply.entryRelationship:indication.act
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
        252. Supply.entryRelationship:indication.encounter
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
        254. Supply.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-32056).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
        256. Supply.entryRelationship:indication.observationMedia
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
        258. Supply.entryRelationship:indication.organizer
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
        260. Supply.entryRelationship:indication.procedure
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
        262. Supply.entryRelationship:indication.regionOfInterest
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
        264. Supply.entryRelationship:indication.substanceAdministration
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
        266. Supply.entryRelationship:indication.supply
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
        268. Supply.entryRelationship:instruction
        Slice Nameinstruction
        ShortThe following entryRelationship captures any instructions associated with the planned supply.
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        270. Supply.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
        272. Supply.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
        274. Supply.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())
        276. Supply.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
        278. Supply.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
        280. Supply.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
        282. Supply.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
        284. Supply.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
        286. Supply.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
        288. Supply.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-32058).

        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
        290. Supply.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.
        292. Supply.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
        294. Supply.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.
        296. Supply.entryRelationship:instruction.sequenceNumber
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
        298. Supply.entryRelationship:instruction.seperatableInd
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
        300. Supply.entryRelationship:instruction.act
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
        302. Supply.entryRelationship:instruction.encounter
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
        304. Supply.entryRelationship:instruction.observation
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Instruction Observation)
        306. Supply.entryRelationship:instruction.observationMedia
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
        308. Supply.entryRelationship:instruction.organizer
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
        310. Supply.entryRelationship:instruction.procedure
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
        312. Supply.entryRelationship:instruction.regionOfInterest
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
        314. Supply.entryRelationship:instruction.substanceAdministration
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
        316. Supply.entryRelationship:instruction.supply
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
        318. Supply.entryRelationship:plannedCoverage
        Slice NameplannedCoverage
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        320. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.typeCode
        Comments

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

        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 ValueCOMP
        340. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.sequenceNumber
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
        348. Supply.entryRelationship:plannedCoverage.seperatableInd
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
        350. Supply.entryRelationship:plannedCoverage.act
        Comments

        SHALL contain exactly one [1..1] Planned Coverage (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.129) (CONF:1098-32062).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Planned Coverage)
        352. Supply.entryRelationship:plannedCoverage.encounter
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
        354. Supply.entryRelationship:plannedCoverage.observation
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
        356. Supply.entryRelationship:plannedCoverage.observationMedia
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
        358. Supply.entryRelationship:plannedCoverage.organizer
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
        360. Supply.entryRelationship:plannedCoverage.procedure
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
        362. Supply.entryRelationship:plannedCoverage.regionOfInterest
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
        364. Supply.entryRelationship:plannedCoverage.substanceAdministration
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
        366. Supply.entryRelationship:plannedCoverage.supply
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
        368. Supply.reference
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
        370. Supply.precondition
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
        372. Supply.sdtcInFulfillmentOf1
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.

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

        0. Supply
        Logical ContainerClinicalDocument (CDA Class)
        ValidationInstance of this type are validated by templateId
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
        Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
        should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
        shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') ((product | participant.where(typeCode='DEV')).count() = 1)
        should-author: SHOULD contain author (author.exists())
        2. Supply.templateId
        Control1..?
        SlicingThis element introduces a set of slices on Supply.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ root
        • value @ extension
        • 4. Supply.templateId:planned-supply
          Slice Nameplanned-supply
          Control1..1
          6. Supply.templateId:planned-supply.root
          Control1..?
          Pattern Value2.16.840.1.113883.10.20.22.4.43
          8. Supply.templateId:planned-supply.extension
          Control1..?
          Pattern Value2024-05-01
          10. Supply.classCode
          Comments

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

          12. Supply.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-8578).

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

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

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

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

          Control1..?
          22. Supply.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-32047).

          Control1..?
          Fixed Valueactive
          24. Supply.effectiveTime
          ShortThe effectiveTime in a planned supply represents the time that the supply should occur.
          Comments

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

          Control0..1
          26. Supply.repeatNumber
          ShortIn a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4.
          Comments

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

          28. Supply.quantity
          Comments

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

          30. Supply.product
          ShortRepresents either a medication or an immunization supply
          32. Supply.product.manufacturedProduct
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
          34. Supply.performer
          ShortThe clinician who is expected to perform the supply could be identified using supply/performer.
          Comments

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

          36. Supply.author
          ShortThe author in a supply represents the clinician who is requesting or planning the supply.
          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-31129).

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
          38. Supply.participant
          ShortThis participant represents a device that is ordered, requested or intended for the patient.
          SlicingThis element introduces a set of slices on Supply.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ typeCode
          • 40. Supply.participant:productInstance
            Slice NameproductInstance
            Comments

            MAY contain zero or one [0..1] participant (CONF:1098-32094) such that it

            Control0..1
            42. Supply.participant:productInstance.typeCode
            Pattern ValueDEV
            44. Supply.participant:productInstance.participantRole
            Comments

            SHALL contain exactly one [1..1] Product Instance (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.37) (CONF:1098-32095).

            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole(Product Instance)
            46. Supply.entryRelationship
            ShortThe following entryRelationship represents the insurance coverage the patient may have for the supply.
            SlicingThis element introduces a set of slices on Supply.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • profile @ act
            • profile @ observation
            • 48. Supply.entryRelationship:priorityPreference
              Slice NamepriorityPreference
              ShortThe following entryRelationship represents the priority that a patient or a provider places on the supply.
              Comments

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

              Control0..*
              50. Supply.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-31111).

              Fixed ValueREFR
              52. Supply.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-31112).

              Control1..?
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
              54. Supply.entryRelationship:indication
              Slice Nameindication
              ShortThe following entryRelationship represents the indication for the supply.
              Comments

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

              Control0..*
              56. Supply.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-32055).

              Fixed ValueRSON
              58. Supply.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-32056).

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

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

              Control0..*
              62. Supply.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-32058).

              Fixed ValueSUBJ
              64. Supply.entryRelationship:instruction.observation
              Control1..?
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Instruction Observation)
              66. Supply.entryRelationship:plannedCoverage
              Slice NameplannedCoverage
              Comments

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

              Control0..*
              68. Supply.entryRelationship:plannedCoverage.typeCode
              Comments

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

              Fixed ValueCOMP
              70. Supply.entryRelationship:plannedCoverage.act
              Comments

              SHALL contain exactly one [1..1] Planned Coverage (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.129) (CONF:1098-32062).

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

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

              0. Supply
              Definition

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

              ShortBase for all types and resources
              Control1..1
              Is Modifierfalse
              Logical ContainerClinicalDocument (CDA Class)
              ValidationInstance of this type are validated by templateId
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
              shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') ((product | participant.where(typeCode='DEV')).count() = 1)
              should-author: SHOULD contain author (author.exists())
              2. Supply.nullFlavor
              Definition

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

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

              When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
              6. Supply.typeId
              Definition

              When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              8. Supply.typeId.nullFlavor
              Definition

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

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

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

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

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

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

              Identifies the type as an HL7 Registered model

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

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

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

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              SlicingThis element introduces a set of slices on Supply.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ root
              • value @ extension
              • 20. Supply.templateId:planned-supply
                Slice Nameplanned-supply
                Definition

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

                Control1..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                22. Supply.templateId:planned-supply.nullFlavor
                Definition

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

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

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

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

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

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

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

                Control1..1
                BindingThe codes SHALL be taken from ActClassSupply
                (required to http://terminology.hl7.org/ValueSet/v3-ActClassSupply)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                Default ValueSPLY
                Fixed ValueSPLY
                34. Supply.moodCode
                Comments

                SHALL contain exactly one [1..1] @moodCode, 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-8578).

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

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

                Control1..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                38. Supply.code
                Control0..1
                BindingFor example codes, see v3 Code System ActCode
                (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                40. Supply.text
                ShortSHOULD reference the portion of section narrative text corresponding to this entry
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                42. Supply.text.nullFlavor
                Definition

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                LabelThumbnail
                62. Supply.statusCode
                Comments

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

                Control1..1
                BindingThe codes SHALL be taken from ActStatus
                (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
                64. Supply.statusCode.nullFlavor
                Definition

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

                Control0..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
                66. Supply.statusCode.code
                Definition

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

                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-32047).

                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
                68. Supply.statusCode.codeSystem
                Definition

                Specifies the code system that defines the code.

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

                The common name of the coding system.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                Control0..0
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                XML FormatThe type of this property is determined using the xsi:typeattribute.
                LabelTranslation
                86. Supply.effectiveTime
                ShortThe effectiveTime in a planned supply represents the time that the supply should occur.
                Comments

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

                Control0..1
                TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
                Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
                XML FormatThe type of this property is determined using the xsi:typeattribute.
                88. Supply.priorityCode
                Control0..*
                BindingFor example codes, see ActPriority
                (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                90. Supply.repeatNumber
                ShortIn a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4.
                Comments

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

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

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

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
                96. Supply.expectedUseTime
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
                98. Supply.product
                ShortRepresents either a medication or an immunization supply
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
                100. Supply.product.nullFlavor
                Definition

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

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

                When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
                104. Supply.product.typeId
                Definition

                When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
                106. Supply.product.typeId.nullFlavor
                Definition

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

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

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

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

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

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

                Identifies the type as an HL7 Registered model

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

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

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

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

                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                118. Supply.product.typeCode
                Control0..1
                BindingThe codes SHALL be taken from ParticipationTargetDirect
                (required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                Fixed ValuePRD
                120. Supply.product.manufacturedProduct
                Shorticon Removed:Base for all types and resources
                Control1..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
                122. Supply.subject
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
                124. Supply.specimen
                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
                126. Supply.performer
                ShortThe clinician who is expected to perform the supply could be identified using supply/performer.
                Comments

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

                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
                128. Supply.author
                ShortThe author in a supply represents the clinician who is requesting or planning the supply.
                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-31129).

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
                130. Supply.informant
                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
                132. Supply.participant
                ShortThis participant represents a device that is ordered, requested or intended for the patient.
                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
                SlicingThis element introduces a set of slices on Supply.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ typeCode
                • 134. Supply.participant:productInstance
                  Slice NameproductInstance
                  Comments

                  MAY contain zero or one [0..1] participant (CONF:1098-32094) such that it

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
                  136. Supply.participant:productInstance.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
                  138. Supply.participant:productInstance.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
                  140. Supply.participant:productInstance.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())
                  142. Supply.participant:productInstance.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
                  144. Supply.participant:productInstance.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
                  146. Supply.participant:productInstance.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
                  148. Supply.participant:productInstance.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
                  150. Supply.participant:productInstance.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
                  152. Supply.participant:productInstance.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
                  154. Supply.participant:productInstance.typeCode
                  Control1..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.
                  Pattern ValueDEV
                  156. Supply.participant:productInstance.contextControlCode
                  Control0..1
                  BindingThe codes SHALL be taken from CDAContextControl
                  (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
                  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 ValueOP
                  158. Supply.participant:productInstance.sdtcFunctionCode
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                  XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namefunctionCode.
                  160. Supply.participant:productInstance.time
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
                  162. Supply.participant:productInstance.awarenessCode
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                  164. Supply.participant:productInstance.participantRole
                  Comments

                  SHALL contain exactly one [1..1] Product Instance (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.37) (CONF:1098-32095).

                  Control1..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole(Product Instance)
                  166. Supply.entryRelationship
                  ShortThe following entryRelationship represents the insurance coverage the patient may have for the supply.
                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                  SlicingThis element introduces a set of slices on Supply.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • profile @ act
                  • profile @ observation
                  • 168. Supply.entryRelationship:priorityPreference
                    Slice NamepriorityPreference
                    ShortThe following entryRelationship represents the priority that a patient or a provider places on the supply.
                    Comments

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

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                    170. Supply.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
                    172. Supply.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
                    174. Supply.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())
                    176. Supply.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
                    178. Supply.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
                    180. Supply.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
                    182. Supply.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
                    184. Supply.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
                    186. Supply.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
                    188. Supply.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-31111).

                    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
                    190. Supply.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.
                    192. Supply.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
                    194. Supply.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.
                    196. Supply.entryRelationship:priorityPreference.sequenceNumber
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                    198. Supply.entryRelationship:priorityPreference.seperatableInd
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                    200. Supply.entryRelationship:priorityPreference.act
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
                    202. Supply.entryRelationship:priorityPreference.encounter
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                    204. Supply.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-31112).

                    Control1..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
                    206. Supply.entryRelationship:priorityPreference.observationMedia
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                    208. Supply.entryRelationship:priorityPreference.organizer
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                    210. Supply.entryRelationship:priorityPreference.procedure
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                    212. Supply.entryRelationship:priorityPreference.regionOfInterest
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                    214. Supply.entryRelationship:priorityPreference.substanceAdministration
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                    216. Supply.entryRelationship:priorityPreference.supply
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                    218. Supply.entryRelationship:indication
                    Slice Nameindication
                    ShortThe following entryRelationship represents the indication for the supply.
                    Comments

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

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                    220. Supply.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
                    222. Supply.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
                    224. Supply.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())
                    226. Supply.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
                    228. Supply.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
                    230. Supply.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
                    232. Supply.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
                    234. Supply.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
                    236. Supply.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
                    238. Supply.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-32055).

                    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
                    240. Supply.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.
                    242. Supply.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
                    244. Supply.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.
                    246. Supply.entryRelationship:indication.sequenceNumber
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                    248. Supply.entryRelationship:indication.seperatableInd
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                    250. Supply.entryRelationship:indication.act
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
                    252. Supply.entryRelationship:indication.encounter
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                    254. Supply.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-32056).

                    Control1..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
                    256. Supply.entryRelationship:indication.observationMedia
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                    258. Supply.entryRelationship:indication.organizer
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                    260. Supply.entryRelationship:indication.procedure
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                    262. Supply.entryRelationship:indication.regionOfInterest
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                    264. Supply.entryRelationship:indication.substanceAdministration
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                    266. Supply.entryRelationship:indication.supply
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                    268. Supply.entryRelationship:instruction
                    Slice Nameinstruction
                    ShortThe following entryRelationship captures any instructions associated with the planned supply.
                    Comments

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

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                    270. Supply.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
                    272. Supply.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
                    274. Supply.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())
                    276. Supply.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
                    278. Supply.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
                    280. Supply.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
                    282. Supply.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
                    284. Supply.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
                    286. Supply.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
                    288. Supply.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-32058).

                    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
                    290. Supply.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.
                    292. Supply.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
                    294. Supply.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.
                    296. Supply.entryRelationship:instruction.sequenceNumber
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                    298. Supply.entryRelationship:instruction.seperatableInd
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                    300. Supply.entryRelationship:instruction.act
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
                    302. Supply.entryRelationship:instruction.encounter
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                    304. Supply.entryRelationship:instruction.observation
                    Control1..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Instruction Observation)
                    306. Supply.entryRelationship:instruction.observationMedia
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                    308. Supply.entryRelationship:instruction.organizer
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                    310. Supply.entryRelationship:instruction.procedure
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                    312. Supply.entryRelationship:instruction.regionOfInterest
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                    314. Supply.entryRelationship:instruction.substanceAdministration
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                    316. Supply.entryRelationship:instruction.supply
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                    318. Supply.entryRelationship:plannedCoverage
                    Slice NameplannedCoverage
                    Comments

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

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                    320. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.typeCode
                    Comments

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

                    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 ValueCOMP
                    340. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.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. Supply.entryRelationship:plannedCoverage.sequenceNumber
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                    348. Supply.entryRelationship:plannedCoverage.seperatableInd
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                    350. Supply.entryRelationship:plannedCoverage.act
                    Comments

                    SHALL contain exactly one [1..1] Planned Coverage (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.129) (CONF:1098-32062).

                    Control1..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Planned Coverage)
                    352. Supply.entryRelationship:plannedCoverage.encounter
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                    354. Supply.entryRelationship:plannedCoverage.observation
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
                    356. Supply.entryRelationship:plannedCoverage.observationMedia
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                    358. Supply.entryRelationship:plannedCoverage.organizer
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                    360. Supply.entryRelationship:plannedCoverage.procedure
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                    362. Supply.entryRelationship:plannedCoverage.regionOfInterest
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                    364. Supply.entryRelationship:plannedCoverage.substanceAdministration
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                    366. Supply.entryRelationship:plannedCoverage.supply
                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                    368. Supply.reference
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
                    370. Supply.precondition
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
                    372. Supply.sdtcInFulfillmentOf1
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
                    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.