FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Responsible Owner: Pharmacy icon Work GroupStandards Status: Normative
Element Id DosageDetails
Definition

Indicates how the medication is/was taken or should be taken by the patient.

Short Display How the medication is/was taken or should be taken
Cardinality 0..*
Type BackboneType
Summary true
Constraints
Defined on this element
dosdet-1Rule Can only have a simple dose, or one or more steps in a sequencesimple.empty() or step.empty()
Element Id DosageDetails.renderedInstruction
Definition

The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.

Short Display Full representation of the dosage instructions
Cardinality 0..1
Type markdown
Summary true
Comments

The content of the renderedInstructions SHALL not be disagree with the dose represented in the dosage structure content. It may contain additional information not found in the dosage content.

Element Id DosageDetails.simple
Definition

Dosage details if it is a simple dose - a single dosage regime with no dependencies or multiple steps.

Short Display Dosage details if it is a simple dose
Cardinality 0..1
Type Dosage
Summary true
Element Id DosageDetails.step
Definition

One step in a sequence of steps that comprise the dosage course.

Short Display One step in a sequence of steps that comprise the dosage course
Cardinality 0..*
Summary true
Element Id DosageDetails.step.start
Definition

When the step starts. In the absence of a linked event, the step is assumed to start immediately (or after the previous step).

Short Display When the step starts
Cardinality 0..1
Type RelativeTime
Summary true
Element Id DosageDetails.step.end
Definition

When the step ends. In the absence of a linked event, the step is assumed to end when the internal timing schedule termnates.

Short Display When the step ends
Cardinality 0..1
Type RelativeTime
Summary true
Element Id DosageDetails.step.count
Definition

How many times to do this step (if not 1).

Short Display How many times to do this step (if not 1)
Cardinality 0..1
Type integer
Summary true
Element Id DosageDetails.step.component
Definition

A dosage details that is part of this step.

Short Display A dosage details that is part of this step
Cardinality 1..*
Type Dosage
Summary true
Element Id DosageDetails.step.safety
Definition

Safety Information about this step of the dose course.

Short Display Safety Information about this step of the dose course
Cardinality 0..1
Type DosageSafety
Summary true
Element Id DosageDetails.safety
Definition

Safety Information about the combined dose course.

Short Display Safety Information about the combined dose course
Cardinality 0..1
Type DosageSafety
Summary true
Element Id Dosage
Definition

Indicates how the medication is/was taken or should be taken by the patient.

Short Display How the medication is/was taken or should be taken
Cardinality 0..*
Type BackboneType
Summary true
Constraints
Defined on this element
dos-1Rule AsNeededFor can only be set if AsNeeded is empty or trueasNeededFor.empty() or asNeeded.empty() or asNeeded
Element Id Dosage.condition
Definition

Whether the dosage applies (e.g. as a whole). The Disage applies if any of the conditions are true.

Short Display Whether the dosage applies (e.g. as a whole) (any can be true)
Cardinality 0..*
Type DosageCondition
Summary true
Element Id Dosage.text
Definition

Free text dosage instructions e.g. SIG.

Short Display Free text dosage instructions e.g. SIG
Cardinality 0..1
Type string
Requirements

Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.

Summary true
Element Id Dosage.additionalInstruction
Definition

Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").

Short Display Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Cardinality 0..*
Terminology Binding SNOMED CT Additional Dosage Instructions (Example)
Type CodeableConcept
Requirements

Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded.

Summary true
Comments

Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or take "immediately following drug x") should be populated in dosage.text.

Element Id Dosage.patientInstruction
Definition

Instructions in terms that are understood by the patient or consumer.

Short Display Patient or consumer oriented instructions
Cardinality 0..1
Type string
Summary true
Element Id Dosage.timing
Definition

When medication should be administered.

Short Display When medication should be administered
Cardinality 0..1
Type Timing
Requirements

The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

Summary true
Comments

This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.

Element Id Dosage.asNeeded
Definition

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).

Short Display Take "as needed"
Cardinality 0..1
Type boolean
Summary true
Comments

Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated.

Constraints
Affect this element
dos-1Rule AsNeededFor can only be set if AsNeeded is empty or trueasNeededFor.empty() or asNeeded.empty() or asNeeded
Element Id Dosage.asNeededFor
Definition

Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).

Short Display Take "as needed" (for x)
Cardinality 0..*
Terminology Binding SNOMED CT Medication As Needed Reason Codes (Example)
Type CodeableConcept
Summary true
Comments

Can express "as needed" with a reason by including the CodeableConcept. Based on the invariant, the Dosage.asNeededFor is not populated when Dosage.asNeeded is false. If the Dosage.asNeeded is "false", then the dose is given according to the schedule and is not "prn" or "as needed".

Constraints
Affect this element
dos-1Rule AsNeededFor can only be set if AsNeeded is empty or trueasNeededFor.empty() or asNeeded.empty() or asNeeded
Element Id Dosage.site
Definition

Body site to administer to.

Short Display Body site to administer to
Cardinality 0..1
Terminology Binding SNOMED CT Anatomical Structure for Administration Site Codes (Example)
Type CodeableConcept
Requirements

A coded specification of the anatomic site where the medication first enters the body.

Summary true
Comments

If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.

Element Id Dosage.route
Definition

How drug should enter body.

Short Display How drug should enter body
Cardinality 0..1
Terminology Binding SNOMED CT Route Codes (Example)
Type CodeableConcept
Requirements

A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.

Summary true
Element Id Dosage.method
Definition

Technique for administering medication.

Short Display Technique for administering medication
Cardinality 0..1
Terminology Binding SNOMED CT Administration Method Codes (Example)
Type CodeableConcept
Requirements

A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.

Summary true
Comments

Terminologies used often pre-coordinate this term with the route and or form of administration.

Element Id Dosage.doseAndRate
Definition

Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.

Short Display Amount of medication administered, to be administered or typical amount to be administered
Cardinality 0..*
Summary true
Element Id Dosage.doseAndRate.type
Definition

The kind of dose or rate specified, for example, ordered or calculated.

Short Display The kind of dose or rate specified
Cardinality 0..1
Terminology Binding DoseAndRateType icon (Example)
Type CodeableConcept
Requirements

If the type is not populated, assume to be "ordered".

Summary true
Element Id Dosage.doseAndRate.dose[x]
Definition

Amount of medication per dose.

Short Display Amount of medication per dose
Cardinality 0..1
Type Range|SimpleQuantity|Expression
[x] Note See Choice of Datatypes for further information about how to use [x]
Requirements

The amount of therapeutic or other substance given at one administration event.

Summary true
Comments

Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. Expression is provided for medications that are e.g. weight dependent, or skin surface are dependent.

Element Id Dosage.doseAndRate.rate[x]
Definition

Amount of medication per unit of time.

Short Display Amount of medication per unit of time
Cardinality 0..1
Type Ratio|Range|SimpleQuantity|Expression
[x] Note See Choice of Datatypes for further information about how to use [x]
Requirements

Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

Summary true
Comments

It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate.

It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. Expression is provided for medications that are e.g. weight dependent, or skin surface are dependent.

Element Id Dosage.safety
Definition

Safety Information about the this dosage instructions.

Short Display Safety Information about the this dosage instructions
Cardinality 0..1
Type DosageSafety
Summary true
Element Id DosageSafety
Definition

Safety Details about the usage of the medication.

Short Display Safety Details about the usage of the medication
Cardinality 0..*
Type BackboneType
Summary true
Element Id DosageSafety.doseLimit
Definition

A dose limit for safe use of the medication.

Short Display A dose limit for safe use of the medication
Cardinality 0..*
Summary true
Element Id DosageSafety.doseLimit.value[x]
Definition

Quantity that is safe to use.

Short Display Quantity that is safe to use
Cardinality 1..1
Type integer|Quantity|Expression
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Element Id DosageSafety.doseLimit.scope
Definition

dosage | period | administration | lifetime - The scope of the dose limitation.

Short Display dosage | period | administration | lifetime - The scope of the dose limitation
Cardinality 1..1
Terminology Binding Dose Limit Scope ValueSet (Required)
Type code
Summary true
Element Id DosageSafety.doseLimit.period
Definition

The period over which the quantity is safe to use (if scope = period).

Short Display The period over which the quantity is safe to use (if scope = period)
Cardinality 0..1
Type Duration
Summary true
Element Id DosageSafety.doseLimit.text
Definition

Additional notes about the dose limit.

Short Display Additional notes about the dose limit
Cardinality 0..1
Type string
Summary true
Element Id DosageSafety.ifExceeded
Definition

What to do if the instructions lead to exceeding the dose limits.

Short Display What to do if the instructions lead to exceeding the dose limits
Cardinality 0..1
Type string
Summary true
Element Id DosageCondition
Definition

DosageCondition expresses a time or time period as relative to the time of an event defined in data types other than dateTime.

Short Display Expresses that something is dependent on an event happening
Cardinality 0..*
Type BackboneType
Summary true
Element Id DosageCondition.code
Definition

The specific event occurrence or resource context used as a base point (reference point) in time. This establishes the context in which the 'path' is evaluated.

Short Display The specific event occurrence or resource context used as a base point (reference point) in time
Cardinality 1..1
Terminology Binding Dose Limit Scope ValueSet (Preferred)
Type CodeableConcept
Summary true
Element Id DosageCondition.details
Definition

Additional details about the event - depends on the code.

Short Display Additional details about the event - depends on the code
Cardinality 0..1
Terminology Binding Dosage Condition Details VS (Example)
Type CodeableConcept
Summary true
Element Id DosageCondition.operation
Definition

How the value is tested.

Short Display eq | ne | in | nin | gt | lt | ge | le | sa | eb | ap
Cardinality 0..1
Terminology Binding Dose Limit Scope ValueSet (Required)
Type code
Summary true
Element Id DosageCondition.value[x]
Definition

The value for this critera.

Short Display The value for this critera
Cardinality 0..1
Type *
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Element Id DosageCondition.text
Definition

Free-text (human-readable) description.

Short Display Free-text description
Cardinality 0..1
Type string
Summary true