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.

    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: 4.3.0

    FHIR MedicationAdministration

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? instantiates? partOf? medicationAdminStatusEnum status statusReason? category? medication subject context? supportingInformation? effective performer? reasonCode? reasonReference? request? device? note? dosage? eventHistory?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getInstantiatesElement setInstantiatesElement addInstantiatesElement hasInstantiatesElement getInstantiates setInstantiates addInstantiates hasInstantiates getPartOf setPartOf addPartOf hasPartOf getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusReason setStatusReason addStatusReason hasStatusReason getCategory setCategory hasCategory getMedication setMedication hasMedication getMedicationCodeableConcept hasMedicationCodeableConcept getMedicationReference hasMedicationReference getSubject setSubject hasSubject getContext setContext hasContext getSupportingInformation setSupportingInformation addSupportingInformation hasSupportingInformation getEffective setEffective hasEffective getEffectiveDateTimeType hasEffectiveDateTimeType getEffectivePeriod hasEffectivePeriod getPerformer setPerformer addPerformer hasPerformer getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference 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 initInstantiates initPartOf initStatusReason initSupportingInformation initPerformer initReasonCode initReasonReference 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
    instantiates?: UriType[]

    MedicationAdministration.instantiates Element

    FHIR Specification

    • Short: Instantiates protocol or definition
    • Definition: A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    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 usage
    • Definition: Indicates where the medication is expected to be consumed or administered.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    medication: null | IDataType

    MedicationAdministration.medication[x] Element

    @ChoiceDataTypesMeta('MedicationAdministration.medication[x]', ['CodeableConcept','Reference',]

    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 Types: 'CodeableConcept', 'Reference',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    MedicationAdministration.subject Element

    FHIR Specification

    context?: Reference

    MedicationAdministration.context Element

    FHIR Specification

    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.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    effective: null | IDataType

    MedicationAdministration.effective[x] Element

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

    FHIR Specification

    • Short: Start and end time of administration
    • Definition: A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
    • FHIR Types: 'dateTime', 'Period',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    performer?: MedicationAdministrationPerformerComponent[]

    MedicationAdministration.performer Element

    FHIR Specification

    • Short: Who performed the medication administration and what they did
    • Definition: Indicates who or what performed the medication administration and how they were involved.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    reasonCode?: CodeableConcept[]

    MedicationAdministration.reasonCode Element

    FHIR Specification

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

    MedicationAdministration.reasonReference 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?: Reference[]

    MedicationAdministration.device Element

    FHIR Specification

    • Short: Device used to administer
    • Definition: The device used in administering the medication to the patient. For example, a particular infusion pump.
    • FHIR Type: Reference
    • 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

    • 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetInstantiatesElementsetInstantiatesElementaddInstantiatesElementhasInstantiatesElementgetInstantiatessetInstantiatesaddInstantiateshasInstantiatesgetPartOfsetPartOfaddPartOfhasPartOfgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusReasonsetStatusReasonaddStatusReasonhasStatusReasongetCategorysetCategoryhasCategorygetMedicationsetMedicationhasMedicationgetMedicationCodeableConcepthasMedicationCodeableConceptgetMedicationReferencehasMedicationReferencegetSubjectsetSubjecthasSubjectgetContextsetContexthasContextgetSupportingInformationsetSupportingInformationaddSupportingInformationhasSupportingInformationgetEffectivesetEffectivehasEffectivegetEffectiveDateTimeTypehasEffectiveDateTimeTypegetEffectivePeriodhasEffectivePeriodgetPerformersetPerformeraddPerformerhasPerformergetReasonCodesetReasonCodeaddReasonCodehasReasonCodegetReasonReferencesetReasonReferenceaddReasonReferencehasReasonReferencegetRequestsetRequesthasRequestgetDevicesetDeviceaddDevicehasDevicegetNotesetNoteaddNotehasNotegetDosagesetDosagehasDosagegetEventHistorysetEventHistoryaddEventHistoryhasEventHistoryfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitInstantiatesinitPartOfinitStatusReasoninitSupportingInformationinitPerformerinitReasonCodeinitReasonReferenceinitDeviceinitNoteinitEventHistory