MedicationRecord
0.1.0-test - CI Build Belgium flag

MedicationRecord, published by HL7 Belgium. This guide is not an authorized publication; it is the continuous build for version 0.1.0-test built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/medication-record and changes regularly. See the Directory of published versions

Logical Model: BeModelMedicationDispense - Detailed Descriptions

Draft as of 2024-01-26

Definitions for the be-model-medication-dispense logical model.

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

0. BeMedicationDispense
Definition

This is the logical model for the Dispense Record entry - the information that can be captured upon the act of dispensing - in a hospital pharmacy, or a community pharmacy. This is not for a future dispense, rather a record of an actual dispense.

ShortAn individual record of a medication dispense
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. BeMedicationDispense.identifier
Definition

The business identifier(s) for the medication dispense session, also known as Session GUID (SGUID).

ShortThe business identifier(s) for the medication dispense session
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
4. BeMedicationDispense.patient
Definition

The person for which the medication is dispensed.

ShortThe person for which the medication is dispensed.
Control1..1
TypeReference(BePatient)
6. BeMedicationDispense.dispenser
ShortThe dispenser, if known and relevant
Control0..1
TypeBackboneElement
8. BeMedicationDispense.dispenser.person
Definition

Who was responsible for asserting the observed value as "true". (Reference)

ShortReference to person that performed the recording or reporting
Control1..1
TypeReference(BePractitioner)
10. BeMedicationDispense.dispenser.organization
Definition

Who was responsible for asserting the observed value as "true". (Reference)

ShortReference to person that performed the recording or reporting
Control1..1
TypeReference(BeOrganization)
12. BeMedicationDispense.dispenseDate
Definition

The date (or date-time) when the dispense ocurred

ShortThe date when the dispense ocurred
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. BeMedicationDispense.prescription
ShortThe information about a prescription related to the dispense
Control0..1
TypeBackboneElement
16. BeMedicationDispense.prescription.isPrescribed
ShortWhether this dispense was performed against a prescription
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. BeMedicationDispense.prescription.prescription
ShortThe prescription identification
Control0..1
TypeCodeableConcept
20. BeMedicationDispense.identifier
Definition

The business identifier(s) for the medication dispense. The DGUID is the current identifier.

ShortThe business identifier(s) for the medication dispense
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
22. BeMedicationDispense.dispensedItem
ShortEach product that was dispensed
Control0..*
TypeCodeableConcept
24. BeMedicationDispense.dispensedItem.product
ShortThe product that was dispensed - coded or not (e.g. for magistral preparations)
Control0..1
TypeCodeableConcept
26. BeMedicationDispense.dispensedItem.quantityDispensed
ShortThe amound of product that was dispensed
Control0..1
TypeQuantity
28. BeMedicationDispense.dispensedItem.dosageInstructions
ShortThe instructions for use
Control0..1
TypeDosage
30. BeMedicationDispense.dispensedItem.note
Definition

Additional information about the dispense - this can be relevant history, any remarks by the patient or professional, etc.

ShortAdditional information about the dispensed item
Control0..*
TypeAnnotation
32. BeMedicationDispense.note
Definition

Additional information about the dispense - this can be relevant history, any remarks by the patient or professional, etc.

ShortAdditional information about the dispense
Control0..*
TypeAnnotation

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

0. BeMedicationDispense
Definition

This is the logical model for the Dispense Record entry - the information that can be captured upon the act of dispensing - in a hospital pharmacy, or a community pharmacy. This is not for a future dispense, rather a record of an actual dispense.


Base definition for all elements in a resource.

ShortAn individual record of a medication dispenseBase for all elements
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
2. BeMedicationDispense.identifier
Definition

The business identifier(s) for the medication dispense session, also known as Session GUID (SGUID).

ShortThe business identifier(s) for the medication dispense session
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
4. BeMedicationDispense.patient
Definition

The person for which the medication is dispensed.

ShortThe person for which the medication is dispensed.
Control1..1
TypeReference(BePatient)
6. BeMedicationDispense.dispenser
ShortThe dispenser, if known and relevant
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
8. BeMedicationDispense.dispenser.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 manageable, 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
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
Invariantsele-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())
10. BeMedicationDispense.dispenser.person
Definition

Who was responsible for asserting the observed value as "true". (Reference)

ShortReference to person that performed the recording or reporting
Control1..1
TypeReference(BePractitioner)
12. BeMedicationDispense.dispenser.organization
Definition

Who was responsible for asserting the observed value as "true". (Reference)

ShortReference to person that performed the recording or reporting
Control1..1
TypeReference(BeOrganization)
14. BeMedicationDispense.dispenseDate
Definition

The date (or date-time) when the dispense ocurred

ShortThe date when the dispense ocurred
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. BeMedicationDispense.prescription
ShortThe information about a prescription related to the dispense
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
18. BeMedicationDispense.prescription.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 manageable, 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
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
Invariantsele-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())
20. BeMedicationDispense.prescription.isPrescribed
ShortWhether this dispense was performed against a prescription
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. BeMedicationDispense.prescription.prescription
ShortThe prescription identification
Control0..1
TypeCodeableConcept
24. BeMedicationDispense.identifier
Definition

The business identifier(s) for the medication dispense. The DGUID is the current identifier.

ShortThe business identifier(s) for the medication dispense
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
26. BeMedicationDispense.dispensedItem
ShortEach product that was dispensed
Control0..*
TypeCodeableConcept
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
28. BeMedicationDispense.dispensedItem.product
ShortThe product that was dispensed - coded or not (e.g. for magistral preparations)
Control0..1
TypeCodeableConcept
30. BeMedicationDispense.dispensedItem.quantityDispensed
ShortThe amound of product that was dispensed
Control0..1
TypeQuantity
32. BeMedicationDispense.dispensedItem.dosageInstructions
ShortThe instructions for use
Control0..1
TypeDosage
34. BeMedicationDispense.dispensedItem.note
Definition

Additional information about the dispense - this can be relevant history, any remarks by the patient or professional, etc.

ShortAdditional information about the dispensed item
Control0..*
TypeAnnotation
36. BeMedicationDispense.note
Definition

Additional information about the dispense - this can be relevant history, any remarks by the patient or professional, etc.

ShortAdditional information about the dispense
Control0..*
TypeAnnotation

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

0. BeMedicationDispense
Definition

This is the logical model for the Dispense Record entry - the information that can be captured upon the act of dispensing - in a hospital pharmacy, or a community pharmacy. This is not for a future dispense, rather a record of an actual dispense.

ShortAn individual record of a medication dispense
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
2. BeMedicationDispense.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. BeMedicationDispense.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 manageable, 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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 BeMedicationDispense.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. BeMedicationDispense.identifier
Definition

The business identifier(s) for the medication dispense session, also known as Session GUID (SGUID).

ShortThe business identifier(s) for the medication dispense session
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
8. BeMedicationDispense.patient
Definition

The person for which the medication is dispensed.

ShortThe person for which the medication is dispensed.
Control1..1
TypeReference(BePatient)
10. BeMedicationDispense.dispenser
ShortThe dispenser, if known and relevant
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
12. BeMedicationDispense.dispenser.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
14. BeMedicationDispense.dispenser.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 manageable, 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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 BeMedicationDispense.dispenser.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. BeMedicationDispense.dispenser.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 manageable, 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
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
Invariantsele-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())
18. BeMedicationDispense.dispenser.person
Definition

Who was responsible for asserting the observed value as "true". (Reference)

ShortReference to person that performed the recording or reporting
Control1..1
TypeReference(BePractitioner)
20. BeMedicationDispense.dispenser.organization
Definition

Who was responsible for asserting the observed value as "true". (Reference)

ShortReference to person that performed the recording or reporting
Control1..1
TypeReference(BeOrganization)
22. BeMedicationDispense.dispenseDate
Definition

The date (or date-time) when the dispense ocurred

ShortThe date when the dispense ocurred
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. BeMedicationDispense.prescription
ShortThe information about a prescription related to the dispense
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
26. BeMedicationDispense.prescription.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
28. BeMedicationDispense.prescription.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 manageable, 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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 BeMedicationDispense.prescription.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
30. BeMedicationDispense.prescription.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 manageable, 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
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
Invariantsele-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())
32. BeMedicationDispense.prescription.isPrescribed
ShortWhether this dispense was performed against a prescription
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. BeMedicationDispense.prescription.prescription
ShortThe prescription identification
Control0..1
TypeCodeableConcept
36. BeMedicationDispense.identifier
Definition

The business identifier(s) for the medication dispense. The DGUID is the current identifier.

ShortThe business identifier(s) for the medication dispense
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
38. BeMedicationDispense.dispensedItem
ShortEach product that was dispensed
Control0..*
TypeCodeableConcept
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
40. BeMedicationDispense.dispensedItem.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
42. BeMedicationDispense.dispensedItem.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 manageable, 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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 BeMedicationDispense.dispensedItem.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. BeMedicationDispense.dispensedItem.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. BeMedicationDispense.dispensedItem.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. BeMedicationDispense.dispensedItem.product
ShortThe product that was dispensed - coded or not (e.g. for magistral preparations)
Control0..1
TypeCodeableConcept
50. BeMedicationDispense.dispensedItem.quantityDispensed
ShortThe amound of product that was dispensed
Control0..1
TypeQuantity
52. BeMedicationDispense.dispensedItem.dosageInstructions
ShortThe instructions for use
Control0..1
TypeDosage
54. BeMedicationDispense.dispensedItem.note
Definition

Additional information about the dispense - this can be relevant history, any remarks by the patient or professional, etc.

ShortAdditional information about the dispensed item
Control0..*
TypeAnnotation
56. BeMedicationDispense.note
Definition

Additional information about the dispense - this can be relevant history, any remarks by the patient or professional, etc.

ShortAdditional information about the dispense
Control0..*
TypeAnnotation