IHE-FHIR-PHARM-MEDICATIONRECORD\Medication Record - Medication Treatment - Definitions

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: ModelMedicationRecordTreatment - Detailed Descriptions

Active as of 2023-03-27

Definitions for the ModelMedicationRecordTreatment logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

1. ModelMedicationRecordTreatment
Definition	A model for the Medication Treatment.
Control	0..?
2. ModelMedicationRecordTreatment.identifier
Definition	The business identifier(s) for the medication treatment
Note	This is a business identifier, not a resource identifier (see discussion)
Control	0..1
Type	BackboneElement
3. ModelMedicationRecordTreatment.identifier.treatmentGuid
Definition	The Global Unique identifier(s) for the medication treatment
Control	0..1
Type	Identifier
4. ModelMedicationRecordTreatment.subject
Definition	The subject of the medication treatment
Control	1..1
Type	Reference(Patient)
5. ModelMedicationRecordTreatment.status
Definition	Status of the medication treatment
Control	1..1
Type	code
6. ModelMedicationRecordTreatment.intent
Control	1..1
Type	code
7. ModelMedicationRecordTreatment.category
Definition	Category(ies) of the medication treatment
Control	0..*
Type	CodeableConcept
8. ModelMedicationRecordTreatment.title
Definition	Short title of the medication treatment
Control	0..1
Type	string
9. ModelMedicationRecordTreatment.description
Definition	Textual description of the medication treatment
Control	0..1
Type	string
10. ModelMedicationRecordTreatment.encounter
Definition	The encounter in which the medication treatment was created or updated
Control	0..1
Type	Reference(Encounter)
11. ModelMedicationRecordTreatment.period
Definition	The duration of the treatment
Control	0..1
Type	Period
12. ModelMedicationRecordTreatment.created
Definition	When the treatment record was created
Control	0..1
Type	dateTime
13. ModelMedicationRecordTreatment.author
Definition	The current author/responsible for the medication treatment plan
Control	0..1
Type	Reference(Patient\|Practitioner\|PractitionerRole\|Device\|RelatedPerson\|Organization\|CareTeam)
14. ModelMedicationRecordTreatment.note
Definition	Comments about the plan
Control	0..*
Type	Annotation

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

1. ModelMedicationRecordTreatment
Definition	A model for the Medication Treatment. Base definition for all types defined in FHIR type system.
Control	0..*
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. ModelMedicationRecordTreatment.identifier
Definition	The business identifier(s) for the medication treatment
Note	This is a business identifier, not a resource identifier (see discussion)
Control	0..1
Type	BackboneElement
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. ModelMedicationRecordTreatment.identifier.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).
Control	0..*
Type	Extension
Is Modifier	true
Summary	true
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 Names	extensions, 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.
Invariants	Defined 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())
4. ModelMedicationRecordTreatment.identifier.treatmentGuid
Definition	The Global Unique identifier(s) for the medication treatment
Control	0..1
Type	Identifier
5. ModelMedicationRecordTreatment.subject
Definition	The subject of the medication treatment
Control	1..1
Type	Reference(Patient)
6. ModelMedicationRecordTreatment.status
Definition	Status of the medication treatment
Control	1..1
Type	code
7. ModelMedicationRecordTreatment.intent
Control	1..1
Type	code
8. ModelMedicationRecordTreatment.category
Definition	Category(ies) of the medication treatment
Control	0..*
Type	CodeableConcept
9. ModelMedicationRecordTreatment.title
Definition	Short title of the medication treatment
Control	0..1
Type	string
10. ModelMedicationRecordTreatment.description
Definition	Textual description of the medication treatment
Control	0..1
Type	string
11. ModelMedicationRecordTreatment.encounter
Definition	The encounter in which the medication treatment was created or updated
Control	0..1
Type	Reference(Encounter)
12. ModelMedicationRecordTreatment.period
Definition	The duration of the treatment
Control	0..1
Type	Period
13. ModelMedicationRecordTreatment.created
Definition	When the treatment record was created
Control	0..1
Type	dateTime
14. ModelMedicationRecordTreatment.author
Definition	The current author/responsible for the medication treatment plan
Control	0..1
Type	Reference(Patient\|Practitioner\|PractitionerRole\|Device\|RelatedPerson\|Organization\|CareTeam)
15. ModelMedicationRecordTreatment.note
Definition	Comments about the plan
Control	0..*
Type	Annotation

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

1. ModelMedicationRecordTreatment
Definition	A model for the Medication Treatment.
Control	0..*
2. ModelMedicationRecordTreatment.identifier
Definition	The business identifier(s) for the medication treatment
Note	This is a business identifier, not a resource identifier (see discussion)
Control	0..1
Type	BackboneElement
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. ModelMedicationRecordTreatment.identifier.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1 This element is affected by the following invariants: ele-1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
4. ModelMedicationRecordTreatment.identifier.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.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, 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.
Invariants	Defined 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())
Slicing	This element introduces a set of slices on ModelMedicationRecordTreatment.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
5. ModelMedicationRecordTreatment.identifier.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).
Control	0..*
Type	Extension
Is Modifier	true
Summary	true
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 Names	extensions, 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.
Invariants	Defined 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())
6. ModelMedicationRecordTreatment.identifier.treatmentGuid
Definition	The Global Unique identifier(s) for the medication treatment
Control	0..1
Type	Identifier
7. ModelMedicationRecordTreatment.subject
Definition	The subject of the medication treatment
Control	1..1
Type	Reference(Patient)
8. ModelMedicationRecordTreatment.status
Definition	Status of the medication treatment
Control	1..1
Type	code
9. ModelMedicationRecordTreatment.intent
Control	1..1
Type	code
10. ModelMedicationRecordTreatment.category
Definition	Category(ies) of the medication treatment
Control	0..*
Type	CodeableConcept
11. ModelMedicationRecordTreatment.title
Definition	Short title of the medication treatment
Control	0..1
Type	string
12. ModelMedicationRecordTreatment.description
Definition	Textual description of the medication treatment
Control	0..1
Type	string
13. ModelMedicationRecordTreatment.encounter
Definition	The encounter in which the medication treatment was created or updated
Control	0..1
Type	Reference(Encounter)
14. ModelMedicationRecordTreatment.period
Definition	The duration of the treatment
Control	0..1
Type	Period
15. ModelMedicationRecordTreatment.created
Definition	When the treatment record was created
Control	0..1
Type	dateTime
16. ModelMedicationRecordTreatment.author
Definition	The current author/responsible for the medication treatment plan
Control	0..1
Type	Reference(Patient\|Practitioner\|PractitionerRole\|Device\|RelatedPerson\|Organization\|CareTeam)
17. ModelMedicationRecordTreatment.note
Definition	Comments about the plan
Control	0..*
Type	Annotation

IG © 2022+ Integrating the Healthcare Enterprise (IHE). Package ihe-fhir-pharm-medicationrecord#0.1.0 based on FHIR 5.0.0. Generated 2023-03-27
Links: Table of Contents | QA Report Version History | | Propose a change external