Template

Show index

Template Planned Medication Activity (V2) 2014‑06‑09

Id2.16.840.1.113883.10.20.22.4.42Effective Date2014‑06‑09
Statusdraft DraftVersion Label2.1
NamePlannedMedicationActivityV2Display NamePlanned Medication Activity (V2)
Description
This template represents planned medication activities. The priority of the medication activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the medication activity is intended to take place. The authorTime indicates when the documentation of the plan occurred.
ContextParent nodes of template element with id 2.16.840.1.113883.10.20.22.4.42
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 10 transactions and 19 templates, Uses 6 templates
Used by as NameVersion
2.16.840.1.113883.3.1937.99.3.4.27Transactionfinal Operative Note (V3)2015‑08‑01
2.16.840.1.113883.3.1937.99.3.4.31Transactionfinal Transfer Summary (V2)2015‑08‑01
2.16.840.1.113883.3.1937.99.3.4.25Transactionfinal Discharge Summary (V3)2015‑08‑01
2.16.840.1.113883.3.1937.99.3.4.29Transactionfinal Progress Note (V3)2015‑08‑01
2.16.840.1.113883.3.1937.99.3.4.26Transactionfinal History and Physical (V3)2015‑08‑01
2.16.840.1.113883.3.1937.99.3.4.22Transactionfinal Consultation Note (V3)2015‑08‑01
2.16.840.1.113883.3.1937.99.3.4.28Transactionfinal Procedure Note (V3)2015‑08‑01
2.16.840.1.113883.3.1937.99.3.4.23Transactionfinal Continuity of Care Document (CCD) (V3)2015‑08‑01
2.16.840.1.113883.3.1937.99.3.4.30Transactionfinal Referral Note (V2)2015‑08‑01
2.16.840.1.113883.3.1937.99.3.4.21Transactionfinal Care Plan (V2)2015‑08‑01
2.16.840.1.113883.3.1937.99.61.8.10.3.2Containmentdraft Plan of Care Section2014‑02‑04 13:11:29
2.16.840.1.113883.3.1937.99.61.21.10.20Containmentdraft NH MI (fake) Recommendation (2.1)2019‑07‑25 23:56:49
2.16.840.1.113883.3.1937.99.61.26.10.122Containmentdraft Nutrition Recommendation (2.1)2019‑04‑29 09:01:33
2.16.840.1.113883.10.20.21.2.3linkdraft Interventions Section (V3) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.2linkdraft Continuity of Care Document (CCD) (V3) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.3linkdraft History and Physical (V3) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.4linkdraft Consultation Note (V3) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.6linkdraft Procedure Note (V3) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.7linkdraft Operative Note (V3) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.8linkdraft Discharge Summary (V3) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.9linkdraft Progress Note (V3) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.13linkdraft Transfer Summary (V2) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.14linkdraft Referral Note (V2) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.15linkdraft Care Plan (V2) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.2.10linkdraft Plan of Treatment Section (V2) (2.1)2014‑06‑09
2.16.840.1.113883.10.20.22.2.10Containmentdraft Plan of Treatment Section (V2) (2.1)2019‑03‑16 08:54:08
2.16.840.1.113883.10.20.22.4.130Containmentdraft Nutrition Recommendation (2.1)2015‑08‑13
2.16.840.1.113883.10.20.22.4.131linkdraft Intervention Act (V2) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.4.146Containmentdraft Planned Intervention Act (V2) (2.1)2015‑08‑01
Uses as NameVersion
2.16.840.1.113883.10.20.22.4.19Containmentdraft Indication (V2) (2.1)2014‑06‑09
2.16.840.1.113883.10.20.22.4.20Containmentdraft Instruction (V2) (2.1)2014‑06‑09
2.16.840.1.113883.10.20.22.4.23Containmentdraft Medication Information (V2) (2.1)2014‑06‑09
2.16.840.1.113883.10.20.22.4.25Containmentdraft Precondition for Substance Administration (V2) (2.1)2014‑06‑09
2.16.840.1.113883.10.20.22.4.119Containmentdraft Author Participation (2.1)2015‑08‑13
2.16.840.1.113883.10.20.22.4.143Containmentdraft Priority Preference (2.1)2015‑08‑13
RelationshipSpecialization: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-

Version: template 2.16.840.1.113883.10.20.22.4.42 Plan of Care Activity Substance Administration (2013‑01‑31)
ItemDTCardConfDescriptionLabel
cda:substanceAdministration
PlandotstyV2
@classCode
cs1 … 1FSBADMCONFdots8572
 SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8572).
@moodCode
cs1 … 1RSHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8573).CONFdots8573
 CONF
The value of @moodCode shall be drawn from value set 2.16.840.1.113883.11.20.9.24 Plan of Care moodCode (SubstanceAdministration/Supply) (DYNAMIC)
cda:templateId
II1 … 1MC-CDA R1.1 templateId root without an extensionCONFdots2936
@root
uid1 … 1F2.16.840.1.113883.10.20.22.4.42
cda:templateId
II1 … 1MSHALL contain exactly one [1..1] templateId (CONF:1098-30465) such that itCONFdots0465
@root
uid1 … 1F2.16.840.1.113883.10.20.22.4.42CONFdots0466
 SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.42" (CONF:1098-30466).
