Back To Index  <<  Back To Templates

draft Template  IPS Immunization

Id 2.16.840.1.113883.10.22.4.15 Effective Date 2024‑08‑04 21:20:24
Status draft Draft Version Label STU2
Name IPSImmunization Display Name IPS 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.10.22.4.15
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Associated with
Associated with 3 concepts
Id Name Data Set
hl7ips-dataelement-215 draft Product Administration Process draft CEN/TC 251 prEN 17269
hl7ips-dataelement-45 draft Immunization draft CEN/TC 251 prEN 17269
hl7ips-dataelement-53 draft Date of Immunization draft CEN/TC 251 prEN 17269
Used by / Uses
Used by 0 transactions and 2 templates, Uses 3 templates
Used by as Name Version
2.16.840.1.113883.10.22.3.5 Containment pending IPS Immunizations Section (STU1) 2017‑04‑05
2.16.840.1.113883.10.22.1.1 link draft International Patient Summary (2021) 2020‑07‑14 16:08:21
Uses as Name Version
2.16.840.1.113883.10.22.4.16 Include draft IPS Immunization Medication Information (STU2) DYNAMIC
2.16.840.1.113883.10.12.318 Containment active CDA Author (Body) DYNAMIC
2.16.840.1.113883.10.21.4.6 Containment draft UV Subordinate Substance Administration (2023) DYNAMIC
Relationship Specialization: template 2.16.840.1.113883.10.22.4.15 IPS Immunization (2017‑03‑08)
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>  </code></substanceAdministration>
Item DT Card Conf Description Label
hl7:substanceAdministration
 		(IPSdotsion)
 
target
hl7ips-dataelement-215 draft Product Administration Process draft CEN/TC 251 prEN 17269
hl7ips-dataelement-45 draft Immunization draft CEN/TC 251 prEN 17269
@classCode
 		cs 1 … 1 F SBADM
@moodCode
 		cs 1 … 1 F EVN
hl7:templateId
 		II 1 … 1 M (IPSdotsion)
@root
 		uid 1 … 1 F 2.16.840.1.113883.10.22.4.15
hl7:id
 		II 0 … * (IPSdotsion)
hl7:code
 		CV.IPS 1 … 1 M (IPSdotsion)
  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 M (IPSdotsion)
@code
 		CONF 1 … 1 F completed
hl7:effectiveTime
 		TS 1 … 1 R (IPSdotsion)
 
target
hl7ips-dataelement-53 draft Date of Immunization draft CEN/TC 251 prEN 17269
  Example <effectiveTime value="20170322"/>
hl7:consumable
 		1 … 1 M (IPSdotsion)
Included from 2.16.840.1.113883.10.22.4.16 IPS Immunization Medication Information (DYNAMIC)
hl7:manufacturedProduct
 		(IPSdotsion)
 
target
hl7ips-dataelement-54 draft Product Administered draft CEN/TC 251 prEN 17269
@classCode
 		cs 1 … 1 F MANU
hl7:templateId
 		II 1 … 1 M (IPSdotsion)
@root
 		uid 1 … 1 F 2.16.840.1.113883.10.22.4.16
hl7:manufacturedMaterial
 		1 … 1 M (IPSdotsion)
hl7:code
 		CD.IPS (preferred) 1 … 1 R (IPSdotsion)
 
target
hl7ips-dataelement-46 draft Immunizations Content Status draft CEN/TC 251 prEN 17269
hl7ips-dataelement-52 draft Vaccine for type of disease draft CEN/TC 251 prEN 17269
  CONF
The value of @code comes preferably from value set 2.16.840.1.113883.11.22.44 IPS Vaccines (DYNAMIC)
hl7:translation
 		CE 0 … * (IPSdotsion)
  CONF
shall be drawn from concept domain "Product Code"
hl7:translation
 		CE 0 … 1 candidate: for when WHO ATC code system is preferred (IPSdotsion)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.78 IPS Vaccines WHO ATC (DYNAMIC)
hl7:lotNumberText
 		ST 0 … 1 (IPSdotsion)
hl7:manufacturerOrganization
 		0 … 1 R Contains 2.16.840.1.113883.10.22.9.1 IPS CDA Organization (DYNAMIC) (IPSdotsion)
hl7:author
 		0 … * R Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC) (IPSdotsion)
hl7:entryRelationship
 		0 … * Contains 2.16.840.1.113883.10.21.4.6 UV Subordinate Substance Administration (DYNAMIC) (IPSdotsion)
@typeCode
 		cs 1 … 1 F RSON