Id
2.16.840.1.113883.10.22.4.47
ref
hl7ips-
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)
Used by / Uses
Used by 0 transactions and 3 templates, Uses 2 templates
Relationship
Adaptation: 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 >
Expand All Collapse All
Item
DT
Card
Conf
Description
Label
hl7:substanceAdministration
(IPS ion)
@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
(IPS ion)
@root
uid
1 … 1
F
2.16.840.1.113883.10.22.4.47
hl7:id
II
0 … *
(IPS ion)
hl7:code
CV.IPS
1 … 1
M
(IPS ion)
CONF
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.
(IPS ion)
Example
< text > < reference value =" #problem-1 " / > </ text >
hl7:reference
TEL
1 … 1
M
(IPS ion)
@value
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
(IPS ion)
@code
CONF
1 … 1
F
completed
hl7:effectiveTime
TS
0 … 1
R
(IPS ion)
Example
< effectiveTime value =" 20170322 " / >
hl7:consumable
1 … 1
M
Contains 2.16.840.1.113883.10.22.4.16 IPS Immunization Medication Information (DYNAMIC)
(IPS ion)
hl7:author
0 … *
R
Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC)
(IPS ion)