Data Model Libraries
    Preparing search index...

    Class MedicationAdministration

    MedicationAdministration Class

    Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. This event can also be used to record waste using a status of not-done and the appropriate statusReason.

    FHIR Specification

    • Short: Administration of medication to a patient
    • Definition: Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
    • FHIR Version: 5.0.0

    FHIR MedicationAdministration

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? basedOn? partOf? medicationAdminStatusEnum status statusReason? category? medication subject encounter? supportingInformation? occurence recorded? isSubPotent? subPotentReason? performer? reason? request? device? note? dosage? eventHistory?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getBasedOn setBasedOn addBasedOn hasBasedOn getPartOf setPartOf addPartOf hasPartOf getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusReason setStatusReason addStatusReason hasStatusReason getCategory setCategory addCategory hasCategory getMedication setMedication hasMedication getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getSupportingInformation setSupportingInformation addSupportingInformation hasSupportingInformation getOccurence setOccurence hasOccurence getOccurenceDateTimeType hasOccurenceDateTimeType getOccurencePeriod hasOccurencePeriod getOccurenceTiming hasOccurenceTiming getRecordedElement setRecordedElement hasRecordedElement getRecorded setRecorded hasRecorded getIsSubPotentElement setIsSubPotentElement hasIsSubPotentElement getIsSubPotent setIsSubPotent hasIsSubPotent getSubPotentReason setSubPotentReason addSubPotentReason hasSubPotentReason getPerformer setPerformer addPerformer hasPerformer getReason setReason addReason hasReason getRequest setRequest hasRequest getDevice setDevice addDevice hasDevice getNote setNote addNote hasNote getDosage setDosage hasDosage getEventHistory setEventHistory addEventHistory hasEventHistory fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initBasedOn initPartOf initStatusReason initCategory initSupportingInformation initSubPotentReason initPerformer initReason initDevice initNote initEventHistory

    Constructors

    Properties

    identifier?: Identifier[]

    MedicationAdministration.identifier Element

    FHIR Specification

    • Short: External identifier
    • Definition: Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
    • Comment: This is a business identifier, not a resource identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    basedOn?: Reference[]

    MedicationAdministration.basedOn Element

    FHIR Specification

    • Short: Plan this is fulfilled by this administration
    • Definition: A plan that is fulfilled in whole or in part by this MedicationAdministration.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    partOf?: Reference[]

    MedicationAdministration.partOf Element

    FHIR Specification

    medicationAdminStatusEnum: MedicationAdminStatusEnum

    FHIR CodeSystem: MedicationAdminStatus

    MedicationAdminStatusEnum

    status: null | EnumCodeType

    MedicationAdministration.status Element

    FHIR Specification

    • Short: in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
    • Definition: Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: MedicationAdminStatusEnum

    statusReason?: CodeableConcept[]

    MedicationAdministration.statusReason Element

    FHIR Specification

    • Short: Reason administration not performed
    • Definition: A code indicating why the administration was not performed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    category?: CodeableConcept[]

    MedicationAdministration.category Element

    FHIR Specification

    • Short: Type of medication administration
    • Definition: The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    medication: null | CodeableReference

    MedicationAdministration.medication Element

    FHIR Specification

    • Short: What was administered
    • Definition: Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
    • Comment: If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.
    • FHIR Type: CodeableReference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    MedicationAdministration.subject Element

    FHIR Specification

    encounter?: Reference

    MedicationAdministration.encounter Element

    FHIR Specification

    • Short: Encounter administered as part of
    • Definition: The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    supportingInformation?: Reference[]

    MedicationAdministration.supportingInformation Element

    FHIR Specification

    • Short: Additional information to support administration
    • Definition: Additional information (for example, patient height and weight) that supports the administration of the medication. This attribute can be used to provide documentation of specific characteristics of the patient present at the time of administration. For example, if the dose says "give "x" if the heartrate exceeds "y"", then the heart rate can be included using this attribute.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    occurence: null | IDataType

    MedicationAdministration.occurence[x] Element

    @ChoiceDataTypesMeta('MedicationAdministration.occurence[x]', ['dateTime','Period','Timing',]

    FHIR Specification

    • Short: Specific date/time or interval of time during which the administration took place (or did not take place)
    • Definition: A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
    • FHIR Types: 'dateTime', 'Period', 'Timing',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    recorded?: DateTimeType

    MedicationAdministration.recorded Element

    FHIR Specification

    • Short: When the MedicationAdministration was first captured in the subject's record
    • Definition: The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    isSubPotent?: BooleanType

    MedicationAdministration.isSubPotent Element

    FHIR Specification

    • Short: Full dose was not administered
    • Definition: An indication that the full dose was not administered.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    subPotentReason?: CodeableConcept[]

    MedicationAdministration.subPotentReason Element

    FHIR Specification

    • Short: Reason full dose was not administered
    • Definition: The reason or reasons why the full dose was not administered.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    performer?: MedicationAdministrationPerformerComponent[]

    MedicationAdministration.performer Element

    FHIR Specification

    • Short: Who or what performed the medication administration and what type of performance they did
    • Definition: The performer of the medication treatment. For devices this is the device that performed the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    reason?: CodeableReference[]

    MedicationAdministration.reason Element

    FHIR Specification

    request?: Reference

    MedicationAdministration.request Element

    FHIR Specification

    • Short: Request administration performed against
    • Definition: The original request, instruction or authority to perform the administration.
    • Comment: This is a reference to the MedicationRequest where the intent is either order or instance-order. It should not reference MedicationRequests where the intent is any other value.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    device?: CodeableReference[]

    MedicationAdministration.device Element

    FHIR Specification

    • Short: Device used to administer
    • Definition: The device that is to be used for the administration of the medication (for example, PCA Pump).
    • FHIR Type: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    MedicationAdministration.note Element

    FHIR Specification

    • Short: Information about the administration
    • Definition: Extra information about the medication administration that is not conveyed by the other attributes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    dosage?: MedicationAdministrationDosageComponent

    MedicationAdministration.dosage Element

    FHIR Specification

    • Short: Details of how medication was taken
    • Definition: Describes the medication dosage information details e.g. dose, rate, site, route, etc.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    eventHistory?: Reference[]

    MedicationAdministration.eventHistory Element

    FHIR Specification

    • Short: A list of events of interest in the lifecycle
    • Definition: A summary of the events of interest that have occurred, such as when the administration was verified.
    • Comment: This might not include provenances for all versions of the request - only those deemed "relevant" or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a "relevant" change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationAdministration

      • OptionaloptSourceField: string

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

      Returns undefined | MedicationAdministration

      MedicationAdministration data model or undefined for MedicationAdministration

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetBasedOnsetBasedOnaddBasedOnhasBasedOngetPartOfsetPartOfaddPartOfhasPartOfgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusReasonsetStatusReasonaddStatusReasonhasStatusReasongetCategorysetCategoryaddCategoryhasCategorygetMedicationsetMedicationhasMedicationgetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetSupportingInformationsetSupportingInformationaddSupportingInformationhasSupportingInformationgetOccurencesetOccurencehasOccurencegetOccurenceDateTimeTypehasOccurenceDateTimeTypegetOccurencePeriodhasOccurencePeriodgetOccurenceTiminghasOccurenceTiminggetRecordedElementsetRecordedElementhasRecordedElementgetRecordedsetRecordedhasRecordedgetIsSubPotentElementsetIsSubPotentElementhasIsSubPotentElementgetIsSubPotentsetIsSubPotenthasIsSubPotentgetSubPotentReasonsetSubPotentReasonaddSubPotentReasonhasSubPotentReasongetPerformersetPerformeraddPerformerhasPerformergetReasonsetReasonaddReasonhasReasongetRequestsetRequesthasRequestgetDevicesetDeviceaddDevicehasDevicegetNotesetNoteaddNotehasNotegetDosagesetDosagehasDosagegetEventHistorysetEventHistoryaddEventHistoryhasEventHistoryfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitBasedOninitPartOfinitStatusReasoninitCategoryinitSupportingInformationinitSubPotentReasoninitPerformerinitReasoninitDeviceinitNoteinitEventHistory