IHE Pharmacy Medication Record
0.1.0 - ci-build
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
Active as of 2023-03-27 |
Definitions for the MedRecordTreatmentLine resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. MedicationStatement | |
2. MedicationStatement.meta | |
Control | 0..? |
3. MedicationStatement.meta.profile | |
Control | 1..? |
4. MedicationStatement.extension | |
Slicing | This element introduces a set of slices on MedicationStatement.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
5. MedicationStatement.extension:treatmentPlan | |
SliceName | treatmentPlan |
Control | 0..1 |
Type | Extension(basedOn) (Extension Type: Reference(CarePlan)) |
Must Support | true |
6. MedicationStatement.extension:treatmentPlan.valueReference | |
Control | 0..1 |
7. MedicationStatement.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
8. MedicationStatement.status | |
Must Support | true |
9. MedicationStatement.category | |
Must Support | true |
10. MedicationStatement.medication | |
Must Support | true |
11. MedicationStatement.subject | |
Must Support | true |
12. MedicationStatement.effectiveDateTime | |
Control | 0..1 |
Type | dateTime |
Must Support | true |
13. MedicationStatement.effectivePeriod | |
Control | 0..1 |
Type | Period |
Must Support | true |
14. MedicationStatement.dateAsserted | |
Must Support | true |
15. MedicationStatement.informationSource | |
Must Support | true |
16. MedicationStatement.note | |
Must Support | true |
17. MedicationStatement.dosage | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here.
1. MedicationStatement | |
Definition | 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 medicationstatement and a medicationadministration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medicationstatement 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. As stated earlier, the Medication Statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information. The MedicationStatement resource was previously called MedicationStatement. |
Control | 0..* |
Summary | false |
Alternate Names | MedicationStatement |
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
2. MedicationStatement.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Summary | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
3. MedicationStatement.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
4. MedicationStatement.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. 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 MedicationStatement.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
5. MedicationStatement.extension:treatmentPlan | |
SliceName | treatmentPlan |
Definition | basedOn |
Control | 0..1 |
Type | Extension(basedOn) (Extension Type: Reference(CarePlan)) |
Must Support | true |
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. MedicationStatement.extension:treatmentPlan.extension | |
Definition | An Extension 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..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 MedicationStatement.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
7. MedicationStatement.extension:treatmentPlan.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/basedOn |
8. MedicationStatement.extension:treatmentPlan.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Control | 0..1 This element is affected by the following invariants: ext-1 |
Type | Choice of: Reference(CarePlan), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationStatement.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
9. MedicationStatement.extension:treatmentPlan.value[x]:valueReference | |
SliceName | valueReference |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Control | 0..1 This element is affected by the following invariants: ext-1 |
Type | Choice of: Reference, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. MedicationStatement.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 |
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()) |
11. MedicationStatement.identifier | |
Definition | Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Must Support | true |
Summary | true |
Comments | This is a business identifier, not a resource identifier. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. MedicationStatement.status | |
Definition | A code representing the status of recording the medication statement. |
Control | 1..1 |
Binding | The codes SHALL be taken from MedicationStatementStatusCodes A coded concept indicating the current status of a MedicationStatement. |
Type | code |
Is Modifier | true |
Must Support | true |
Summary | true |
Comments | This status concerns just the recording of the medication statement. MedicationStatement.adherence should be used for indicating a patient's adherence to the information in this resource. Note, the statuses are different than in previous releases for MedicationStatement or MedicationStatement. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. MedicationStatement.category | |
Definition | Type of medication statement (for example, drug classification like ATC, where meds would be administered, legal category of the medication.). |
Control | 0..* |
Binding | For example codes, see MedicationRequestAdministrationLocationCodes A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
Type | CodeableConcept |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. MedicationStatement.medication | |
Definition | 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. |
Control | 1..1 |
Binding | For example codes, see SNOMEDCTMedicationCodes A coded concept identifying the substance or product being taken. |
Type | CodeableReference(Medication) |
Must Support | true |
Summary | true |
Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
15. MedicationStatement.subject | |
Definition | The person, animal or group who is/was taking the medication. |
Control | 1..1 |
Type | Reference(Patient|Group) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
16. MedicationStatement.effective[x] | |
Definition | 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.adherence element is Not Taking). |
Control | 0..1 |
Type | Choice of: dateTime, Period, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationStatement.effective[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
17. MedicationStatement.effective[x]:effectiveDateTime | |
SliceName | effectiveDateTime |
Definition | 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.adherence element is Not Taking). |
Control | 0..1 |
Type | Choice of: dateTime, Period, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. MedicationStatement.effective[x]:effectivePeriod | |
SliceName | effectivePeriod |
Definition | 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.adherence element is Not Taking). |
Control | 0..1 |
Type | Choice of: Period, dateTime, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. MedicationStatement.dateAsserted | |
Definition | The date when the Medication Statement was asserted by the information source. |
Control | 0..1 |
Type | dateTime |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. MedicationStatement.informationSource | |
Definition | The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest. |
Control | 0..* |
Type | Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|Organization) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. MedicationStatement.note | |
Definition | Provides extra information about the Medication Statement that is not conveyed by the other attributes. |
Control | 0..* |
Type | Annotation |
Must Support | true |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. MedicationStatement.dosage | |
Definition | Indicates how the medication is/was or should be taken by the patient. |
Control | 0..* |
Type | Dosage |
Must Support | true |
Summary | false |
Comments | The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
1. MedicationStatement | |
Definition | 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 medicationstatement and a medicationadministration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medicationstatement 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. As stated earlier, the Medication Statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information. The MedicationStatement resource was previously called MedicationStatement. |
Control | 0..* |
Summary | false |
Alternate Names | MedicationStatement |
2. MedicationStatement.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Summary | true |
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
3. MedicationStatement.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
4. MedicationStatement.meta.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 |
5. MedicationStatement.meta.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 MedicationStatement.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
6. MedicationStatement.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Control | 0..1 |
Type | id |
Summary | true |
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. MedicationStatement.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Control | 0..1 |
Type | instant |
Summary | true |
Comments | This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
8. MedicationStatement.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Control | 0..1 |
Type | uri |
Summary | true |
Comments | The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. MedicationStatement.meta.profile | |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 1..* |
Type | canonical(StructureDefinition) |
Summary | true |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. MedicationStatement.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Control | 0..* |
Binding | The codes SHALL be taken from AllSecurityLabels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System |
Type | Coding |
Summary | true |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. MedicationStatement.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Control | 0..* |
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
Type | Coding |
Summary | true |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. MedicationStatement.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Summary | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. MedicationStatement.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages IETF language tag for a human languag |
Type | code |
Summary | false |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. MedicationStatement.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-6 |
Type | Narrative |
Summary | false |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
15. MedicationStatement.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
16. MedicationStatement.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Summary | false |
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 MedicationStatement.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
17. MedicationStatement.extension:treatmentPlan | |
SliceName | treatmentPlan |
Definition | basedOn |
Control | 0..1 |
Type | Extension(basedOn) (Extension Type: Reference(CarePlan)) |
Must Support | true |
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()) |
18. MedicationStatement.extension:treatmentPlan.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 |
19. MedicationStatement.extension:treatmentPlan.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Summary | false |
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 MedicationStatement.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
20. MedicationStatement.extension:treatmentPlan.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/basedOn |
21. MedicationStatement.extension:treatmentPlan.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Control | 0..1 This element is affected by the following invariants: ext-1 |
Type | Reference(CarePlan) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationStatement.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
22. MedicationStatement.extension:treatmentPlan.value[x]:valueReference | |
SliceName | valueReference |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Control | 0..1 This element is affected by the following invariants: ext-1 |
Type | Reference |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
23. MedicationStatement.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 |
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()) |
24. MedicationStatement.identifier | |
Definition | Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Must Support | true |
Summary | true |
Comments | This is a business identifier, not a resource identifier. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. MedicationStatement.partOf | |
Definition | A larger event of which this particular MedicationStatement is a component or step. |
Control | 0..* |
Type | Reference(Procedure|MedicationStatement) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. MedicationStatement.status | |
Definition | A code representing the status of recording the medication statement. |
Control | 1..1 |
Binding | The codes SHALL be taken from MedicationStatementStatusCodes A coded concept indicating the current status of a MedicationStatement |
Type | code |
Is Modifier | true |
Must Support | true |
Summary | true |
Comments | This status concerns just the recording of the medication statement. MedicationStatement.adherence should be used for indicating a patient's adherence to the information in this resource. Note, the statuses are different than in previous releases for MedicationStatement or MedicationStatement. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. MedicationStatement.category | |
Definition | Type of medication statement (for example, drug classification like ATC, where meds would be administered, legal category of the medication.). |
Control | 0..* |
Binding | For example codes, see MedicationRequestAdministrationLocationCodes A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered |
Type | CodeableConcept |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. MedicationStatement.medication | |
Definition | 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. |
Control | 1..1 |
Binding | For example codes, see SNOMEDCTMedicationCodes A coded concept identifying the substance or product being taken |
Type | CodeableReference(Medication) |
Must Support | true |
Summary | true |
Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. MedicationStatement.subject | |
Definition | The person, animal or group who is/was taking the medication. |
Control | 1..1 |
Type | Reference(Patient|Group) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. MedicationStatement.encounter | |
Definition | The encounter that establishes the context for this MedicationStatement. |
Control | 0..1 |
Type | Reference(Encounter) |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. MedicationStatement.effective[x] | |
Definition | 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.adherence element is Not Taking). |
Control | 0..1 |
Type | Choice of: dateTime, Period, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationStatement.effective[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
32. MedicationStatement.effective[x]:effectiveDateTime | |
SliceName | effectiveDateTime |
Definition | 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.adherence element is Not Taking). |
Control | 0..1 |
Type | dateTime |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. MedicationStatement.effective[x]:effectivePeriod | |
SliceName | effectivePeriod |
Definition | 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.adherence element is Not Taking). |
Control | 0..1 |
Type | Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. MedicationStatement.dateAsserted | |
Definition | The date when the Medication Statement was asserted by the information source. |
Control | 0..1 |
Type | dateTime |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. MedicationStatement.informationSource | |
Definition | The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest. |
Control | 0..* |
Type | Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|Organization) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
36. MedicationStatement.derivedFrom | |
Definition | Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. |
Control | 0..* |
Type | Reference(Resource) |
Summary | false |
Comments | Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
37. MedicationStatement.reason | |
Definition | A concept, Condition or observation that supports why the medication is being/was taken. |
Control | 0..* |
Binding | For example codes, see ConditionProblemDiagnosisCodes A coded concept identifying why the medication is being taken |
Type | CodeableReference(Condition|Observation|DiagnosticReport) |
Summary | false |
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
38. MedicationStatement.note | |
Definition | Provides extra information about the Medication Statement that is not conveyed by the other attributes. |
Control | 0..* |
Type | Annotation |
Must Support | true |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
39. MedicationStatement.relatedClinicalInformation | |
Definition | Link to information that is relevant to a medication statement, for example, illicit drug use, gestational age, etc. |
Control | 0..* |
Type | Reference(Observation|Condition) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
40. MedicationStatement.renderedDosageInstruction | |
Definition | The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses. |
Control | 0..1 |
Type | markdown |
Summary | false |
Requirements | The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
41. MedicationStatement.dosage | |
Definition | Indicates how the medication is/was or should be taken by the patient. |
Control | 0..* |
Type | Dosage |
Must Support | true |
Summary | false |
Comments | The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
42. MedicationStatement.adherence | |
Definition | Indicates whether the medication is or is not being consumed or administered. |
Control | 0..1 |
Type | BackboneElement |
Summary | true |
Comments | This element can be used to indicate whether a patient is following a course of treatment as instructed/prescribed or whether they are taking medications of their own volition. It can also be used to indicate that a patient is not taking a medication, either because they were told not to or because they decided on their own. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
43. MedicationStatement.adherence.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 | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
44. MedicationStatement.adherence.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()) |
45. MedicationStatement.adherence.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()) |
46. MedicationStatement.adherence.code | |
Definition | Type of the adherence for the medication. |
Control | 1..1 |
Binding | For example codes, see MedicationStatementAdherenceCodes |
Type | CodeableConcept |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
47. MedicationStatement.adherence.reason | |
Definition | Captures the reason for the current use or adherence of a medication. |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTDrugTherapyStatusCodes |
Type | CodeableConcept |
Summary | false |
Comments | This is generally only used for "exception" statuses such as "entered-in-error". The reason for performing the event at all is captured in reasonCode, not here. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |