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)