Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Draft as of 2024-09-12 |
Definitions for the dh-medicationstatement-core-1 resource profile.
Guidance on how to interpret the contents of this table can be found here
0. MedicationStatement | |
Invariants | inv-dh-mst-01: If present, an information source shall at least have a reference, an identifier or a display (informationSource.exists() implies informationSource.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) ) |
2. MedicationStatement.basedOn | |
Type | Reference(ADHA Core MedicationRequest, CarePlan, ADHA Core ServiceRequest) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
4. MedicationStatement.status | |
Must Support | true |
6. MedicationStatement.statusReason | |
Must Support | true |
8. MedicationStatement.category | |
Must Support | true |
10. MedicationStatement.medication[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
Slicing | This element introduces a set of slices on MedicationStatement.medication[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
12. MedicationStatement.medication[x]:medicationCodeableConcept | |
Slice Name | medicationCodeableConcept |
Type | CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
14. MedicationStatement.medication[x]:medicationCodeableConcept.coding | |
Slicing | This element introduces a set of slices on MedicationStatement.medication[x].coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | |
Slice Name | pbs |
Must Support | true |
18. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | |
Slice Name | amt |
Must Support | true |
20. MedicationStatement.medication[x]:medicationReference | |
Slice Name | medicationReference |
Type | Reference(ADHA Core Medication) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
22. MedicationStatement.subject | |
Type | Reference(ADHA Core Patient) |
Must Support | true |
Invariants | inv-dh-mst-02: At least reference or a valid identifier shall be present (reference.exists() or identifier.where(system.count() + value.count() >1).exists() ) |
24. MedicationStatement.context | |
Type | Reference(ADHA Core Encounter) |
Must Support | true |
26. MedicationStatement.effective[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
28. MedicationStatement.dateAsserted | |
Must Support | true |
30. MedicationStatement.informationSource | |
Type | Reference(ADHA Core Patient, ADHA Core PractitionerRole, ADHA Core RelatedPerson) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
32. MedicationStatement.reasonCode | |
Must Support | true |
34. MedicationStatement.note | |
Must Support | true |
36. MedicationStatement.dosage | |
Must Support | true |
Invariants | inv-dh-mst-03: If present, the dosage shall at least have text or patient instructions (text.exists() or patientInstruction.exists() ) |
Guidance on how to interpret the contents of this table can be found here
0. 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 medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement 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. | |||||||||||||||
Short | A record of medication being taken by a patient in an Australian healthcare contextRecord of medication being taken by a patient | |||||||||||||||
Comments | When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error. | |||||||||||||||
Control | 0..* | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()) inv-dh-mst-01: If present, an information source shall at least have a reference, an identifier or a display ( informationSource.exists() implies informationSource.all($this.reference.exists() or $this.identifier.exists() or $this.display.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. | |||||||||||||||
Short | A set of rules under which this content was created | |||||||||||||||
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 it's narrative along with other profiles, value sets, etc. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | uri | |||||||||||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
4. MedicationStatement.extension:longTerm | ||||||||||||||||
Slice Name | longTerm | |||||||||||||||
Definition | Indicator of long term use of a medication. | |||||||||||||||
Short | Medication Long Term Indicator | |||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||||||||
Type | Extension(Long Term) (Extension Type: boolean) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Invariants | 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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||||||||
6. 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 manageable, 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). | |||||||||||||||
Short | Extensions that cannot be ignored | |||||||||||||||
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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Extension | |||||||||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | |||||||||||||||
Summary | false | |||||||||||||||
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 | |||||||||||||||
Invariants | 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()) | |||||||||||||||
8. MedicationStatement.basedOn | ||||||||||||||||
Definition | A plan, proposal or order that is fulfilled in whole or in part by this event. | |||||||||||||||
Short | Fulfils plan, proposal or order | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Reference(ADHA Core MedicationRequest, CarePlan, ADHA Core ServiceRequest, MedicationRequest, ServiceRequest) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
10. MedicationStatement.status | ||||||||||||||||
Definition | A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed. | |||||||||||||||
Short | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken | |||||||||||||||
Comments | MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | |||||||||||||||
Control | 1..1 | |||||||||||||||
Binding | The codes SHALL be taken from Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 )A coded concept indicating the current status of a MedicationStatement. | |||||||||||||||
Type | code | |||||||||||||||
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
12. MedicationStatement.statusReason | ||||||||||||||||
Definition | Captures the reason for the current state of the MedicationStatement. | |||||||||||||||
Short | Reason for current status | |||||||||||||||
Comments | This is generally only used for "exception" statuses such as "not-taken", "on-hold", "cancelled" or "entered-in-error". The reason for performing the event at all is captured in reasonCode, not here. | |||||||||||||||
Control | 0..* | |||||||||||||||
Binding | For example codes, see SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes (example to http://hl7.org/fhir/ValueSet/reason-medication-status-codes )A coded concept indicating the reason for the status of the statement. | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
14. MedicationStatement.category | ||||||||||||||||
Definition | Indicates where the medication is expected to be consumed or administered. | |||||||||||||||
Short | Type of medication usage | |||||||||||||||
Control | 0..1 | |||||||||||||||
Binding | The codes SHOULD be taken from Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category (preferred to http://hl7.org/fhir/ValueSet/medication-statement-category )A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
16. MedicationStatement.medication[x] | ||||||||||||||||
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. | |||||||||||||||
Short | Medication DetailWhat medication was taken | |||||||||||||||
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. | |||||||||||||||
Control | 1..1 | |||||||||||||||
Binding | For example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes (example to http://hl7.org/fhir/ValueSet/medication-codes )A coded concept identifying the substance or product being taken. | |||||||||||||||
Type | Choice of: CodeableConcept, Reference(Medication) | |||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | 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.medication[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | |||||||||||||||
18. MedicationStatement.medication[x]:medicationCodeableConcept | ||||||||||||||||
Slice Name | medicationCodeableConcept | |||||||||||||||
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. | |||||||||||||||
Short | Coded MedicationWhat medication was taken | |||||||||||||||
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. | |||||||||||||||
Control | 01..1 | |||||||||||||||
Binding | For example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes (example to http://hl7.org/fhir/ValueSet/medication-codes )
| |||||||||||||||
Type | CodeableConcept, Reference(Medication) | |||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
20. MedicationStatement.medication[x]:medicationCodeableConcept.coding | ||||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Short | Code 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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Coding | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||||||||||||||
Invariants | 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.medication[x].coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
22. MedicationStatement.medication[x]:medicationCodeableConcept.coding.extension:medicationClass | ||||||||||||||||
Slice Name | medicationClass | |||||||||||||||
Definition | The type of information covered by the medication coding, e.g. branded product with no strength or form. | |||||||||||||||
Short | Medication type | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Extension(Medication Type) (Extension Type: Coding) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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.medication[x]:medicationCodeableConcept.coding:pbs | ||||||||||||||||
Slice Name | pbs | |||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Short | Code 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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Coding | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
26. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs.extension:medicationClass | ||||||||||||||||
Slice Name | medicationClass | |||||||||||||||
Definition | The type of information covered by the medication coding, e.g. branded product with no strength or form. | |||||||||||||||
Short | Medication type | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Extension(Medication Type) (Extension Type: Coding) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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()) | |||||||||||||||
28. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | ||||||||||||||||
Slice Name | amt | |||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Short | Code 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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Coding | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
30. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt.extension:medicationClass | ||||||||||||||||
Slice Name | medicationClass | |||||||||||||||
Definition | The type of information covered by the medication coding, e.g. branded product with no strength or form. | |||||||||||||||
Short | Medication type | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Extension(Medication Type) (Extension Type: Coding) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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()) | |||||||||||||||
32. MedicationStatement.medication[x]:medicationReference | ||||||||||||||||
Slice Name | medicationReference | |||||||||||||||
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. | |||||||||||||||
Short | Medication ReferenceWhat medication was taken | |||||||||||||||
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. | |||||||||||||||
Control | 01..1 | |||||||||||||||
Type | Reference(ADHA Core Medication, Medication), CodeableConcept | |||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
34. MedicationStatement.subject | ||||||||||||||||
Definition | The person, animal or group who is/was taking the medication. | |||||||||||||||
Short | Who is/was taking the medication | |||||||||||||||
Control | 1..1 This element is affected by the following invariants: inv-dh-mst-02 | |||||||||||||||
Type | Reference(ADHA Core Patient, Patient, Group) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-dh-mst-02: At least reference or a valid identifier shall be present ( reference.exists() or identifier.where(system.count() + value.count() >1).exists() ) | |||||||||||||||
36. MedicationStatement.context | ||||||||||||||||
Definition | The encounter or episode of care that establishes the context for this MedicationStatement. | |||||||||||||||
Short | Encounter / Episode associated with MedicationStatement | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Reference(ADHA Core Encounter, Encounter, EpisodeOfCare) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
38. 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.taken element is No). | |||||||||||||||
Short | The date/time or interval when the medication is/was/will be taken | |||||||||||||||
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 at the time the statement is recorded, the "end" date will be omitted. 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. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Choice of: dateTime, Period | |||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Must Support | true | |||||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
40. MedicationStatement.dateAsserted | ||||||||||||||||
Definition | The date when the medication statement was asserted by the information source. | |||||||||||||||
Short | When the statement was asserted? | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | dateTime | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
42. 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. | |||||||||||||||
Short | Person or organization that provided the information about the taking of this medication | |||||||||||||||
Control | 0..1 This element is affected by the following invariants: inv-dh-mst-01 | |||||||||||||||
Type | Reference(ADHA Core Patient, ADHA Core PractitionerRole, ADHA Core RelatedPerson, Patient, Practitioner, PractitionerRole, RelatedPerson, Organization) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
44. MedicationStatement.reasonCode | ||||||||||||||||
Definition | A reason for why the medication is being/was taken. | |||||||||||||||
Short | Reason for why the medication is being/was taken | |||||||||||||||
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference. | |||||||||||||||
Control | 0..* | |||||||||||||||
Binding | The codes SHOULD be taken from For example codes, see Medication Reason Taken http://hl7.org/fhir/ValueSet/condition-code (preferred to https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 ) | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
46. MedicationStatement.note | ||||||||||||||||
Definition | Provides extra information about the medication statement that is not conveyed by the other attributes. | |||||||||||||||
Short | Further information about the statement | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Annotation | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
48. MedicationStatement.dosage | ||||||||||||||||
Definition | Indicates how the medication is/was taken or should be taken by the patient. Indicates how the medication is/was or should be taken by the patient. | |||||||||||||||
Short | Dosage information in an Australian healthcare contextDetails of how medication is/was taken or should be taken | |||||||||||||||
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. | |||||||||||||||
Control | 0..* This element is affected by the following invariants: inv-dh-mst-03 | |||||||||||||||
Type | Dosage(AU Base Dosage) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-dh-mst-03: If present, the dosage shall at least have text or patient instructions ( text.exists() or patientInstruction.exists() ) |
Guidance on how to interpret the contents of this table can be found here
0. 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 medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement 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. | |||||||||||||||
Short | A record of medication being taken by a patient in an Australian healthcare context | |||||||||||||||
Comments | When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error. | |||||||||||||||
Control | 0..* | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() )inv-dh-mst-01: If present, an information source shall at least have a reference, an identifier or a display ( informationSource.exists() implies informationSource.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) ) | |||||||||||||||
2. MedicationStatement.id | ||||||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||||||||||||||
Short | Logical id of this artifact | |||||||||||||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | id | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
4. 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. | |||||||||||||||
Short | Metadata about the resource | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Meta | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
6. 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. | |||||||||||||||
Short | A set of rules under which this content was created | |||||||||||||||
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 it's narrative along with other profiles, value sets, etc. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | uri | |||||||||||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
8. MedicationStatement.language | ||||||||||||||||
Definition | The base language in which the resource is written. | |||||||||||||||
Short | Language of the resource content | |||||||||||||||
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). | |||||||||||||||
Control | 0..1 | |||||||||||||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| |||||||||||||||
Type | code | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
10. 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. | |||||||||||||||
Short | Text summary of the resource, for human interpretation | |||||||||||||||
Comments | Contained resources do not have 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. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Narrative | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Alternate Names | narrative, html, xhtml, display | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
12. MedicationStatement.contained | ||||||||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |||||||||||||||
Short | Contained, inline 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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Resource | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Alternate Names | inline resources, anonymous resources, contained resources | |||||||||||||||
14. MedicationStatement.extension | ||||||||||||||||
Definition | An Extension | |||||||||||||||
Short | Extension | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Extension | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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 areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
16. MedicationStatement.extension:longTerm | ||||||||||||||||
Slice Name | longTerm | |||||||||||||||
Definition | Indicator of long term use of a medication. | |||||||||||||||
Short | Medication Long Term Indicator | |||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||||||||
Type | Extension(Long Term) (Extension Type: boolean) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Invariants | 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.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 manageable, 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). | |||||||||||||||
Short | Extensions that cannot be ignored | |||||||||||||||
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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Extension | |||||||||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | |||||||||||||||
Summary | false | |||||||||||||||
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 | |||||||||||||||
Invariants | 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() ) | |||||||||||||||
20. 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. | |||||||||||||||
Short | External identifier | |||||||||||||||
Comments | This is a business identifier, not a resource identifier. | |||||||||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Identifier | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
22. MedicationStatement.basedOn | ||||||||||||||||
Definition | A plan, proposal or order that is fulfilled in whole or in part by this event. | |||||||||||||||
Short | Fulfils plan, proposal or order | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Reference(ADHA Core MedicationRequest, CarePlan, ADHA Core ServiceRequest) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
24. MedicationStatement.partOf | ||||||||||||||||
Definition | A larger event of which this particular event is a component or step. | |||||||||||||||
Short | Part of referenced event | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Reference(MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Observation) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used. | |||||||||||||||
Invariants | 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 patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed. | |||||||||||||||
Short | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken | |||||||||||||||
Comments | MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | |||||||||||||||
Control | 1..1 | |||||||||||||||
Binding | The codes SHALL be taken from Medication Status Codes (required to http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 )A coded concept indicating the current status of a MedicationStatement. | |||||||||||||||
Type | code | |||||||||||||||
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
28. MedicationStatement.statusReason | ||||||||||||||||
Definition | Captures the reason for the current state of the MedicationStatement. | |||||||||||||||
Short | Reason for current status | |||||||||||||||
Comments | This is generally only used for "exception" statuses such as "not-taken", "on-hold", "cancelled" or "entered-in-error". The reason for performing the event at all is captured in reasonCode, not here. | |||||||||||||||
Control | 0..* | |||||||||||||||
Binding | For example codes, see SNOMEDCTDrugTherapyStatusCodes (example to http://hl7.org/fhir/ValueSet/reason-medication-status-codes )A coded concept indicating the reason for the status of the statement. | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
30. MedicationStatement.category | ||||||||||||||||
Definition | Indicates where the medication is expected to be consumed or administered. | |||||||||||||||
Short | Type of medication usage | |||||||||||||||
Control | 0..1 | |||||||||||||||
Binding | The codes SHOULD be taken from Medication usage category codes (preferred to http://hl7.org/fhir/ValueSet/medication-statement-category )A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
32. MedicationStatement.medication[x] | ||||||||||||||||
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. | |||||||||||||||
Short | Medication Detail | |||||||||||||||
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. | |||||||||||||||
Control | 1..1 | |||||||||||||||
Binding | For example codes, see SNOMEDCTMedicationCodes (example to http://hl7.org/fhir/ValueSet/medication-codes )A coded concept identifying the substance or product being taken. | |||||||||||||||
Type | Choice of: CodeableConcept, Reference(Medication) | |||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | 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.medication[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | |||||||||||||||
34. MedicationStatement.medication[x]:medicationCodeableConcept | ||||||||||||||||
Slice Name | medicationCodeableConcept | |||||||||||||||
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. | |||||||||||||||
Short | Coded Medication | |||||||||||||||
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. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Binding | For example codes, see SNOMEDCTMedicationCodes (example to http://hl7.org/fhir/ValueSet/medication-codes )
| |||||||||||||||
Type | CodeableConcept | |||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
36. MedicationStatement.medication[x]:medicationCodeableConcept.id | ||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||
Short | Unique id for inter-element referencing | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||
Summary | false | |||||||||||||||
38. MedicationStatement.medication[x]:medicationCodeableConcept.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. | |||||||||||||||
Short | Additional 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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Extension | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Alternate Names | extensions, user content | |||||||||||||||
Invariants | 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.medication[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
40. MedicationStatement.medication[x]:medicationCodeableConcept.coding | ||||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Short | Code 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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Coding | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||||||||||||||
Invariants | 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.medication[x].coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
42. MedicationStatement.medication[x]:medicationCodeableConcept.coding.id | ||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||
Short | Unique id for inter-element referencing | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||
Summary | false | |||||||||||||||
44. MedicationStatement.medication[x]:medicationCodeableConcept.coding.extension | ||||||||||||||||
Definition | An Extension | |||||||||||||||
Short | Extension | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Extension | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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.medication[x].coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
46. MedicationStatement.medication[x]:medicationCodeableConcept.coding.extension:medicationClass | ||||||||||||||||
Slice Name | medicationClass | |||||||||||||||
Definition | The type of information covered by the medication coding, e.g. branded product with no strength or form. | |||||||||||||||
Short | Medication type | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Extension(Medication Type) (Extension Type: Coding) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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() ) | |||||||||||||||
48. MedicationStatement.medication[x]:medicationCodeableConcept.coding.system | ||||||||||||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||||||||||||||
Short | Identity of the terminology system | |||||||||||||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | uri | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
50. MedicationStatement.medication[x]:medicationCodeableConcept.coding.version | ||||||||||||||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | |||||||||||||||
Short | Version of the system - if relevant | |||||||||||||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | |||||||||||||||
Note | This is a business version Id, not a resource version Id (see discussion) | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
52. MedicationStatement.medication[x]:medicationCodeableConcept.coding.code | ||||||||||||||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | |||||||||||||||
Short | Symbol in syntax defined by the system | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | code | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Need to refer to a particular code in the system. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
54. MedicationStatement.medication[x]:medicationCodeableConcept.coding.display | ||||||||||||||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||||||||||||||
Short | Representation defined by the system | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
56. MedicationStatement.medication[x]:medicationCodeableConcept.coding.userSelected | ||||||||||||||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | |||||||||||||||
Short | If this coding was chosen directly by the user | |||||||||||||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | boolean | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
58. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | ||||||||||||||||
Slice Name | pbs | |||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Short | Code 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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Coding | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
60. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs.id | ||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||
Short | Unique id for inter-element referencing | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||
Summary | false | |||||||||||||||
62. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs.extension | ||||||||||||||||
Definition | An Extension | |||||||||||||||
Short | Extension | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Extension | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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.medication[x].coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
64. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs.extension:medicationClass | ||||||||||||||||
Slice Name | medicationClass | |||||||||||||||
Definition | The type of information covered by the medication coding, e.g. branded product with no strength or form. | |||||||||||||||
Short | Medication type | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Extension(Medication Type) (Extension Type: Coding) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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() ) | |||||||||||||||
66. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs.system | ||||||||||||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||||||||||||||
Short | Identity of the terminology system | |||||||||||||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | uri | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
68. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs.version | ||||||||||||||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | |||||||||||||||
Short | Version of the system - if relevant | |||||||||||||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | |||||||||||||||
Note | This is a business version Id, not a resource version Id (see discussion) | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
70. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs.code | ||||||||||||||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | |||||||||||||||
Short | Symbol in syntax defined by the system | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | code | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Need to refer to a particular code in the system. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
72. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs.display | ||||||||||||||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||||||||||||||
Short | Representation defined by the system | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
74. MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs.userSelected | ||||||||||||||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | |||||||||||||||
Short | If this coding was chosen directly by the user | |||||||||||||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | boolean | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
76. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | ||||||||||||||||
Slice Name | amt | |||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Short | Code 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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Coding | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
78. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt.id | ||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||
Short | Unique id for inter-element referencing | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||
Summary | false | |||||||||||||||
80. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt.extension | ||||||||||||||||
Definition | An Extension | |||||||||||||||
Short | Extension | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Extension | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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.medication[x].coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
82. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt.extension:medicationClass | ||||||||||||||||
Slice Name | medicationClass | |||||||||||||||
Definition | The type of information covered by the medication coding, e.g. branded product with no strength or form. | |||||||||||||||
Short | Medication type | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Extension(Medication Type) (Extension Type: Coding) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | 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() ) | |||||||||||||||
84. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt.system | ||||||||||||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||||||||||||||
Short | Identity of the terminology system | |||||||||||||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | uri | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
86. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt.version | ||||||||||||||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | |||||||||||||||
Short | Version of the system - if relevant | |||||||||||||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | |||||||||||||||
Note | This is a business version Id, not a resource version Id (see discussion) | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
88. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt.code | ||||||||||||||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | |||||||||||||||
Short | Symbol in syntax defined by the system | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | code | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Need to refer to a particular code in the system. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
90. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt.display | ||||||||||||||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||||||||||||||
Short | Representation defined by the system | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
92. MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt.userSelected | ||||||||||||||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | |||||||||||||||
Short | If this coding was chosen directly by the user | |||||||||||||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | boolean | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
94. MedicationStatement.medication[x]:medicationCodeableConcept.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. This may be a brand or generic name as suitable for the intent of the entry. | |||||||||||||||
Short | Medication primary text | |||||||||||||||
Comments | Very often the text is the same as a displayName of one of the codings. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Summary | true | |||||||||||||||
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. | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
96. MedicationStatement.medication[x]:medicationReference | ||||||||||||||||
Slice Name | medicationReference | |||||||||||||||
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. | |||||||||||||||
Short | Medication Reference | |||||||||||||||
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. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Reference(ADHA Core Medication) | |||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
98. MedicationStatement.subject | ||||||||||||||||
Definition | The person, animal or group who is/was taking the medication. | |||||||||||||||
Short | Who is/was taking the medication | |||||||||||||||
Control | 1..1 This element is affected by the following invariants: inv-dh-mst-02 | |||||||||||||||
Type | Reference(ADHA Core Patient) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )inv-dh-mst-02: At least reference or a valid identifier shall be present ( reference.exists() or identifier.where(system.count() + value.count() >1).exists() ) | |||||||||||||||
100. MedicationStatement.context | ||||||||||||||||
Definition | The encounter or episode of care that establishes the context for this MedicationStatement. | |||||||||||||||
Short | Encounter / Episode associated with MedicationStatement | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Reference(ADHA Core Encounter) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
102. 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.taken element is No). | |||||||||||||||
Short | The date/time or interval when the medication is/was/will be taken | |||||||||||||||
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 at the time the statement is recorded, the "end" date will be omitted. 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. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Choice of: dateTime, Period | |||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Must Support | true | |||||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
104. MedicationStatement.dateAsserted | ||||||||||||||||
Definition | The date when the medication statement was asserted by the information source. | |||||||||||||||
Short | When the statement was asserted? | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | dateTime | |||||||||||||||
Is Modifier | false | |||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
106. 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. | |||||||||||||||
Short | Person or organization that provided the information about the taking of this medication | |||||||||||||||
Control | 0..1 This element is affected by the following invariants: inv-dh-mst-01 | |||||||||||||||
Type | Reference(ADHA Core Patient, ADHA Core PractitionerRole, ADHA Core RelatedPerson) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
108. MedicationStatement.derivedFrom | ||||||||||||||||
Definition | Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. | |||||||||||||||
Short | Additional supporting information | |||||||||||||||
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. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Reference(Resource) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
110. MedicationStatement.reasonCode | ||||||||||||||||
Definition | A reason for why the medication is being/was taken. | |||||||||||||||
Short | Reason for why the medication is being/was taken | |||||||||||||||
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference. | |||||||||||||||
Control | 0..* | |||||||||||||||
Binding | The codes SHOULD be taken from Medication Reason Taken (preferred to https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 ) | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
112. MedicationStatement.reasonReference | ||||||||||||||||
Definition | Condition or observation that supports why the medication is being/was taken. | |||||||||||||||
Short | Condition or observation that supports why the medication is being/was taken | |||||||||||||||
Comments | This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Reference(Condition, Observation, DiagnosticReport) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
114. MedicationStatement.note | ||||||||||||||||
Definition | Provides extra information about the medication statement that is not conveyed by the other attributes. | |||||||||||||||
Short | Further information about the statement | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Annotation | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
116. MedicationStatement.dosage | ||||||||||||||||
Definition | Indicates how the medication is/was taken or should be taken by the patient. | |||||||||||||||
Short | Dosage information in an Australian healthcare context | |||||||||||||||
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. | |||||||||||||||
Control | 0..* This element is affected by the following invariants: inv-dh-mst-03 | |||||||||||||||
Type | Dosage(AU Base Dosage) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Must Support | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )inv-dh-mst-03: If present, the dosage shall at least have text or patient instructions ( text.exists() or patientInstruction.exists() ) |