| MedicationAdministration UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
"Information about the actual consumption of medication by a patient. While this is generally only relevant for hospital/institutional systems which track individual administrations, it could also be used in ambulatory care e.g. home-health environments which capture administrations such as insulin injections and which use messaging to communicate the information back to a central source; recording immunizations." (HL7 Version 3).
Attributes | ||
AdministeredDrug | administeredDrug |
Pointer to the medication or substance that was or will be administered."Contains the identifier of the medical substance/treatment administered.... If the substance administered is a vaccine, CVX codes may be used to code this field...." - HL7 Version 2.8, RXA-5"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." - HL7 FHIR, MedicationAdministration.medication[x]"Vaccine that was administered or was to be administered." - HL7 FHIR, Immunization.vaccineCode |
«CS» Code | category |
""Indicates where the medication is expected to be consumed or administered." - HL7 FHIR, MedicationAdministration.category" - HL7 FHIR, MedicationAdministration.category. Possible values for this property include Inpatient, Outpatient, Community. |
DeviceInstance | deviceInstance |
"The device used in administering the medication to the patient. For example, a particular infusion pump." - HL7 FHIR, MedicationAdministration.device |
MedicationAdministrationTopic | medicationAdministrationTopic | |
Boolean | notGiven |
This property is included for compatibility to FHIR. FHIM uses separate classes to indicate medication administrations that happened or didn't happen. If this property is to be used, it would be hard-coded to true."Indicates if the vaccination was or was not given." - HL7 FHIR, Immunization.notGiven"Set this to true if the record is saying that the medication was NOT administered." - HL7 FHIR, MedicationAdministration.notGiven |
HealthConcern | patientCondition |
Patient conditions are observations about the patient which impact forecasting next doses. These include allergies, previous adverse reactions and special risk factors. |
PatientEducationPerformed | patientEducationPerformed |
Pointer to any counselling or education provided to the Patient with regards to the medication (or vaccine) being administered. |
«PQ» Quantity | quantityGiven |
"Contains the amount administered." - HL7 Version 2.8, RXA-6"This field is conditional because it is required if the administered amount code does not imply units. This field must be in simple units that reflect the actual quantity of the substance administered. It does not include compound units." - HL7 Version 2.8, RXA-7"The amount of the therapeutic agent or other substance given at one administration event." - HL7 Version 3 |
ReactionObservation | reaction |
Pointer to a record of an adverse physiological response attributed to the exposure of the Patient to the given substance"Categorical data indicating that an adverse event is associated in time to an immunization." - HL7 FHIR, Immunization.reaction |
«TS» PointInTime | systemEntryDateTime |
"Date/time the administration information was entered into the source system. This field is used to detect instances where treatment administration information is inadvertently entered multiple times by providing a unique identification field. Under usual circumstances, this field would be provided automatically by the computer system rather than being entered by a person." - HL7 Version 2.8, RXA-22 |
Attributes inherited from FHIM::Common::ActionPerformed | ||
basedOn, bodySite, complication, complicationDetail, duration, enactsPlan, focalDevice, followUp, fulfillsOrder, fulfillsPromise, nonCompletionTimeframe, outcome, partOf, performancePeriod, performer, procedureModifier, report, researchStudy, status, statusReason, timesPerformed, topicCode, usedCode, usedReference, wasCompleted |
Attributes inherited from FHIM::Common::ActionStatement | ||
category, currentStatus, description, indication, inputFinding, instantiatesCanonical, instantiatesUri, insurance, intent, justification, location, method, outputFinding, precondition, reasonCode, reasonNarrative, reasonReference, relevantHistory, scope, supportingInformation, usingDevice, wasReported |
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 | MedicationAdministrationPerformed |
Name Expression | |
Namespace | MedicationAdministration |
Owned Template Signature | |
Owner | MedicationAdministration |
Owning Template Parameter | |
Package | MedicationAdministration |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public AdministeredDrug administeredDrug
Pointer to the medication or substance that was or will be administered."Contains the identifier of the medical substance/treatment administered.... If the substance administered is a vaccine, CVX codes may be used to code this field...." - HL7 Version 2.8, RXA-5"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." - HL7 FHIR, MedicationAdministration.medication[x]"Vaccine that was administered or was to be administered." - HL7 FHIR, Immunization.vaccineCode
Aggregation | None |
Alias | |
Association | medicationAdministrationPerformed_administeredDrug |
Association End | |
Class | MedicationAdministrationPerformed |
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 | administeredDrug |
Name Expression | |
Namespace | MedicationAdministrationPerformed |
Opposite | |
Owner | MedicationAdministrationPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed::administeredDrug |
Stereotype | |
Template Parameter | |
Type | AdministeredDrug |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code category
""Indicates where the medication is expected to be consumed or administered." - HL7 FHIR, MedicationAdministration.category" - HL7 FHIR, MedicationAdministration.category. Possible values for this property include Inpatient, Outpatient, Community.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicationAdministrationPerformed |
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 | MedicationAdministrationPerformed |
Opposite | |
Owner | MedicationAdministrationPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed::category |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public DeviceInstance deviceInstance
"The device used in administering the medication to the patient. For example, a particular infusion pump." - HL7 FHIR, MedicationAdministration.device
Aggregation | None |
Alias | |
Association | mMedicationAdministrationPerformed_deviceInstance |
Association End | |
Class | MedicationAdministrationPerformed |
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 | deviceInstance |
Name Expression | |
Namespace | MedicationAdministrationPerformed |
Opposite | |
Owner | MedicationAdministrationPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed::deviceInstance |
Stereotype | |
Template Parameter | |
Type | DeviceInstance |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public MedicationAdministrationTopic medicationAdministrationTopic
Aggregation | None |
Alias | |
Association | medicationAdministrationPerformed_medicationAdministrationTopic |
Association End | |
Class | MedicationAdministrationPerformed |
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 | medicationAdministrationTopic |
Name Expression | |
Namespace | MedicationAdministrationPerformed |
Opposite | |
Owner | MedicationAdministrationPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed::medicationAdministrationTopic |
Stereotype | |
Template Parameter | |
Type | MedicationAdministrationTopic |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Boolean notGiven
This property is included for compatibility to FHIR. FHIM uses separate classes to indicate medication administrations that happened or didn't happen. If this property is to be used, it would be hard-coded to true."Indicates if the vaccination was or was not given." - HL7 FHIR, Immunization.notGiven"Set this to true if the record is saying that the medication was NOT administered." - HL7 FHIR, MedicationAdministration.notGiven
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicationAdministrationPerformed |
Datatype | |
Default | false |
Default Value | (false) |
Is Composite | false |
Is Derived | true |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | true |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | notGiven |
Name Expression | |
Namespace | MedicationAdministrationPerformed |
Opposite | |
Owner | MedicationAdministrationPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed::notGiven |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public HealthConcern patientCondition
Patient conditions are observations about the patient which impact forecasting next doses. These include allergies, previous adverse reactions and special risk factors.
Aggregation | None |
Alias | |
Association | medicationAdministrationPerformed_patientCondition |
Association End | |
Class | MedicationAdministrationPerformed |
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 | patientCondition |
Name Expression | |
Namespace | MedicationAdministrationPerformed |
Opposite | |
Owner | MedicationAdministrationPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed::patientCondition |
Stereotype | |
Template Parameter | |
Type | HealthConcern |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public PatientEducationPerformed patientEducationPerformed
Pointer to any counselling or education provided to the Patient with regards to the medication (or vaccine) being administered.
Aggregation | None |
Alias | |
Association | medicationAdministrationPerformed_patientEducationPerformed |
Association End | |
Class | MedicationAdministrationPerformed |
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 | patientEducationPerformed |
Name Expression | |
Namespace | MedicationAdministrationPerformed |
Opposite | |
Owner | MedicationAdministrationPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed::patientEducationPerformed |
Stereotype | |
Template Parameter | |
Type | PatientEducationPerformed |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «PQ» Quantity quantityGiven
"Contains the amount administered." - HL7 Version 2.8, RXA-6"This field is conditional because it is required if the administered amount code does not imply units. This field must be in simple units that reflect the actual quantity of the substance administered. It does not include compound units." - HL7 Version 2.8, RXA-7"The amount of the therapeutic agent or other substance given at one administration event." - HL7 Version 3
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicationAdministrationPerformed |
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 | quantityGiven |
Name Expression | |
Namespace | MedicationAdministrationPerformed |
Opposite | |
Owner | MedicationAdministrationPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed::quantityGiven |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public ReactionObservation reaction
Pointer to a record of an adverse physiological response attributed to the exposure of the Patient to the given substance"Categorical data indicating that an adverse event is associated in time to an immunization." - HL7 FHIR, Immunization.reaction
Aggregation | None |
Alias | |
Association | medicationAdministrationPerformed_reaction |
Association End | |
Class | MedicationAdministrationPerformed |
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 | reaction |
Name Expression | |
Namespace | MedicationAdministrationPerformed |
Opposite | |
Owner | MedicationAdministrationPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed::reaction |
Stereotype | |
Template Parameter | |
Type | ReactionObservation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime systemEntryDateTime
"Date/time the administration information was entered into the source system. This field is used to detect instances where treatment administration information is inadvertently entered multiple times by providing a unique identification field. Under usual circumstances, this field would be provided automatically by the computer system rather than being entered by a person." - HL7 Version 2.8, RXA-22
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicationAdministrationPerformed |
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 | systemEntryDateTime |
Name Expression | |
Namespace | MedicationAdministrationPerformed |
Opposite | |
Owner | MedicationAdministrationPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::MedicationAdministration::MedicationAdministrationPerformed::systemEntryDateTime |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| MedicationAdministration UML Documentation |
Summary:AttributesProperties | Detail:Attributes |