Data Model Libraries
    Preparing search index...

    Class MedicationAdministrationDosageComponent

    MedicationAdministrationDosageComponent Class

    FHIR Specification

    • Short: Details of how medication was taken
    • Definition: Describes the medication dosage information details e.g. dose, rate, site, route, etc.

    FHIR MedicationAdministration

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    text? site? route? method? dose? rate?

    Methods

    parse getTextElement setTextElement hasTextElement getText setText hasText getSite setSite hasSite getRoute setRoute hasRoute getMethod setMethod hasMethod getDose setDose hasDose getRate setRate hasRate getRateRatio hasRateRatio getRateQuantity hasRateQuantity fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    Private Optionaltext

    text?: StringType

    MedicationAdministration.dosage.text Element

    FHIR Specification

    • Short: Free text dosage instructions e.g. SIG
    • Definition: Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    site?: CodeableConcept

    MedicationAdministration.dosage.site Element

    FHIR Specification

    • Short: Body site administered to
    • Definition: A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".
    • Comment: If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    route?: CodeableConcept

    MedicationAdministration.dosage.route Element

    FHIR Specification

    • Short: Path of substance into body
    • Definition: A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    method?: CodeableConcept

    MedicationAdministration.dosage.method Element

    FHIR Specification

    • Short: How drug was administered
    • Definition: A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.
    • Comment: One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    dose?: Quantity

    MedicationAdministration.dosage.dose Element

    FHIR Specification

    • Short: Amount of medication per dose
    • Definition: The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.
    • Comment: If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    rate?: IDataType

    MedicationAdministration.dosage.rate[x] Element

    @ChoiceDataTypesMeta('MedicationAdministration.dosage.rate[x]', ['Ratio','Quantity',]

    FHIR Specification

    • Short: Dose quantity per unit of time
    • Definition: 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.
    • Comment: If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate.
    • FHIR Types: 'Ratio', 'Quantity',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationAdministrationDosageComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicationAdministrationDosageComponent

      MedicationAdministrationDosageComponent data model or undefined for MedicationAdministrationDosageComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • 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

    • 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 complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods