This page is part of the US Drug Formulary (v1.2.0: STU 2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
An indication of whether and which quantity limits the coverage plan imposes on this drug. (Only include if QuantityLimit = true)
The official URL for this extension is:
http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimitDetail-extension
Status: active
Extension maintained by: HL7 Pharmacy Working Group
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
Mandatory: 1 element (17 nested mandatory elements)
Fixed Value: 5 elements
Prohibited: 7 elements
Slices
This structure defines the following Slices:
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | Quantity Limit Detail | |
extension | 1..* | Extension | Extension | |
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" | |
Slices for value[x] | 1..1 | Timing | Value of extension Slice: Unordered, Open by type:$this | |
valueTiming | 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" | |
Slices for value[x] | 1..1 | Quantity | Value of extension Slice: Unordered, Open by type:$this | |
valueQuantity | 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" | |
Slices for value[x] | 1..1 | Timing | Value of extension Slice: Unordered, Open by type:$this | |
valueTiming | 1..1 | Timing | Value of extension | |
event | 0..0 | |||
repeat | 1..1 | Element | When the event is to occur | |
Slices for bounds[x] | 1..1 | Duration | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
boundsDuration | 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 | |
Slices for 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 | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "Rolling" | |
Slices for value[x] | 1..1 | Timing | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueTiming | 1..1 | Timing | Value of extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | ΣI | 1..1 | Element | When the event is to occur |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "MaximumDaily" | |
Slices for value[x] | 1..1 | Quantity | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueQuantity | 1..1 | Quantity | Value of extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | ΣI | 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 | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "DaysSupply" | |
Slices for value[x] | 1..1 | Timing | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueTiming | 1..1 | Timing | Value of extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | ΣI | 1..1 | Element | When the event is to occur |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for bounds[x] | Σ | 1..1 | Duration | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this |
bounds[x]:boundsDuration | Σ | 1..1 | Duration | Length/Range of lengths, or (Start and/or end) limits |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | ΣI | 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
Mandatory: 1 element (17 nested mandatory elements)
Fixed Value: 5 elements
Prohibited: 7 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | Quantity Limit Detail | |
extension | 1..* | Extension | Extension | |
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" | |
Slices for value[x] | 1..1 | Timing | Value of extension Slice: Unordered, Open by type:$this | |
valueTiming | 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" | |
Slices for value[x] | 1..1 | Quantity | Value of extension Slice: Unordered, Open by type:$this | |
valueQuantity | 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" | |
Slices for value[x] | 1..1 | Timing | Value of extension Slice: Unordered, Open by type:$this | |
valueTiming | 1..1 | Timing | Value of extension | |
event | 0..0 | |||
repeat | 1..1 | Element | When the event is to occur | |
Slices for bounds[x] | 1..1 | Duration | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
boundsDuration | 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 | |
Slices for 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 | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "Rolling" | |
Slices for value[x] | 1..1 | Timing | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueTiming | 1..1 | Timing | Value of extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | ΣI | 1..1 | Element | When the event is to occur |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "MaximumDaily" | |
Slices for value[x] | 1..1 | Quantity | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueQuantity | 1..1 | Quantity | Value of extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | ΣI | 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 | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "DaysSupply" | |
Slices for value[x] | 1..1 | Timing | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueTiming | 1..1 | Timing | Value of extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | ΣI | 1..1 | Element | When the event is to occur |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for bounds[x] | Σ | 1..1 | Duration | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this |
bounds[x]:boundsDuration | Σ | 1..1 | Duration | Length/Range of lengths, or (Start and/or end) limits |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | ΣI | 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 |
Extension.extension:Rolling.value[x]:valueTiming.repeat.durationUnit | required | UnitsOfTime |
Extension.extension:Rolling.value[x]:valueTiming.repeat.periodUnit | required | Pattern: d |
Extension.extension:Rolling.value[x]:valueTiming.repeat.dayOfWeek | required | DaysOfWeek |
Extension.extension:Rolling.value[x]:valueTiming.repeat.when | required | EventTiming |
Extension.extension:Rolling.value[x]:valueTiming.code | preferred | TimingAbbreviation |
Extension.extension:MaximumDaily.value[x]:valueQuantity.comparator | required | QuantityComparator |
Extension.extension:DaysSupply.value[x]:valueTiming.repeat.bounds[x]:boundsDuration.comparator | required | QuantityComparator |
Extension.extension:DaysSupply.value[x]:valueTiming.repeat.durationUnit | required | UnitsOfTime |
Extension.extension:DaysSupply.value[x]:valueTiming.repeat.periodUnit | required | Pattern: d |
Extension.extension:DaysSupply.value[x]:valueTiming.repeat.dayOfWeek | required | DaysOfWeek |
Extension.extension:DaysSupply.value[x]:valueTiming.repeat.when | required | EventTiming |
Extension.extension:DaysSupply.value[x]:valueTiming.code | preferred | TimingAbbreviation |