Back To Index  <<  Back To Templates

pending Template  Planned Immunization Activity

Id 2.16.840.1.113883.10.20.22.4.120
ref
ccda-
 		Effective Date 2015‑08‑13
Status pending Under pre-publication review Version Label 2.1
Name PlannedImmunizationActivity Display Name Planned 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.
Context Parent nodes of template element with id 2.16.840.1.113883.10.20.22.4.120
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 2 templates, Uses 6 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
Uses as Name Version
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.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.25 Containment pending Precondition for Substance Administration (V2) (2.1) 2014‑06‑09
Relationship Specialization: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-
Item DT Card Conf Description Label
cda:substanceAdministration
(Pladotsity)
treetree @classCode
1 … 1 F SBADM CONFdots2091
  SHALL contain exactly one [1..1] @classCode="SBADM" (CONF:1098-32091).
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 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)
treetree cda:templateId
II 1 … 1 M SHALL contain exactly one [1..1] templateId (CONF:1098-32098) such that it CONFdots2098
treeblank treetree @root
1 … 1 F 2.16.840.1.113883.10.20.22.4.120 CONFdots2099
  SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.120" (CONF:1098-32099).
treetree cda:id
II 1 … * SHALL contain at least one [1..*] id (CONF:1098-32100). CONFdots2100
treetree cda:statusCode
CS 1 … 1 M SHALL contain exactly one [1..1] statusCode (CONF:1098-32101). CONFdots2101
treeblank treetree @code
CONF 1 … 1 F active
treetree cda:effectiveTime
1 … 1 SHALL 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
treetree cda:repeatNumber
0 … 1 MAY 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
treetree cda:routeCode
0 … 1 MAY 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)
treetree cda:approachSiteCode
CD 0 … * 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)
treetree cda:doseQuantity
0 … 1 MAY contain zero or one [0..1] doseQuantity (CONF:1098-32129). CONFdots2129
treeblank treetree @unit
0 … 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)
treetree cda:consumable
1 … 1 M Contains 2.16.840.1.113883.10.20.22.4.54 Immunization Medication Information (V2) (2014‑06‑09) CONFdots2131
treeblank where [cda:manufacturedProduct [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.54'] [@extension = '2014-06-09']]]
treetree 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
treetree 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
treeblank where [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.119']]
treetree 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
treeblank where [cda:observation [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.143']]]
treeblank treetree @typeCode
1 … 1 F REFR CONFdots2109
  SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32109).
treetree 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
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 CONFdots2115
  SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32115).
treetree 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
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 CONFdots2118
  SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32118).
treetree cda:precondition
0 … * Contains 2.16.840.1.113883.10.20.22.4.25 Precondition for Substance Administration (V2) (2014‑06‑09) CONFdots2123
treeblank where [cda:criterion [cda:templateId [@root = '2.16.840.1.113883.10.20.22.4.25'] [@extension = '2014-06-09']]]
treeblank treetree @typeCode
1 … 1 F PRCN CONFdots2124
  SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32124).