Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: PlannedSupply - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the PlannedSupply logical model.

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

0. Supply
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. 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).

4. 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)
6. Supply.templateId
Control1..?
SlicingThis element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
8. Supply.templateId:primary
Slice Nameprimary
Comments

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

Control1..1
10. Supply.templateId:primary.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.43" (CONF:1098-30464).

Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.43
12. Supply.templateId:primary.extension
Comments

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32556).

Control1..?
Pattern Value2014-06-09
14. Supply.id
Comments

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

Control1..?
16. Supply.statusCode
Comments

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

Control1..?
18. 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
20. 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
22. 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).

24. Supply.quantity
Comments

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

26. Supply.product
ShortA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
Comments

MAY contain zero or one [0..1] product (CONF:1098-32049 and CONF:1098-32051 and CONF:1098-32325).

Invariants1098-32325: SHOULD contain zero or one [0..1] product (CONF:1098-32325). ()
1098-32092: If the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093). ()
28. Supply.product.manufacturedProduct
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
30. 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).

32. 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)
34. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ participantRole
36. Supply.participant:productInstance
Slice NameproductInstance
Comments

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

Control0..1
Invariants1098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). ()
38. 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)
40. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ act
  • profile @ observation
42. 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..*
44. 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
46. 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)
48. 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..*
50. 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
52. 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)
54. 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..*
56. 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
58. Supply.entryRelationship:instruction.act
Comments

SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32059).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
60. Supply.entryRelationship:plannedCoverage
Slice NameplannedCoverage
Comments

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

Control0..*
62. 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
64. 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 found here

0. Supply
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. 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
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
4. 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)
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.
6. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
8. Supply.templateId:primary
Slice Nameprimary
Definition

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

Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Supply.templateId:primary.root
Definition

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.43" (CONF:1098-30464).

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
12. Supply.templateId:primary.extension
Definition

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

Comments

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32556).

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

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
16. Supply.statusCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
18. 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
20. 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
22. 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
24. 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
26. 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
28. 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
30. 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
32. 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
34. 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.
36. 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
38. Supply.quantity
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
40. Supply.product
ShortA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
Comments

MAY contain zero or one [0..1] product (CONF:1098-32049 and CONF:1098-32051 and CONF:1098-32325).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1098-32325: SHOULD contain zero or one [0..1] product (CONF:1098-32325). ()
1098-32092: If the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093). ()
42. Supply.product.manufacturedProduct
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. 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
46. Supply.author
Definition

Base definition for all types defined in FHIR type system.

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)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ participantRole
50. 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
Invariants1098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). ()
52. Supply.participant:productInstance.participantRole
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
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)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ act
  • profile @ observation
56. 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
58. 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
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
60. Supply.entryRelationship:priorityPreference.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
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)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. 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
64. 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
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
66. Supply.entryRelationship:indication.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
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)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. 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
70. 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
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
72. Supply.entryRelationship:instruction.act
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32059).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. 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
76. 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
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
78. Supply.entryRelationship:plannedCoverage.act
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
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)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. Supply
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. 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
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
4. 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)
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.
6. Supply.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
8. Supply.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
12. Supply.templateId:primary
Slice Nameprimary
Definition

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

Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
14. Supply.templateId:primary.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
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
16. Supply.templateId:primary.assigningAuthorityName
Definition

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

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

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

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

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.43" (CONF:1098-30464).

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
22. Supply.templateId:primary.extension
Definition

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

Comments

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32556).

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

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. Supply.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
28. Supply.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
30. Supply.statusCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
32. 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 NullFlavor
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
34. 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
36. 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
38. 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
40. 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
42. 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
44. 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.
46. 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.
48. 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
50. 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
52. 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
54. 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.
56. Supply.priorityCode
Control0..*
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
58. 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
60. Supply.independentInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
62. Supply.quantity
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
64. Supply.expectedUseTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
66. Supply.product
ShortA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
Comments

