Id2.16.840.1.113883.3.1937.99.61.26.10.124Effective Date2019‑04‑29 09:02:35
Statusdraft DraftVersion Label2.1
NamePlannedImmunizationActivityDisplay NamePlanned Immunization Activity
Description
This template represents planned immunizations. Planned Immunization Activity is very similar to Planned Medication Activity with some key differences, for example, the drug code system is constrained to CVX codes. The priority of the immunization activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the immunization activity is intended to take place and authorTime indicates when the documentation of the plan occurred.
ContextParent nodes of template element with id 2.16.840.1.113883.3.1937.99.61.26.10.124
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 0 templates, Uses 6 templates
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.25Containmentdraft Precondition for Substance Administration (V2) (2.1)2014‑06‑09
2.16.840.1.113883.10.20.22.4.54Containmentdraft Immunization Medication Information (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.20.22.4.120 Planned Immunization Activity (2015‑08‑13)
ref
ccda-

Specialization: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-
ItemDTCardConfDescriptionLabel
cda:substanceAdministration
Plandotsvity
@classCode
cs1 … 1FSBADMCONFdots2091
 SHALL contain exactly one [1..1] @classCode="SBADM" (CONF:1098-32091).
@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 2014-09-01 (CONF:1098-32097).CONFdots2097
 CONF
The value of @moodCode shall be drawn from value set 2.16.840.1.113883.11.20.9.24 Planned moodCode (SubstanceAdministration/Supply) (2014‑09‑01)
hl7:templateId
II1 … 1MPlandotsvity
@root
uid1 … 1F2.16.840.1.113883.3.1937.99.61.26.10.124
cda:templateId
II1 … 1MSHALL contain exactly one [1..1] templateId (CONF:1098-32098) such that itCONFdots2098
@root
uid1 … 1F2.16.840.1.113883.10.20.22.4.120CONFdots2099
 SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.120" (CONF:1098-32099).
cda:id
II1 … *SHALL contain at least one [1..*] id (CONF:1098-32100).CONFdots2100
cda:statusCode
CS1 … 1MSHALL contain exactly one [1..1] statusCode (CONF:1098-32101).CONFdots2101
@code
CONF1 … 1Factive
cda:effectiveTime
1 … 1SHALL contain exactly one [1..1] effectiveTime (CONF:1098-32103).

The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.

CONFdots2103
cda:repeatNumber
0 … 1MAY contain zero or one [0..1] repeatNumber (CONF:1098-32126).

In a Planned Immunization 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.

CONFdots2126
cda:routeCode
0 … 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-32127).CONFdots2127
 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)
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-32128).CONFdots2128
 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-32129).CONFdots2129
@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-32130).CONFdots2130
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.1.11.12839 UnitsOfMeasureCaseSensitive (DYNAMIC)
cda:consumable
1 … 1MContains 2.16.840.1.113883.10.20.22.4.54 Immunization Medication Information (V2) (2014‑06‑09)CONFdots2131
cda:performer
0 … *MAY contain zero or more [0..*] performer (CONF:1098-32104).

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

CONFdots2104
cda:author
0 … *MAY contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32105).

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


Contains 2.16.840.1.113883.10.20.22.4.119 Author Participation (2015‑08‑13)		CONFdots2105
cda:entryRelationship
0 … *The following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
Contains 2.16.840.1.113883.10.20.22.4.143 Priority Preference (2015‑08‑13)		CONFdots2108
@typeCode
cs1 … 1FREFRCONFdots2109
 SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32109).
cda:entryRelationship
0 … *The following entryRelationship represents the indication for the immunization activity.
Contains 2.16.840.1.113883.10.20.22.4.19 Indication (V2) (2014‑06‑09)		CONFdots2114
@typeCode
cs1 … 1FRSONCONFdots2115
 SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32115).
cda:entryRelationship
0 … *The following entryRelationship captures any instructions associated with the planned immunization activity.
Contains 2.16.840.1.113883.10.20.22.4.20 Instruction (V2) (2014‑06‑09)		CONFdots2117
@typeCode
cs1 … 1FSUBJCONFdots2118
 SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32118).
cda:precondition
0 … *Contains 2.16.840.1.113883.10.20.22.4.25 Precondition for Substance Administration (V2) (2014‑06‑09)CONFdots2123
@typeCode
cs1 … 1FPRCNCONFdots2124
 SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32124).