Back To Index  <<  Back To Templates

ref Template  UV Use Period

Id 2.16.840.1.113883.10.21.9.1
ref
pharmcda-
 		Effective Date 2017‑05‑02
Other versions this id:
Status draft Draft Version Label
Name Useperiod Display Name UV 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.
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Associated with
Associated with 1 concept
Id Name Data Set
hl7ips-dataelement-103 draft Period of Medication Use draft CEN/TC 251 prEN 17269
Used by / Uses
Used by 0 transactions and 3 templates, Uses 0 templates
Used by as Name Version
2.16.840.1.113883.10.22.4.4 Include draft IPS Medication Statement 2016‑11‑11
2.16.840.1.113883.10.22.3.1 link draft IPS Medication Summary Section 2016‑11‑11
2.16.840.1.113883.10.22.1.1 link draft International Patient Summary 2017‑04‑11
Item DT Card Conf Description Label
Choice 1 … 1
The <effectiveTime> element encodes the use period 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]
hl7:effectiveTime
 IVL_TS 0 … 1 C Case 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 therapy) 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. 		(Usedotsiod)
treeblank where [hl7:low or
hl7:high]
 
target
hl7ips-dataelement-103 draft Period of Medication Use draft CEN/TC 251 prEN 17269
@nullFlavor
 cs 0 … 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
continous therapy
<effectiveTime xsi:type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="NA"/></effectiveTime>
hl7:low
 IVXB_TS 1 … 1 R (Usedotsiod)
hl7:high
 IVXB_TS 0 … 1 R (Usedotsiod)
hl7:effectiveTime
 IVL_TS 0 … 1 C Case 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.....) 		(Usedotsiod)
treeblank where [hl7:width]
 
target
hl7ips-dataelement-103 draft Period of Medication Use draft CEN/TC 251 prEN 17269
  Example
2 week period
<effectiveTime xsi:type="IVL_TS">
  <width value="2" unit="w"/></effectiveTime>
hl7:low
 NP (Usedotsiod)
hl7:width
 PQ 1 … 1 R (Usedotsiod)
@unit
 cs 1 … 1 R
  CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)