Difference between revisions of "2.16.840.1.113883.10.22.4.5/static-2016-11-11T000000"

From HL7 IPS
Jump to: navigation, search
(Automated ADBot page content)
(Automated ADBot page content)
Line 1: Line 1:
<table xmlns="http://www.w3.org/1999/xhtml" class="artdecor" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Id</th><td style="text-align: left;">2.16.840.1.113883.10.22.4.5</td><th style="width: 20em; text-align: left;">Effective Date</th><td style="text-align: left;"> valid from 2016‑11‑11</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Status</th><td style="text-align: left;">[[File:Kyellow.png|14px]] Draft</td><th style="width: 20em; text-align: left;">Version Label</th><td style="text-align: left;"></td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Name</th><td style="text-align: left;">IPSAllergyAndIntoleranceConcern</td><th style="width: 20em; text-align: left;">Display Name</th><td style="text-align: left;">IPS Allergy and Intolerance Concern</td></tr><td style="text-align: left;" colspan="4"><table class="treetable" id="templateDescTable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;">Description</td></tr><tr><td><div><div>This template reflects an ongoing concern on behalf of the person that placed the allergy on a patient’s allergy list. </div>
+
<table xmlns="http://www.w3.org/1999/xhtml" class="artdecor" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Id</th><td style="text-align: left;">2.16.840.1.113883.10.22.4.5</td><th style="width: 20em; text-align: left;">Effective Date</th><td style="text-align: left;"> valid from 2016‑11‑11</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Status</th><td style="text-align: left;">[[File:Kyellow.png|14px]] Draft</td><th style="width: 20em; text-align: left;">Version Label</th><td style="text-align: left;"></td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Name</th><td style="text-align: left;">IPSAllergyAndIntoleranceConcern</td><th style="width: 20em; text-align: left;">Display Name</th><td style="text-align: left;">IPS Allergy and Intolerance Concern</td></tr><td style="text-align: left;" colspan="4"><table class="treetable" id="templateDescTable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;">Description</td></tr><tr><td><div><div>This template reflects an ongoing concern on behalf of the person that placed the allergy on a patient’s allergy list. </div><div><br />A concern may refer to one or more allergies or intolerances.<br /><br /></div><div>There are different kinds of status that could be related to an allergy, or more in general to a condition:</div><div><ul><li>The status of the concern (active, inactive,..) <br /></li><li>The status of the condition (e.g. active, inactive, resolved,..) <br /></li><li>The confirmation status [clinical workflow status, certainty] (e.g. confirmed, likely, unlikely,…) <br /></li></ul></div><div>Not all of them can be represented in a CDA using the statusCode elements of the concern (ACT) and observation (condition). </div><div><br /></div><div>As long as the underlying condition is of concern to the author (i.e., as long as the allergy, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “active”. <br />In case the clinician deems that there is no longer any need to track the underlying conditions then the the concern is inactive and the statusCode is set to "completed".<br />The effectiveTime/low of the Allergy Concern Act asserts when the concern became active. This equates to the time the concern was authored in the patient's chart. <br />The effectiveTime/high asserts when the concern become inactive, and it is present if the statusCode of the concern act is "completed"</div></div></td></tr></table></td><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Context</th><td style="text-align: left;" colspan="3">Parent nodes of template element with id 2.16.840.1.113883.10.22.4.5</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Classification</th><td style="text-align: left;" colspan="3">CDA Entry Level Template</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Open/Closed</th><td style="text-align: left;" colspan="3">Open (other than defined elements are allowed)</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Used by / Uses</th><td style="text-align: left;" colspan="3"><table class="treetable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;">Used by 0 transactions and 2 templates, Uses 1 template</td></tr><tr><td><div><table class="artdecor" width="100%" border="0" cellspacing="1" cellpadding="3" style="background: transparent;"><tr><th style="width: 20%; text-align: left;">Used by</th><th style="width: 1%; text-align: left;"> as </th><th style="width: 60%; text-align: left;">Name</th><th style="width: 19%; text-align: left;">Version</th></tr><tr><td style="text-align: left;">2.16.840.1.113883.10.22.3.2</td><td style="text-align: left;">Containment</td><td style="text-align: left;">[[File:Kyellow.png|14px]] IPS Allergies and Intolerances Section</td><td style="text-align: left;">2016‑11‑11</td></tr><tr><td style="text-align: left;">2.16.840.1.113883.10.22.1.1</td><td style="text-align: left;">[[File:Link.png|14px]]</td><td style="text-align: left;">[[File:Kyellow.png|14px]] International Patient Summary</td><td style="text-align: left;">2017‑04‑11</td></tr><tr><th style="width: 20%; text-align: left;">Uses</th><th style="width: 1%; text-align: left;"> as </th><th style="width: 60%; text-align: left;">Name</th><th style="width: 19%; text-align: left;">Version</th></tr><tr><td style="text-align: left;">2.16.840.1.113883.10.22.4.1</td><td style="text-align: left;">Containment</td><td style="text-align: left;">[[File:Kyellow.png|14px]] IPS Allergy or Intolerance</td><td style="text-align: left;">DYNAMIC</td></tr></table></div></td></tr></table></td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Relationship</th><td style="text-align: left;" colspan="3">Adaptation: template 2.16.840.1.113883.10.12.301 <i> </i> (2005‑09‑07)<br />Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.4.5.3 <i> </i> (2013‑12‑20)</td></tr><tr class="explabel " style="vertical-align: top;"><td style="width: 20em; text-align: left;">Example</td><td colspan="3" class="explabelblue"><table class="treetable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;" class="togglertreetable"><span class="expcaption">Example</span></td></tr><tr><td><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">act</span> <span class="ppattribute">classCode</span><span class="ppsign">="</span><span class="ppcontent">ACT</span><span class="ppsign">"</span> <span class="ppattribute">moodCode</span><span class="ppsign">="</span><span class="ppcontent">EVN</span><span class="ppsign">"</span><span class="ppsign">&gt;</span><br /><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">templateId</span> <span class="ppattribute">root</span><span class="ppsign">="</span><span class="ppcontent">2.16.840.1.113883.10.22.4.5</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">id</span> <span class="ppattribute">root</span><span class="ppsign">="</span><span class="ppcontent">1.2.3.999</span><span class="ppsign">"</span> <span class="ppattribute">extension</span><span class="ppsign">="</span><span class="ppcontent">--example only--</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">code</span> <span class="ppattribute">code</span><span class="ppsign">="</span><span class="ppcontent">CONC</span><span class="ppsign">"</span> <span class="ppattribute">codeSystem</span><span class="ppsign">="</span><span class="ppcontent">2.16.840.1.113883.5.6</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">statusCode</span> <span class="ppattribute">code</span><span class="ppsign">="</span><span class="ppcontent">active</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span><span class="ppsign">&gt;</span><br /><span style="display: block;" class="explrendered">    <span class="ppsign">&lt;</span><span class="ppelement">low</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">    <span class="ppsign">&lt;</span><span class="ppelement">high</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span>  <span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">effectiveTime</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">entryRelationship</span> <span class="ppattribute">typeCode</span><span class="ppsign">="</span><span class="ppcontent">SUBJ</span><span class="ppsign">"</span> <span class="ppattribute">inversionInd</span><span class="ppsign">="</span><span class="ppcontent">false</span><span class="ppsign">"</span><span class="ppsign">&gt;</span><br /><span style="display: block;">    <span style="color:green">&lt;!-- template 2.16.840.1.113883.10.22.4.1 'IPS Allergy or Intolerance' (dynamic) --&gt;<br /></span></span>  <span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">entryRelationship</span><span class="ppsign">&gt;</span></span><span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">act</span><span class="ppsign">&gt;</span></span></tt></td></tr></table></td></tr><tr style="vertical-align: top;"><td colspan="4" class="tabtab"><table class="treetable" id="transactionTable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr><th style="width: 30%; text-align: left;">Item</th><th style="width: 2em; text-align: left;">DT</th><th style="width: 2em; text-align: left;">Card</th><th style="width: 2em; text-align: left;">Conf</th><th style="text-align: left;">Description</th><th style="width: 2em; text-align: left;">Label</th></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td><tt><strong>hl7:act<br /></strong></tt></td></tr></table></td><td><strong></strong></td><td><span style="color: black;"><strong>0 … *</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@classCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">ACT</td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@moodCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">EVN</td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:templateId<br /></strong></tt></td></tr></table></td><td><strong>II</strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>M</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@root<br /></strong></tt></td></tr></table></td><td>uid</td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">2.16.840.1.113883.10.22.4.5</td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:id<br /></strong></tt></td></tr></table></td><td><strong>II</strong></td><td><span style="color: black;"><strong>0 … *</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:code<br /></strong></tt></td></tr></table></td><td><strong>CD</strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>M</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top;"><td><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@code<br /></strong></tt></td></tr></table></td><td rowspan="2" class="conf">CONF</td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><strong>F</strong></td><td colspan="2">CONC</td></tr><tr style="vertical-align: top;"><td><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@codeSystem<br /></strong></tt></td></tr></table></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><strong>F</strong></td><td colspan="2">2.16.840.1.113883.5.6 (ActClass)</td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:statusCode<br /></strong></tt></td></tr></table></td><td><strong>CS</strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td>As long as the underlying conditions are of concern to the author (i.e., as long as allergies, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “<b>active</b>”. The concern is tracked by the author.<br /><br />Only when the underlying allergies are no longer of concern then the statusCode is set to “<b>completed</b>”. The author is no more tracking this concern and no further actions are expected.<br /></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td class="conf">CONF</td><td colspan="4"><table class="artdecor" width="100%" border="0" cellspacing="2" cellpadding="2" style="background: transparent;"><tr style="vertical-align: top;"><td>The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.4 <i>ActStatusActiveCompleted </i>(2017‑03‑06)</td></tr></table></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:effectiveTime<br /></strong></tt></td></tr></table></td><td><strong>IVL_TS</strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:low<br /></strong></tt></td></tr></table></td><td><strong>IVXB_TS</strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td>This element asserts when the concern became active. This equates to the time the concern was authored in the patient's chart and the author started tracking this concern.<br /></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:high<br /></strong></tt></td></tr></table></td><td><strong>IVXB_TS</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>C</strong></span></td><td>This element asserts when the clinician deemed there is no longer any need to track the underlying conditions.<br /></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top; background-color: #FAFAD2;"><td style="background-color: white;" colspan="1"> </td><td class="conf">Constraint</td><td style="background-color: #FAFAD2;" colspan="4">If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high</td></tr><tr style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td rowspan="3" class="stron">Schematron assert</td><td style="background-color: #FFEEEE;">role</td><td colspan="2">[[File:Kred.png|14px]] error</td><td style="background-color: white;"> </td></tr><tr style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td style="background-color: #FFEEEE;">test</td><td colspan="2">not(../hl7:statusCode[@code='completed']) or hl7:high</td><td style="background-color: white;"> </td></tr><tr style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td style="background-color: #FFEEEE;">Message</td><td colspan="2"><span class="pptext">If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high</span></td><td style="background-color: white;"> </td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:entryRelationship<br /></strong></tt></td></tr></table></td><td><strong></strong></td><td><span style="color: black;"><strong>1 … *</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td>Contains 2.16.840.1.113883.10.22.4.1 <i>IPS Allergy or Intolerance</i> (DYNAMIC)</td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td colspan="5" style="background-color: #FFEAEA;"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td> where  <i> [hl7:observation [hl7:code [concat(@code,@codeSystem)=doc('include/voc-2.16.840.1.113883.11.22.2-DYNAMIC.xml')//valueSet [1]/conceptList/concept/concat(@code,@codeSystem)]]]</i></td></tr></table></td><td></td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@typeCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">SUBJ</td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@inversionInd<br /></strong></tt></td></tr></table></td><td>bl</td><td><span><strong>0 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">false</td></tr></table></td></tr></table>
<div><br />A concern may refer to one or more allergies or intolerances.<br /><br />
 
</div>
 
<div>There are different kinds of status that could be related to an allergy, or more in general to a condition:</div>
 
<div>
 
    <ul>
 
        <li>The status of the concern (active, inactive,..) <br />
 
        </li>
 
        <li>The status of the condition (e.g. active, inactive, resolved,..) <br />
 
        </li>
 
        <li>The confirmation status [clinical workflow status, certainty] (e.g. confirmed, likely, unlikely,…) <br />
 
        </li>
 
    </ul>
 
</div>
 
<div>Not all of them can be represented in a CDA using the statusCode elements of the concern (ACT) and observation (condition). </div>
 
<div><br />
 
</div>
 
<div>As long as the underlying condition is of concern to the author (i.e., as long as the allergy, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “active”. <br />In case the clinician deems that there is no longer any need to track the underlying conditions then the the concern is inactive and the statusCode is set to "completed".<br />The effectiveTime/low of the Allergy Concern Act asserts when the concern became active. This equates to the time the concern was authored in the patient's chart. <br />The effectiveTime/high asserts when the concern become inactive, and it is present if the statusCode of the concern act is "completed"</div></div></td></tr></table></td><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Context</th><td style="text-align: left;" colspan="3">Parent nodes of template element with id 2.16.840.1.113883.10.22.4.5</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Classification</th><td style="text-align: left;" colspan="3">CDA Entry Level Template</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Open/Closed</th><td style="text-align: left;" colspan="3">Open (other than defined elements are allowed)</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Used by / Uses</th><td style="text-align: left;" colspan="3"><table class="treetable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;">Used by 0 transactions and 2 templates, Uses 1 template</td></tr><tr><td><div><table class="artdecor" width="100%" border="0" cellspacing="1" cellpadding="3" style="background: transparent;"><tr><th style="width: 20%; text-align: left;">Used by</th><th style="width: 1%; text-align: left;"> as </th><th style="width: 60%; text-align: left;">Name</th><th style="width: 19%; text-align: left;">Version</th></tr><tr><td style="text-align: left;">2.16.840.1.113883.10.22.3.2</td><td style="text-align: left;">Containment</td><td style="text-align: left;">[[File:Kyellow.png|14px]] IPS Allergies and Intolerances Section</td><td style="text-align: left;">2016‑11‑11</td></tr><tr><td style="text-align: left;">2.16.840.1.113883.10.22.1.1</td><td style="text-align: left;">[[File:Link.png|14px]]</td><td style="text-align: left;">[[File:Kyellow.png|14px]] International Patient Summary</td><td style="text-align: left;">2017‑04‑11</td></tr><tr><th style="width: 20%; text-align: left;">Uses</th><th style="width: 1%; text-align: left;"> as </th><th style="width: 60%; text-align: left;">Name</th><th style="width: 19%; text-align: left;">Version</th></tr><tr><td style="text-align: left;">2.16.840.1.113883.10.22.4.1</td><td style="text-align: left;">Containment</td><td style="text-align: left;">[[File:Kyellow.png|14px]] IPS Allergy or Intolerance</td><td style="text-align: left;">DYNAMIC</td></tr></table></div></td></tr></table></td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Relationship</th><td style="text-align: left;" colspan="3">Adaptation: template 2.16.840.1.113883.10.12.301 <i> </i> (2005‑09‑07)<br />Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.4.5.3 <i> </i> (2013‑12‑20)</td></tr><tr class="explabel " style="vertical-align: top;"><td style="width: 20em; text-align: left;">Example</td><td colspan="3" class="explabelblue"><table class="treetable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;" class="togglertreetable"><span class="expcaption">Example</span></td></tr><tr><td><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">act</span> <span class="ppattribute">classCode</span><span class="ppsign">="</span><span class="ppcontent">ACT</span><span class="ppsign">"</span> <span class="ppattribute">moodCode</span><span class="ppsign">="</span><span class="ppcontent">EVN</span><span class="ppsign">"</span><span class="ppsign">&gt;</span><br /><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">templateId</span> <span class="ppattribute">root</span><span class="ppsign">="</span><span class="ppcontent">2.16.840.1.113883.10.22.4.5</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">id</span> <span class="ppattribute">root</span><span class="ppsign">="</span><span class="ppcontent">1.2.3.999</span><span class="ppsign">"</span> <span class="ppattribute">extension</span><span class="ppsign">="</span><span class="ppcontent">--example only--</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">code</span> <span class="ppattribute">code</span><span class="ppsign">="</span><span class="ppcontent">CONC</span><span class="ppsign">"</span> <span class="ppattribute">codeSystem</span><span class="ppsign">="</span><span class="ppcontent">2.16.840.1.113883.5.6</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">statusCode</span> <span class="ppattribute">code</span><span class="ppsign">="</span><span class="ppcontent">active</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span><span class="ppsign">&gt;</span><br /><span style="display: block;" class="explrendered">    <span class="ppsign">&lt;</span><span class="ppelement">low</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">    <span class="ppsign">&lt;</span><span class="ppelement">high</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span>  <span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">effectiveTime</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">entryRelationship</span> <span class="ppattribute">typeCode</span><span class="ppsign">="</span><span class="ppcontent">SUBJ</span><span class="ppsign">"</span> <span class="ppattribute">inversionInd</span><span class="ppsign">="</span><span class="ppcontent">false</span><span class="ppsign">"</span><span class="ppsign">&gt;</span><br /><span style="display: block;">    <span style="color:green">&lt;!-- template 2.16.840.1.113883.10.22.4.1 'IPS Allergy or Intolerance' (dynamic) --&gt;<br /></span></span>  <span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">entryRelationship</span><span class="ppsign">&gt;</span></span><span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">act</span><span class="ppsign">&gt;</span></span></tt></td></tr></table></td></tr><tr style="vertical-align: top;"><td colspan="4" class="tabtab"><table class="treetable" id="transactionTable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr><th style="width: 30%; text-align: left;">Item</th><th style="width: 2em; text-align: left;">DT</th><th style="width: 2em; text-align: left;">Card</th><th style="width: 2em; text-align: left;">Conf</th><th style="text-align: left;">Description</th><th style="width: 2em; text-align: left;">Label</th></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td><tt><strong>hl7:act<br /></strong></tt></td></tr></table></td><td><strong></strong></td><td><span style="color: black;"><strong>0 … *</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@classCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">ACT</td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@moodCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">EVN</td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:templateId<br /></strong></tt></td></tr></table></td><td><strong>II</strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>M</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@root<br /></strong></tt></td></tr></table></td><td>uid</td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">2.16.840.1.113883.10.22.4.5</td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:id<br /></strong></tt></td></tr></table></td><td><strong>II</strong></td><td><span style="color: black;"><strong>0 … *</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:code<br /></strong></tt></td></tr></table></td><td><strong>CD</strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>M</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top;"><td><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@code<br /></strong></tt></td></tr></table></td><td rowspan="2" class="conf">CONF</td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><strong>F</strong></td><td colspan="2">CONC</td></tr><tr style="vertical-align: top;"><td><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@codeSystem<br /></strong></tt></td></tr></table></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><strong>F</strong></td><td colspan="2">2.16.840.1.113883.5.6 (ActClass)</td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:statusCode<br /></strong></tt></td></tr></table></td><td><strong>CS</strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td>As long as the underlying conditions are of concern to the author (i.e., as long as allergies, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “<b>active</b>”. The concern is tracked by the author.<br /><br />Only when the underlying allergies are no longer of concern then the statusCode is set to “<b>completed</b>”. The author is no more tracking this concern and no further actions are expected.<br /></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td class="conf">CONF</td><td colspan="4"><table class="artdecor" width="100%" border="0" cellspacing="2" cellpadding="2" style="background: transparent;"><tr style="vertical-align: top;"><td>The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.4 <i>ActStatusActiveCompleted </i>(2017‑03‑06)</td></tr></table></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:effectiveTime<br /></strong></tt></td></tr></table></td><td><strong>IVL_TS</strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:low<br /></strong></tt></td></tr></table></td><td><strong>IVXB_TS</strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td>This element asserts when the concern became active. This equates to the time the concern was authored in the patient's chart and the author started tracking this concern.<br /></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:high<br /></strong></tt></td></tr></table></td><td><strong>IVXB_TS</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>C</strong></span></td><td>This element asserts when the clinician deemed there is no longer any need to track the underlying conditions.<br /></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top; background-color: #FAFAD2;"><td style="background-color: white;" colspan="1"> </td><td class="conf">Constraint</td><td style="background-color: #FAFAD2;" colspan="4">If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high</td></tr><tr style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td rowspan="3" class="stron">Schematron assert</td><td style="background-color: #FFEEEE;">role</td><td colspan="2">[[File:Kred.png|14px]] error</td><td style="background-color: white;"> </td></tr><tr style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td style="background-color: #FFEEEE;">test</td><td colspan="2">not(../hl7:statusCode[@code='completed']) or hl7:high</td><td style="background-color: white;"> </td></tr><tr style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td style="background-color: #FFEEEE;">Message</td><td colspan="2"><span class="pptext">If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high</span></td><td style="background-color: white;"> </td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:entryRelationship<br /></strong></tt></td></tr></table></td><td><strong></strong></td><td><span style="color: black;"><strong>1 … *</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td>Contains 2.16.840.1.113883.10.22.4.1 <i>IPS Allergy or Intolerance</i> (DYNAMIC)</td><td style="background-color: #FFEEEE;"><span title="">(IPS…ern)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td colspan="5" style="background-color: #FFEAEA;"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td> where  <i> [hl7:observation [hl7:code [concat(@code,@codeSystem)=doc('include/voc-2.16.840.1.113883.11.22.2-DYNAMIC.xml')//valueSet [1]/conceptList/concept/concat(@code,@codeSystem)]]]</i></td></tr></table></td><td></td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@typeCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">SUBJ</td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@inversionInd<br /></strong></tt></td></tr></table></td><td>bl</td><td><span><strong>0 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">false</td></tr></table></td></tr></table>
 

Revision as of 15:15, 24 July 2017

Id2.16.840.1.113883.10.22.4.5Effective Date valid from 2016‑11‑11
StatusKyellow.png DraftVersion Label
NameIPSAllergyAndIntoleranceConcernDisplay NameIPS Allergy and Intolerance Concern
Description
This template reflects an ongoing concern on behalf of the person that placed the allergy on a patient’s allergy list. 

A concern may refer to one or more allergies or intolerances.

There are different kinds of status that could be related to an allergy, or more in general to a condition:
  • The status of the concern (active, inactive,..) 
  • The status of the condition (e.g. active, inactive, resolved,..) 
  • The confirmation status [clinical workflow status, certainty] (e.g. confirmed, likely, unlikely,…) 
Not all of them can be represented in a CDA using the statusCode elements of the concern (ACT) and observation (condition). 

As long as the underlying condition is of concern to the author (i.e., as long as the allergy, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “active”.
In case the clinician deems that there is no longer any need to track the underlying conditions then the the concern is inactive and the statusCode is set to "completed".
The effectiveTime/low of the Allergy Concern Act asserts when the concern became active. This equates to the time the concern was authored in the patient's chart.
The effectiveTime/high asserts when the concern become inactive, and it is present if the statusCode of the concern act is "completed"
ContextParent nodes of template element with id 2.16.840.1.113883.10.22.4.5
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 2 templates, Uses 1 template
Used by as NameVersion
2.16.840.1.113883.10.22.3.2ContainmentKyellow.png IPS Allergies and Intolerances Section2016‑11‑11
2.16.840.1.113883.10.22.1.1Link.pngKyellow.png International Patient Summary2017‑04‑11
Uses as NameVersion
2.16.840.1.113883.10.22.4.1ContainmentKyellow.png IPS Allergy or IntoleranceDYNAMIC
RelationshipAdaptation: template 2.16.840.1.113883.10.12.301 (2005‑09‑07)
Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.4.5.3 (2013‑12‑20)
Example
Example
<act classCode="ACT" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.22.4.5"/>  <id root="1.2.3.999" extension="--example only--"/>  <code code="CONC" codeSystem="2.16.840.1.113883.5.6"/>  <statusCode code="active"/>  <effectiveTime>
    <low/>    <high/>  </effectiveTime>
  <entryRelationship typeCode="SUBJ" inversionInd="false">
    <!-- template 2.16.840.1.113883.10.22.4.1 'IPS Allergy or Intolerance' (dynamic) -->
  </entryRelationship>
</act>
ItemDTCardConfDescriptionLabel
hl7:act
0 … *R(IPS…ern)
Treetree.png@classCode
cs1 … 1FACT
Treetree.png@moodCode
cs1 … 1FEVN
Treetree.pnghl7:templateId
II1 … 1M(IPS…ern)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.22.4.5
Treetree.pnghl7:id
II0 … *R(IPS…ern)
Treetree.pnghl7:code
CD1 … 1M(IPS…ern)
Treeblank.pngTreetree.png@code
CONF1 … 1FCONC
Treeblank.pngTreetree.png@codeSystem
1 … 1F2.16.840.1.113883.5.6 (ActClass)
Treetree.pnghl7:statusCode
CS1 … 1RAs long as the underlying conditions are of concern to the author (i.e., as long as allergies, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “active”. The concern is tracked by the author.

Only when the underlying allergies are no longer of concern then the statusCode is set to “completed”. The author is no more tracking this concern and no further actions are expected.
(IPS…ern)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.4 ActStatusActiveCompleted (2017‑03‑06)
Treetree.pnghl7:effectiveTime
IVL_TS1 … 1R(IPS…ern)
Treeblank.pngTreetree.pnghl7:low
IVXB_TS1 … 1RThis element asserts when the concern became active. This equates to the time the concern was authored in the patient's chart and the author started tracking this concern.
(IPS…ern)
Treeblank.pngTreetree.pnghl7:high
IVXB_TS0 … 1CThis element asserts when the clinician deemed there is no longer any need to track the underlying conditions.
(IPS…ern)
 ConstraintIf statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
 Schematron assertroleKred.png error 
 testnot(../hl7:statusCode[@code='completed']) or hl7:high 
 MessageIf statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high 
Treetree.pnghl7:entryRelationship
1 … *RContains 2.16.840.1.113883.10.22.4.1 IPS Allergy or Intolerance (DYNAMIC)(IPS…ern)
Treeblank.png where [hl7:observation [hl7:code [concat(@code,@codeSystem)=doc('include/voc-2.16.840.1.113883.11.22.2-DYNAMIC.xml')//valueSet [1]/conceptList/concept/concat(@code,@codeSystem)]]]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FSUBJ
Treeblank.pngTreetree.png@inversionInd
bl0 … 1Ffalse