@extension
st1 … 1F2014-06-09CONFdots2557
 SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32557).
cda:id
II1 … *SHALL contain at least one [1..*] id (CONF:1098-8575).CONFdots8575
cda:statusCode
CS1 … 1MSHALL contain exactly one [1..1] statusCode (CONF:1098-32087).CONFdots2087
@code
CONF1 … 1Factive
Choice1 … 
Note: This effectiveTime represents either the medication duration (i.e., the time the medication should be started and stopped) or the timestamp when the single-administration should occur.
Elements to choose from:
  • cda:effectiveTime[@value]
  • cda:effectiveTime[cda:low]
cda:effectiveTime
TS0 … 1CCONFdots0468
where [@value]
@value
1 … 1RSHOULD contain exactly one [1..1] @value; Note: indicates a single-administration timestampCONFdots2944
cda:effectiveTime
IVL_TS0 … 1CCONFdots0468
where [cda:low]
cda:low
TS1 … 1RSHOULD contain exactly one [1..1] low; Note: indicates when medication startedCONFdots2948
cda:high
TS0 … 1MAY contain zero or one [0..1] high; Note: indicates when medication stoppedCONFdots2949
cda:effectiveTime
1 … 1SHOULD contain exactly one [1..1] effectiveTimeCONFdots2943
where [@xsi:type='PIVL_TS' or @xsi:type='EIVL_TS']
@operator
cs1 … 1FACONFdots2943
 SHALL contain exactly one [1..1] @operator="A" (CONF:1098-32945).
@xsi:type
cs1 … 1R SHALL contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-32946).CONFdots2943
 CONF
@xsi:type shall be "PIVL_TS"
or
@xsi:type shall be "EIVL_TS"
cda:repeatNumber
0 … 1MAY contain zero or one [0..1] repeatNumber (CONF:1098-32066).

In a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.

CONFdots2066
cda:routeCode
CD0 … 1MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet Medication Route FDA urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32067).CONFdots2067
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.3221.8.7 Medication Route FDA (DYNAMIC)
hl7:translation
CD0 … *The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHALL be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952).
CONFdots2952
 CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.1 Medication Route (DYNAMIC)
cda:approachSiteCode
CD0 … *MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32078).CONFdots2078
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.3221.8.9 Body Site (DYNAMIC)
cda:doseQuantity
0 … 1MAY contain zero or one [0..1] doseQuantity (CONF:1098-32068).CONFdots2068
@unit
cs0 … 1 The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32133).CONFdots2133
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.1.11.12839 UnitsOfMeasureCaseSensitive (DYNAMIC)
cda:rateQuantity
0 … 1MAY contain zero or one [0..1] rateQuantity (CONF:1098-32079).CONFdots2079
@unit
cs0 … 1 The rateQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32134).CONFdots2134
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.1.11.12839 UnitsOfMeasureCaseSensitive (DYNAMIC)
cda:maxDoseQuantity
0 … 1MAY contain zero or one [0..1] maxDoseQuantity (CONF:1098-32080).CONFdots2080
cda:administrationUnitCode
CE0 … 1MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1098-32081).CONFdots2081
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113762.1.4.1021.30 Administration Unit Dose Form (DYNAMIC)
cda:consumable
1 … 1Contains 2.16.840.1.113883.10.20.22.4.23 Medication Information (V2) (2014‑06‑09)CONFdots2082
cda:performer
0 … *MAY contain zero or more [0..*] performer (CONF:1098-30470).

The clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer.

CONFdots0470
cda:author
0 … 1RSHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32046).

The author in a planned medication activity represents the clinician who is requesting or planning the medication activity.


Contains 2.16.840.1.113883.10.20.22.4.119 Author Participation (2015‑08‑13)		CONFdots2046
cda:entryRelationship
0 … *The following entryRelationship represents the priority that a patient or a provider places on the planned medication activity.
Contains 2.16.840.1.113883.10.20.22.4.143 Priority Preference (2015‑08‑13)		CONFdots1104
@typeCode
cs1 … 1FREFRCONFdots1105
 SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31105).
cda:entryRelationship
0 … *The following entryRelationship represents the indication for the planned medication activity.
Contains 2.16.840.1.113883.10.20.22.4.19 Indication (V2) (2014‑06‑09)		CONFdots2069
@typeCode
cs1 … 1FRSONCONFdots2070
 SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32070).
cda:entryRelationship
0 … *The following entryRelationship captures any instructions associated with the planned medication activity.
Contains 2.16.840.1.113883.10.20.22.4.20 Instruction (V2) (2014‑06‑09)		CONFdots2072
@typeCode
cs1 … 1FSUBJCONFdots2073
 SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32073).
cda:precondition
0 … *Contains 2.16.840.1.113883.10.20.22.4.25 Precondition for Substance Administration (V2) (2014‑06‑09)CONFdots2084
@typeCode
cs1 … 1FPRCNCONFdots2085
 The precondition, if present, SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32085).