Difference between revisions of "2.16.840.1.113883.10.21.9.1/static-2017-05-02T000000"

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.21.9.1</td><th style="width: 20em; text-align: left;">Effective Date</th><td style="text-align: left;"> valid from 2017‑05‑02<p></p>There are versions of templates with this id:<ul><li>Useperiod as of 2017‑05‑02</li><li>Useperiod as of 2017‑01‑02</li></ul></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;">Useperiod</td><th style="width: 20em; text-align: left;">Display Name</th><td style="text-align: left;">UV Use Period</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>This element encodes the start and stop time of the medication regimen. This an interval of time (xsi:type='IVL_TS'), and must be specified as shown.  This is an additional constraint placed upon CDA Release 2.0 by this profile,  and simplifies the exchange of start/stop and frequency information between EMR systems.</div></td></tr></table></td><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 0 templates</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.21.4.1</td><td style="text-align: left;">Include</td><td style="text-align: left;">[[File:Kyellow.png|14px]] UV Medication Order</td><td style="text-align: left;">2015‑10‑07</td></tr><tr><td style="text-align: left;">2.16.840.1.113883.10.21.4.7</td><td style="text-align: left;">Include</td><td style="text-align: left;">[[File:Kyellow.png|14px]] UV Medication Statement</td><td style="text-align: left;">2017‑05‑01</td></tr></table></div></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 class="choice"><td style="font-style: italic;" colspan="2">Choice</td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td></td><td colspan="2"><div>The &lt;effectiveTime&gt; element encodes the period of administration of the medication, it is always expressed as an interval of time.<br />It may be expressed using the &lt;low&gt; and &lt;high&gt; OR with the &lt;width&gt; element.<br />The first is used to indicate a specified interval (e.g. from march 15th, 2017); the latter for indicating a 'floating' period (e.g. 2 weeks).</div>Elements to choose from:<ul><li>hl7:effectiveTime[hl7:low | hl7:high]</li><li>hl7:effectiveTime[hl7:width]</li></ul></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>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td><b>Case 1: specified interval</b><br />The &lt;low&gt; and &lt;high&gt; values of the first &lt;effectiveTime&gt; element represent the start and stop times for the medication. The &lt;low&gt; value represents the start time, and the                        &lt;high&gt; value represents the stop time. If either the &lt;low&gt; or the &lt;high&gt; value is unknown, this shall be recorded by setting the nullFlavor attribute to UNK.<br /><br />In case of unbounded period (continous terapy) the &lt;high&gt; element will be valued with the nullFlavor attribute to NA.<br /><br />The &lt;high&gt; value records the end of the medication regime according to the information provided in the prescription or order. For example, if the prescription is for enough medication to last 30 days, then the high value should contain a date that is 30 days later then the &lt;low&gt; value. The rationale is that a provider, seeing an un-refilled prescription would normally assume that the medication is no longer being taken, even if the intent of the treatment plan is to continue the medication indefinitely.</td><td style="background-color: #FFEEEE;"><span title="">(Use…iod)</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:low </i>or<br /><i> hl7:high]</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>@nullFlavor<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>0 … 1</strong></span></td><td> </td><td style="vertical-align: top;" colspan="2"></td></tr><tr class="explabel " style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td>Example</td><td colspan="4" class="explabelblue"><div>Known Interval</div><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span> <span class="ppattribute">xsi:type</span><span class="ppsign">="</span><span class="ppcontent">IVL_TS</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">low</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">20130321</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">high</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">20140321</span><span class="ppsign">"</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></tt></td></tr><tr class="explabel " style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td>Example</td><td colspan="4" class="explabelblue"><div>Information not available about the period</div><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span> <span class="ppattribute">xsi:type</span><span class="ppsign">="</span><span class="ppcontent">IVL_TS</span><span class="ppsign">"</span> <span class="ppattribute">nullFlavor</span><span class="ppsign">="</span><span class="ppcontent">NI</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span></tt></td></tr><tr class="explabel " style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td>Example</td><td colspan="4" class="explabelblue"><div>Unknown end date</div><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span> <span class="ppattribute">xsi:type</span><span class="ppsign">="</span><span class="ppcontent">IVL_TS</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">low</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">20130321</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">high</span> <span class="ppattribute">nullFlavor</span><span class="ppsign">="</span><span class="ppcontent">UNK</span><span class="ppsign">"</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></tt></td></tr><tr class="explabel " style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td>Example</td><td colspan="4" class="explabelblue"><div>Continuous terapy</div><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span> <span class="ppattribute">xsi:type</span><span class="ppsign">="</span><span class="ppcontent">IVL_TS</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">low</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">20130321</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">high</span> <span class="ppattribute">nullFlavor</span><span class="ppsign">="</span><span class="ppcontent">NA</span><span class="ppsign">"</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></tt></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></td><td style="background-color: #FFEEEE;"><span title="">(Use…iod)</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>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(Use…iod)</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:effectiveTime<br /></strong></tt></td></tr></table></td><td><strong>IVL_TS</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td><b>Case 2: 'floating' period:</b><br />The width element is used to specify a period of (actual or intended) administration that is not anchored to any specific date (e.g. a two weeks therapy.....)</td><td style="background-color: #FFEEEE;"><span title="">(Use…iod)</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:width]</i></td></tr></table></td><td></td></tr><tr class="explabel " style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td>Example</td><td colspan="4" class="explabelblue"><div>2 week period</div><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span> <span class="ppattribute">xsi:type</span><span class="ppsign">="</span><span class="ppcontent">IVL_TS</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">width</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">2</span><span class="ppsign">"</span> <span class="ppattribute">unit</span><span class="ppsign">="</span><span class="ppcontent">w</span><span class="ppsign">"</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></tt></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:width<br /></strong></tt></td></tr></table></td><td><strong>PQ</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="">(Use…iod)</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:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@unit<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>1 … 1</strong></span></td><td>R</td><td style="vertical-align: top;" colspan="2"></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 @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 <i>Medication Time Units (UCUM) </i>(DYNAMIC)</td></tr></table></td></tr></table></td></tr></table>
+
<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.21.9.1</td><th style="width: 20em; text-align: left;">Effective Date</th><td style="text-align: left;"> valid from 2017‑05‑02<p></p>There are versions of templates with this id:<ul><li>Useperiod as of 2017‑05‑02</li><li>Useperiod as of 2017‑01‑02</li></ul></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;">Useperiod</td><th style="width: 20em; text-align: left;">Display Name</th><td style="text-align: left;">UV Use Period</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>This element encodes the start and stop time of the medication regimen. This an interval of time (xsi:type='IVL_TS'), and must be specified as shown.  This is an additional constraint placed upon CDA Release 2.0 by this profile,  and simplifies the exchange of start/stop and frequency information between EMR systems.</div></td></tr></table></td><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 0 templates</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.21.4.1</td><td style="text-align: left;">Include</td><td style="text-align: left;">[[File:Kyellow.png|14px]] UV Medication Order</td><td style="text-align: left;">2015‑10‑07</td></tr><tr><td style="text-align: left;">2.16.840.1.113883.10.21.4.7</td><td style="text-align: left;">Include</td><td style="text-align: left;">[[File:Kyellow.png|14px]] UV Medication Statement</td><td style="text-align: left;">2017‑05‑01</td></tr></table></div></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 class="choice"><td style="font-style: italic;" colspan="2">Choice</td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td></td><td colspan="2"><div>The &lt;effectiveTime&gt; element encodes the period of administration of the medication, it is always expressed as an interval of time.<br />It may be expressed using the &lt;low&gt; and &lt;high&gt; OR with the &lt;width&gt; element.<br />The first is used to indicate a specified interval (e.g. from march 15th, 2017); the latter for indicating a 'floating' period (e.g. 2 weeks).</div>Elements to choose from:<ul><li>hl7:effectiveTime[hl7:low | hl7:high]</li><li>hl7:effectiveTime[hl7:width]</li></ul></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="artdecor" 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>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td><b>Case 1: specified interval</b><br />The &lt;low&gt; and &lt;high&gt; values of the first &lt;effectiveTime&gt; element represent the start and stop times for the medication. The &lt;low&gt; value represents the start time, and the                        &lt;high&gt; value represents the stop time. If either the &lt;low&gt; or the &lt;high&gt; value is unknown, this shall be recorded by setting the nullFlavor attribute to UNK.<br /><br />In case of unbounded period (continous terapy) the &lt;high&gt; element will be valued with the nullFlavor attribute to NA.<br /><br />The &lt;high&gt; value records the end of the medication regime according to the information provided in the prescription or order. For example, if the prescription is for enough medication to last 30 days, then the high value should contain a date that is 30 days later then the &lt;low&gt; value. The rationale is that a provider, seeing an un-refilled prescription would normally assume that the medication is no longer being taken, even if the intent of the treatment plan is to continue the medication indefinitely.</td><td style="background-color: #FFEEEE;"><span title="">(Use…iod)</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:low </i>or<br /><i> hl7:high]</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>@nullFlavor<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>0 … 1</strong></span></td><td> </td><td style="vertical-align: top;" colspan="2"></td></tr><tr class="explabel" style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td>Example</td><td colspan="4" class="explabelblue"><div>Known Interval</div><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span> <span class="ppattribute">xsi:type</span><span class="ppsign">="</span><span class="ppcontent">IVL_TS</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">low</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">20130321</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">high</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">20140321</span><span class="ppsign">"</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></tt></td></tr><tr class="explabel" style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td>Example</td><td colspan="4" class="explabelblue"><div>Information not available about the period</div><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span> <span class="ppattribute">xsi:type</span><span class="ppsign">="</span><span class="ppcontent">IVL_TS</span><span class="ppsign">"</span> <span class="ppattribute">nullFlavor</span><span class="ppsign">="</span><span class="ppcontent">NI</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span></tt></td></tr><tr class="explabel" style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td>Example</td><td colspan="4" class="explabelblue"><div>Unknown end date</div><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span> <span class="ppattribute">xsi:type</span><span class="ppsign">="</span><span class="ppcontent">IVL_TS</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">low</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">20130321</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">high</span> <span class="ppattribute">nullFlavor</span><span class="ppsign">="</span><span class="ppcontent">UNK</span><span class="ppsign">"</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></tt></td></tr><tr class="explabel" style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td>Example</td><td colspan="4" class="explabelblue"><div>Continuous terapy</div><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span> <span class="ppattribute">xsi:type</span><span class="ppsign">="</span><span class="ppcontent">IVL_TS</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">low</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">20130321</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">high</span> <span class="ppattribute">nullFlavor</span><span class="ppsign">="</span><span class="ppcontent">NA</span><span class="ppsign">"</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></tt></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td 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>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></td><td style="background-color: #FFEEEE;"><span title="">(Use…iod)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td 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>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>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(Use…iod)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="artdecor" 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>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td><b>Case 2: 'floating' period:</b><br />The width element is used to specify a period of (actual or intended) administration that is not anchored to any specific date (e.g. a two weeks therapy.....)</td><td style="background-color: #FFEEEE;"><span title="">(Use…iod)</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:width]</i></td></tr></table></td><td></td></tr><tr class="explabel" style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td>Example</td><td colspan="4" class="explabelblue"><div>2 week period</div><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">effectiveTime</span> <span class="ppattribute">xsi:type</span><span class="ppsign">="</span><span class="ppcontent">IVL_TS</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">width</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">2</span><span class="ppsign">"</span> <span class="ppattribute">unit</span><span class="ppsign">="</span><span class="ppcontent">w</span><span class="ppsign">"</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></tt></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td 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>hl7:width<br /></strong></tt></td></tr></table></td><td><strong>PQ</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="">(Use…iod)</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:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@unit<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>1 … 1</strong></span></td><td>R</td><td style="vertical-align: top;" colspan="2"></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 @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 <i>Medication Time Units (UCUM) </i>(DYNAMIC)</td></tr></table></td></tr></table></td></tr></table>

Revision as of 17:17, 27 July 2017

Id2.16.840.1.113883.10.21.9.1Effective Date valid from 2017‑05‑02

There are versions of templates with this id:
  • Useperiod as of 2017‑05‑02
  • Useperiod as of 2017‑01‑02
StatusKyellow.png DraftVersion Label
NameUseperiodDisplay NameUV Use Period
Description
This element encodes the start and stop time of the medication regimen. This an interval of time (xsi:type='IVL_TS'), and must be specified as shown. This is an additional constraint placed upon CDA Release 2.0 by this profile, and simplifies the exchange of start/stop and frequency information between EMR systems.
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 2 templates, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.10.21.4.1IncludeKyellow.png UV Medication Order2015‑10‑07
2.16.840.1.113883.10.21.4.7IncludeKyellow.png UV Medication Statement2017‑05‑01
ItemDTCardConfDescriptionLabel
Choice1 … 1
The <effectiveTime> element encodes the period of administration of the medication, it is always expressed as an interval of time.
It may be expressed using the <low> and <high> OR with the <width> element.
The first is used to indicate a specified interval (e.g. from march 15th, 2017); the latter for indicating a 'floating' period (e.g. 2 weeks).
Elements to choose from:
  • hl7:effectiveTime[hl7:low | hl7:high]
  • hl7:effectiveTime[hl7:width]
