Difference between revisions of "2.16.840.1.113883.10.21.9.1"

From HL7 IPS
Jump to: navigation, search
(Automatic ADBot page (caf2be0fdef137dcd6105cf8f4acdc3cce995780))
(Automatic ADBot page (caf2be0fdef137dcd6105cf8f4acdc3cce995780))
 
Line 5: Line 5:
 
=Template ''Useperiod''=
 
=Template ''Useperiod''=
  
<p>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.</p>
+
<p>This element encodes the start and stop time of the medication regimen. This is 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.</p>
 
==Actual version==
 
==Actual version==
 
{{:{{BASEPAGENAME}}/dynamic}}
 
{{:{{BASEPAGENAME}}/dynamic}}
  
 
==List of all versions of this template==
 
==List of all versions of this template==
*[[2.16.840.1.113883.10.21.9.1/static-2017-05-02T000000|2017-05-02 (Under develeopment)]]
+
*[[2.16.840.1.113883.10.21.9.1/static-2023-01-30T095527|2023-01-30 09:55:27 (Under develeopment)]]
 +
*[[2.16.840.1.113883.10.21.9.1/static-2017-05-02T000000|2017-05-02 (Under pre-publication review)]]
 
*[[2.16.840.1.113883.10.21.9.1/static-2017-01-02T000000|2017-01-02 (Retired)]]
 
*[[2.16.840.1.113883.10.21.9.1/static-2017-01-02T000000|2017-01-02 (Retired)]]
<!--597b6fa6bdab38aeeddf9a089c7b1948a28026f6-->
+
<!--2d836cca139bfd73cfd6188a7bbe3a77ae90dee5-->

Latest revision as of 15:09, 31 January 2023

Comments on this page

Template Useperiod

This element encodes the start and stop time of the medication regimen. This is 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.

Actual version

Id2.16.840.1.113883.10.21.9.1Effective Date2023‑01‑30 09:55:27
Other versions this id:
  • Kblank.png Useperiod as of 2017‑05‑02
  • Kblank.png Useperiod as of 2017‑01‑02
StatusKyellow.png DraftVersion Label2023
NameUseperiodDisplay NameUV Use Period
Description
This element encodes the start and stop time of the medication regimen. This is 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)
ItemDTCardConfDescriptionLabel
Choice1 … 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][not(hl7:width)]
  • hl7:effectiveTime[hl7:width][not(hl7:low|hl7:high)]
  • hl7:effectiveTime[hl7:low | hl7:width][not(hl7:high)]
Treetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 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 (continuous 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 a prescription that has not been refilled 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)
where [hl7:low or
[not(hl7:width)]
Treeblank.pngTreetree.png@nullFlavor
cs0 … 1 
 Example
Known Interval
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high value="20140321"/></effectiveTime>
 Example
Information not available about the period
<effectiveTime type="IVL_TS" nullFlavor="NI"/>
 Example
Unknown end date
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="UNK"/></effectiveTime>
 Example
continous therapy
<effectiveTime 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 … 1CCase 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)
where [hl7:width] [not(hl7:lowor
hl7:high)]
 Example
2 week period
<effectiveTime type="IVL_TS">
  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreetree.pnghl7:low
NP(Use...iod)
Treeblank.pngTreetree.pnghl7:high
NP(Use...iod)
Treeblank.pngTreetree.pnghl7:center
NP(Use...iod)
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)
Treetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 3: anchored period:
The width element is used to specify a period of (actual or intended) administration anchored to a specific date (e.g. a two weeks therapy starting today)
(Use...iod)
where [hl7:low or
[not(hl7:high)]
 Example
2 week period starting on 2013-03-21
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreetree.pnghl7:low
IVXB_TS0 … 1C(Use...iod)
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)


List of all versions of this template