Back To Index  <<  Back To Templates

pending Template  Planned Supply (V2)

Id 2.16.840.1.113883.10.20.22.4.43
ref
ccda-
Effective Date 2014‑06‑09
Status pending Under pre-publication review Version Label 2.1
Name PlannedSupplyV2 Display Name Planned Supply (V2)
Description
This template represents both medicinal and non-medicinal supplies ordered, requested, or intended for the patient (e.g., medication prescription, order for wheelchair). The importance of the supply order or request to the patient and provider may be indicated in the Priority Preference. The effective time indicates the time when the supply is intended to take place and author time indicates when the documentation of the plan occurred. The Planned Supply template may also indicate the potential insurance coverage for the procedure. Depending on the type of supply, the product or participant will be either a Medication Information product (medication), an Immunization Medication Information product (immunization), or a Product Instance participant (device/equipment).
Context Parent nodes of template element with id 2.16.840.1.113883.10.20.22.4.43
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 3 templates, Uses 8 templates
Used by as Name Version
2.16.840.1.113883.10.20.22.2.10 Containment draft Plan of Treatment Section (V2) (2.1) 2019‑03‑16 08:54:08
2.16.840.1.113883.3.51.60.2.4.1 link draft BC CDA ClinicalDocumentDischargeSummary (V3) (2.1) 2019‑03‑19 14:15:51
2.16.840.1.113883.10.20.22.4.130 Containment pending Nutrition Recommendation (2.1) 2015‑08‑13
Uses as Name Version
2.16.840.1.113883.10.20.22.4.23 Containment pending Medication Information (V2) (2.1) 2014‑06‑09
2.16.840.1.113883.10.20.22.4.54 Containment pending Immunization Medication Information (V2) (2.1) 2014‑06‑09
2.16.840.1.113883.10.20.22.4.119 Containment pending Author Participation (2.1) 2015‑08‑13
2.16.840.1.113883.10.20.22.4.37 Containment pending Product Instance (2.1) 2015‑08‑13
2.16.840.1.113883.10.20.22.4.143 Containment pending Priority Preference (2.1) 2015‑08‑13
2.16.840.1.113883.10.20.22.4.19 Containment pending Indication (V2) (2.1) 2014‑06‑09
2.16.840.1.113883.10.20.22.4.20 Containment pending Instruction (V2) (2.1) 2014‑06‑09
2.16.840.1.113883.10.20.22.4.129 Containment pending Planned Coverage (2.1) 2015‑08‑13
Relationship Specialization: template 2.16.840.1.113883.10.12.309 CDA Supply (2005‑09‑07)
ref
ad1bbr-

Version: template 2.16.840.1.113883.10.20.22.4.43 Plan of Care Activity Supply (2013‑01‑31)
ref
ccda-
Item DT Card Conf Description Label
cda:supply
(PladotsyV2)
treetree @classCode
1 … 1 F SPLY CONFdots8577
  SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8577).
treetree @moodCode
1 … 1 R 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). CONFdots8578
  CONF
The value of @moodCode shall be drawn from value set 2.16.840.1.113883.11.20.9.24 Planned moodCode (SubstanceAdministration/Supply) (2011‑09‑30)
treetree cda:templateId
II 1 … 1 M SHALL contain exactly one [1..1] templateId (CONF:1098-30463) such that it CONFdots0463
treeblank treetree @root
1 … 1 F 2.16.840.1.113883.10.20.22.4.43 CONFdots0464
  SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.43" (CONF:1098-30464).
treeblank treetree @extension
1 … 1 F 2014-06-09 CONFdots2556
  SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32556).
treetree cda:id
II 1 … * SHALL contain at least one [1..*] id (CONF:1098-8580). CONFdots8580
treetree cda:statusCode
CS 1 … 1 M SHALL contain exactly one [1..1] statusCode (CONF:1098-30458). CONFdots0458
treeblank treetree @code
CONF 1 … 1 F active
treetree cda:effectiveTime
0 … 1 R SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30459).

