Back To Index << Back To Templates

# Template IPS Planned Immunization

Id | 2.16.840.1.113883.10.22.4.47 | Effective Date | 2020‑05‑08 17:29:18
Status | Under pre-publication review | Version Label | TI-2020
Name | IPSPlannedImmunization | Display Name | IPS Planned Immunization
Description | A Planned Immunization entry describes the intent of administrating immunization substance.
Context | Parent nodes of template element with id 2.16.840.1.113883.10.22.4.47
Classification | CDA Entry Level Template
Open/Closed | Open (other than defined elements are allowed)
Associated with |
Associated with 3 concepts
Id | Name | Dataset
--- | --- | ---
hl7ips-dataelement-215 | Product Administration Process | CEN/TC 251 prEN 17269
hl7ips-dataelement-45 | Immunization | CEN/TC 251 prEN 17269
hl7ips-dataelement-53 | Date of Immunization | CEN/TC 251 prEN 17269
Used by / Uses |
Used by 0 transactions and 2 templates, Uses 2 templates
Used by | as | Name | Version
--- | --- | --- | ---
2.16.840.1.113883.10.22.3.9 | Containment | IPS Plan of Care Section (TI-2020) | 2020‑05‑08 18:28:38
2.16.840.1.113883.10.22.1.2 |  | International Patient Summary (2024) | 2024‑08‑02 13:02:39
Uses | as | Name | Version
2.16.840.1.113883.10.22.4.16 | Include | IPS Immunization Medication Information (STU2) | DYNAMIC
2.16.840.1.113883.10.12.318 | Containment | CDA Author (Body) | DYNAMIC
Relationship | Adaptation: 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>
Item | DT | Card | Conf | Description | Label
--- | --- | --- | --- | --- | ---
hl7:substanceAdministration |  |  |  |  |
hl7ips-dataelement-215 | Product Administration Process | CEN/TC 251 prEN 17269
hl7ips-dataelement-45 | Immunization | CEN/TC 251 prEN 17269
@classCode | cs | 1 … 1 | F | SBADM
@moodCode | cs | 1 … 1 | R |
| CONF |
@moodCode SHALL be "INT"
or
@moodCode SHALL be "RQO"
or
@moodCode SHALL be "PRP"
hl7:templateId | II | 1 … 1 | M |  |
@root | uid | 1 … 1 | F | 2.16.840.1.113883.10.22.4.47
hl7:id | II | 0 … * |  |  |
hl7:code | CV.IPS | 1 … 1 | M |  |
| CONF |
The value of @code SHALL be drawn from value set 2.16.840.1.113883.1.11.19709 ActSubstanceAdministrationImmunizationCode (DYNAMIC)
hl7:text | ED | 0 … 1 | R | The element if present points to the text describing the problem being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the problem in the document that is being described. |
| Example | <text> <reference value="#problem-1"/></text>
hl7:reference | TEL | 1 … 1 | M |  |
@value | url | 1 … 1 | R | When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1
hl7:statusCode | CS | 1 … 1 | M |  |
@code | CONF | 1 … 1 | F | completed
hl7:effectiveTime | TS | 0 … 1 | R |  |
hl7ips-dataelement-53 | Date of Immunization | CEN/TC 251 prEN 17269
| Example | <effectiveTime value="20170322"/>
hl7:consumable |  | 1 … 1 | M |  |
Included |  |  | from 2.16.840.1.113883.10.22.4.16 IPS Immunization Medication Information (DYNAMIC)
hl7:manufacturedProduct |  |  |  |  |
hl7ips-dataelement-54 | Product Administered | CEN/TC 251 prEN 17269
@classCode | cs | 1 … 1 | F | MANU
hl7:templateId | II | 1 … 1 | M |  |
@root | uid | 1 … 1 | F | 2.16.840.1.113883.10.22.4.16
hl7:manufacturedMaterial |  | 1 … 1 | M |  |
hl7:code | CD.IPS (preferred) | 1 … 1 | R |  |
hl7ips-dataelement-46 | Immunizations Content Status | CEN/TC 251 prEN 17269
hl7ips-dataelement-52 | Vaccine for type of disease | 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 … * |  |  |
| CONF |
SHALL be drawn from concept domain "Product Code"
hl7:translation | CE | 0 … 1 |  | candidate: for when WHO ATC code system is preferred |
| 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 |  |  |
hl7:manufacturerOrganization |  | 0 … 1 | R | Contains 2.16.840.1.113883.10.22.9.1 IPS CDA Organization (DYNAMIC) |
hl7:author |  | 0 … * | R | Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC) |