AU Base Implementation Guide
4.2.2-ballot - Ballot
This page is part of the Australian Base IG (v4.2.2-ballot: AU Base R4.2 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions
Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the au-medicationadministration resource profile.
Guidance on how to interpret the contents of this table can be found here
0. MedicationAdministration | |
Short | A record of medication administered to a patient in an Australian healthcare context |
Standard Status | Draft (from Trial Use) |
2. MedicationAdministration.medication[x] | |
Short | Medication Detail |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
4. MedicationAdministration.medication[x]:medicationCodeableConcept | |
Slice Name | medicationCodeableConcept |
Short | Coded Medication |
Control | 0..? |
Type | CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
6. MedicationAdministration.medication[x]:medicationCodeableConcept.coding | |
Short | Medication Codes |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x].coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. MedicationAdministration.medication[x]:medicationCodeableConcept.coding.extension | |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x].coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
10. MedicationAdministration.medication[x]:medicationCodeableConcept.coding.extension:medicationClass | |
Slice Name | medicationClass |
Control | 0..1 |
Type | Extension(Medication Type) (Extension Type: Coding) |
12. MedicationAdministration.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 |
14. MedicationAdministration.medication[x]:medicationReference | |
Slice Name | medicationReference |
Short | Medication Reference |
Control | 0..? |
Type | Reference(Medication) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
16. MedicationAdministration.dosage | |
18. MedicationAdministration.dosage.site | |
Binding | The codes SHOULD be taken from Body Site (preferred to https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 ) |
20. MedicationAdministration.dosage.route | |
Binding | The codes SHOULD be taken from Route of Administration (preferred to https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 ) |
22. MedicationAdministration.dosage.method |
Guidance on how to interpret the contents of this table can be found here
0. MedicationAdministration | ||||||||||||||||
Definition | Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. | |||||||||||||||
Short | A record of medication administered to a patient in an Australian healthcare contextAdministration of medication to a patient | |||||||||||||||
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()) | |||||||||||||||
2. MedicationAdministration.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. MedicationAdministration.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()) | |||||||||||||||
6. MedicationAdministration.status | ||||||||||||||||
Definition | Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way. | |||||||||||||||
Short | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown | |||||||||||||||
Comments | 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 MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 )A set of codes indicating the current status of a MedicationAdministration. | |||||||||||||||
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 | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
8. MedicationAdministration.medication[x] | ||||||||||||||||
Definition | Identifies the medication that was 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 was administered | |||||||||||||||
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 )Codes identifying substance or product that can be administered. | |||||||||||||||
Type | Choice of: 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())) | |||||||||||||||
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | |||||||||||||||
10. MedicationAdministration.medication[x]:medicationCodeableConcept | ||||||||||||||||
Slice Name | medicationCodeableConcept | |||||||||||||||
Definition | Identifies the medication that was 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 was administered | |||||||||||||||
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())) | |||||||||||||||
12. MedicationAdministration.medication[x]:medicationCodeableConcept.coding | ||||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Short | Medication CodesCode 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 MedicationAdministration.medication[x].coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
14. MedicationAdministration.medication[x]:medicationCodeableConcept.coding.extension | ||||||||||||||||
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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 | ExtensionAdditional 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 MedicationAdministration.medication[x].coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
16. MedicationAdministration.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()) | |||||||||||||||
18. MedicationAdministration.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. 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. | |||||||||||||||
Short | Medication primary textPlain text representation of the concept | |||||||||||||||
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())) | |||||||||||||||
20. MedicationAdministration.medication[x]:medicationReference | ||||||||||||||||
Slice Name | medicationReference | |||||||||||||||
Definition | Identifies the medication that was 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 was administered | |||||||||||||||
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(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())) | |||||||||||||||
22. MedicationAdministration.subject | ||||||||||||||||
Definition | The person or animal or group receiving the medication. | |||||||||||||||
Short | Who received medication | |||||||||||||||
Control | 1..1 | |||||||||||||||
Type | Reference(Patient, Group) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||
24. MedicationAdministration.effective[x] | ||||||||||||||||
Definition | A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. | |||||||||||||||
Short | Start and end time of administration | |||||||||||||||
Control | 1..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 | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. MedicationAdministration | ||||||||||||||||
Definition | Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. | |||||||||||||||
Short | A record of medication administered to a patient in an Australian healthcare context | |||||||||||||||
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() ) | |||||||||||||||
2. MedicationAdministration.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. MedicationAdministration.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. MedicationAdministration.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. MedicationAdministration.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. MedicationAdministration.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. MedicationAdministration.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. MedicationAdministration.extension | ||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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() ) | |||||||||||||||
16. MedicationAdministration.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() ) | |||||||||||||||
18. MedicationAdministration.identifier | ||||||||||||||||
Definition | Identifiers associated with this Medication Administration 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 | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
20. MedicationAdministration.instantiates | ||||||||||||||||
Definition | A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event. | |||||||||||||||
Short | Instantiates protocol or definition | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | uri | |||||||||||||||
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()) ) | |||||||||||||||
22. MedicationAdministration.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, Procedure) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
24. MedicationAdministration.status | ||||||||||||||||
Definition | Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way. | |||||||||||||||
Short | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown | |||||||||||||||
Comments | 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 MedicationAdministration Status Codes (required to http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 )A set of codes indicating the current status of a MedicationAdministration. | |||||||||||||||
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 | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
26. MedicationAdministration.statusReason | ||||||||||||||||
Definition | A code indicating why the administration was not performed. | |||||||||||||||
Short | Reason administration not performed | |||||||||||||||
Control | 0..* | |||||||||||||||
Binding | For example codes, see SNOMEDCTReasonMedicationNotGivenCodes (example to http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes )A set of codes indicating the reason why the MedicationAdministration is negated. | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
28. MedicationAdministration.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 MedicationAdministration Category Codes (preferred to http://hl7.org/fhir/ValueSet/medication-admin-category )A coded concept describing where the medication administered is expected to occur. | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
30. MedicationAdministration.medication[x] | ||||||||||||||||
Definition | Identifies the medication that was 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 )Codes identifying substance or product that can be administered. | |||||||||||||||
Type | Choice of: 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()) ) | |||||||||||||||
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | |||||||||||||||
32. MedicationAdministration.medication[x]:medicationCodeableConcept | ||||||||||||||||
Slice Name | medicationCodeableConcept | |||||||||||||||
Definition | Identifies the medication that was 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()) ) | |||||||||||||||
34. MedicationAdministration.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 | |||||||||||||||
36. MedicationAdministration.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 MedicationAdministration.medication[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
38. MedicationAdministration.medication[x]:medicationCodeableConcept.coding | ||||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Short | Medication Codes | |||||||||||||||
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 MedicationAdministration.medication[x].coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
40. MedicationAdministration.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 | |||||||||||||||
42. MedicationAdministration.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 MedicationAdministration.medication[x].coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||
44. MedicationAdministration.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() ) | |||||||||||||||
46. MedicationAdministration.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()) ) | |||||||||||||||
48. MedicationAdministration.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()) ) | |||||||||||||||
50. MedicationAdministration.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()) ) | |||||||||||||||
52. MedicationAdministration.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()) ) | |||||||||||||||
54. MedicationAdministration.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()) ) | |||||||||||||||
56. MedicationAdministration.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()) ) | |||||||||||||||
58. MedicationAdministration.medication[x]:medicationReference | ||||||||||||||||
Slice Name | medicationReference | |||||||||||||||
Definition | Identifies the medication that was 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(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()) ) | |||||||||||||||
60. MedicationAdministration.subject | ||||||||||||||||
Definition | The person or animal or group receiving the medication. | |||||||||||||||
Short | Who received medication | |||||||||||||||
Control | 1..1 | |||||||||||||||
Type | Reference(Patient, Group) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
62. MedicationAdministration.context | ||||||||||||||||
Definition | The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. | |||||||||||||||
Short | Encounter or Episode of Care administered as part of | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Reference(Encounter, EpisodeOfCare) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
64. MedicationAdministration.supportingInformation | ||||||||||||||||
Definition | Additional information (for example, patient height and weight) that supports the administration of the medication. | |||||||||||||||
Short | Additional information to support administration | |||||||||||||||
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()) ) | |||||||||||||||
66. MedicationAdministration.effective[x] | ||||||||||||||||
Definition | A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. | |||||||||||||||
Short | Start and end time of administration | |||||||||||||||
Control | 1..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 | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
68. MedicationAdministration.performer | ||||||||||||||||
Definition | Indicates who or what performed the medication administration and how they were involved. | |||||||||||||||
Short | Who performed the medication administration and what they did | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | BackboneElement | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
70. MedicationAdministration.performer.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 | |||||||||||||||
72. MedicationAdministration.performer.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() ) | |||||||||||||||
74. MedicationAdministration.performer.modifierExtension | ||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||||||||
Short | Extensions that cannot be ignored even if unrecognized | |||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Extension | |||||||||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||||||||
Alternate Names | extensions, user content, modifiers | |||||||||||||||
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() ) | |||||||||||||||
76. MedicationAdministration.performer.function | ||||||||||||||||
Definition | Distinguishes the type of involvement of the performer in the medication administration. | |||||||||||||||
Short | Type of performance | |||||||||||||||
Control | 0..1 | |||||||||||||||
Binding | For example codes, see MedicationAdministration Performer Function Codes (example to http://hl7.org/fhir/ValueSet/med-admin-perform-function )A code describing the role an individual played in administering the medication. | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
78. MedicationAdministration.performer.actor | ||||||||||||||||
Definition | Indicates who or what performed the medication administration. | |||||||||||||||
Short | Who performed the medication administration | |||||||||||||||
Control | 1..1 | |||||||||||||||
Type | Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Device) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | true | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
80. MedicationAdministration.reasonCode | ||||||||||||||||
Definition | A code indicating why the medication was given. | |||||||||||||||
Short | Reason administration performed | |||||||||||||||
Control | 0..* | |||||||||||||||
Binding | For example codes, see ReasonMedicationGivenCodes (example to http://hl7.org/fhir/ValueSet/reason-medication-given-codes )A set of codes indicating the reason why the MedicationAdministration was made. | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
82. MedicationAdministration.reasonReference | ||||||||||||||||
Definition | Condition or observation that supports why the medication was administered. | |||||||||||||||
Short | Condition or observation that supports why the medication was administered | |||||||||||||||
Comments | This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode. | |||||||||||||||
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()) ) | |||||||||||||||
84. MedicationAdministration.request | ||||||||||||||||
Definition | The original request, instruction or authority to perform the administration. | |||||||||||||||
Short | Request administration performed against | |||||||||||||||
Comments | This is a reference to the MedicationRequest where the intent is either order or instance-order. It should not reference MedicationRequests where the intent is any other value. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Reference(MedicationRequest) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
86. MedicationAdministration.device | ||||||||||||||||
Definition | The device used in administering the medication to the patient. For example, a particular infusion pump. | |||||||||||||||
Short | Device used to administer | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Reference(Device) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
88. MedicationAdministration.note | ||||||||||||||||
Definition | Extra information about the medication administration that is not conveyed by the other attributes. | |||||||||||||||
Short | Information about the administration | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Annotation | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
90. MedicationAdministration.dosage | ||||||||||||||||
Definition | Describes the medication dosage information details e.g. dose, rate, site, route, etc. | |||||||||||||||
Short | Details of how medication was taken | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | BackboneElement | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] ( dose.exists() or rate.exists() ) | |||||||||||||||
92. MedicationAdministration.dosage.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 | |||||||||||||||
94. MedicationAdministration.dosage.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() ) | |||||||||||||||
96. MedicationAdministration.dosage.modifierExtension | ||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||||||||
Short | Extensions that cannot be ignored even if unrecognized | |||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Extension | |||||||||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | |||||||||||||||
Summary | true | |||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||||||||
Alternate Names | extensions, user content, modifiers | |||||||||||||||
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() ) | |||||||||||||||
98. MedicationAdministration.dosage.text | ||||||||||||||||
Definition | Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered. | |||||||||||||||
Short | Free text dosage instructions e.g. SIG | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | string | |||||||||||||||
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()) ) | |||||||||||||||
100. MedicationAdministration.dosage.site | ||||||||||||||||
Definition | A coded specification of the anatomic site where the medication first entered the body. For example, "left arm". | |||||||||||||||
Short | Body site administered to | |||||||||||||||
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Binding | The codes SHOULD be taken from Body Site (preferred to https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 ) | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
102. MedicationAdministration.dosage.route | ||||||||||||||||
Definition | A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc. | |||||||||||||||
Short | Path of substance into body | |||||||||||||||
Control | 0..1 | |||||||||||||||
Binding | The codes SHOULD be taken from Route of Administration (preferred to https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 ) | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
104. MedicationAdministration.dosage.method | ||||||||||||||||
Definition | A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. | |||||||||||||||
Short | How drug was administered | |||||||||||||||
Comments | One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Binding | The codes SHOULD be taken from SNOMEDCTAdministrationMethodCodes (preferred to http://hl7.org/fhir/ValueSet/administration-method-codes ) | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
106. MedicationAdministration.dosage.dose | ||||||||||||||||
Definition | The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection. | |||||||||||||||
Short | Amount of medication per dose | |||||||||||||||
Comments | If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Quantity(SimpleQuantity) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
108. MedicationAdministration.dosage.rate[x] | ||||||||||||||||
Definition | Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. | |||||||||||||||
Short | Dose quantity per unit of time | |||||||||||||||
Comments | If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate. | |||||||||||||||
Control | 0..1 | |||||||||||||||
Type | Choice of: Ratio, Quantity(SimpleQuantity) | |||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | |||||||||||||||
110. MedicationAdministration.eventHistory | ||||||||||||||||
Definition | A summary of the events of interest that have occurred, such as when the administration was verified. | |||||||||||||||
Short | A list of events of interest in the lifecycle | |||||||||||||||
Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. | |||||||||||||||
Control | 0..* | |||||||||||||||
Type | Reference(Provenance) | |||||||||||||||
Is Modifier | false | |||||||||||||||
Summary | false | |||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |