IHE Pharmacy Medication Record
0.1.0 - ci-build International flag

IHE Pharmacy Medication Record, published by Integrating the Healthcare Enterprise (IHE). This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/IHE/pharm-medo/ and changes regularly. See the Directory of published versions

Logical Model: ModelMedicationRecord - Detailed Descriptions

Active as of 2023-03-27

Definitions for the ModelMedicationRecord logical model.

Guidance on how to interpret the contents of this table can be found here.

1. ModelMedicationRecord
Definition

A model for a structure collection of a patient's medication history.

Control0..?
2. ModelMedicationRecord.identifier
Definition

The business identifier(s) for the Medication Record

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
3. ModelMedicationRecord.patient
Definition

The subject of the medication record

Control1..1
TypeReference
4. ModelMedicationRecord.treatments
Definition

The treaments that are included in this record

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatment
5. ModelMedicationRecord.treatmentLines
Definition

The treatment lines that are included in this record

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatmentLine
6. ModelMedicationRecord.summaryView
Definition

The summary views that are produced from this record or entered into it

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordSummaryView
7. ModelMedicationRecord.detailedRecords
Definition

Detailed records - the most granular interactions

Control0..*
TypeBackboneElement
8. ModelMedicationRecord.detailedRecords.orders
Definition

Explicit or implicit order for medication use or changes

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordOrder
9. ModelMedicationRecord.detailedRecords.schedule
Definition

Scheduled administrations of the medication

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationScheduledAdministration
10. ModelMedicationRecord.detailedRecords.dispenses
Definition

Registered or reported dispenses

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordDispense
11. ModelMedicationRecord.detailedRecords.administrations
Definition

Registered or reported single administrations

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordAdministration
12. ModelMedicationRecord.detailedRecords.usageReports
Definition

Reported statements of medication usage

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordUsage
13. ModelMedicationRecord.changeRecord
Definition

Change records and provenance for the medication record components

Control0..*
TypeProvenance

Guidance on how to interpret the contents of this table can be found here.

1. ModelMedicationRecord
Definition

A model for a structure collection of a patient's medication history.

Base definition for all types defined in FHIR type system.

Control0..*
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. ModelMedicationRecord.identifier
Definition

The business identifier(s) for the Medication Record

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
3. ModelMedicationRecord.patient
Definition

The subject of the medication record

Control1..1
TypeReference
4. ModelMedicationRecord.treatments
Definition

The treaments that are included in this record

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatment
5. ModelMedicationRecord.treatmentLines
Definition

The treatment lines that are included in this record

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatmentLine
6. ModelMedicationRecord.summaryView
Definition

The summary views that are produced from this record or entered into it

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordSummaryView
7. ModelMedicationRecord.detailedRecords
Definition

Detailed records - the most granular interactions

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. ModelMedicationRecord.detailedRecords.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. ModelMedicationRecord.detailedRecords.orders
Definition

Explicit or implicit order for medication use or changes

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordOrder
10. ModelMedicationRecord.detailedRecords.schedule
Definition

Scheduled administrations of the medication

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationScheduledAdministration
11. ModelMedicationRecord.detailedRecords.dispenses
Definition

Registered or reported dispenses

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordDispense
12. ModelMedicationRecord.detailedRecords.administrations
Definition

Registered or reported single administrations

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordAdministration
13. ModelMedicationRecord.detailedRecords.usageReports
Definition

Reported statements of medication usage

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordUsage
14. ModelMedicationRecord.changeRecord
Definition

Change records and provenance for the medication record components

Control0..*
TypeProvenance

Guidance on how to interpret the contents of this table can be found here.

1. ModelMedicationRecord
Definition

A model for a structure collection of a patient's medication history.

Control0..*
2. ModelMedicationRecord.identifier
Definition

The business identifier(s) for the Medication Record

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
3. ModelMedicationRecord.patient
Definition

The subject of the medication record

Control1..1
TypeReference
4. ModelMedicationRecord.treatments
Definition

The treaments that are included in this record

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatment
5. ModelMedicationRecord.treatmentLines
Definition

The treatment lines that are included in this record

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatmentLine
6. ModelMedicationRecord.summaryView
Definition

The summary views that are produced from this record or entered into it

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordSummaryView
7. ModelMedicationRecord.detailedRecords
Definition

Detailed records - the most granular interactions

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. ModelMedicationRecord.detailedRecords.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
9. ModelMedicationRecord.detailedRecords.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ModelMedicationRecord.detailedRecords.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. ModelMedicationRecord.detailedRecords.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. ModelMedicationRecord.detailedRecords.orders
Definition

Explicit or implicit order for medication use or changes

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordOrder
12. ModelMedicationRecord.detailedRecords.schedule
Definition

Scheduled administrations of the medication

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationScheduledAdministration
13. ModelMedicationRecord.detailedRecords.dispenses
Definition

Registered or reported dispenses

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordDispense
14. ModelMedicationRecord.detailedRecords.administrations
Definition

Registered or reported single administrations

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordAdministration
15. ModelMedicationRecord.detailedRecords.usageReports
Definition

Reported statements of medication usage

Control0..*
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordUsage
16. ModelMedicationRecord.changeRecord
Definition

Change records and provenance for the medication record components

Control0..*
TypeProvenance