OncoFAIR
0.1.0 - ci-build
OncoFAIR - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2025-05-22 |
Definitions for the oncofair-medicationadministration-element resource profile.
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 | Administration of medication to a patient |
Control | 0..* |
Is Modifier | false |
Must Support | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
2. 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 its 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 its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. MedicationAdministration.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
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..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
6. MedicationAdministration.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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 | 10..* |
Type | Extension |
Is Modifier | false |
Must Support | 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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. MedicationAdministration.extension:oncofair-ma-element-urgent | |
Slice Name | oncofair-ma-element-urgent |
Definition | Extension created as part of OncoFAIR containing the notion of emergency. Extension créée dans le cadre d'OncoFAIR contenant la notion d'urgence. |
Short | Boolean attribute indicating the notion of urgency in creating the administration element |
Control | 0..1 |
Type | Extension(OncoFAIRMAElementUrgent) (Extension Type: boolean) |
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())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
10. MedicationAdministration.extension:oncofair-ma-element-expirationdate | |
Slice Name | oncofair-ma-element-expirationdate |
Definition | Extension created as part of OncoFAIR containing the expiry date of the component administered. Extension créée dans le cadre d'OncoFAIR contenant la date de péremption du composant administré. |
Short | Expiry date of administered component |
Control | 0..1 |
Type | Extension(OncoFAIRMAElementExpirationDate) (Extension Type: dateTime) |
Is Modifier | false |
Must Support | 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()) |
12. MedicationAdministration.extension:oncofair-ma-element-traceability | |
Slice Name | oncofair-ma-element-traceability |
Definition | Extension created as part of OncoFAIR containing the batch and serial number of the administered component/administration element. Extension créée dans le cadre d'OncoFAIR contenant le numéro de lot et de série du composant administré/élément d'administration. |
Short | OncoFAIRMAElementTraceability |
Control | 0..1 |
Type | Extension(OncoFAIRMAElementTraceability) (Complex Extension) |
Is Modifier | false |
Must Support | 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() ) |
14. MedicationAdministration.extension:oncofair-ma-plannedperiod | |
Slice Name | oncofair-ma-plannedperiod |
Definition | Extension created as part of OncoFAIR containing the planned start and end date of administration. Extension créée dans le cadre d'OncoFAIR contenant la date de début et de fin prévue de l'administration. |
Short | OncoFAIRMAElementPlannedPeriod |
Control | 1..1 |
Type | Extension(OncoFAIRMAElementPlannedPeriod) (Extension Type: Period) |
Is Modifier | false |
Must Support | 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()) |
16. MedicationAdministration.extension:oncofair-element-form | |
Slice Name | oncofair-element-form |
Definition | Extension created as part of OncoFair containing the drug form. Extension créée dans le cadre d'OncoFair contenant la forme du médicament. |
Short | Pharmaceutical form of the prescription/administration item |
Control | 0..1 |
Type | Extension(OncoFAIRElementForm) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | 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.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
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 |
Must Support | false |
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 |
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. 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 | Unique identifier of the administration element in the HIS.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 | 10..1* |
Type | Identifier |
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())) |
22. MedicationAdministration.partOf | |
Definition | A larger event of which this particular event is a component or step. |
Short | The medication administration report linked to the element of administrationPart of referenced event |
Comments | MedicationDispense will be used to indicate waste. |
Control | 10..1* |
Type | Reference(OncoFAIR MedicationAdministration Report, MedicationAdministration, Procedure, MedicationDispense) |
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())) |
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 MedicationAdministrationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0 )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 |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. MedicationAdministration.category | |
Definition | The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication). |
Short | Type of medication administration |
Control | 0..* |
Binding | For example codes, see MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-location (example to http://hl7.org/fhir/ValueSet/medication-admin-location )A coded concept describing where the medication administered is expected to occur. |
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())) |
Slicing | This element introduces a set of slices on MedicationAdministration.category . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
28. MedicationAdministration.category:code | |
Slice Name | code |
Definition | The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication). |
Short | Type of medication administration |
Control | 0..1* |
Binding | For example codes, see MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-location (example to http://hl7.org/fhir/ValueSet/medication-admin-location )A coded concept describing where the medication administered is expected to occur. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. MedicationAdministration.category:nature | |
Slice Name | nature |
Definition | The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication). |
Short | Type of medication administration |
Control | 0..1* |
Binding | For example codes, see MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-location (example to http://hl7.org/fhir/ValueSet/medication-admin-location )A coded concept describing where the medication administered is expected to occur. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. MedicationAdministration.medication | |
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 | What 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 | The codes SHALL be taken from For example codes, see Concepts Medication Value Sethttp://hl7.org/fhir/ValueSet/medication-codes (required to http://ltsi.univ-rennes.fr/ValueSet/concept-medication-oncofair-valueset ) |
Type | CodeableReference(Medication) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. MedicationAdministration.medication.concept | |
Definition | A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology. |
Short | Reference to a concept (by class) |
Control | 0..1 |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. 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 |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. MedicationAdministration.occurence[x] | |
Definition | A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. |
Short | Specific date/time or interval of time during which the administration took place (or did not take place) |
Control | 1..1 |
Type | Choice of: dateTime, Period, Timing |
[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 | 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.occurence[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
40. MedicationAdministration.occurence[x]:occurencePeriod | |
Slice Name | occurencePeriod |
Definition | A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. |
Short | Specific date/time or interval of time during which the administration took place (or did not take place) |
Control | 01..1 |
Type | Period, dateTime, Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
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())) |
42. MedicationAdministration.occurence[x]:occurencePeriod.start | |
Definition | The start of the period. The boundary is inclusive. |
Short | Effective date and time for startinf administration of the administration elementStarting time with inclusive boundary |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Control | 10..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
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())) |
44. MedicationAdministration.occurence[x]:occurencePeriod.end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Short | Effective date and time for ending administration of the administration elementEnd time with inclusive boundary, if not ongoing |
Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Control | 0..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
46. 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 |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
48. MedicationAdministration.request.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Short | Literal reference, Relative, internal or absolute URL |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Control | 0..1 This element is affected by the following invariants: ref-2, ref-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.request.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Short | Unique identifier of the prescription element to which this administration element respondsLogical reference, when literal reference is not known |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 This element is affected by the following invariants: ref-2 |
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())) |
52. MedicationAdministration.device | |
Definition | The device that is to be used for the administration of the medication (for example, PCA Pump). |
Short | Specifies, where applicable, the medical devices or equipment to be used to administer the product. By default, the associated devices are those listed in the prescription element associated with the administration elementDevice used to administer |
Control | 0..* |
Type | CodeableReference(Device) |
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())) |
54. MedicationAdministration.note | |
Definition | Extra information about the medication administration that is not conveyed by the other attributes. |
Short | Information about the administration |
Control | 10..* |
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())) |
Slicing | This element introduces a set of slices on MedicationAdministration.note . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
56. MedicationAdministration.note:wording | |
Slice Name | wording |
Definition | Extra information about the medication administration that is not conveyed by the other attributes. |
Short | Wording of the administration elementInformation about the administration |
Control | 10..1* |
Type | Annotation |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. MedicationAdministration.note:wording.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 | 10..1 This element is affected by the following invariants: ele-1 |
Type | idstring |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Pattern Value | wording |
60. MedicationAdministration.note:wording.text | |
Definition | The text of the annotation in markdown format. |
Short | The annotation - text content (as markdown) |
Control | 1..1 |
Type | markdown |
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())) |
62. MedicationAdministration.note:comments | |
Slice Name | comments |
Definition | Extra information about the medication administration that is not conveyed by the other attributes. |
Short | Comment attached to the administration elementInformation about the administration |
Control | 0..1* |
Type | Annotation |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. MedicationAdministration.note:comments.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 | 10..1 This element is affected by the following invariants: ele-1 |
Type | idstring |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Pattern Value | comments |
66. MedicationAdministration.note:comments.text | |
Definition | The text of the annotation in markdown format. |
Short | The annotation - text content (as markdown) |
Control | 1..1 |
Type | markdown |
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.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 |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) mad-1: If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x] ((dose.exists() or rate.exists() or text.exists())) |
70. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
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()) |
72. MedicationAdministration.dosage.site | |
Definition | A coded specification of the anatomic site where the medication first entered the body. For example, "left arm". |
Short | Specifies, where applicable, the exact point on the body where the product is to be applied to the patient. By default, the place of administration is that shown in the prescription element associated with the administration elementBody 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 http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codes (example to http://hl7.org/fhir/ValueSet/approach-site-codes )A coded concept describing the site location the medicine enters into or onto the body. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
74. 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 | Specifies the route of administration of the product. By default, it is the one shown in the prescription element associated with the administration element.Path of substance into body |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes (example to http://hl7.org/fhir/ValueSet/route-codes )A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
76. 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 | Type of administration element. Must be used to differentiate between management processes adapted to different types of drug treatment.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 SHALL be taken from For example codes, see Type de l'élément d'administration Value Sethttp://hl7.org/fhir/ValueSet/administration-method-codes (required to http://ltsi.univ-rennes.fr/ValueSet/siph-typeeltpla-oncofair-valueset ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
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 | |
2. MedicationAdministration.extension | |
Control | 1..? |
Slicing | This element introduces a set of slices on MedicationAdministration.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. MedicationAdministration.extension:oncofair-ma-element-urgent | |
Slice Name | oncofair-ma-element-urgent |
Control | 0..1 |
Type | Extension(OncoFAIRMAElementUrgent) (Extension Type: boolean) |
Must Support | true |
6. MedicationAdministration.extension:oncofair-ma-element-expirationdate | |
Slice Name | oncofair-ma-element-expirationdate |
Control | 0..1 |
Type | Extension(OncoFAIRMAElementExpirationDate) (Extension Type: dateTime) |
8. MedicationAdministration.extension:oncofair-ma-element-traceability | |
Slice Name | oncofair-ma-element-traceability |
Control | 0..1 |
Type | Extension(OncoFAIRMAElementTraceability) (Complex Extension) |
10. MedicationAdministration.extension:oncofair-ma-plannedperiod | |
Slice Name | oncofair-ma-plannedperiod |
Control | 1..1 |
Type | Extension(OncoFAIRMAElementPlannedPeriod) (Extension Type: Period) |
12. MedicationAdministration.extension:oncofair-element-form | |
Slice Name | oncofair-element-form |
Control | 0..1 |
Type | Extension(OncoFAIRElementForm) (Extension Type: CodeableConcept) |
14. MedicationAdministration.identifier | |
Short | Unique identifier of the administration element in the HIS. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Must Support | true |
16. MedicationAdministration.partOf | |
Short | The medication administration report linked to the element of administration |
Control | 1..1 |
Type | Reference(OncoFAIR MedicationAdministration Report) |
Must Support | true |
18. MedicationAdministration.category | |
Must Support | true |
Slicing | This element introduces a set of slices on MedicationAdministration.category . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. MedicationAdministration.category:code | |
Slice Name | code |
Control | 0..1 |
22. MedicationAdministration.category:nature | |
Slice Name | nature |
Control | 0..1 |
24. MedicationAdministration.medication | |
Binding | The codes SHALL be taken from Concepts Medication Value Set (required to http://ltsi.univ-rennes.fr/ValueSet/concept-medication-oncofair-valueset ) |
26. MedicationAdministration.medication.concept | |
Pattern Value | { |
28. MedicationAdministration.occurence[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on MedicationAdministration.occurence[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. MedicationAdministration.occurence[x]:occurencePeriod | |
Slice Name | occurencePeriod |
Control | 0..1 |
Type | Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
32. MedicationAdministration.occurence[x]:occurencePeriod.start | |
Short | Effective date and time for startinf administration of the administration element |
Control | 1..? |
34. MedicationAdministration.occurence[x]:occurencePeriod.end | |
Short | Effective date and time for ending administration of the administration element |
36. MedicationAdministration.request | |
Must Support | true |
38. MedicationAdministration.request.identifier | |
Short | Unique identifier of the prescription element to which this administration element responds |
Note | This is a business identifier, not a resource identifier (see discussion) |
40. MedicationAdministration.device | |
Short | Specifies, where applicable, the medical devices or equipment to be used to administer the product. By default, the associated devices are those listed in the prescription element associated with the administration element |
Must Support | true |
42. MedicationAdministration.note | |
Control | 1..? |
Must Support | true |
Slicing | This element introduces a set of slices on MedicationAdministration.note . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
44. MedicationAdministration.note:wording | |
Slice Name | wording |
Short | Wording of the administration element |
Control | 1..1 |
46. MedicationAdministration.note:wording.id | |
Control | 1..? |
Pattern Value | wording |
48. MedicationAdministration.note:comments | |
Slice Name | comments |
Short | Comment attached to the administration element |
Control | 0..1 |
50. MedicationAdministration.note:comments.id | |
Control | 1..? |
Pattern Value | comments |
52. MedicationAdministration.dosage | |
Must Support | true |
54. MedicationAdministration.dosage.site | |
Short | Specifies, where applicable, the exact point on the body where the product is to be applied to the patient. By default, the place of administration is that shown in the prescription element associated with the administration element |
56. MedicationAdministration.dosage.route | |
Short | Specifies the route of administration of the product. By default, it is the one shown in the prescription element associated with the administration element. |
58. MedicationAdministration.dosage.method | |
Short | Type of administration element. Must be used to differentiate between management processes adapted to different types of drug treatment. |
Binding | The codes SHALL be taken from Type de l'élément d'administration Value Set (required to http://ltsi.univ-rennes.fr/ValueSet/siph-typeeltpla-oncofair-valueset ) |
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 | Administration of medication to a patient |
Control | 0..* |
Is Modifier | false |
Must Support | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() ) |
2. 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 | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
Control | 0..1 |
Type | id |
Is Modifier | false |
Must Support | 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 |
Must Support | 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 its 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 its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
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 SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0 )IETF language tag for a human language |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
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 a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Control | 0..1 This element is affected by the following invariants: dom-6 |
Type | Narrative |
Is Modifier | false |
Must Support | 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
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..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
14. MedicationAdministration.extension | |
Definition | An Extension |
Short | Extension |
Control | 1..* |
Type | Extension |
Is Modifier | false |
Must Support | 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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. MedicationAdministration.extension:oncofair-ma-element-urgent | |
Slice Name | oncofair-ma-element-urgent |
Definition | Extension created as part of OncoFAIR containing the notion of emergency. Extension créée dans le cadre d'OncoFAIR contenant la notion d'urgence. |
Short | Boolean attribute indicating the notion of urgency in creating the administration element |
Control | 0..1 |
Type | Extension(OncoFAIRMAElementUrgent) (Extension Type: boolean) |
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()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
18. MedicationAdministration.extension:oncofair-ma-element-expirationdate | |
Slice Name | oncofair-ma-element-expirationdate |
Definition | Extension created as part of OncoFAIR containing the expiry date of the component administered. Extension créée dans le cadre d'OncoFAIR contenant la date de péremption du composant administré. |
Short | Expiry date of administered component |
Control | 0..1 |
Type | Extension(OncoFAIRMAElementExpirationDate) (Extension Type: dateTime) |
Is Modifier | false |
Must Support | 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() ) |
20. MedicationAdministration.extension:oncofair-ma-element-traceability | |
Slice Name | oncofair-ma-element-traceability |
Definition | Extension created as part of OncoFAIR containing the batch and serial number of the administered component/administration element. Extension créée dans le cadre d'OncoFAIR contenant le numéro de lot et de série du composant administré/élément d'administration. |
Short | OncoFAIRMAElementTraceability |
Control | 0..1 |
Type | Extension(OncoFAIRMAElementTraceability) (Complex Extension) |
Is Modifier | false |
Must Support | 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() ) |
22. MedicationAdministration.extension:oncofair-ma-plannedperiod | |
Slice Name | oncofair-ma-plannedperiod |
Definition | Extension created as part of OncoFAIR containing the planned start and end date of administration. Extension créée dans le cadre d'OncoFAIR contenant la date de début et de fin prévue de l'administration. |
Short | OncoFAIRMAElementPlannedPeriod |
Control | 1..1 |
Type | Extension(OncoFAIRMAElementPlannedPeriod) (Extension Type: Period) |
Is Modifier | false |
Must Support | 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. MedicationAdministration.extension:oncofair-element-form | |
Slice Name | oncofair-element-form |
Definition | Extension created as part of OncoFair containing the drug form. Extension créée dans le cadre d'OncoFair contenant la forme du médicament. |
Short | Pharmaceutical form of the prescription/administration item |
Control | 0..1 |
Type | Extension(OncoFAIRElementForm) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | 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() ) |
26. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
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 |
Must Support | false |
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 |
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. 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 | Unique identifier of the administration element in the HIS. |
Comments | This is a business identifier, not a resource identifier. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
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. MedicationAdministration.basedOn | |
Definition | A plan that is fulfilled in whole or in part by this MedicationAdministration. |
Short | Plan this is fulfilled by this administration |
Control | 0..* |
Type | Reference(CarePlan) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. MedicationAdministration.partOf | |
Definition | A larger event of which this particular event is a component or step. |
Short | The medication administration report linked to the element of administration |
Comments | MedicationDispense will be used to indicate waste. |
Control | 1..1 |
Type | Reference(OncoFAIR MedicationAdministration Report) |
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()) ) |
34. 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 MedicationAdministrationStatusCodes (required to http://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0 )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 |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
36. 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 |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. MedicationAdministration.category | |
Definition | The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication). |
Short | Type of medication administration |
Control | 0..* |
Binding | For example codes, see MedicationAdministrationLocationCodes (example to http://hl7.org/fhir/ValueSet/medication-admin-location )A coded concept describing where the medication administered is expected to occur. |
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()) ) |
Slicing | This element introduces a set of slices on MedicationAdministration.category . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
40. MedicationAdministration.category:code | |
Slice Name | code |
Definition | The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication). |
Short | Type of medication administration |
Control | 0..1 |
Binding | For example codes, see MedicationAdministrationLocationCodes (example to http://hl7.org/fhir/ValueSet/medication-admin-location )A coded concept describing where the medication administered is expected to occur. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. MedicationAdministration.category:nature | |
Slice Name | nature |
Definition | The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication). |
Short | Type of medication administration |
Control | 0..1 |
Binding | For example codes, see MedicationAdministrationLocationCodes (example to http://hl7.org/fhir/ValueSet/medication-admin-location )A coded concept describing where the medication administered is expected to occur. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
44. MedicationAdministration.medication | |
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 | What 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 | The codes SHALL be taken from Concepts Medication Value Set (required to http://ltsi.univ-rennes.fr/ValueSet/concept-medication-oncofair-valueset ) |
Type | CodeableReference(Medication) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. MedicationAdministration.medication.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
48. MedicationAdministration.medication.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
50. MedicationAdministration.medication.concept | |
Definition | A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology. |
Short | Reference to a concept (by class) |
Control | 0..1 |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
52. MedicationAdministration.medication.reference | |
Definition | A reference to a resource the provides exact details about the information being referenced. |
Short | Reference to a resource (by instance) |
Control | 0..1 |
Type | Reference |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. 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 |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. MedicationAdministration.encounter | |
Definition | The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. |
Short | Encounter administered as part of |
Control | 0..1 |
Type | Reference(Encounter) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
58. MedicationAdministration.supportingInformation | |
Definition | Additional information (for example, patient height and weight) that supports the administration of the medication. This attribute can be used to provide documentation of specific characteristics of the patient present at the time of administration. For example, if the dose says "give "x" if the heartrate exceeds "y"", then the heart rate can be included using this attribute. |
Short | Additional information to support administration |
Control | 0..* |
Type | Reference(Resource) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
60. MedicationAdministration.occurence[x] | |
Definition | A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. |
Short | Specific date/time or interval of time during which the administration took place (or did not take place) |
Control | 1..1 |
Type | Choice of: dateTime, Period, Timing |
[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 | 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.occurence[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
62. MedicationAdministration.occurence[x]:occurencePeriod | |
Slice Name | occurencePeriod |
Definition | A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. |
Short | Specific date/time or interval of time during which the administration took place (or did not take place) |
Control | 0..1 |
Type | Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
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()) ) |
64. MedicationAdministration.occurence[x]:occurencePeriod.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
66. MedicationAdministration.occurence[x]:occurencePeriod.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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.occurence[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
68. MedicationAdministration.occurence[x]:occurencePeriod.start | |
Definition | The start of the period. The boundary is inclusive. |
Short | Effective date and time for startinf administration of the administration element |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Control | 1..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
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. MedicationAdministration.occurence[x]:occurencePeriod.end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Short | Effective date and time for ending administration of the administration element |
Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Control | 0..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
72. MedicationAdministration.recorded | |
Definition | The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event. |
Short | When the MedicationAdministration was first captured in the subject's record |
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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
74. MedicationAdministration.isSubPotent | |
Definition | An indication that the full dose was not administered. |
Short | Full dose was not administered |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
76. MedicationAdministration.subPotentReason | |
Definition | The reason or reasons why the full dose was not administered. |
Short | Reason full dose was not administered |
Control | 0..* |
Binding | For example codes, see MedicationAdministrationSubpotentReason (example to http://hl7.org/fhir/ValueSet/administration-subpotent-reason ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
78. MedicationAdministration.performer | |
Definition | The performer of the medication treatment. For devices this is the device that performed the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers. |
Short | Who or what performed the medication administration and what type of performance they did |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
80. 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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
82. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
84. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
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() ) |
86. 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 MedicationAdministrationPerformerFunctionCodes (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 |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
88. MedicationAdministration.performer.actor | |
Definition | Indicates who or what performed the medication administration. |
Short | Who or what performed the medication administration |
Control | 1..1 |
Type | CodeableReference(Practitioner, PractitionerRole, Patient, RelatedPerson, Device) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
90. MedicationAdministration.reason | |
Definition | A code, Condition or observation that supports why the medication was administered. |
Short | Concept, condition or observation that supports why the medication was administered |
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 | CodeableReference(Condition, Observation, DiagnosticReport) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
92. 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 |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
94. MedicationAdministration.request.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
96. MedicationAdministration.request.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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.request.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
98. MedicationAdministration.request.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Short | Literal reference, Relative, internal or absolute URL |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Control | 0..1 This element is affected by the following invariants: ref-2, ref-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()) ) |
100. MedicationAdministration.request.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). |
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()) ) |
102. MedicationAdministration.request.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Short | Unique identifier of the prescription element to which this administration element responds |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 This element is affected by the following invariants: ref-2 |
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()) ) |
104. MedicationAdministration.request.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Short | Text alternative for the resource |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Control | 0..1 This element is affected by the following invariants: ref-2 |
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()) ) |
106. MedicationAdministration.device | |
Definition | The device that is to be used for the administration of the medication (for example, PCA Pump). |
Short | Specifies, where applicable, the medical devices or equipment to be used to administer the product. By default, the associated devices are those listed in the prescription element associated with the administration element |
Control | 0..* |
Type | CodeableReference(Device) |
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()) ) |
108. MedicationAdministration.note | |
Definition | Extra information about the medication administration that is not conveyed by the other attributes. |
Short | Information about the administration |
Control | 1..* |
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()) ) |
Slicing | This element introduces a set of slices on MedicationAdministration.note . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
110. MedicationAdministration.note:wording | |
Slice Name | wording |
Definition | Extra information about the medication administration that is not conveyed by the other attributes. |
Short | Wording of the administration element |
Control | 1..1 |
Type | Annotation |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
112. MedicationAdministration.note:wording.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 | 1..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Pattern Value | wording |
114. MedicationAdministration.note:wording.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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.note.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
116. MedicationAdministration.note:wording.author[x] | |
Definition | The individual responsible for making the annotation. |
Short | Individual responsible for the annotation |
Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
Control | 0..1 |
Type | Choice of: Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization), string |
[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()) ) |
118. MedicationAdministration.note:wording.time | |
Definition | Indicates when this particular annotation was made. |
Short | When the annotation was made |
Control | 0..1 |
Type | dateTime |
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()) ) |
120. MedicationAdministration.note:wording.text | |
Definition | The text of the annotation in markdown format. |
Short | The annotation - text content (as markdown) |
Control | 1..1 |
Type | markdown |
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()) ) |
122. MedicationAdministration.note:comments | |
Slice Name | comments |
Definition | Extra information about the medication administration that is not conveyed by the other attributes. |
Short | Comment attached to the administration element |
Control | 0..1 |
Type | Annotation |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
124. MedicationAdministration.note:comments.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 | 1..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Pattern Value | comments |
126. MedicationAdministration.note:comments.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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.note.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
128. MedicationAdministration.note:comments.author[x] | |
Definition | The individual responsible for making the annotation. |
Short | Individual responsible for the annotation |
Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
Control | 0..1 |
Type | Choice of: Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization), string |
[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()) ) |
130. MedicationAdministration.note:comments.time | |
Definition | Indicates when this particular annotation was made. |
Short | When the annotation was made |
Control | 0..1 |
Type | dateTime |
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()) ) |
132. MedicationAdministration.note:comments.text | |
Definition | The text of the annotation in markdown format. |
Short | The annotation - text content (as markdown) |
Control | 1..1 |
Type | markdown |
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()) ) |
134. 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 |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )mad-1: If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x] ( (dose.exists() or rate.exists() or text.exists()) ) |
136. 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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
138. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
140. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
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() ) |
142. 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 This element is affected by the following invariants: mad-1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
144. MedicationAdministration.dosage.site | |
Definition | A coded specification of the anatomic site where the medication first entered the body. For example, "left arm". |
Short | Specifies, where applicable, the exact point on the body where the product is to be applied to the patient. By default, the place of administration is that shown in the prescription element associated with the administration element |
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTAnatomicalStructureAdministrationSites (example to http://hl7.org/fhir/ValueSet/approach-site-codes )A coded concept describing the site location the medicine enters into or onto the body. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
146. 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 | Specifies the route of administration of the product. By default, it is the one shown in the prescription element associated with the administration element. |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTRouteCodes (example to http://hl7.org/fhir/ValueSet/route-codes )A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
148. 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 | Type of administration element. Must be used to differentiate between management processes adapted to different types of drug treatment. |
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 SHALL be taken from Type de l'élément d'administration Value Set (required to http://ltsi.univ-rennes.fr/ValueSet/siph-typeeltpla-oncofair-valueset ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
150. 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 This element is affected by the following invariants: mad-1 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
152. 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 This element is affected by the following invariants: mad-1 |
Type | Choice of: Ratio, Quantity(SimpleQuantity) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
154. 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 |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |