2.16.840.1.113883.10.22.4.47

From HL7 IPS
Jump to: navigation, search
Comments on this page

Template IPSPlannedImmunization

A Planned Immunization entry describes the intent of administrating immunization substance. 

Actual version

Id2.16.840.1.113883.10.22.4.47Effective Date2020‑05‑08 17:29:18
StatusKorange.png Under pre-publication reviewVersion LabelTI-2020
NameIPSPlannedImmunizationDisplay NameIPS Planned Immunization
DescriptionA Planned Immunization entry describes the intent of administrating immunization substance. 
ContextParent nodes of template element with id 2.16.840.1.113883.10.22.4.47
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Associated with
Associated with 3 concepts
IdNameData Set
hl7ips-data​element-215Kyellow.png Product Administration Process Kyellow.png CEN/TC 251 prEN 17269
hl7ips-data​element-45Kyellow.png Immunization Kyellow.png CEN/TC 251 prEN 17269
hl7ips-data​element-53Kyellow.png Date of Immunization Kyellow.png CEN/TC 251 prEN 17269
Uses
Uses 2 templates
Uses as NameVersion
2.16.840.1.113883.10.22.4.16IncludeKyellow.png IPS Immunization Medication Information (STU2)DYNAMIC
2.16.840.1.113883.10.12.318ContainmentKgreen.png CDA Author (Body)DYNAMIC
RelationshipAdaptation: 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>
</substanceAdministration>
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
(IPS...ion)
 
Target.png
hl7ips-data​element-215Kyellow.png Product Administration Process Kyellow.png CEN/TC 251 prEN 17269
hl7ips-data​element-45Kyellow.png Immunization Kyellow.png CEN/TC 251 prEN 17269
Treetree.png@classCode
cs1 … 1FSBADM
Treetree.png@moodCode
cs1 … 1R
 CONF
@moodCode shall be "INT"
or
@moodCode shall be "RQO"
or
@moodCode shall be "PRP"
Treetree.pnghl7:templateId
II1 … 1M(IPS...ion)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.22.4.47
Treetree.pnghl7:id
II0 … *(IPS...ion)
Treetree.pnghl7:code
CV.IPS1 … 1M(IPS...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19709 ActSubstanceAdministrationImmunizationCode (DYNAMIC)
Treetree.pnghl7:text
ED0 … 1RThe <text> element if present points to the text describing the problem being recorded; including any dates, comments, et cetera. The <reference> contains a URI in value attribute. This URI points to the free text description of the problem in the document that is being described.</reference></text>(IPS...ion)
 Example<text>
  <reference value="#problem-1"/></text>
Treeblank.pngTreetree.pnghl7:reference
TEL1 … 1M(IPS...ion)
Treeblank.pngTreeblank.pngTreetree.png@value
url1 … 1RWhen used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1
Treetree.pnghl7:statusCode
CS1 … 1M(IPS...ion)
Treeblank.pngTreetree.png@code
CONF1 … 1Fcompleted
Treetree.pnghl7:effectiveTime
TS0 … 1R(IPS...ion)
 
Target.png
hl7ips-data​element-53Kyellow.png Date of Immunization Kyellow.png CEN/TC 251 prEN 17269
 Example<effectiveTime value="20170322"/>
Treetree.pnghl7:consumable
1 … 1M(IPS...ion)
Included from 2.16.840.1.113883.10.22.4.16 IPS Immunization Medication Information (DYNAMIC)
Treeblank.pngTreetree.pnghl7:manufacturedProduct
(IPS...ion)
 
Target.png
hl7ips-data​element-54Kyellow.png Product Administered Kyellow.png CEN/TC 251 prEN 17269
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMANU
Treeblank.pngTreeblank.pngTreetree.pnghl7:templateId
II1 … 1M(IPS...ion)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.22.4.16
Treeblank.pngTreeblank.pngTreetree.pnghl7:manufactured​Material
1 … 1M(IPS...ion)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:code
CD.IPS (preferred)1 … 1R(IPS...ion)
 
Target.png
hl7ips-data​element-46Kyellow.png Immunizations Content Status Kyellow.png CEN/TC 251 prEN 17269
hl7ips-data​element-52Kyellow.png Vaccine for type of disease Kyellow.png 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)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:translation
CE0 … *(IPS...ion)
 CONF
shall be drawn from concept domain "Product Code"
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:translation
CE0 … 1candidate: for when WHO ATC code system is preferred(IPS...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.78 IPS Vaccines WHO ATC (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:lotNumberText
ST0 … 1(IPS...ion)
Treeblank.pngTreeblank.pngTreetree.pnghl7:manufacturerOrganization
0 … 1RContains 2.16.840.1.113883.10.22.9.1 IPS CDA Organization (DYNAMIC)(IPS...ion)
Treetree.pnghl7:author
0 … *RContains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC)(IPS...ion)


List of all versions of this template