Pharmacy
Class PatientReportedMedication

Contains information about a medication which the patient reports to be using. This includes over-the-counter, vitamins, herbal products, and non-prescribed medications. This information is used by the orderer and/or the pharmacy to perform drug-drug interaction checks and to ascertain whether the patient is utilizing the appropriate mix of medications for their condition(s).

"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." - HL7 FHIR, MedicationStatement

Attributes
ActionStatement basedOn basedOn

"A plan, proposal or order that is fulfilled in whole or in part by this event." - HL7 FHIR, MedicationStatement.basedOn

«CS» Code category category

"Indicates where the medication is expected to be consumed or administered." - HL7 FHIR, MedicationStatement.category. In FHIR, the possible values are: Inpatient; Outpatient; Community; Patient specified.

«TS» PointInTime dateAsserted dateAsserted

"The date when the medication statement was asserted by the information source." - HL7 FHIR, MedicationStatement.dateAsserted

«IVL_TS» Period dateRange dateRange

The time period during which the patient was using the medication. This property is a TimeInterval, which contains a start and end date. It is expected that the start date may be unknown, and that the end date will be blank if the patient is still using the medication. Therefore either or both of the dates may be blank.
"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)." - HL7 FHIR, MedicationStatement.effective[x]

ClinicalStatement derivedFrom derivedFrom

"Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement." - HL7 FHIR, MedicationStatement.derivedFrom

Dosage dosage dosage

The amount of the described medication being that the patient is "taking" or using at each instance in time. Note that originally, this FHIM class used a PhysicalQuantityInterval datatype, but FHIR uses the Dosage construct, so FHIM has been changed to do so also, for compatibility with FHIR.
"Indicates how the medication is/was or should be taken by the patient." - HL7 FHIR, MedicationStatement.dosage

Boolean isDiscontinued isDiscontinued

Indicates whether the patient has discontinued using the medication. This property could be calculated if an end date is known, but may be set independently if the end date is not known. This property is useful for separating historical from current records.

OrderablePharmacyItem medication medication

Pointer to the medicinal product that the Patient is reported to be or have been consuming.
"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." - HL7 FHIR, MedicationStatement.medication[x]

ClinicalStatement partOf partOf

"A larger event of which this particular event is a component or step." - HL7 FHIR, MedicationStatement.partOf

«CS» Code reasonCode reasonCode

"A reason for why the medication is being/was taken." - HL7 FHIR, MedicationStatement.reasonCode

«CS» Code reasonReference reasonReference

"Condition or observation that supports why the medication is being/was taken." - HL7 FHIR, MedicationStatement.reasonReference

«CS» Code status status

"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." - HL7 FHIR, MedicationStatement.status. In FHIR, the possible values are: Active; Completed; Entered in Error; Intended; Stopped; On Hold; Unknown; Not Taken.

«CS» Code statusReason statusReason

"Captures the reason for the current state of the MedicationStatement." - HL7 FHIR, MedicationStatement.statusReason

Attributes inherited from FHIM::Common::ClinicalStatement FHIM::Common::ClinicalStatement
clinicalDataSource clinicalDataSource, contentVersion contentVersion, contextCode contextCode, encounter encounter, note note, recordStatus recordStatus, relatedClinicalInformation relatedClinicalInformation, sourceRecordType sourceRecordType, sourceSystem sourceSystem, subjectGroup subjectGroup, subjectOfInformation subjectOfInformation, subjectOfRecord subjectOfRecord, temporalContext temporalContext, topicCode topicCode, cosigned cosigned, recorded recorded, signed signed, verified verified

Attributes inherited from FHIM::Common::InformationEntry FHIM::Common::InformationEntry
identifier identifier

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NamePatientReportedMedication
Name Expression
NamespacePharmacy
Owned Template Signature
OwnerPharmacy
Owning Template Parameter
PackagePharmacy
Qualified NameFHIM::Pharmacy::PatientReportedMedication
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 basedOn
Public ActionStatement basedOn

"A plan, proposal or order that is fulfilled in whole or in part by this event." - HL7 FHIR, MedicationStatement.basedOn

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamebasedOn
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::basedOn
Stereotype
Template Parameter
TypeActionStatement
Upper*
Upper Value(*)
VisibilityPublic


 category
Public «CS» Code category

"Indicates where the medication is expected to be consumed or administered." - HL7 FHIR, MedicationStatement.category. In FHIR, the possible values are: Inpatient; Outpatient; Community; Patient specified.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Terminologies[
HL7_FHIR_R4 Medication usage category codes http://hl7.org/fhir/ValueSet/medication-usage-category
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namecategory
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::category
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 dateAsserted
Public «TS» PointInTime dateAsserted

"The date when the medication statement was asserted by the information source." - HL7 FHIR, MedicationStatement.dateAsserted

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedateAsserted
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::dateAsserted
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dateRange
Public «IVL_TS» Period dateRange

The time period during which the patient was using the medication. This property is a TimeInterval, which contains a start and end date. It is expected that the start date may be unknown, and that the end date will be blank if the patient is still using the medication. Therefore either or both of the dates may be blank.
"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)." - HL7 FHIR, MedicationStatement.effective[x]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedateRange
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::dateRange
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 derivedFrom
Public ClinicalStatement derivedFrom

"Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement." - HL7 FHIR, MedicationStatement.derivedFrom

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamederivedFrom
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::derivedFrom
Stereotype
Template Parameter
TypeClinicalStatement
Upper*
Upper Value(*)
VisibilityPublic


 dosage
Public Dosage dosage

The amount of the described medication being that the patient is "taking" or using at each instance in time. Note that originally, this FHIM class used a PhysicalQuantityInterval datatype, but FHIR uses the Dosage construct, so FHIM has been changed to do so also, for compatibility with FHIR.
"Indicates how the medication is/was or should be taken by the patient." - HL7 FHIR, MedicationStatement.dosage

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namedosage
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::dosage
Stereotype
Template Parameter
TypeDosage
Upper*
Upper Value(*)
VisibilityPublic


 isDiscontinued
Public Boolean isDiscontinued

Indicates whether the patient has discontinued using the medication. This property could be calculated if an end date is known, but may be set independently if the end date is not known. This property is useful for separating historical from current records.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisDiscontinued
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::isDiscontinued
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 medication
Public OrderablePharmacyItem medication

Pointer to the medicinal product that the Patient is reported to be or have been consuming.
"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." - HL7 FHIR, MedicationStatement.medication[x]

Constraints:
Properties:

AggregationNone
Alias
AssociationpatientReportedMedication_orderablePharmacyItem
Association End
ClassPatientReportedMedication
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namemedication
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::medication
Stereotype
Template Parameter
TypeOrderablePharmacyItem
Upper1
Upper Value(1)
VisibilityPublic


 partOf
Public ClinicalStatement partOf

"A larger event of which this particular event is a component or step." - HL7 FHIR, MedicationStatement.partOf

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamepartOf
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::partOf
Stereotype
Template Parameter
TypeClinicalStatement
Upper*
Upper Value(*)
VisibilityPublic


 reasonCode
Public «CS» Code reasonCode

"A reason for why the medication is being/was taken." - HL7 FHIR, MedicationStatement.reasonCode

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Terminologies[
C-CDA_2.1 Problem 2.16.840.1.113883.3.88.12.3221.7.4
,
HL7_FHIR_R4 Condition/Problem/Diagnosis Codes http://hl7.org/fhir/ValueSet/condition-code
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamereasonCode
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::reasonCode
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 reasonReference
Public «CS» Code reasonReference

"Condition or observation that supports why the medication is being/was taken." - HL7 FHIR, MedicationStatement.reasonReference

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamereasonReference
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::reasonReference
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 status
Public «CS» Code status

"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." - HL7 FHIR, MedicationStatement.status. In FHIR, the possible values are: Active; Completed; Entered in Error; Intended; Stopped; On Hold; Unknown; Not Taken.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Terminologies[
C-CDA_2.1 Medication Status 2.16.840.1.113762.1.4.1099.11
,
HL7_FHIR_R4 Medication usage status codes http://hl7.org/fhir/ValueSet/medication-usage-status
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namestatus
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::status
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 statusReason
Public «CS» Code statusReason

"Captures the reason for the current state of the MedicationStatement." - HL7 FHIR, MedicationStatement.statusReason

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPatientReportedMedication
Terminologies[
HL7_FHIR_R4 SNOMED CT Drug Therapy Status codes http://hl7.org/fhir/ValueSet/reason-medication-status-codes
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamestatusReason
Name Expression
NamespacePatientReportedMedication
Opposite
OwnerPatientReportedMedication
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PatientReportedMedication::statusReason
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic