Data Model Libraries
    Preparing search index...

    Class Dosage

    Dosage Class

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

    FHIR Specification

    • Short: How the medication is/was taken or should be taken
    • Definition: Indicates how the medication is/was taken or should be taken by the patient.
    • FHIR Version: 5.0.0

    FHIR Dosage

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    sequence? text? additionalInstruction? patientInstruction? timing? asNeeded? asNeededFor? site? route? method? doseAndRate? maxDosePerPeriod? maxDosePerAdministration? maxDosePerLifetime?

    Methods

    parse getSequenceElement setSequenceElement hasSequenceElement getSequence setSequence hasSequence getTextElement setTextElement hasTextElement getText setText hasText getAdditionalInstruction setAdditionalInstruction addAdditionalInstruction hasAdditionalInstruction getPatientInstructionElement setPatientInstructionElement hasPatientInstructionElement getPatientInstruction setPatientInstruction hasPatientInstruction getTiming setTiming hasTiming getAsNeededElement setAsNeededElement hasAsNeededElement getAsNeeded setAsNeeded hasAsNeeded getAsNeededFor setAsNeededFor addAsNeededFor hasAsNeededFor getSite setSite hasSite getRoute setRoute hasRoute getMethod setMethod hasMethod getDoseAndRate setDoseAndRate addDoseAndRate hasDoseAndRate getMaxDosePerPeriod setMaxDosePerPeriod addMaxDosePerPeriod hasMaxDosePerPeriod getMaxDosePerAdministration setMaxDosePerAdministration hasMaxDosePerAdministration getMaxDosePerLifetime setMaxDosePerLifetime hasMaxDosePerLifetime fhirType isEmpty copy isComplexDataType dataTypeName toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initAdditionalInstruction initAsNeededFor initDoseAndRate initMaxDosePerPeriod

    Constructors

    Properties

    sequence?: IntegerType

    Dosage.sequence Element

    FHIR Specification

    • Short: The order of the dosage instructions
    • Definition: Indicates the order in which the dosage instructions should be applied or interpreted.
    • Requirements: If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Private Optionaltext

    text?: StringType

    Dosage.text Element

    FHIR Specification

    • Short: Free text dosage instructions e.g. SIG
    • Definition: Free text dosage instructions e.g. SIG.
    • 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    additionalInstruction?: CodeableConcept[]

    Dosage.additionalInstruction Element

    FHIR Specification

    • Short: Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
    • 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").
    • Comment: 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.
    • 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    patientInstruction?: StringType

    Dosage.patientInstruction Element

    FHIR Specification

    • Short: Patient or consumer oriented instructions
    • Definition: Instructions in terms that are understood by the patient or consumer.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    timing?: Timing

    Dosage.timing Element

    FHIR Specification

    • Short: When medication should be administered
    • Definition: When medication should be administered.
    • Comment: 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.
    • 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.
    • FHIR Type: Timing
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    asNeeded?: BooleanType

    Dosage.asNeeded Element

    FHIR Specification

    • Short: Take "as needed"
    • Definition: Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).
    • Comment: Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    asNeededFor?: CodeableConcept[]

    Dosage.asNeededFor Element

    FHIR Specification

    • Short: Take "as needed" (for x)
    • Definition: Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).
    • Comment: Can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be False, then the dose is given according to the schedule and is not "prn" or "as needed".
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    site?: CodeableConcept

    Dosage.site Element

    FHIR Specification

    • Short: Body site to administer to
    • Definition: Body site to administer to.
    • Comment: 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.
    • Requirements: A coded specification of the anatomic site where the medication first enters the body.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    route?: CodeableConcept

    Dosage.route Element

    FHIR Specification

    • Short: How drug should enter body
    • Definition: How drug should enter body.
    • Requirements: A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    method?: CodeableConcept

    Dosage.method Element

    FHIR Specification

    • Short: Technique for administering medication
    • Definition: Technique for administering medication.
    • Comment: Terminologies used often pre-coordinate this term with the route and or form of administration.
    • 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    doseAndRate?: DosageDoseAndRateComponent[]

    Dosage.doseAndRate Element

    FHIR Specification

    • Short: Amount of medication administered, to be administered or typical amount to be administered
    • Definition: Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.
    • FHIR Type: Element
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    maxDosePerPeriod?: Ratio[]

    Dosage.maxDosePerPeriod Element

    FHIR Specification

    • Short: Upper limit on medication per unit of time
    • Definition: Upper limit on medication per unit of time.
    • Comment: This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".
    • Requirements: The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.
    • FHIR Type: Ratio
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    maxDosePerAdministration?: Quantity

    Dosage.maxDosePerAdministration Element

    FHIR Specification

    • Short: Upper limit on medication per administration
    • Definition: Upper limit on medication per administration.
    • Comment: This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 - 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.
    • Requirements: The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    maxDosePerLifetime?: Quantity

    Dosage.maxDosePerLifetime Element

    FHIR Specification

    • Short: Upper limit on medication per lifetime of the patient
    • Definition: Upper limit on medication per lifetime of the patient.
    • Requirements: The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided Dosage JSON to instantiate the Dosage data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Dosage

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Dosage

      Returns undefined | Dosage

      Dosage data model or undefined for Dosage

      JsonError if the provided JSON is not a valid JSON object

    • Determines if modifierExtension property exists for the provided url

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if the modifierExtension property exists and has at least one element; false otherwise

    • Adds the provided Extension to the modifierExtension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the modifierExtension property array

      Returns this

      this

    • Removes the Extension having the provided url from the modifierExtension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetSequenceElementsetSequenceElementhasSequenceElementgetSequencesetSequencehasSequencegetTextElementsetTextElementhasTextElementgetTextsetTexthasTextgetAdditionalInstructionsetAdditionalInstructionaddAdditionalInstructionhasAdditionalInstructiongetPatientInstructionElementsetPatientInstructionElementhasPatientInstructionElementgetPatientInstructionsetPatientInstructionhasPatientInstructiongetTimingsetTiminghasTiminggetAsNeededElementsetAsNeededElementhasAsNeededElementgetAsNeededsetAsNeededhasAsNeededgetAsNeededForsetAsNeededForaddAsNeededForhasAsNeededForgetSitesetSitehasSitegetRoutesetRoutehasRoutegetMethodsetMethodhasMethodgetDoseAndRatesetDoseAndRateaddDoseAndRatehasDoseAndRategetMaxDosePerPeriodsetMaxDosePerPeriodaddMaxDosePerPeriodhasMaxDosePerPeriodgetMaxDosePerAdministrationsetMaxDosePerAdministrationhasMaxDosePerAdministrationgetMaxDosePerLifetimesetMaxDosePerLifetimehasMaxDosePerLifetimefhirTypeisEmptycopyisComplexDataTypedataTypeNametoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionisDataTypegetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitAdditionalInstructioninitAsNeededForinitDoseAndRateinitMaxDosePerPeriod