| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
"A plan, proposal or order that is fulfilled in whole or in part by this event." - HL7 FHIR, MedicationStatement.basedOn |
«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. |
«TS» PointInTime | dateAsserted |
"The date when the medication statement was asserted by the information source." - HL7 FHIR, MedicationStatement.dateAsserted |
«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] |
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 |
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 |
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 |
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 |
"A larger event of which this particular event is a component or step." - HL7 FHIR, MedicationStatement.partOf |
«CS» Code | reasonCode |
"A reason for why the medication is being/was taken." - HL7 FHIR, MedicationStatement.reasonCode |
«CS» Code | reasonReference |
"Condition or observation that supports why the medication is being/was taken." - HL7 FHIR, MedicationStatement.reasonReference |
«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. |
«CS» Code | statusReason |
"Captures the reason for the current state of the MedicationStatement." - HL7 FHIR, MedicationStatement.statusReason |
Attributes inherited from FHIM::Common::ClinicalStatement | ||
clinicalDataSource, contentVersion, contextCode, encounter, note, recordStatus, relatedClinicalInformation, sourceRecordType, sourceSystem, subjectGroup, subjectOfInformation, subjectOfRecord, temporalContext, topicCode, cosigned, recorded, signed, verified |
Attributes inherited from FHIM::Common::InformationEntry | ||
identifier |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | PatientReportedMedication |
Name Expression | |
Namespace | Pharmacy |
Owned Template Signature | |
Owner | Pharmacy |
Owning Template Parameter | |
Package | Pharmacy |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public ActionStatement basedOn
"A plan, proposal or order that is fulfilled in whole or in part by this event." - HL7 FHIR, MedicationStatement.basedOn
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | basedOn |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::basedOn |
Stereotype | |
Template Parameter | |
Type | ActionStatement |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
Terminologies | [ HL7_FHIR_R4 Medication usage category codes http://hl7.org/fhir/ValueSet/medication-usage-category ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | category |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::category |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime dateAsserted
"The date when the medication statement was asserted by the information source." - HL7 FHIR, MedicationStatement.dateAsserted
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | dateAsserted |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::dateAsserted |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | dateRange |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::dateRange |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | derivedFrom |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::derivedFrom |
Stereotype | |
Template Parameter | |
Type | ClinicalStatement |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | dosage |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::dosage |
Stereotype | |
Template Parameter | |
Type | Dosage |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | isDiscontinued |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::isDiscontinued |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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]
Aggregation | None |
Alias | |
Association | patientReportedMedication_orderablePharmacyItem |
Association End | |
Class | PatientReportedMedication |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | medication |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::medication |
Stereotype | |
Template Parameter | |
Type | OrderablePharmacyItem |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public ClinicalStatement partOf
"A larger event of which this particular event is a component or step." - HL7 FHIR, MedicationStatement.partOf
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | partOf |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::partOf |
Stereotype | |
Template Parameter | |
Type | ClinicalStatement |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code reasonCode
"A reason for why the medication is being/was taken." - HL7 FHIR, MedicationStatement.reasonCode
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
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 Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | reasonCode |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::reasonCode |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code reasonReference
"Condition or observation that supports why the medication is being/was taken." - HL7 FHIR, MedicationStatement.reasonReference
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | reasonReference |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::reasonReference |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
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 Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | status |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::status |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code statusReason
"Captures the reason for the current state of the MedicationStatement." - HL7 FHIR, MedicationStatement.statusReason
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PatientReportedMedication |
Terminologies | [ HL7_FHIR_R4 SNOMED CT Drug Therapy Status codes http://hl7.org/fhir/ValueSet/reason-medication-status-codes ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | statusReason |
Name Expression | |
Namespace | PatientReportedMedication |
Opposite | |
Owner | PatientReportedMedication |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PatientReportedMedication::statusReason |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |