IHE Pharmacy Medication Overview
0.1.0 - ci-build
IHE Pharmacy Medication Overview, published by Integrating the Healthcare Enterprise (IHE). This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/pharm-meow/ and changes regularly. See the Directory of published versions
Official URL: http://profiles.ihe.net/PHARM/MEOW/StructureDefinition/DosagingInformation | Version: 0.1.0 | |||
Active as of 2024-06-16 | Computable Name: DosagingInformation | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
Logical model for usage instructions for administring the requested product. Based on FHIR Dosage complex data type.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DosagingInformation | 0..* | Base | Dosaging (model) Instances of this logical model can be the target of a Reference | |
sequence | 0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes | |
text | 0..1 | ST | Free text usage/dosage instructions | |
additionalInstruction | 0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
patientInstruction | 0..1 | ST | Patient oriented instructions as free text | |
doseAndRate | 0..* | Class | Amount of medication administered per one dose (= one timing) | |
type | 0..1 | CD | The kind of dose or rate specified (e.g calculated, ordered, etc). | |
dose | 0..1 | PQ | !Range or SimpleQuantity. Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml) | |
rate | 0..1 | RTO | !Ratio, Range or SimpleQuantity. Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes) | |
timing | 0..1 | Class | When medication should be administered (period, time of day, frequency, etc) | |
event | 0..* | dateTime | Exact date and/or time of the administration | |
code | 0..1 | CD | Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc) | |
repeat | 0..1 | Class | Repetition of the administration. | |
bounds | 0..1 | Class | Time bounds for the treatment (current dosaging scheme). Only one of the following can exist. | |
duration | 0..1 | PQ | Number of time units, e.g 10 days | |
range | 0..1 | Range | A range of numbers of time units, 5-10 days | |
period | 0..1 | Period | Start and end date, 05.08.2023 - 10.08.2023 | |
count | 0..1 | Class | Number of times to repeat, exact or range | |
count | 1..1 | INT | Number of times (e.g 'once', '10 times') | |
countMax | 0..1 | INT | Maximum number of times (e.g 'maximum 10 times') | |
duration | 0..1 | Class | Duration of one administration, exact or range | |
duration | 1..1 | PQ | Duration of administration (e.g '5 minutes', '1 hour') | |
durationMax | 0..1 | PQ | Maximum duration of administration (e.g 'maximum 1 hour') | |
frequency | 0..1 | Class | Frequency of intake/administration (e.g 'three times a day') | |
numberOfTimes | 1..1 | INT | Number of times per period (e.g '3 times') | |
maxNumberOfTimes | 0..1 | INT | Maximum number of times per period (e.g. 'maximum 3 times') | |
period | 1..1 | PQ | Duration to which the frequency applies (e.g '... / 1 day') | |
periodMax | 0..1 | PQ | Upper limit of the period (e.g ... / 4-6 hours) | |
dayOfWeek | 0..* | CD | The day of the week of administration, e.g Mon, Tue, etc | |
timeOfDay | 0..* | time | Time of day of administration (e.g '10:00') | |
eventTime | 0..* | Class | An event the administration is bound to, e.g 'before meal', '30 min before meal' | |
when | 0..* | CD | Time period or event ('before meal', 'immediately', 'morning') | |
offset | 0..1 | INT | minutes from event, before or after (?not sure how to show before/after with only positive integers) | |
asNeeded | 0..1 | BL | Take as needed | |
asNeededFor | 0..* | CD | Take as needed for the coded reason | |
bodySite | 0..1 | CD | Body site of administration | |
routeOfAdministration | 0..1 | CD | Route of administration | |
methodOfAdministration | 0..1 | CD | Method of administration | |
maxDose | 0..* | Class | Maximum dose for the patient | |
maxDosePerPeriod | 0..* | RTO | Upper limit on medication per unit of time | |
maxDosePerAdministration | 0..1 | PQ | Upper limit on medication per one administration | |
maxDosePerLifetime | 0..1 | PQ | Upper limit on medication per lifetime of the patient | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DosagingInformation | 0..* | Base | Dosaging (model) Instances of this logical model can be the target of a Reference | |
sequence | 0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes | |
text | 0..1 | ST | Free text usage/dosage instructions | |
additionalInstruction | 0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
patientInstruction | 0..1 | ST | Patient oriented instructions as free text | |
doseAndRate | 0..* | Class | Amount of medication administered per one dose (= one timing) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 0..1 | CD | The kind of dose or rate specified (e.g calculated, ordered, etc). | |
dose | 0..1 | PQ | !Range or SimpleQuantity. Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml) | |
rate | 0..1 | RTO | !Ratio, Range or SimpleQuantity. Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes) | |
timing | 0..1 | Class | When medication should be administered (period, time of day, frequency, etc) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | 0..* | dateTime | Exact date and/or time of the administration | |
code | 0..1 | CD | Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc) | |
repeat | 0..1 | Class | Repetition of the administration. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
bounds | 0..1 | Class | Time bounds for the treatment (current dosaging scheme). Only one of the following can exist. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
duration | 0..1 | PQ | Number of time units, e.g 10 days | |
range | 0..1 | Range | A range of numbers of time units, 5-10 days | |
period | 0..1 | Period | Start and end date, 05.08.2023 - 10.08.2023 | |
count | 0..1 | Class | Number of times to repeat, exact or range | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
count | 1..1 | INT | Number of times (e.g 'once', '10 times') | |
countMax | 0..1 | INT | Maximum number of times (e.g 'maximum 10 times') | |
duration | 0..1 | Class | Duration of one administration, exact or range | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
duration | 1..1 | PQ | Duration of administration (e.g '5 minutes', '1 hour') | |
durationMax | 0..1 | PQ | Maximum duration of administration (e.g 'maximum 1 hour') | |
frequency | 0..1 | Class | Frequency of intake/administration (e.g 'three times a day') | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
numberOfTimes | 1..1 | INT | Number of times per period (e.g '3 times') | |
maxNumberOfTimes | 0..1 | INT | Maximum number of times per period (e.g. 'maximum 3 times') | |
period | 1..1 | PQ | Duration to which the frequency applies (e.g '... / 1 day') | |
periodMax | 0..1 | PQ | Upper limit of the period (e.g ... / 4-6 hours) | |
dayOfWeek | 0..* | CD | The day of the week of administration, e.g Mon, Tue, etc | |
timeOfDay | 0..* | time | Time of day of administration (e.g '10:00') | |
eventTime | 0..* | Class | An event the administration is bound to, e.g 'before meal', '30 min before meal' | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
when | 0..* | CD | Time period or event ('before meal', 'immediately', 'morning') | |
offset | 0..1 | INT | minutes from event, before or after (?not sure how to show before/after with only positive integers) | |
asNeeded | 0..1 | BL | Take as needed | |
asNeededFor | 0..* | CD | Take as needed for the coded reason | |
bodySite | 0..1 | CD | Body site of administration | |
routeOfAdministration | 0..1 | CD | Route of administration | |
methodOfAdministration | 0..1 | CD | Method of administration | |
maxDose | 0..* | Class | Maximum dose for the patient | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
maxDosePerPeriod | 0..* | RTO | Upper limit on medication per unit of time | |
maxDosePerAdministration | 0..1 | PQ | Upper limit on medication per one administration | |
maxDosePerLifetime | 0..1 | PQ | Upper limit on medication per lifetime of the patient | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DosagingInformation | 0..* | Base | Dosaging (model) Instances of this logical model can be the target of a Reference | |
sequence | 0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes | |
text | 0..1 | ST | Free text usage/dosage instructions | |
additionalInstruction | 0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
patientInstruction | 0..1 | ST | Patient oriented instructions as free text | |
doseAndRate | 0..* | Class | Amount of medication administered per one dose (= one timing) | |
@id | 0..1 | id | 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 |
type | 0..1 | CD | The kind of dose or rate specified (e.g calculated, ordered, etc). | |
dose | 0..1 | PQ | !Range or SimpleQuantity. Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml) | |
rate | 0..1 | RTO | !Ratio, Range or SimpleQuantity. Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes) | |
timing | 0..1 | Class | When medication should be administered (period, time of day, frequency, etc) | |
@id | 0..1 | id | 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 |
event | 0..* | dateTime | Exact date and/or time of the administration | |
code | 0..1 | CD | Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc) | |
repeat | 0..1 | Class | Repetition of the administration. | |
@id | 0..1 | id | 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 |
bounds | 0..1 | Class | Time bounds for the treatment (current dosaging scheme). Only one of the following can exist. | |
@id | 0..1 | id | 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 |
duration | 0..1 | PQ | Number of time units, e.g 10 days | |
range | 0..1 | Range | A range of numbers of time units, 5-10 days | |
period | 0..1 | Period | Start and end date, 05.08.2023 - 10.08.2023 | |
count | 0..1 | Class | Number of times to repeat, exact or range | |
@id | 0..1 | id | 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 |
count | 1..1 | INT | Number of times (e.g 'once', '10 times') | |
countMax | 0..1 | INT | Maximum number of times (e.g 'maximum 10 times') | |
duration | 0..1 | Class | Duration of one administration, exact or range | |
@id | 0..1 | id | 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 |
duration | 1..1 | PQ | Duration of administration (e.g '5 minutes', '1 hour') | |
durationMax | 0..1 | PQ | Maximum duration of administration (e.g 'maximum 1 hour') | |
frequency | 0..1 | Class | Frequency of intake/administration (e.g 'three times a day') | |
@id | 0..1 | id | 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 |
numberOfTimes | 1..1 | INT | Number of times per period (e.g '3 times') | |
maxNumberOfTimes | 0..1 | INT | Maximum number of times per period (e.g. 'maximum 3 times') | |
period | 1..1 | PQ | Duration to which the frequency applies (e.g '... / 1 day') | |
periodMax | 0..1 | PQ | Upper limit of the period (e.g ... / 4-6 hours) | |
dayOfWeek | 0..* | CD | The day of the week of administration, e.g Mon, Tue, etc | |
timeOfDay | 0..* | time | Time of day of administration (e.g '10:00') | |
eventTime | 0..* | Class | An event the administration is bound to, e.g 'before meal', '30 min before meal' | |
@id | 0..1 | id | 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 |
when | 0..* | CD | Time period or event ('before meal', 'immediately', 'morning') | |
offset | 0..1 | INT | minutes from event, before or after (?not sure how to show before/after with only positive integers) | |
asNeeded | 0..1 | BL | Take as needed | |
asNeededFor | 0..* | CD | Take as needed for the coded reason | |
bodySite | 0..1 | CD | Body site of administration | |
routeOfAdministration | 0..1 | CD | Route of administration | |
methodOfAdministration | 0..1 | CD | Method of administration | |
maxDose | 0..* | Class | Maximum dose for the patient | |
@id | 0..1 | id | 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 |
maxDosePerPeriod | 0..* | RTO | Upper limit on medication per unit of time | |
maxDosePerAdministration | 0..1 | PQ | Upper limit on medication per one administration | |
maxDosePerLifetime | 0..1 | PQ | Upper limit on medication per lifetime of the patient | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base
Summary
Mandatory: 0 element(4 nested mandatory elements)
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DosagingInformation | 0..* | Base | Dosaging (model) Instances of this logical model can be the target of a Reference | |
sequence | 0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes | |
text | 0..1 | ST | Free text usage/dosage instructions | |
additionalInstruction | 0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
patientInstruction | 0..1 | ST | Patient oriented instructions as free text | |
doseAndRate | 0..* | Class | Amount of medication administered per one dose (= one timing) | |
type | 0..1 | CD | The kind of dose or rate specified (e.g calculated, ordered, etc). | |
dose | 0..1 | PQ | !Range or SimpleQuantity. Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml) | |
rate | 0..1 | RTO | !Ratio, Range or SimpleQuantity. Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes) | |
timing | 0..1 | Class | When medication should be administered (period, time of day, frequency, etc) | |
event | 0..* | dateTime | Exact date and/or time of the administration | |
code | 0..1 | CD | Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc) | |
repeat | 0..1 | Class | Repetition of the administration. | |
bounds | 0..1 | Class | Time bounds for the treatment (current dosaging scheme). Only one of the following can exist. | |
duration | 0..1 | PQ | Number of time units, e.g 10 days | |
range | 0..1 | Range | A range of numbers of time units, 5-10 days | |
period | 0..1 | Period | Start and end date, 05.08.2023 - 10.08.2023 | |
count | 0..1 | Class | Number of times to repeat, exact or range | |
count | 1..1 | INT | Number of times (e.g 'once', '10 times') | |
countMax | 0..1 | INT | Maximum number of times (e.g 'maximum 10 times') | |
duration | 0..1 | Class | Duration of one administration, exact or range | |
duration | 1..1 | PQ | Duration of administration (e.g '5 minutes', '1 hour') | |
durationMax | 0..1 | PQ | Maximum duration of administration (e.g 'maximum 1 hour') | |
frequency | 0..1 | Class | Frequency of intake/administration (e.g 'three times a day') | |
numberOfTimes | 1..1 | INT | Number of times per period (e.g '3 times') | |
maxNumberOfTimes | 0..1 | INT | Maximum number of times per period (e.g. 'maximum 3 times') | |
period | 1..1 | PQ | Duration to which the frequency applies (e.g '... / 1 day') | |
periodMax | 0..1 | PQ | Upper limit of the period (e.g ... / 4-6 hours) | |
dayOfWeek | 0..* | CD | The day of the week of administration, e.g Mon, Tue, etc | |
timeOfDay | 0..* | time | Time of day of administration (e.g '10:00') | |
eventTime | 0..* | Class | An event the administration is bound to, e.g 'before meal', '30 min before meal' | |
when | 0..* | CD | Time period or event ('before meal', 'immediately', 'morning') | |
offset | 0..1 | INT | minutes from event, before or after (?not sure how to show before/after with only positive integers) | |
asNeeded | 0..1 | BL | Take as needed | |
asNeededFor | 0..* | CD | Take as needed for the coded reason | |
bodySite | 0..1 | CD | Body site of administration | |
routeOfAdministration | 0..1 | CD | Route of administration | |
methodOfAdministration | 0..1 | CD | Method of administration | |
maxDose | 0..* | Class | Maximum dose for the patient | |
maxDosePerPeriod | 0..* | RTO | Upper limit on medication per unit of time | |
maxDosePerAdministration | 0..1 | PQ | Upper limit on medication per one administration | |
maxDosePerLifetime | 0..1 | PQ | Upper limit on medication per lifetime of the patient | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DosagingInformation | 0..* | Base | Dosaging (model) Instances of this logical model can be the target of a Reference | |
sequence | 0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes | |
text | 0..1 | ST | Free text usage/dosage instructions | |
additionalInstruction | 0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
patientInstruction | 0..1 | ST | Patient oriented instructions as free text | |
doseAndRate | 0..* | Class | Amount of medication administered per one dose (= one timing) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 0..1 | CD | The kind of dose or rate specified (e.g calculated, ordered, etc). | |
dose | 0..1 | PQ | !Range or SimpleQuantity. Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml) | |
rate | 0..1 | RTO | !Ratio, Range or SimpleQuantity. Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes) | |
timing | 0..1 | Class | When medication should be administered (period, time of day, frequency, etc) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | 0..* | dateTime | Exact date and/or time of the administration | |
code | 0..1 | CD | Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc) | |
repeat | 0..1 | Class | Repetition of the administration. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
bounds | 0..1 | Class | Time bounds for the treatment (current dosaging scheme). Only one of the following can exist. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
duration | 0..1 | PQ | Number of time units, e.g 10 days | |
range | 0..1 | Range | A range of numbers of time units, 5-10 days | |
period | 0..1 | Period | Start and end date, 05.08.2023 - 10.08.2023 | |
count | 0..1 | Class | Number of times to repeat, exact or range | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
count | 1..1 | INT | Number of times (e.g 'once', '10 times') | |
countMax | 0..1 | INT | Maximum number of times (e.g 'maximum 10 times') | |
duration | 0..1 | Class | Duration of one administration, exact or range | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
duration | 1..1 | PQ | Duration of administration (e.g '5 minutes', '1 hour') | |
durationMax | 0..1 | PQ | Maximum duration of administration (e.g 'maximum 1 hour') | |
frequency | 0..1 | Class | Frequency of intake/administration (e.g 'three times a day') | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
numberOfTimes | 1..1 | INT | Number of times per period (e.g '3 times') | |
maxNumberOfTimes | 0..1 | INT | Maximum number of times per period (e.g. 'maximum 3 times') | |
period | 1..1 | PQ | Duration to which the frequency applies (e.g '... / 1 day') | |
periodMax | 0..1 | PQ | Upper limit of the period (e.g ... / 4-6 hours) | |
dayOfWeek | 0..* | CD | The day of the week of administration, e.g Mon, Tue, etc | |
timeOfDay | 0..* | time | Time of day of administration (e.g '10:00') | |
eventTime | 0..* | Class | An event the administration is bound to, e.g 'before meal', '30 min before meal' | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
when | 0..* | CD | Time period or event ('before meal', 'immediately', 'morning') | |
offset | 0..1 | INT | minutes from event, before or after (?not sure how to show before/after with only positive integers) | |
asNeeded | 0..1 | BL | Take as needed | |
asNeededFor | 0..* | CD | Take as needed for the coded reason | |
bodySite | 0..1 | CD | Body site of administration | |
routeOfAdministration | 0..1 | CD | Route of administration | |
methodOfAdministration | 0..1 | CD | Method of administration | |
maxDose | 0..* | Class | Maximum dose for the patient | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
maxDosePerPeriod | 0..* | RTO | Upper limit on medication per unit of time | |
maxDosePerAdministration | 0..1 | PQ | Upper limit on medication per one administration | |
maxDosePerLifetime | 0..1 | PQ | Upper limit on medication per lifetime of the patient | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DosagingInformation | 0..* | Base | Dosaging (model) Instances of this logical model can be the target of a Reference | |
sequence | 0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes | |
text | 0..1 | ST | Free text usage/dosage instructions | |
additionalInstruction | 0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
patientInstruction | 0..1 | ST | Patient oriented instructions as free text | |
doseAndRate | 0..* | Class | Amount of medication administered per one dose (= one timing) | |
@id | 0..1 | id | 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 |
type | 0..1 | CD | The kind of dose or rate specified (e.g calculated, ordered, etc). | |
dose | 0..1 | PQ | !Range or SimpleQuantity. Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml) | |
rate | 0..1 | RTO | !Ratio, Range or SimpleQuantity. Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes) | |
timing | 0..1 | Class | When medication should be administered (period, time of day, frequency, etc) | |
@id | 0..1 | id | 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 |
event | 0..* | dateTime | Exact date and/or time of the administration | |
code | 0..1 | CD | Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc) | |
repeat | 0..1 | Class | Repetition of the administration. | |
@id | 0..1 | id | 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 |
bounds | 0..1 | Class | Time bounds for the treatment (current dosaging scheme). Only one of the following can exist. | |
@id | 0..1 | id | 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 |
duration | 0..1 | PQ | Number of time units, e.g 10 days | |
range | 0..1 | Range | A range of numbers of time units, 5-10 days | |
period | 0..1 | Period | Start and end date, 05.08.2023 - 10.08.2023 | |
count | 0..1 | Class | Number of times to repeat, exact or range | |
@id | 0..1 | id | 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 |
count | 1..1 | INT | Number of times (e.g 'once', '10 times') | |
countMax | 0..1 | INT | Maximum number of times (e.g 'maximum 10 times') | |
duration | 0..1 | Class | Duration of one administration, exact or range | |
@id | 0..1 | id | 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 |
duration | 1..1 | PQ | Duration of administration (e.g '5 minutes', '1 hour') | |
durationMax | 0..1 | PQ | Maximum duration of administration (e.g 'maximum 1 hour') | |
frequency | 0..1 | Class | Frequency of intake/administration (e.g 'three times a day') | |
@id | 0..1 | id | 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 |
numberOfTimes | 1..1 | INT | Number of times per period (e.g '3 times') | |
maxNumberOfTimes | 0..1 | INT | Maximum number of times per period (e.g. 'maximum 3 times') | |
period | 1..1 | PQ | Duration to which the frequency applies (e.g '... / 1 day') | |
periodMax | 0..1 | PQ | Upper limit of the period (e.g ... / 4-6 hours) | |
dayOfWeek | 0..* | CD | The day of the week of administration, e.g Mon, Tue, etc | |
timeOfDay | 0..* | time | Time of day of administration (e.g '10:00') | |
eventTime | 0..* | Class | An event the administration is bound to, e.g 'before meal', '30 min before meal' | |
@id | 0..1 | id | 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 |
when | 0..* | CD | Time period or event ('before meal', 'immediately', 'morning') | |
offset | 0..1 | INT | minutes from event, before or after (?not sure how to show before/after with only positive integers) | |
asNeeded | 0..1 | BL | Take as needed | |
asNeededFor | 0..* | CD | Take as needed for the coded reason | |
bodySite | 0..1 | CD | Body site of administration | |
routeOfAdministration | 0..1 | CD | Route of administration | |
methodOfAdministration | 0..1 | CD | Method of administration | |
maxDose | 0..* | Class | Maximum dose for the patient | |
@id | 0..1 | id | 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 |
maxDosePerPeriod | 0..* | RTO | Upper limit on medication per unit of time | |
maxDosePerAdministration | 0..1 | PQ | Upper limit on medication per one administration | |
maxDosePerLifetime | 0..1 | PQ | Upper limit on medication per lifetime of the patient | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base
Summary
Mandatory: 0 element(4 nested mandatory elements)
Structures
This structure refers to these other structures: