Current Build

11.8.0 Dosage

Pharmacy Work GroupMaturity Level: 3Ballot Status: Trial Use

The Dosage structure defines general dosage instruction information typically represented in medication requests, medication dispenses and medication statements.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage ΣElementHow the medication is/was taken or should be taken
Elements defined in Ancestors: id, extension
... sequence Σ0..1integerThe order of the dosage instructions
... text Σ0..1stringFree text dosage instructions e.g. SIG
... additionalInstruction Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
SNOMED CT Additional Dosage Instructions (Example)
... patientInstruction Σ0..1stringPatient or consumer oriented instructions
... timing Σ0..1TimingWhen medication should be administered
... asNeeded[x] Σ0..1Take "as needed" (for x)
SNOMED CT Medication As Needed Reason Codes (Example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... site Σ0..1CodeableConceptBody site to administer to
SNOMED CT Anatomical Structure for Administration Site Codes (Example)
... route Σ0..1CodeableConceptHow drug should enter body
SNOMED CT Route Codes (Example)
... method Σ0..1CodeableConceptTechnique for administering medication
SNOMED CT Administration Method Codes (Example)
... dose[x] Σ0..1Amount of medication per dose
.... doseRangeRange
.... doseQuantitySimpleQuantity
... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
... rate[x] Σ0..1Amount of medication per unit of time
.... rateRatioRatio
.... rateRangeRange
.... rateQuantitySimpleQuantity

doco Documentation for this format

UML Diagram (Legend)

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*DosageIndicates the order in which the dosage instructions should be applied or interpretedsequence : integer [0..1]Free text dosage instructions e.g. SIGtext : string [0..1]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")additionalInstruction : CodeableConcept [0..*] « A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". (Strength=Example)SNOMED CT Additional Dosage I...?? »Instructions in terms that are understood by the patient or consumerpatientInstruction : string [0..1]When medication should be administeredtiming : Timing [0..1]Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept)asNeeded[x] : Type [0..1] « boolean|CodeableConcept; A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. (Strength=Example)SNOMED CT Medication As Neede...?? »Body site to administer tosite : CodeableConcept [0..1] « A coded concept describing the site location the medicine enters into or onto the body. (Strength=Example)SNOMED CT Anatomical Structur...?? »How drug should enter bodyroute : CodeableConcept [0..1] « A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. (Strength=Example)SNOMED CT Route ?? »Technique for administering medicationmethod : CodeableConcept [0..1] « A coded concept describing the technique by which the medicine is administered. (Strength=Example)SNOMED CT Administration Meth...?? »Amount of medication per dosedose[x] : Type [0..1] « Range|Quantity(SimpleQuantity) »Upper limit on medication per unit of timemaxDosePerPeriod : Ratio [0..1]Upper limit on medication per administrationmaxDosePerAdministration : Quantity(SimpleQuantity) [0..1]Upper limit on medication per lifetime of the patientmaxDosePerLifetime : Quantity(SimpleQuantity) [0..1]Amount of medication per unit of timerate[x] : Type [0..1] « Ratio|Range|Quantity(SimpleQuantity) »

Turtle Template


@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Dosage.sequence [ integer ]; # 0..1 The order of the dosage instructions
  fhir:Dosage.text [ string ]; # 0..1 Free text dosage instructions e.g. SIG
  fhir:Dosage.additionalInstruction [ CodeableConcept ], ... ; # 0..* Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
  fhir:Dosage.patientInstruction [ string ]; # 0..1 Patient or consumer oriented instructions
  fhir:Dosage.timing [ Timing ]; # 0..1 When medication should be administered
  # Dosage.asNeeded[x] : 0..1 Take "as needed" (for x). One of these 2
    fhir:Dosage.asNeededBoolean [ boolean ]
    fhir:Dosage.asNeededCodeableConcept [ CodeableConcept ]
  fhir:Dosage.site [ CodeableConcept ]; # 0..1 Body site to administer to
  fhir:Dosage.route [ CodeableConcept ]; # 0..1 How drug should enter body
  fhir:Dosage.method [ CodeableConcept ]; # 0..1 Technique for administering medication
  # Dosage.dose[x] : 0..1 Amount of medication per dose. One of these 2
    fhir:Dosage.doseRange [ Range ]
    fhir:Dosage.doseSimpleQuantity [ Quantity(SimpleQuantity) ]
  fhir:Dosage.maxDosePerPeriod [ Ratio ]; # 0..1 Upper limit on medication per unit of time
  fhir:Dosage.maxDosePerAdministration [ Quantity(SimpleQuantity) ]; # 0..1 Upper limit on medication per administration
  fhir:Dosage.maxDosePerLifetime [ Quantity(SimpleQuantity) ]; # 0..1 Upper limit on medication per lifetime of the patient
  # Dosage.rate[x] : 0..1 Amount of medication per unit of time. One of these 3
    fhir:Dosage.rateRatio [ Ratio ]
    fhir:Dosage.rateRange [ Range ]
    fhir:Dosage.rateSimpleQuantity [ Quantity(SimpleQuantity) ]
]

Changes since DSTU2



This complex-type did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage ΣElementHow the medication is/was taken or should be taken
Elements defined in Ancestors: id, extension
... sequence Σ0..1integerThe order of the dosage instructions
... text Σ0..1stringFree text dosage instructions e.g. SIG
... additionalInstruction Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
SNOMED CT Additional Dosage Instructions (Example)
... patientInstruction Σ0..1stringPatient or consumer oriented instructions
... timing Σ0..1TimingWhen medication should be administered
... asNeeded[x] Σ0..1Take "as needed" (for x)
SNOMED CT Medication As Needed Reason Codes (Example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... site Σ0..1CodeableConceptBody site to administer to
SNOMED CT Anatomical Structure for Administration Site Codes (Example)
... route Σ0..1CodeableConceptHow drug should enter body
SNOMED CT Route Codes (Example)
... method Σ0..1CodeableConceptTechnique for administering medication
SNOMED CT Administration Method Codes (Example)
... dose[x] Σ0..1Amount of medication per dose
.... doseRangeRange
.... doseQuantitySimpleQuantity
... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
... rate[x] Σ0..1Amount of medication per unit of time
.... rateRatioRatio
.... rateRangeRange
.... rateQuantitySimpleQuantity

doco Documentation for this format

UML Diagram (Legend)

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*DosageIndicates the order in which the dosage instructions should be applied or interpretedsequence : integer [0..1]Free text dosage instructions e.g. SIGtext : string [0..1]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")additionalInstruction : CodeableConcept [0..*] « A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". (Strength=Example)SNOMED CT Additional Dosage I...?? »Instructions in terms that are understood by the patient or consumerpatientInstruction : string [0..1]When medication should be administeredtiming : Timing [0..1]Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept)asNeeded[x] : Type [0..1] « boolean|CodeableConcept; A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. (Strength=Example)SNOMED CT Medication As Neede...?? »Body site to administer tosite : CodeableConcept [0..1] « A coded concept describing the site location the medicine enters into or onto the body. (Strength=Example)SNOMED CT Anatomical Structur...?? »How drug should enter bodyroute : CodeableConcept [0..1] « A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. (Strength=Example)SNOMED CT Route ?? »Technique for administering medicationmethod : CodeableConcept [0..1] « A coded concept describing the technique by which the medicine is administered. (Strength=Example)SNOMED CT Administration Meth...?? »Amount of medication per dosedose[x] : Type [0..1] « Range|Quantity(SimpleQuantity) »Upper limit on medication per unit of timemaxDosePerPeriod : Ratio [0..1]Upper limit on medication per administrationmaxDosePerAdministration : Quantity(SimpleQuantity) [0..1]Upper limit on medication per lifetime of the patientmaxDosePerLifetime : Quantity(SimpleQuantity) [0..1]Amount of medication per unit of timerate[x] : Type [0..1] « Ratio|Range|Quantity(SimpleQuantity) »

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Dosage.sequence [ integer ]; # 0..1 The order of the dosage instructions
  fhir:Dosage.text [ string ]; # 0..1 Free text dosage instructions e.g. SIG
  fhir:Dosage.additionalInstruction [ CodeableConcept ], ... ; # 0..* Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
  fhir:Dosage.patientInstruction [ string ]; # 0..1 Patient or consumer oriented instructions
  fhir:Dosage.timing [ Timing ]; # 0..1 When medication should be administered
  # Dosage.asNeeded[x] : 0..1 Take "as needed" (for x). One of these 2
    fhir:Dosage.asNeededBoolean [ boolean ]
    fhir:Dosage.asNeededCodeableConcept [ CodeableConcept ]
  fhir:Dosage.site [ CodeableConcept ]; # 0..1 Body site to administer to
  fhir:Dosage.route [ CodeableConcept ]; # 0..1 How drug should enter body
  fhir:Dosage.method [ CodeableConcept ]; # 0..1 Technique for administering medication
  # Dosage.dose[x] : 0..1 Amount of medication per dose. One of these 2
    fhir:Dosage.doseRange [ Range ]
    fhir:Dosage.doseSimpleQuantity [ Quantity(SimpleQuantity) ]
  fhir:Dosage.maxDosePerPeriod [ Ratio ]; # 0..1 Upper limit on medication per unit of time
  fhir:Dosage.maxDosePerAdministration [ Quantity(SimpleQuantity) ]; # 0..1 Upper limit on medication per administration
  fhir:Dosage.maxDosePerLifetime [ Quantity(SimpleQuantity) ]; # 0..1 Upper limit on medication per lifetime of the patient
  # Dosage.rate[x] : 0..1 Amount of medication per unit of time. One of these 3
    fhir:Dosage.rateRatio [ Ratio ]
    fhir:Dosage.rateRange [ Range ]
    fhir:Dosage.rateSimpleQuantity [ Quantity(SimpleQuantity) ]
]

Changes since DSTU2

This complex-type did not exist in Release 2

Constraints

Dosage is used in the following places: ActivityDefinition, MedicationDispense, MedicationRequest and MedicationStatement