Treetree.pnghl7:effectiveTime
IVL_TS0 … 1RCase 1: specified interval
The <low> and <high> values of the first <effectiveTime> element represent the start and stop times for the medication. The <low> value represents the start time, and the <high> value represents the stop time. If either the <low> or the <high> value is unknown, this shall be recorded by setting the nullFlavor attribute to UNK.

In case of unbounded period (continous terapy) the <high> element will be valued with the nullFlavor attribute to NA.

The <high> value records the end of the medication regime according to the information provided in the prescription or order. For example, if the prescription is for enough medication to last 30 days, then the high value should contain a date that is 30 days later then the <low> value. The rationale is that a provider, seeing an un-refilled prescription would normally assume that the medication is no longer being taken, even if the intent of the treatment plan is to continue the medication indefinitely.
(Use…iod)
Treeblank.png where [hl7:low or
hl7:high]
Treeblank.pngTreetree.png@nullFlavor
cs0 … 1 
 Example
Known Interval
<effectiveTime xsi:type="IVL_TS">
  <low value="20130321"/>  <high value="20140321"/></effectiveTime>
 Example
Information not available about the period
<effectiveTime xsi:type="IVL_TS" nullFlavor="NI"/>
 Example
Unknown end date
<effectiveTime xsi:type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="UNK"/></effectiveTime>
 Example
Continuous terapy
<effectiveTime xsi:type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="NA"/></effectiveTime>
Treeblank.pngTreetree.pnghl7:low
IVXB_TS1 … 1R(Use…iod)
Treeblank.pngTreetree.pnghl7:high
IVXB_TS0 … 1R(Use…iod)
Treetree.pnghl7:effectiveTime
IVL_TS0 … 1RCase 2: 'floating' period:
The width element is used to specify a period of (actual or intended) administration that is not anchored to any specific date (e.g. a two weeks therapy.....)
(Use…iod)
Treeblank.png where [hl7:width]
 Example
2 week period
<effectiveTime xsi:type="IVL_TS">
  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreetree.pnghl7:width
PQ1 … 1R(Use…iod)
Treeblank.pngTreeblank.pngTreetree.png@unit
cs1 … 1R
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)