Templates

Show index

Template UV Use Period 2023‑01‑30 09:55:27

Id2.16.840.1.113883.10.21.9.1
ref
pharmcda-
Effective Date2023‑01‑30 09:55:27
Statusdraft 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)
Used by / Uses
Used by 3 transactions and 13 templates, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.3.1937.777.15.4.6Transactiondraft Create Medication Administration2019‑02‑17
2.16.840.1.113883.3.1937.777.15.4.2Transactiondraft Create Medication Order2017‑05‑10
2.16.840.1.113883.3.1937.777.15.4.4Transactiondraft Create Medication Statement2017‑05‑10
2.16.840.1.113883.2.51.10.40Includeactive XeH Medication Statement (1.0)2021‑10‑19 11:09:33
2.16.840.1.113883.10.21.4.1Includepending UV Medication Order (STU1)2015‑10‑07
2.16.840.1.113883.10.21.4.1Includepending UV Medication Order (R1-STU2-ballot)2021‑08‑04 17:03:38
2.16.840.1.113883.10.21.4.1Includedraft UV Medication Order (2023)2023‑01‑30 08:30:30
2.16.840.1.113883.10.21.4.1Includedraft UV Medication Order (2023)2023‑01‑31 10:52:39
2.16.840.1.113883.10.21.4.1Includedraft UV Medication Order (2023)2023‑01‑31 11:29:28
2.16.840.1.113883.10.21.4.7Includepending UV Medication Statement (STU1)2017‑05‑01
2.16.840.1.113883.10.21.4.7Includepending UV Medication Statement (R1-STU2-ballot)2021‑08‑04 14:09:15
2.16.840.1.113883.10.21.4.7Includedraft UV Medication Statement (2023)2023‑01‑30 08:32:34
2.16.840.1.113883.10.21.4.13Includepending UV Medication Administration (R1-STU2-ballot)2019‑02‑17
2.16.840.1.113883.10.21.4.13Includedraft UV Medication Administration (2023)2023‑01‑30 08:31:37
2.16.840.1.113883.10.22.4.4Includepending IPS Medication Statement (STU1)2016‑11‑11
2.16.840.1.113883.10.22.4.4Includedraft IPS Medication Statement (2021)2021‑09‑02 12:17:54
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)]
hl7: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.
Useperiod
where [hl7:low or
[not(hl7:width)]
@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>
hl7:low
IVXB_TS1 … 1RUseperiod
hl7:high
IVXB_TS0 … 1RUseperiod
hl7: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)
Useperiod
where [hl7:width] [not(hl7:lowor
hl7:high)]
 Example
2 week period
<effectiveTime type="IVL_TS">
  <width value="2" unit="w"/></effectiveTime>
hl7:low
NPUseperiod
hl7:high
NPUseperiod
hl7:center
NPUseperiod
hl7:width
PQ1 … 1RUseperiod
@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)
hl7: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)
Useperiod
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>
hl7:low
IVXB_TS0 … 1CUseperiod
hl7:width
PQ1 … 1RUseperiod
@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)

Template UV Use Period 2017‑05‑02

Id2.16.840.1.113883.10.21.9.1
ref
pharmcda-
Effective Date2017‑05‑02
Statuspending Under pre-publication reviewVersion LabelR1-STU2-ballot
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]
  • hl7:effectiveTime[hl7:width]
hl7: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.
Useperiod
where [hl7:low or
hl7:high]
@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
continous therapy
<effectiveTime xsi:type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="NA"/></effectiveTime>
hl7:low
IVXB_TS1 … 1RUseperiod
hl7:high
IVXB_TS0 … 1RUseperiod
hl7: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)
Useperiod
where [hl7:width]
 Example
2 week period
<effectiveTime xsi:type="IVL_TS">
  <width value="2" unit="w"/></effectiveTime>
hl7:low
NPUseperiod
hl7:width
PQ1 … 1RUseperiod
@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)

Template UV Use Period 2017‑01‑02

Id2.16.840.1.113883.10.21.9.1
ref
pharmcda-
Effective Date2017‑01‑02
Statusretired 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]
hl7:effectiveTime
IVL_TSMedication Regimen PeriodUseperiod
where [1] [hl7:low]
@xsl:type
1 … 1FIVL_TS
hl7:low
TS1 … 1RStart date/timeUseperiod
hl7:high
TS1 … 1REnd date/timeUseperiod
hl7:effectiveTime
IVL_TSMedication Regimen Period width know, exact start/end date/time unknownUseperiod
where [1] [hl7:width]
hl7:width
PQ1 … 1RUseperiod
@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)
hl7:effectiveTime
IVL_TSMedication Regimen Period not applicableUseperiod
where [1] [@nullFlavor]
@nullFlavor
cs1 … 1FNA