DaVinci Payer Data Exchange (PDex) US Drug Formulary
2.0.0 - STU 2 United States of America flag

DaVinci Payer Data Exchange (PDex) US Drug Formulary, published by HL7 Pharmacy Working Group. This is not an authorized publication; it is the continuous build for version 2.0.0). 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

Extension: Quantity Limit Detail

Official URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension Version: 2.0.0
Active as of 2022-08-25 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):

  • Element

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Mandatory: 1 element (17 nested mandatory elements)
Fixed Value: 5 elements
Prohibited: 7 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this
  • The element Extension.extension.valueTiming.repeat.bounds[x] is sliced based on the value of type:$this

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionQuantity Limit Detail
... extension 1..*ExtensionExtension
... extension:Description 0..1ExtensionA human readable description of quantity limits.
.... extension 0..0
.... url 1..1uri"Description"
.... value[x] 1..1stringValue of extension
... extension:Rolling 0..1ExtensionIndicator of dispense amount limit per time period.
.... extension 0..0
.... url 1..1uri"Rolling"
.... value[x] 1..1TimingValue of extension
Slice: Unordered, Open by type:$this
.... valueTiming 1..1TimingValue of extension
..... event 0..0
..... repeat 1..1ElementWhen the event is to occur
...... count 1..1positiveIntNumber of times to repeat
...... period 1..1decimalEvent occurs frequency times per period
...... periodUnit 0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Required Pattern: d
.... extension 0..0
.... url 1..1uri"MaximumDaily"
.... value[x] 1..1QuantityValue of extension
Slice: Unordered, Open by type:$this
.... valueQuantity 1..1QuantityValue of extension
..... value 1..1decimalNumerical value (with implicit precision)
... extension:DaysSupply 0..1ExtensionIndicator of number of therapy days over time period.
.... extension 0..0
.... url 1..1uri"DaysSupply"
.... value[x] 1..1TimingValue of extension
Slice: Unordered, Open by type:$this
.... valueTiming 1..1TimingValue of extension
..... event 0..0
..... repeat 1..1ElementWhen the event is to occur
...... bounds[x] 1..1DurationLength/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Open by type:$this
...... boundsDuration 1..1DurationLength/Range of lengths, or (Start and/or end) limits
....... value 1..1decimalNumerical value (with implicit precision)
....... system 0..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
....... code 0..1codeCoded form of the unit
Required Pattern: d
...... count 1..1positiveIntNumber of times to repeat
...... period 1..1decimalEvent occurs frequency times per period
...... periodUnit 0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Required Pattern: d
... url 1..1uri"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionQuantity Limit Detail
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:Description 0..1ExtensionA human readable description of quantity limits.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"Description"
.... value[x] 1..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"Rolling"
.... Slices for value[x] 1..1TimingValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueTiming 1..1TimingValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... repeat ΣI1..1ElementWhen the event is to occur
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... bounds[x] Σ0..1Length/Range of lengths, or (Start and/or end) limits
........ boundsDurationDuration
........ boundsRangeRange
........ boundsPeriodPeriod
....... count Σ1..1positiveIntNumber of times to repeat
....... countMax Σ0..1positiveIntMaximum number of times to repeat
....... duration Σ0..1decimalHow long when it happens
....... durationMax Σ0..1decimalHow long when it happens (Max)
....... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

....... frequency Σ0..1positiveIntEvent occurs frequency times per period
....... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
....... period Σ1..1decimalEvent occurs frequency times per period
....... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
....... periodUnit Σ0..1codes | 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..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
....... timeOfDay Σ0..*timeTime of day for action
....... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


....... offset Σ0..1unsignedIntMinutes from event (before or after)
...... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

... extension:MaximumDaily 0..1ExtensionIndicator of maximum daily amount.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"MaximumDaily"
.... Slices for value[x] 1..1QuantityValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueQuantity 1..1QuantityValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ1..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ0..1stringUnit representation
...... system ΣI0..1uriSystem that defines coded unit form
...... code Σ0..1codeCoded form of the unit
... extension:DaysSupply 0..1ExtensionIndicator of number of therapy days over time period.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"DaysSupply"
.... Slices for value[x] 1..1TimingValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueTiming 1..1TimingValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... repeat ΣI1..1ElementWhen the event is to occur
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... Slices for bounds[x] Σ1..1DurationLength/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Closed by type:$this
........ bounds[x]:boundsDuration Σ1..1DurationLength/Range of lengths, or (Start and/or end) limits
......... id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... value Σ1..1decimalNumerical value (with implicit precision)
......... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

......... unit Σ0..1stringUnit representation
......... system ΣI0..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
......... code Σ0..1codeCoded form of the unit
Required Pattern: d
....... count Σ1..1positiveIntNumber of times to repeat
....... countMax Σ0..1positiveIntMaximum number of times to repeat
....... duration Σ0..1decimalHow long when it happens
....... durationMax Σ0..1decimalHow long when it happens (Max)
....... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

....... frequency Σ0..1positiveIntEvent occurs frequency times per period
....... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
....... period Σ1..1decimalEvent occurs frequency times per period
....... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
....... periodUnit Σ0..1codes | 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..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
....... timeOfDay Σ0..*timeTime of day for action
....... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


....... offset Σ0..1unsignedIntMinutes from event (before or after)
...... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

... url 1..1uri"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 1 element (17 nested mandatory elements)
Fixed Value: 5 elements
Prohibited: 7 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this
  • The element Extension.extension.valueTiming.repeat.bounds[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionQuantity Limit Detail
... extension 1..*ExtensionExtension
... extension:Description 0..1ExtensionA human readable description of quantity limits.
.... extension 0..0
.... url 1..1uri"Description"
.... value[x] 1..1stringValue of extension
... extension:Rolling 0..1ExtensionIndicator of dispense amount limit per time period.
.... extension 0..0
.... url 1..1uri"Rolling"
.... value[x] 1..1TimingValue of extension
Slice: Unordered, Open by type:$this
.... valueTiming 1..1TimingValue of extension
..... event 0..0
..... repeat 1..1ElementWhen the event is to occur
...... count 1..1positiveIntNumber of times to repeat
...... period 1..1decimalEvent occurs frequency times per period
...... periodUnit 0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Required Pattern: d
.... extension 0..0
.... url 1..1uri"MaximumDaily"
.... value[x] 1..1QuantityValue of extension
Slice: Unordered, Open by type:$this
.... valueQuantity 1..1QuantityValue of extension
..... value 1..1decimalNumerical value (with implicit precision)
... extension:DaysSupply 0..1ExtensionIndicator of number of therapy days over time period.
.... extension 0..0
.... url 1..1uri"DaysSupply"
.... value[x] 1..1TimingValue of extension
Slice: Unordered, Open by type:$this
.... valueTiming 1..1TimingValue of extension
..... event 0..0
..... repeat 1..1ElementWhen the event is to occur
...... bounds[x] 1..1DurationLength/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Open by type:$this
...... boundsDuration 1..1DurationLength/Range of lengths, or (Start and/or end) limits
....... value 1..1decimalNumerical value (with implicit precision)
....... system 0..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
....... code 0..1codeCoded form of the unit
Required Pattern: d
...... count 1..1positiveIntNumber of times to repeat
...... period 1..1decimalEvent occurs frequency times per period
...... periodUnit 0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Required Pattern: d
... url 1..1uri"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionQuantity Limit Detail
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:Description 0..1ExtensionA human readable description of quantity limits.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"Description"
.... value[x] 1..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"Rolling"
.... Slices for value[x] 1..1TimingValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueTiming 1..1TimingValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... repeat ΣI1..1ElementWhen the event is to occur
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... bounds[x] Σ0..1Length/Range of lengths, or (Start and/or end) limits
........ boundsDurationDuration
........ boundsRangeRange
........ boundsPeriodPeriod
....... count Σ1..1positiveIntNumber of times to repeat
....... countMax Σ0..1positiveIntMaximum number of times to repeat
....... duration Σ0..1decimalHow long when it happens
....... durationMax Σ0..1decimalHow long when it happens (Max)
....... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

....... frequency Σ0..1positiveIntEvent occurs frequency times per period
....... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
....... period Σ1..1decimalEvent occurs frequency times per period
....... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
....... periodUnit Σ0..1codes | 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..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
....... timeOfDay Σ0..*timeTime of day for action
....... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


....... offset Σ0..1unsignedIntMinutes from event (before or after)
...... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

... extension:MaximumDaily 0..1ExtensionIndicator of maximum daily amount.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"MaximumDaily"
.... Slices for value[x] 1..1QuantityValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueQuantity 1..1QuantityValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ1..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ0..1stringUnit representation
...... system ΣI0..1uriSystem that defines coded unit form
...... code Σ0..1codeCoded form of the unit
... extension:DaysSupply 0..1ExtensionIndicator of number of therapy days over time period.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"DaysSupply"
.... Slices for value[x] 1..1TimingValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueTiming 1..1TimingValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... repeat ΣI1..1ElementWhen the event is to occur
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... Slices for bounds[x] Σ1..1DurationLength/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Closed by type:$this
........ bounds[x]:boundsDuration Σ1..1DurationLength/Range of lengths, or (Start and/or end) limits
......... id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... value Σ1..1decimalNumerical value (with implicit precision)
......... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

......... unit Σ0..1stringUnit representation
......... system ΣI0..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
......... code Σ0..1codeCoded form of the unit
Required Pattern: d
....... count Σ1..1positiveIntNumber of times to repeat
....... countMax Σ0..1positiveIntMaximum number of times to repeat
....... duration Σ0..1decimalHow long when it happens
....... durationMax Σ0..1decimalHow long when it happens (Max)
....... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

....... frequency Σ0..1positiveIntEvent occurs frequency times per period
....... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
....... period Σ1..1decimalEvent occurs frequency times per period
....... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
....... periodUnit Σ0..1codes | 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..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
....... timeOfDay Σ0..*timeTime of day for action
....... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


....... offset Σ0..1unsignedIntMinutes from event (before or after)
...... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

... url 1..1uri"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Extension.extension:Rolling.value[x]:valueTiming.repeat.durationUnitrequiredUnitsOfTime
Extension.extension:Rolling.value[x]:valueTiming.repeat.periodUnitrequiredPattern: d
Extension.extension:Rolling.value[x]:valueTiming.repeat.dayOfWeekrequiredDaysOfWeek
Extension.extension:Rolling.value[x]:valueTiming.repeat.whenrequiredEventTiming
Extension.extension:Rolling.value[x]:valueTiming.codepreferredTimingAbbreviation
Extension.extension:MaximumDaily.value[x]:valueQuantity.comparatorrequiredQuantityComparator
Extension.extension:DaysSupply.value[x]:valueTiming.repeat.bounds[x]:boundsDuration.comparatorrequiredQuantityComparator
Extension.extension:DaysSupply.value[x]:valueTiming.repeat.durationUnitrequiredUnitsOfTime
Extension.extension:DaysSupply.value[x]:valueTiming.repeat.periodUnitrequiredPattern: d
Extension.extension:DaysSupply.value[x]:valueTiming.repeat.dayOfWeekrequiredDaysOfWeek
Extension.extension:DaysSupply.value[x]:valueTiming.repeat.whenrequiredEventTiming
Extension.extension:DaysSupply.value[x]:valueTiming.codepreferredTimingAbbreviation