Data Model Libraries
    Preparing search index...

    Class MedicationStatement

    MedicationStatement Class

    A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.

    FHIR Specification

    • Short: Record of medication being taken by a patient
    • Definition: A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.
    • Comment: When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error.
    • FHIR Version: 4.3.0

    FHIR MedicationStatement

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? basedOn? partOf? medicationStatementStatusEnum status statusReason? category? medication subject context? effective? dateAsserted? informationSource? derivedFrom? reasonCode? reasonReference? note? dosage?

    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 hasCategory getMedication setMedication hasMedication getMedicationCodeableConcept hasMedicationCodeableConcept getMedicationReference hasMedicationReference getSubject setSubject hasSubject getContext setContext hasContext getEffective setEffective hasEffective getEffectiveDateTimeType hasEffectiveDateTimeType getEffectivePeriod hasEffectivePeriod getDateAssertedElement setDateAssertedElement hasDateAssertedElement getDateAsserted setDateAsserted hasDateAsserted getInformationSource setInformationSource hasInformationSource getDerivedFrom setDerivedFrom addDerivedFrom hasDerivedFrom getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getNote setNote addNote hasNote getDosage setDosage addDosage hasDosage 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 initDerivedFrom initReasonCode initReasonReference initNote initDosage

    Constructors

    Properties

    identifier?: Identifier[]

    MedicationStatement.identifier Element

    FHIR Specification

    • Short: External identifier
    • Definition: Identifiers associated with this Medication Statement 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: true
    basedOn?: Reference[]

    MedicationStatement.basedOn Element

    FHIR Specification

    partOf?: Reference[]

    MedicationStatement.partOf Element

    FHIR Specification

    medicationStatementStatusEnum: MedicationStatementStatusEnum

    FHIR CodeSystem: MedicationStatementStatus

    MedicationStatementStatusEnum

    status: null | EnumCodeType

    MedicationStatement.status Element

    FHIR Specification

    • Short: active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
    • Definition: A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.
    • Comment: MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error). 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: MedicationStatementStatusEnum

    statusReason?: CodeableConcept[]

    MedicationStatement.statusReason Element

    FHIR Specification

    • Short: Reason for current status
    • Definition: Captures the reason for the current state of the MedicationStatement.
    • Comment: This is generally only used for "exception" statuses such as "not-taken", "on-hold", "cancelled" or "entered-in-error". The reason for performing the event at all is captured in reasonCode, not here.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    category?: CodeableConcept

    MedicationStatement.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: true
    medication: null | IDataType

    MedicationStatement.medication[x] Element

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

    FHIR Specification

    • Short: What medication was taken
    • Definition: Identifies the medication being 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

    MedicationStatement.subject Element

    FHIR Specification

    context?: Reference

    MedicationStatement.context Element

    FHIR Specification

    effective?: IDataType

    MedicationStatement.effective[x] Element

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

    FHIR Specification

    • Short: The date/time or interval when the medication is/was/will be taken
    • Definition: The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).
    • Comment: This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.
    • FHIR Types: 'dateTime', 'Period',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    dateAsserted?: DateTimeType

    MedicationStatement.dateAsserted Element

    FHIR Specification

    • Short: When the statement was asserted?
    • Definition: The date when the medication statement was asserted by the information source.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    informationSource?: Reference

    MedicationStatement.informationSource Element

    FHIR Specification

    derivedFrom?: Reference[]

    MedicationStatement.derivedFrom Element

    FHIR Specification

    • Short: Additional supporting information
    • Definition: Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.
    • Comment: Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonCode?: CodeableConcept[]

    MedicationStatement.reasonCode Element

    FHIR Specification

    • Short: Reason for why the medication is being/was taken
    • Definition: A reason for why the medication is being/was taken.
    • Comment: This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonReference?: Reference[]

    MedicationStatement.reasonReference Element

    FHIR Specification

    note?: Annotation[]

    MedicationStatement.note Element

    FHIR Specification

    • Short: Further information about the statement
    • Definition: Provides extra information about the medication statement that is not conveyed by the other attributes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    dosage?: Dosage[]

    MedicationStatement.dosage Element

    FHIR Specification

    • Short: Details of how medication is/was taken or should be taken
    • Definition: Indicates how the medication is/was or should be taken by the patient.
    • Comment: The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest.
    • FHIR Type: Dosage
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationStatement

      • OptionaloptSourceField: string

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

      Returns undefined | MedicationStatement

      MedicationStatement data model or undefined for MedicationStatement

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the partOf property.

      Parameters

      • value: undefined | Reference[]

        the partOf array value

      Returns this

      this

      @ReferenceTargets('MedicationStatement.partOf', ['MedicationAdministration','MedicationDispense','MedicationStatement','Procedure','Observation',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided InformationSource object value to the informationSource property.

      Parameters

      • value: undefined | Reference

        the informationSource object value

      Returns this

      this

      @ReferenceTargets('MedicationStatement.informationSource', ['Patient','Practitioner','PractitionerRole','RelatedPerson','Organization',])

      InvalidTypeError for invalid data type or reference value

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