Data Model Libraries
    Preparing search index...

    Class DosageDoseAndRateComponent

    DosageDoseAndRateComponent Class

    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 Dosage

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    type_? dose? rate?

    Methods

    parse getType setType hasType getDose setDose hasDose getDoseRange hasDoseRange getDoseQuantity hasDoseQuantity getRate setRate hasRate getRateRatio hasRateRatio getRateRange hasRateRange getRateQuantity hasRateQuantity fhirType isEmpty copy dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    Private Optionaltype_

    type_?: CodeableConcept

    Dosage.doseAndRate.type Element

    FHIR Specification

    • Short: The kind of dose or rate specified
    • Definition: The kind of dose or rate specified, for example, ordered or calculated.
    • Requirements: If the type is not populated, assume to be "ordered".
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    dose?: IDataType

    Dosage.doseAndRate.dose[x] Element

    @ChoiceDataTypesMeta('Dosage.doseAndRate.dose[x]', ['Range','Quantity',]

    FHIR Specification

    • Short: Amount of medication per dose
    • Definition: Amount of medication per dose.
    • Comment: 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.
    • Requirements: The amount of therapeutic or other substance given at one administration event.
    • FHIR Types: 'Range', 'Quantity',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    rate?: IDataType

    Dosage.doseAndRate.rate[x] Element

    @ChoiceDataTypesMeta('Dosage.doseAndRate.rate[x]', ['Ratio','Range','Quantity',]

    FHIR Specification

    • Short: Amount of medication per unit of time
    • Definition: Amount of medication per unit of time.
    • Comment: 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.
    • 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.
    • FHIR Types: 'Ratio', 'Range', 'Quantity',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DosageDoseAndRateComponent

      • OptionaloptSourceField: string

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

      Returns undefined | DosageDoseAndRateComponent

      DosageDoseAndRateComponent data model or undefined for DosageDoseAndRateComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods