DaVinci Payer Data Exchange (PDex) US Drug Formulary
2.1.0 - STU 3 (ci-build)
DaVinci Payer Data Exchange (PDex) US Drug Formulary
2.1.0 - STU 3 (ci-build)
DaVinci Payer Data Exchange (PDex) US Drug Formulary, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-formulary/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension | Version: 2.1.0 | |||
| Standards status: Trial-use | Computable Name: QuantityLimitDetail | |||
A detailed definition of the quantity limits the coverage plan imposes on this drug. These limit details may include (potentially including a rolling dispense limit, maximum daily, or therapy days for a period of time. (Only include if QuantityLimit = true)
Context of Use
This extension may be used on the following element(s):
Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Summary
Complex Extension: A detailed definition of the quantity limits the coverage plan imposes on this drug. These limit details may include (potentially including a rolling dispense limit, maximum daily, or therapy days for a period of time. (Only include if QuantityLimit = true)
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension |
0..* | Extension | Quantity Limit Detail | |
  extension |
1..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:Description |
0..1 | Extension | A human readable description of quantity limits. | |
  extension |
0..0 | |||
| url |
1..1 | uri | "Description" | |
  value[x] |
1..1 | string | Value of extension | |
| extension:Rolling |
0..1 | Extension | Indicator of dispense amount limit per time period. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "Rolling" | |
  value[x] |
1..1 | Timing | Value of extension | |
 event |
0..0 | |||
 repeat |
1..1 | Element | When the event is to occur | |
| count |
1..1 | positiveInt | Number of times to repeat | |
| period |
1..1 | decimal | Event occurs frequency times per period | |
 periodUnit |
0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Required Pattern: d | |
| extension:MaximumDaily |
0..1 | Extension | Indicator of maximum daily amount. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "MaximumDaily" | |
| value[x] |
1..1 | Quantity | Value of extension | |
| value |
1..1 | decimal | Numerical value (with implicit precision) | |
 extension:DaysSupply |
0..1 | Extension | Indicator of number of therapy days over time period. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "DaysSupply" | |
| value[x] |
1..1 | Timing | Value of extension | |
| event |
0..0 | |||
| repeat |
1..1 | Element | When the event is to occur | |
| bounds[x] |
1..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | |
| value |
1..1 | decimal | Numerical value (with implicit precision) | |
| system |
0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | |
| code |
0..1 | code | Coded form of the unit Required Pattern: d | |
| count |
1..1 | positiveInt | Number of times to repeat | |
| period |
1..1 | decimal | Event occurs frequency times per period | |
| periodUnit |
0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Required Pattern: d | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Quantity Limit Detail | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:Description |
0..1 | Extension | A human readable description of quantity limits. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "Description" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:Rolling |
0..1 | Extension | Indicator of dispense amount limit per time period. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "Rolling" | |
| value[x] |
1..1 | Timing | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| repeat |
ΣC | 1..1 | Element | When the event is to occur |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
 bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |
| boundsDuration |
Duration | |||
| boundsRange |
Range | |||
| boundsPeriod |
Period | |||
| count |
Σ | 1..1 | positiveInt | Number of times to repeat |
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat |
| duration |
Σ | 0..1 | decimal | How long when it happens |
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) |
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period |
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
| period |
Σ | 1..1 | decimal | Event occurs frequency times per period |
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Required Pattern: d |
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| timeOfDay |
Σ | 0..* | time | Time of day for action |
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| extension:MaximumDaily |
0..1 | Extension | Indicator of maximum daily amount. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "MaximumDaily" | |
| value[x] |
1..1 | Quantity | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit |
Σ | 0..1 | string | Unit representation |
| system |
ΣC | 0..1 | uri | System that defines coded unit form |
| code |
Σ | 0..1 | code | Coded form of the unit |
| extension:DaysSupply |
0..1 | Extension | Indicator of number of therapy days over time period. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "DaysSupply" | |
| value[x] |
1..1 | Timing | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| repeat |
ΣC | 1..1 | Element | When the event is to occur |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| bounds[x] |
Σ | 1..1 | Duration | Length/Range of lengths, or (Start and/or end) limits |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit |
Σ | 0..1 | string | Unit representation |
| system |
ΣC | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org |
| code |
Σ | 0..1 | code | Coded form of the unit Required Pattern: d |
| count |
Σ | 1..1 | positiveInt | Number of times to repeat |
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat |
| duration |
Σ | 0..1 | decimal | How long when it happens |
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) |
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period |
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
| period |
Σ | 1..1 | decimal | Event occurs frequency times per period |
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Required Pattern: d |
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| timeOfDay |
Σ | 0..* | time | Time of day for action |
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| url |
1..1 | uri | "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: A detailed definition of the quantity limits the coverage plan imposes on this drug. These limit details may include (potentially including a rolling dispense limit, maximum daily, or therapy days for a period of time. (Only include if QuantityLimit = true)
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Quantity Limit Detail | |
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:Description |
0..1 | Extension | A human readable description of quantity limits. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "Description" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:Rolling |
0..1 | Extension | Indicator of dispense amount limit per time period. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "Rolling" | |
| value[x] |
1..1 | Timing | Value of extension | |
| event |
0..0 | |||
| repeat |
1..1 | Element | When the event is to occur | |
| count |
1..1 | positiveInt | Number of times to repeat | |
| period |
1..1 | decimal | Event occurs frequency times per period | |
| periodUnit |
0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Required Pattern: d | |
| extension:MaximumDaily |
0..1 | Extension | Indicator of maximum daily amount. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "MaximumDaily" | |
| value[x] |
1..1 | Quantity | Value of extension | |
| value |
1..1 | decimal | Numerical value (with implicit precision) | |
| extension:DaysSupply |
0..1 | Extension | Indicator of number of therapy days over time period. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "DaysSupply" | |
| value[x] |
1..1 | Timing | Value of extension | |
| event |
0..0 | |||
| repeat |
1..1 | Element | When the event is to occur | |
| bounds[x] |
1..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | |
| value |
1..1 | decimal | Numerical value (with implicit precision) | |
| system |
0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | |
| code |
0..1 | code | Coded form of the unit Required Pattern: d | |
| count |
1..1 | positiveInt | Number of times to repeat | |
| period |
1..1 | decimal | Event occurs frequency times per period | |
| periodUnit |
0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Required Pattern: d | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Quantity Limit Detail | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:Description |
0..1 | Extension | A human readable description of quantity limits. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "Description" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:Rolling |
0..1 | Extension | Indicator of dispense amount limit per time period. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "Rolling" | |
| value[x] |
1..1 | Timing | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| repeat |
ΣC | 1..1 | Element | When the event is to occur |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |
| boundsDuration |
Duration | |||
| boundsRange |
Range | |||
| boundsPeriod |
Period | |||
| count |
Σ | 1..1 | positiveInt | Number of times to repeat |
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat |
| duration |
Σ | 0..1 | decimal | How long when it happens |
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) |
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period |
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
| period |
Σ | 1..1 | decimal | Event occurs frequency times per period |
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Required Pattern: d |
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| timeOfDay |
Σ | 0..* | time | Time of day for action |
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| extension:MaximumDaily |
0..1 | Extension | Indicator of maximum daily amount. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "MaximumDaily" | |
| value[x] |
1..1 | Quantity | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit |
Σ | 0..1 | string | Unit representation |
| system |
ΣC | 0..1 | uri | System that defines coded unit form |
| code |
Σ | 0..1 | code | Coded form of the unit |
| extension:DaysSupply |
0..1 | Extension | Indicator of number of therapy days over time period. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "DaysSupply" | |
| value[x] |
1..1 | Timing | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| repeat |
ΣC | 1..1 | Element | When the event is to occur |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| bounds[x] |
Σ | 1..1 | Duration | Length/Range of lengths, or (Start and/or end) limits |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit |
Σ | 0..1 | string | Unit representation |
| system |
ΣC | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org |
| code |
Σ | 0..1 | code | Coded form of the unit Required Pattern: d |
| count |
Σ | 1..1 | positiveInt | Number of times to repeat |
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat |
| duration |
Σ | 0..1 | decimal | How long when it happens |
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) |
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period |
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
| period |
Σ | 1..1 | decimal | Event occurs frequency times per period |
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Required Pattern: d |
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| timeOfDay |
Σ | 0..* | time | Time of day for action |
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| url |
1..1 | uri | "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code | URI |
| Extension.extension:Rolling.value[x].repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | |
| Extension.extension:Rolling.value[x].repeat.periodUnit | required | Pattern: dhttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | |
| Extension.extension:Rolling.value[x].repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | |
| Extension.extension:Rolling.value[x].repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | |
| Extension.extension:Rolling.value[x].code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | |
| Extension.extension:MaximumDaily.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | |
| Extension.extension:DaysSupply.value[x].repeat.bounds[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | |
| Extension.extension:DaysSupply.value[x].repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | |
| Extension.extension:DaysSupply.value[x].repeat.periodUnit | required | Pattern: dhttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | |
| Extension.extension:DaysSupply.value[x].repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | |
| Extension.extension:DaysSupply.value[x].repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | |
| Extension.extension:DaysSupply.value[x].code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard |
IG © 2022+ HL7 International / Pharmacy. Package hl7.fhir.us.davinci-drug-formulary#2.1.0 based on FHIR 4.0.1. Generated 2024-09-24
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change