The Immunization Detail Content Module extends the Immunization Summary to contain additional data elements needed to provide immunization decision support.
Care Record messages that conform to the requirements of this content module shall indicate their conformance by the inclusion of the appropriate <templateId> elements in <careProvisionEvent> element of the message. This is shown in the sample message below. A Care Record message may conform to more than one template. This content module inherits from the Immunization Summary content module, and so must conform to the requirements of that template as well, thus all <templateId> elements shown in the example below shall be included.
Sample Immunization Detail Document
<careProvisionEvent>
<templateId root="Immunization Detail"/>
<templateId root="1.3.6.1.4.1.19376.1.5.3.1.1.18.1.1"/><recordTarget>
<patient>
<id extension="" root=""/>
<addr/>
<telecom use="" value=""/>
<statusCode code="active"/>
<patientPerson>
<name/>
<administrativeGenderCode code=""
codeSystem="2.16.840.1.113883.5.1"
codeSystemName="AdministrativeGender" displayName=""/>
<birthTime value=""/>
</patientPerson>
</patient>
</recordTarget>
<pertinentInformation3>
:
<!-- Required History of Immunizations element -->
<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.12'/>
:
</pertinentInformation3>
<pertinentInformation3>
:
<!-- Required if known Problem Entry element -->
<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.5'/>
:
</pertinentInformation3>
<pertinentInformation3>
:
<!-- Required if known Allergies and Intolerances element -->
<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.6'/>
:
</pertinentInformation3>
<pertinentInformation3>
:
<!-- Required if known Medications element -->
<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.7'/>
:
</pertinentInformation3>
<pertinentInformation3>
:
<!-- Required if known Lab Results element -->
<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.13'/>
:
</pertinentInformation3>
<pertinentInformation3>
:
<!-- Required if known Vital Signs element -->
<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.13.1'/>
:
</pertinentInformation3>
<pertinentInformation3>
:
<!-- Required if known Pregnancy Observation element -->
<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.13.5'/>
:
</pertinentInformation3>
<pertinentInformation3>
:
<!-- Required if known Advance Directive Observation element -->
<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.13.7'/>
:
</pertinentInformation3>
<pertinentInformation3>
:
<!-- Optional Comments element -->
<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.2'/>
:
</pertinentInformation3>
</careProvisionEvent>
Schematron
<pattern name='Template_1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2'>
<rule context='*[cda:templateId/@root="1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2"]'>
<!-- Verify that the template id is used on the appropriate type of object -->
<assert test='../cda:careProvisionEvent'>
Error: The Immunization Detail can only be used on Care Provision Events.
</assert>
<!-- Verify that the parent templateId is also present. -->
<assert test='cda:templateId[@root="1.3.6.1.4.1.19376.1.5.3.1.1.18.1.1"]'>
Error: The parent template identifier for Immunization Detail is not present.
</assert>}}
<assert test='.//cda:templateId[@root = "1.3.6.1.4.1.19376.1.5.3.1.4.12"]'>
<!-- Verify that all required data elements are present -->
Error: The Immunization Detail must contain a(n) History of Immunizations Entry.
See http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2
</assert>
<assert test='.//cda:templateId[@root = "1.3.6.1.4.1.19376.1.5.3.1.4.5"]'>
<!-- Alert on any missing required if known elements -->
Warning: The Immunization Detail should contain a(n) Problem Entry Entry.
See http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2
</assert>
<assert test='.//cda:templateId[@root = "1.3.6.1.4.1.19376.1.5.3.1.4.6"]'>
<!-- Alert on any missing required if known elements -->
Warning: The Immunization Detail should contain a(n) Allergies and Intolerances Entry.
See http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2
</assert>
<assert test='.//cda:templateId[@root = "1.3.6.1.4.1.19376.1.5.3.1.4.7"]'>
<!-- Alert on any missing required if known elements -->
Warning: The Immunization Detail should contain a(n) Medications Entry.
See http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2
</assert>
<assert test='.//cda:templateId[@root = "1.3.6.1.4.1.19376.1.5.3.1.4.13"]'>
<!-- Alert on any missing required if known elements -->
Warning: The Immunization Detail should contain a(n) Lab Results Entry.
See http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2
</assert>
<assert test='.//cda:templateId[@root = "1.3.6.1.4.1.19376.1.5.3.1.4.13.1"]'>
<!-- Alert on any missing required if known elements -->
Warning: The Immunization Detail should contain a(n) Vital Signs Entry.
See http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2
</assert>
<assert test='.//cda:templateId[@root = "1.3.6.1.4.1.19376.1.5.3.1.4.13.5"]'>
<!-- Alert on any missing required if known elements -->
Warning: The Immunization Detail should contain a(n) Pregnancy Observation Entry.
See http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2
</assert>
<assert test='.//cda:templateId[@root = "1.3.6.1.4.1.19376.1.5.3.1.4.13.7"]'>
<!-- Alert on any missing required if known elements -->
Warning: The Immunization Detail should contain a(n) Advance Directive Observation Entry.
See http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2
</assert>
<assert test='.//cda:templateId[@root = "1.3.6.1.4.1.19376.1.5.3.1.4.2"]'>
<!-- Note any missing optional elements -->
Note: This Immunization Detail does not contain a(n) Comments Entry.
See http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.1.18.1.2
</assert>
</rule>
</pattern>