MAY contain zero or one [0..1] product (CONF:1098-32049 and CONF:1098-32051 and CONF:1098-32325).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1098-32325: SHOULD contain zero or one [0..1] product (CONF:1098-32325). ()
1098-32092: If the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093). ()
68. 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 NullFlavor
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
70. 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
72. 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
74. 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
76. Supply.product.typeCode
Control0..1
BindingThe codes SHALL be taken from 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
78. Supply.product.manufacturedProduct
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Supply.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
82. Supply.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
84. 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
86. Supply.author
Definition

Base definition for all types defined in FHIR type system.

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)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Supply.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
90. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ participantRole
92. 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
Invariants1098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). ()
94. 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 NullFlavor
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
96. Supply.participant:productInstance.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
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.
98. Supply.participant:productInstance.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
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
100. 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
102. 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
104. 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
106. 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.
108. Supply.participant:productInstance.time
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
110. Supply.participant:productInstance.awarenessCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
112. Supply.participant:productInstance.participantRole
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
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)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ act
  • profile @ observation
116. 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
118. 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 NullFlavor
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
120. 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
122. 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
124. 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
126. 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
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
128. 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.
130. 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
132. 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.
134. Supply.entryRelationship:priorityPreference.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
136. Supply.entryRelationship:priorityPreference.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
138. Supply.entryRelationship:priorityPreference.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
140. Supply.entryRelationship:priorityPreference.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
142. Supply.entryRelationship:priorityPreference.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
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)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. Supply.entryRelationship:priorityPreference.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
146. Supply.entryRelationship:priorityPreference.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
148. Supply.entryRelationship:priorityPreference.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
150. Supply.entryRelationship:priorityPreference.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
152. Supply.entryRelationship:priorityPreference.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
154. Supply.entryRelationship:priorityPreference.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
156. 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
158. 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 NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
160. Supply.entryRelationship: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
162. 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
164. 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
166. 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
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
168. 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.
170. 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
172. 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.
174. Supply.entryRelationship:indication.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
176. Supply.entryRelationship:indication.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
178. Supply.entryRelationship:indication.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
180. Supply.entryRelationship:indication.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
182. Supply.entryRelationship:indication.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
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)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
184. Supply.entryRelationship:indication.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
186. Supply.entryRelationship:indication.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
188. Supply.entryRelationship:indication.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
190. Supply.entryRelationship:indication.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
192. Supply.entryRelationship:indication.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
194. Supply.entryRelationship:indication.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
196. 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
198. 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 NullFlavor
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
200. 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
202. 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
204. 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
206. 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
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
208. 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.
210. 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
212. 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.
214. Supply.entryRelationship:instruction.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
216. Supply.entryRelationship:instruction.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
218. Supply.entryRelationship:instruction.act
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32059).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
220. Supply.entryRelationship:instruction.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
222. Supply.entryRelationship:instruction.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
224. Supply.entryRelationship:instruction.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
226. Supply.entryRelationship:instruction.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
228. Supply.entryRelationship:instruction.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
230. Supply.entryRelationship:instruction.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
232. Supply.entryRelationship:instruction.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
234. Supply.entryRelationship:instruction.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
236. 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
238. 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 NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
240. 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
242. 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
244. 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
246. 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
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
248. 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.
250. 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
252. 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.
254. Supply.entryRelationship:plannedCoverage.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
256. Supply.entryRelationship:plannedCoverage.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
258. Supply.entryRelationship:plannedCoverage.act
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
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)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
260. Supply.entryRelationship:plannedCoverage.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
262. Supply.entryRelationship:plannedCoverage.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
264. Supply.entryRelationship:plannedCoverage.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
266. Supply.entryRelationship:plannedCoverage.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
268. Supply.entryRelationship:plannedCoverage.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
270. Supply.entryRelationship:plannedCoverage.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
272. Supply.entryRelationship:plannedCoverage.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
274. Supply.entryRelationship:plannedCoverage.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
276. Supply.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
278. Supply.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition