hl7:substanceAdministration
|
|
|
R |
An immunization is a substance administration event.
|
(eHD ion) |
@classCode
|
cs |
1 … 1 |
F |
SBADM |
@moodCode
|
cs |
1 … 1 |
F |
EVN |
hl7:templateId
|
II |
1 … 1 |
M |
eHDSI Immunizations |
(eHD ion) |
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.12559.11.10.1.3.1.3.19 |
hl7:templateId
|
II |
1 … 1 |
M |
IHE Immunizations Entry (IHE PCC) |
(eHD ion) |
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.5.3.1.4.12 |
hl7:templateId
|
II |
1 … 1 |
M |
Medication activity (CCD) |
(eHD ion) |
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.10.20.1.24 |
hl7:id
|
II.EPSOS |
1 … 1 |
M |
|
(eHD ion) |
hl7:code
|
CD.EPSOS |
1 … 1 |
M |
This required element records that the act was an immunization. The substance administration
act must have a <code> element with code and codeSystem attributes present. If no
coding system is used by the source, then simply record the code exactly as shown
above. This <code> element shall not be used to record the type of vaccine used from
a vocabulary of drug names.
codeSystem
|
codeSystemName
|
Description
|
1.3.5.1.4.1.19376.1.5.3.2
|
IHEActCode
|
The IMMUNIZ term from the IHE ActCode vocabulary.
|
|
(eHD ion) |
@code
|
CONF |
1 … 1 |
F |
IMMUNIZ |
@codeSystem
|
1 … 1 |
F |
1.3.5.1.4.1.19376.1.5.3.2 (IHEActCode) |
hl7:text
|
ED |
1 … 1 |
R |
The URI given in the value attribute of the <reference> element points to an element
in the narrative content that contains the complete text describing the immunization
activity.
|
(eHD ion) |
|
|
hl7:reference
|
TEL |
1 … 1 |
M |
|
(eHD ion) |
@value
|
|
1 … 1 |
R |
Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1 |
hl7:statusCode
|
CS |
1 … 1 |
R |
The statusCode shall be set to "completed" for all administered immunizations. If
the immunization is not administered, the statusCode has to be set to "cancelled".
|
(eHD ion) |
|
CONF |
|
hl7:effectiveTime
|
|
1 … 1 |
R |
The effectiveTime element shall be present and should contain a time value that indicates
the date of the substance administration. If the date is unknown, this shall be recorded
using the nullFlavor attribute, with the reason that the information is unknown being
specified. Otherwise, the date shall be recorded, and should have precision of at
least the day.
|
(eHD ion) |
|
|
hl7:routeCode
|
CE |
0 … 1 |
R |
See routeCode under the Medication Item Entry Content module.
|
(eHD ion) |
hl7:doseQuantity
|
IVL_PQ |
0 … 1 |
R |
See doseQuantity under the Medication Item Entry Content module.
|
(eHD ion) |
hl7:consumable
|
|
1 … 1 |
R |
The <consumable> element shall be present, and shall contain a <manufacturedElement>
element, conforming to the Product Entry Content Module template.
Contains 1.3.6.1.4.1.12559.11.10.1.3.1.3.18 eHDSI Immunization Product (DYNAMIC)
|
(eHD ion) |
@typeCode
|
cs |
1 … 1 |
F |
CSM |
hl7:performer
|
|
0 … * |
R |
When present, this element represents the Health Professional and centre that provided
the immunization.
Contains 2.16.840.1.113883.3.1937.777.11.10.150 CDA Performer (Body) (DYNAMIC)
|
(eHD ion) |
|
|
hl7:participant
|
|
0 … * |
|
Disease or agent that the vaccination provides
protection against.
|
(eHD ion) |
@typeCode
|
cs |
1 … 1 |
F |
IND |
hl7:participantRole
|
|
1 … 1 |
R |
|
(eHD ion) |
@classCode
|
cs |
1 … 1 |
F |
AGNT |
hl7:playingEntity
|
|
1 … 1 |
R |
|
(eHD ion) |
@classCode
|
cs |
1 … 1 |
F |
ENT |
hl7:code
|
CD.EPSOS |
1 … 1 |
R |
Code for the illness or disease that the vaccination provides protection against.
|
(eHD ion) |
|
|
|
CONF |
|
hl7:name
|
PN |
0 … * |
R |
Name for the illness or disease that the vaccination provides protection against.
|
(eHD ion) |
hl7:entryRelationship
|
|
0 … 1 |
R |
This optional entry relationship may be present to indicate that position of this
immunization in a series of immunizations. The <code> element shall be present and
must be recorded with the code and codeSystem attributes shown above. This element
indicates that the observation describes the dose number for the immunization. The
<statusCode> element shall be present, and must be recorded exactly as shown above.
This element indicates that the observation has been completed. The <value> element
shall be present, and shall indicate the immunization
series number in the value attribute.
Contains 1.3.6.1.4.1.12559.11.10.1.3.1.3.28 eHDSI Position Of Vaccination (DYNAMIC)
|
(eHD ion) |
|
|
|
Example |
<entryRelationship typeCode="SUBJ"> <observation classCode="OBS" moodCode="EVN"> <templateId root="1.3.6.1.4.1.12559.11.10.1.3.1.3.28"/> <code code="30973-2" displayName="Dose Number" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC"/> <statusCode code="completed"/> <value type="INT" value=" "/> </observation></entryRelationship> |
hl7:entryRelationship
|
|
0 … * |
R |
This repeatable element should be used to identify adverse reactions caused by the
immunization. The <observation> element provides a pointer to the adverse reaction
caused by the immunization. The template IDs describe that it points to a conforming
Problem Entry Content Module that also conform to the CCD Reaction template.
The <id> element is required, and gives the identifier of the adverse reaction. The
adverse reaction pointed to by this element shall be described in more detail using
the Allergies entry, elsewhere in the document where the Allergies and Intolerances
section is found.
Contains 1.3.6.1.4.1.12559.11.10.1.3.1.3.44 eHDSI Reaction Manifestation (DYNAMIC)
|
(eHD ion) |
|
Example |
<entryRelationship inversionInd="false" typeCode="CAUS"> <observation classCode="OBS" moodCode="EVN"> <templateId root="1.3.6.1.4.1.12559.11.10.1.3.1.3.44"/> <id root=" " extension=" "/> </observation></entryRelationship> |
hl7:entryRelationship
|
|
0 … * |
R |
An immunization entry can have negationInd set to true to indicate that an immunization
did not occur. In this case, it shall have at least one comment that provides an explanation
for why the immunization did not take place. Other comments may also be present.
Contains 1.3.6.1.4.1.12559.11.10.1.3.1.3.11 eHDSI Comment (DYNAMIC)
|
(eHD ion) |