Back To Index  <<  Back To Templates

draft Template  XeH Immunization

Id 2.16.840.1.113883.2.51.10.64 Effective Date 2022‑05‑06 09:23:08
Status draft Draft Version Label
Name XeHImmunization Display Name XeH Immunization
Description An Immunization entry describes immunization substance administrations that have actually occurred. 
Context Parent nodes of template element with id 2.16.840.1.113883.2.51.10.64
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 4 templates
Used by as Name Version
2.16.840.1.113883.2.51.10.65 Containment draft XeH Immunizations Section 2022‑05‑06 09:34:10
2.16.840.1.113883.2.51.10.12 link draft XeH Hospital Discharge Report (0.1) 2021‑09‑10 14:49:32
2.16.840.1.113883.2.51.10.13 link draft XeH RD Patient Summary (0.1) 2021‑09‑10 14:50:49
Uses as Name Version
2.16.840.1.113883.10.22.4.16 Containment pending IPS Immunization Medication Information (STU1) DYNAMIC
2.16.840.1.113883.10.12.323 Containment active CDA Performer (Body) DYNAMIC
2.16.840.1.113883.10.12.318 Containment active CDA Author (Body) DYNAMIC
2.16.840.1.113883.2.51.10.66 Containment draft XeH Immunization Refusal Reason DYNAMIC
Relationship Specialization: template 2.16.840.1.113883.10.22.4.15 IPS Immunization (2017‑03‑08)
ref
hl7ips-

Adaptation: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-

Adaptation: template 2.16.840.1.113883.10.20.22.4.52 Immunization Activity (V3) (2015‑08‑01)
ref
ccda-
Example
Example
<substanceAdministration classCode="SBADM" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.22.4.15"/>  <id root="1.2.3.999" extension="__example only__"/>  <code code="IMMUNIZ" displayName="Immunization" codeSystem="2.16.840.1.113883.5.4"/>  <statusCode code="completed"/>  <effectiveTime value="20170721082737"/>  <consumable>
    <!-- template 2.16.840.1.113883.10.22.4.16 'IPS Immunization Medication Information' (dynamic) -->
  </consumable>  <author>
    <!-- template 2.16.840.1.113883.10.12.318 'CDA Author (Body)' (dynamic) -->
  </author></substanceAdministration>
Item DT Card Conf Description Label
hl7:substanceAdministration
 		(XeHdotsion)
@classCode
 		cs 1 … 1 F SBADM
@moodCode
 		cs 1 … 1 F EVN
hl7:templateId
 		II 1 … 1 M (XeHdotsion)
@root
 		uid 1 … 1 F 2.16.840.1.113883.2.51.10.64
hl7:id
 		II 0 … * (XeHdotsion)
hl7:code
 		CV.IPS 1 … 1 M (XeHdotsion)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19709 ActSubstanceAdministrationImmunizationCode (DYNAMIC)
hl7:statusCode
 		CS 1 … 1 R (XeHdotsion)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.15933 ActStatus (DYNAMIC)
hl7:effectiveTime
 		TS 1 … 1 R (XeHdotsion)
  Example <effectiveTime value="20170322"/>
hl7:repeatNumber
 		0 … 1 In "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series. (XeHdotsion)
hl7:routeCode
 		CE 0 … 1 (XeHdotsion)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.14581 RouteOfAdministration (DYNAMIC)
hl7:approachSiteCode
 		CD 0 … * (XeHdotsion)
  CONF
shall be drawn from concept domain "ActSite"
hl7:consumable
 		1 … 1 M Contains 2.16.840.1.113883.10.22.4.16 IPS Immunization Medication Information (DYNAMIC) (XeHdotsion)
hl7:performer
 		0 … * Contains 2.16.840.1.113883.10.12.323 CDA Performer (Body) (DYNAMIC) (XeHdotsion)
hl7:author
 		0 … * R Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC) (XeHdotsion)
hl7:entryRelationship
 		0 … 1 Contains 2.16.840.1.113883.2.51.10.66 XeH Immunization Refusal Reason (DYNAMIC) (XeHdotsion)
@typeCode
 		cs 1 … 1 F RSON