The effectiveTime in a planned supply represents the time that the supply should occur.
CONFdots0459
treetree cda:repeatNumber
0 … 1 MAY contain zero or one [0..1] repeatNumber (CONF:1098-32063).

In 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.
CONFdots2063
treetree cda:quantity
0 … 1 MAY contain zero or one [0..1] quantity (CONF:1098-32064). CONFdots2064
treetree cda:product
0 … 1 This product represents medication that is ordered, requested or intended for the patient.
Contains 2.16.840.1.113883.10.20.22.4.23 Medication Information (V2) (2014‑06‑09)
CONFdots2049
treeblank where [cda:manufacturedProduct [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.23'] [@extension = '2014-06-09']]]
  Constraint If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product *SHALL NOT* be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant *SHALL NOT* be Product Instance.
treetree cda:product
0 … 1 This product represents immunization medication that is ordered, requested or intended for the patient.
Contains 2.16.840.1.113883.10.20.22.4.54 Immunization Medication Information (V2) (2014‑06‑09)
CONFdots2051
treeblank where [cda:manufacturedProduct [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.54'] [@extension = '2014-06-09']]]
  Constraint If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product *SHALL NOT* be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant *SHALL NOT* be Product Instance.
treetree cda:product
0 … 1 R SHOULD contain zero or one [0..1] product (CONF:1098-32325).

A product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
CONFdots2325
treetree cda:performer
0 … * MAY contain zero or more [0..*] performer (CONF:1098-32048).

The clinician who is expected to perform the supply could be identified using supply/performer.
CONFdots2048
treetree cda:author
0 … 1 R 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).

The author in a supply represents the clinician who is requesting or planning the supply.
Contains 2.16.840.1.113883.10.20.22.4.119 Author Participation (2015‑08‑13)
CONFdots1129
treeblank where [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.119']]
treetree cda:participant
0 … 1 This participant represents a device that is ordered, requested or intended for the patient.
Contains 2.16.840.1.113883.10.20.22.4.37 Product Instance (2015‑08‑13)
CONFdots2094
treeblank where [cda:participantRole [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.37']]]
  Constraint If the participant is Product Instance then the product *SHALL NOT* be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product *SHALL NOT* be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2).
treetree cda:entryRelationship
0 … * The following entryRelationship represents the priority that a patient or a provider places on the supply.
Contains 2.16.840.1.113883.10.20.22.4.143 Priority Preference (2015‑08‑13)
CONFdots1110
treeblank where [cda:observation [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.143']]]
treeblank treetree @typeCode
1 … 1 F REFR CONFdots1111
  SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31111).
treetree cda:entryRelationship
0 … * The following entryRelationship represents the indication for the supply.
Contains 2.16.840.1.113883.10.20.22.4.19 Indication (V2) (2014‑06‑09)
CONFdots2054
treeblank where [cda:observation [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.19'] [@extension = '2014-06-09']]]
treeblank treetree @typeCode
1 … 1 F RSON CONFdots2055
  SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32055).
treetree cda:entryRelationship
0 … * The following entryRelationship captures any instructions associated with the planned supply.
Contains 2.16.840.1.113883.10.20.22.4.20 Instruction (V2) (2014‑06‑09)
CONFdots2057
treeblank where [cda:act [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.20'] [@extension = '2014-06-09']]]
treeblank treetree @typeCode
1 … 1 F SUBJ CONFdots2058
  SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32058).
treetree cda:entryRelationship
0 … * The following entryRelationship represents the insurance coverage the patient may have for the supply.
Contains 2.16.840.1.113883.10.20.22.4.129 Planned Coverage (2015‑08‑13)
CONFdots2060
treeblank where [cda:act [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.129']]]
treeblank treetree @typeCode
1 … 1 F COMP CONFdots2061
  SHALL contain exactly one [1..1] @typeCode="COMP" Has Component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32061).