Difference between revisions of "2.16.840.1.113883.10.21.9.1/static-2017-01-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‑01‑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:Kvalidblue.png|12px]] Retired</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.  
+
<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‑01‑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:Kvalidblue.png|12px]] Retired</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 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">Take medication from 27-05-2011 (start) to 03-06-2011 (end)</span></td></tr><tr><td><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">20110527000000+0200</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">20110603235959+0200</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></table></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">Take medication from 27-05-2011 (start) for one week</span></td></tr><tr><td><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">20110527000000+0200</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">width</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">1</span><span class="ppsign">"</span> <span class="ppattribute">unit</span><span class="ppsign">="</span><span class="ppcontent">wk</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></table></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">Take medication from 27-05-2011 on (start), end open</span></td></tr><tr><td><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">20110527000000+0200</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></table></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">Take medication for two weeks, start open</span></td></tr><tr><td><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">wk</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></table></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">Information about the Medication Regimen Period not applicable</span></td></tr><tr><td><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">NA</span><span class="ppsign">"</span><span class="ppsign">/</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 class="choice"><td style="font-style: italic;" colspan="2">Choice</td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td></td><td colspan="2">Elements to choose from:<ul><li>hl7:effectiveTime[1][hl7:low]</li><li>hl7:effectiveTime[1][hl7:width]</li><li>hl7:effectiveTime[1][@nullFlavor]</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></strong></span></td><td><span style="color: color: black;"><strong></strong></span></td><td>Medication Regimen Period</td><td style="background-color: #FFEEEE;"><span title="">Useperiod</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> [1] [hl7:low]</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>@xsl:type<br /></strong></tt></td></tr></table></td><td></td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">IVL_TS</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>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>Start date/time</td><td style="background-color: #FFEEEE;"><span title="">Useperiod</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>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>End date/time</td><td style="background-color: #FFEEEE;"><span title="">Useperiod</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></strong></span></td><td><span style="color: color: black;"><strong></strong></span></td><td>Medication Regimen Period width know, exact start/end date/time unknown</td><td style="background-color: #FFEEEE;"><span title="">Useperiod</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> [1] [hl7:width]</i></td></tr></table></td><td></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="">Useperiod</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>0 … 1</strong></span></td><td> </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><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></strong></span></td><td><span style="color: color: black;"><strong></strong></span></td><td>Medication Regimen Period not applicable</td><td style="background-color: #FFEEEE;"><span title="">Useperiod</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> [1] [@nullFlavor]</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>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">NA</td></tr></table></td></tr></table>
                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 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">Take medication from 27-05-2011 (start) to 03-06-2011 (end)</span></td></tr><tr><td><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">20110527000000+0200</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">20110603235959+0200</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></table></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">Take medication from 27-05-2011 (start) for one week</span></td></tr><tr><td><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">20110527000000+0200</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">width</span> <span class="ppattribute">value</span><span class="ppsign">="</span><span class="ppcontent">1</span><span class="ppsign">"</span> <span class="ppattribute">unit</span><span class="ppsign">="</span><span class="ppcontent">wk</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></table></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">Take medication from 27-05-2011 on (start), end open</span></td></tr><tr><td><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">20110527000000+0200</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></table></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">Take medication for two weeks, start open</span></td></tr><tr><td><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">wk</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></table></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">Information about the Medication Regimen Period not applicable</span></td></tr><tr><td><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">NA</span><span class="ppsign">"</span><span class="ppsign">/</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 class="choice"><td style="font-style: italic;" colspan="2">Choice</td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td></td><td colspan="2">Elements to choose from:<ul><li>hl7:effectiveTime[1][hl7:low]</li><li>hl7:effectiveTime[1][hl7:width]</li><li>hl7:effectiveTime[1][@nullFlavor]</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></strong></span></td><td><span style="color: color: black;"><strong></strong></span></td><td>Medication Regimen Period</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> [1] [hl7:low]</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>@xsl:type<br /></strong></tt></td></tr></table></td><td></td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">IVL_TS</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>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>Start date/time</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>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>End date/time</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></strong></span></td><td><span style="color: color: black;"><strong></strong></span></td><td>Medication Regimen Period width know, exact start/end date/time unknown</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> [1] [hl7:width]</i></td></tr></table></td><td></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></td><td><span><strong>0 … 1</strong></span></td><td> </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><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></strong></span></td><td><span style="color: color: black;"><strong></strong></span></td><td>Medication Regimen Period not applicable</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> [1] [@nullFlavor]</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></td><td><span><strong>1 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">NA</td></tr></table></td></tr></table>
 

Revision as of 13:51, 26 March 2018

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

There are versions of templates with this id:
  • Useperiod as of 2017‑05‑02
  • Useperiod as of 2017‑01‑02
StatusKvalidblue.png RetiredVersion 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)
Example
Take medication from 27-05-2011 (start) to 03-06-2011 (end)
<effectiveTime xsi:type="IVL_TS">
  <low value="20110527000000+0200"/>  <high value="20110603235959+0200"/></effectiveTime>
Example
Take medication from 27-05-2011 (start) for one week
<effectiveTime xsi:type="IVL_TS">
  <low value="20110527000000+0200"/>  <width value="1" unit="wk"/></effectiveTime>
Example
Take medication from 27-05-2011 on (start), end open
<effectiveTime xsi:type="IVL_TS">
  <low value="20110527000000+0200"/>  <high nullFlavor="UNK"/></effectiveTime>
Example
Take medication for two weeks, start open
<effectiveTime xsi:type="IVL_TS">
  <width value="2" unit="wk"/></effectiveTime>
Example
Information about the Medication Regimen Period not applicable
<effectiveTime xsi:type="IVL_TS" nullFlavor="NA"/>
ItemDTCardConfDescriptionLabel
Choice0 … 1Elements to choose from:
  • hl7:effectiveTime[1][hl7:low]
  • hl7:effectiveTime[1][hl7:width]
  • hl7:effectiveTime[1][@nullFlavor]
Treetree.pnghl7:effectiveTime
IVL_TSMedication Regimen PeriodUseperiod
Treeblank.png where [1] [hl7:low]
Treeblank.pngTreetree.png@xsl:type
1 … 1FIVL_TS
Treeblank.pngTreetree.pnghl7:low
TS1 … 1RStart date/timeUseperiod
Treeblank.pngTreetree.pnghl7:high
TS1 … 1REnd date/timeUseperiod
Treetree.pnghl7:effectiveTime
IVL_TSMedication Regimen Period width know, exact start/end date/time unknownUseperiod
Treeblank.png where [1] [hl7:width]
Treeblank.pngTreetree.pnghl7:width
PQ1 … 1RUseperiod
Treeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)
Treetree.pnghl7:effectiveTime
IVL_TSMedication Regimen Period not applicableUseperiod
Treeblank.png where [1] [@nullFlavor]
Treeblank.pngTreetree.png@nullFlavor
cs1 … 1FNA