Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Draft as of 2019-04-05 |
Definitions for the CareConnect-MedicationAdministration-1 resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. MedicationAdministration | |
2. MedicationAdministration.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..? |
3. MedicationAdministration.identifier.assigner | |
Control | 0..? |
Type | Reference(CareConnect-Organization-1) |
4. MedicationAdministration.partOf | |
Type | Reference(CareConnect-Procedure-1|CareConnect-MedicationAdministration-1|MedicationAdministration|Procedure) |
5. MedicationAdministration.medicationReference:medicationReference | |
SliceName | medicationReference |
Control | 0..? |
Type | Reference(Medication|CareConnect-Medication-1) |
6. MedicationAdministration.subject | |
Type | Reference(Group|CareConnectPatient1|Patient) |
7. MedicationAdministration.context | |
Type | Reference(CareConnect-Encounter-1|CareConnect-EpisodeOfCare-1|Encounter|EpisodeOfCare) |
8. MedicationAdministration.performer | |
Control | 0..? |
9. MedicationAdministration.performer.actor | |
Type | Reference(Device|CareConnectPatient1|CareConnect-RelatedPerson-1|CareConnect-Practitioner-1|Practitioner|Patient|RelatedPerson) |
10. MedicationAdministration.performer.onBehalfOf | |
Type | Reference(CareConnect-Organization-1|Organization) |
11. MedicationAdministration.reasonReference | |
Type | Reference(CareConnect-Condition-1|CareConnect-Observation-1|Condition|Observation) |
12. MedicationAdministration.prescription | |
Type | Reference(CareConnect-MedicationRequest-1|MedicationRequest) |
13. MedicationAdministration.note | |
Control | 0..? |
14. MedicationAdministration.note.author[x] | |
Control | 0..? |
Type | Choice of: string, Reference(CareConnectPatient1|CareConnect-RelatedPerson-1|CareConnect-Practitioner-1) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
15. MedicationAdministration.dosage | |
Control | 0..? |
16. MedicationAdministration.dosage.route | |
Control | 0..? |
17. MedicationAdministration.dosage.route.coding | |
Control | 0..? |
Slicing | This element introduces a set of slices on MedicationAdministration.dosage.route.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
18. MedicationAdministration.dosage.route.coding:snomedCT | |
SliceName | snomedCT |
Control | 0..1 |
Binding | For example codes, see Care Connect Medication Dosage Route A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration |
19. MedicationAdministration.dosage.route.coding:snomedCT.extension | |
Control | 0..? |
Slicing | This element introduces a set of slices on MedicationAdministration.dosage.route.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
20. MedicationAdministration.dosage.route.coding:snomedCT.extension:SnomedCTDescriptionId | |
SliceName | SnomedCTDescriptionId |
Definition | The SNOMED CT Description ID for the display. |
Control | 0..1 |
Type | Extension(Extension-coding-sctdescid) (Complex Extension) |
21. MedicationAdministration.dosage.route.coding:snomedCT.system | |
Control | 1..? |
Fixed Value | http://snomed.info/sct |
22. MedicationAdministration.dosage.route.coding:snomedCT.code | |
Control | 1..? |
23. MedicationAdministration.dosage.route.coding:snomedCT.display | |
Control | 1..? |
Guidance on how to interpret the contents of this table can be found here.
1. 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. |
Control | 0..* |
Comments | The WG will be updating the MedicationAdministration resource to adjust each affected resource to align with the workflow pattern (see workflow.html). |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) 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 (: contained.where(('#'+id in %resource.descendants().reference).not()).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()) mad-2: Reason not given is only permitted if NotGiven is true (: reasonNotGiven.empty() or notGiven = true) mad-3: Reason given is only permitted if NotGiven is false (: reasonCode.empty() or notGiven.empty() or notGiven = 'false') |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Summary | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
3. 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
4. MedicationAdministration.partOf | |
Definition | A larger event of which this particular event is a component or step. |
Control | 0..* |
Type | Reference(CareConnect-Procedure-1|CareConnect-MedicationAdministration-1|MedicationAdministration|Procedure) |
Summary | true |
5. 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. |
Control | 1..1 |
Binding | The codes SHALL be taken from MedicationAdministrationStatus A set of codes indicating the current status of a MedicationAdministration. |
Type | code |
Is Modifier | true |
Summary | true |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
6. MedicationAdministration.medication[x] | |
Definition | Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
Control | 1..1 |
Type | Choice of: Reference(Medication), CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example if you require form or lot number, then you must reference the Medication resource. . |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
7. MedicationAdministration.medication[x]:medicationReference | |
SliceName | medicationReference |
Definition | Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
Control | 1..1 |
Type | Choice of: Reference(Medication|CareConnect-Medication-1), CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example if you require form or lot number, then you must reference the Medication resource. . |
8. MedicationAdministration.subject | |
Definition | The person or animal or group receiving the medication. |
Control | 1..1 |
Type | Reference(Group|CareConnectPatient1|Patient) |
Summary | true |
9. MedicationAdministration.context | |
Definition | The visit, admission or other contact between patient and health care provider the medication administration was performed as part of. |
Control | 0..1 |
Type | Reference(CareConnect-Encounter-1|CareConnect-EpisodeOfCare-1|Encounter|EpisodeOfCare) |
10. MedicationAdministration.effective[x] | |
Definition | A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. |
Control | 1..1 |
Type | Choice of: dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
11. MedicationAdministration.notGiven | |
Definition | Set this to true if the record is saying that the medication was NOT administered. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Summary | true |
Comments | This element is labeled as a modifier because it indicates that a administration didn't happen. |
Meaning if Missing | If this is missing, then the medication was administered |
12. MedicationAdministration.reasonReference | |
Definition | Condition or observation that supports why the medication was administered. |
Control | 0..* |
Type | Reference(CareConnect-Condition-1|CareConnect-Observation-1|Condition|Observation) |
Comments | This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode. |
13. MedicationAdministration.prescription | |
Definition | The original request, instruction or authority to perform the administration. |
Control | 0..1 |
Type | Reference(CareConnect-MedicationRequest-1|MedicationRequest) |
Guidance on how to interpret the contents of this table can be found here.
1. 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. | ||||
Control | 0..* | ||||
Comments | The WG will be updating the MedicationAdministration resource to adjust each affected resource to align with the workflow pattern (see workflow.html). | ||||
2. MedicationAdministration.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Summary | true | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. MedicationAdministration.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
4. 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | true | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
5. MedicationAdministration.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
A human language
| ||||
Type | code | ||||
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). | ||||
6. MedicationAdministration.text | |||||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
7. MedicationAdministration.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||||
8. MedicationAdministration.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
9. 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
10. MedicationAdministration.identifier | |||||
Definition | External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
11. MedicationAdministration.identifier.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
12. MedicationAdministration.identifier.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on MedicationAdministration.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
13. MedicationAdministration.identifier.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
14. MedicationAdministration.identifier.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
15. MedicationAdministration.identifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
16. MedicationAdministration.identifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||||
Example | General:123456 | ||||
17. MedicationAdministration.identifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
18. MedicationAdministration.identifier.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-Organization-1) | ||||
Summary | true | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
19. MedicationAdministration.definition | |||||
Definition | A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event. | ||||
Control | 0..* | ||||
Type | Reference(PlanDefinition|ActivityDefinition) | ||||
Summary | true | ||||
20. MedicationAdministration.partOf | |||||
Definition | A larger event of which this particular event is a component or step. | ||||
Control | 0..* | ||||
Type | Reference(CareConnect-Procedure-1|CareConnect-MedicationAdministration-1) | ||||
Summary | true | ||||
21. 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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from MedicationAdministrationStatus A set of codes indicating the current status of a MedicationAdministration | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||
22. MedicationAdministration.category | |||||
Definition | Indicates the type of medication administration and where the medication is expected to be consumed or administered. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from MedicationAdministrationCategory A coded concept describing where the medication administered is expected to occu | ||||
Type | CodeableConcept | ||||
23. MedicationAdministration.medication[x] | |||||
Definition | Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. | ||||
Control | 1..1 | ||||
Type | Reference | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example if you require form or lot number, then you must reference the Medication resource. . | ||||
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
24. MedicationAdministration.medication[x]:medicationReference | |||||
SliceName | medicationReference | ||||
Definition | Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. | ||||
Control | 1..1 | ||||
Type | Reference(Medication|CareConnect-Medication-1) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example if you require form or lot number, then you must reference the Medication resource. . | ||||
25. MedicationAdministration.subject | |||||
Definition | The person or animal or group receiving the medication. | ||||
Control | 1..1 | ||||
Type | Reference(Group|CareConnectPatient1) | ||||
Summary | true | ||||
26. MedicationAdministration.context | |||||
Definition | The visit, admission or other contact between patient and health care provider the medication administration was performed as part of. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-Encounter-1|CareConnect-EpisodeOfCare-1) | ||||
27. MedicationAdministration.supportingInformation | |||||
Definition | Additional information (for example, patient height and weight) that supports the administration of the medication. | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
28. MedicationAdministration.effective[x] | |||||
Definition | A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. | ||||
Control | 1..1 | ||||
Type | Choice of: dateTime, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
29. MedicationAdministration.performer | |||||
Definition | The individual who was responsible for giving the medication to the patient. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
30. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
31. MedicationAdministration.performer.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
32. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
33. MedicationAdministration.performer.actor | |||||
Definition | The device, practitioner, etc. who performed the action. | ||||
Control | 1..1 | ||||
Type | Reference(Device|CareConnectPatient1|CareConnect-RelatedPerson-1|CareConnect-Practitioner-1) | ||||
Summary | true | ||||
34. MedicationAdministration.performer.onBehalfOf | |||||
Definition | The organization the device or practitioner was acting on behalf of. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-Organization-1) | ||||
35. MedicationAdministration.notGiven | |||||
Definition | Set this to true if the record is saying that the medication was NOT administered. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | true | ||||
Summary | true | ||||
Comments | This element is labeled as a modifier because it indicates that a administration didn't happen. | ||||
Meaning if Missing | If this is missing, then the medication was administered | ||||
36. MedicationAdministration.reasonNotGiven | |||||
Definition | A code indicating why the administration was not performed. | ||||
Control | 0..* This element is affected by the following invariants: mad-2 | ||||
Binding | For example codes, see SNOMED CT Reason Medication Not Given Codes A set of codes indicating the reason why the MedicationAdministration is negated | ||||
Type | CodeableConcept | ||||
37. MedicationAdministration.reasonCode | |||||
Definition | A code indicating why the medication was given. | ||||
Control | 0..* This element is affected by the following invariants: mad-3 | ||||
Binding | For example codes, see Reason Medication Given Codes A set of codes indicating the reason why the MedicationAdministration was made | ||||
Type | CodeableConcept | ||||
38. MedicationAdministration.reasonReference | |||||
Definition | Condition or observation that supports why the medication was administered. | ||||
Control | 0..* | ||||
Type | Reference(CareConnect-Condition-1|CareConnect-Observation-1) | ||||
Comments | This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode. | ||||
39. MedicationAdministration.prescription | |||||
Definition | The original request, instruction or authority to perform the administration. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-MedicationRequest-1) | ||||
40. MedicationAdministration.device | |||||
Definition | The device used in administering the medication to the patient. For example, a particular infusion pump. | ||||
Control | 0..* | ||||
Type | Reference(Device) | ||||
41. MedicationAdministration.note | |||||
Definition | Extra information about the medication administration that is not conveyed by the other attributes. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
42. MedicationAdministration.note.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
43. MedicationAdministration.note.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on MedicationAdministration.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
44. MedicationAdministration.note.author[x] | |||||
Definition | The individual responsible for making the annotation. | ||||
Control | 0..1 | ||||
Type | Choice of: string, Reference(CareConnectPatient1|CareConnect-RelatedPerson-1|CareConnect-Practitioner-1) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
45. MedicationAdministration.note.time | |||||
Definition | Indicates when this particular annotation was made. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Summary | true | ||||
46. MedicationAdministration.note.text | |||||
Definition | The text of the annotation. | ||||
Control | 1..1 | ||||
Type | string | ||||
47. MedicationAdministration.dosage | |||||
Definition | Describes the medication dosage information details e.g. dose, rate, site, route, etc. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] (: dose.exists() or rate.exists()) | ||||
48. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
49. MedicationAdministration.dosage.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
50. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
51. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
52. MedicationAdministration.dosage.site | |||||
Definition | A coded specification of the anatomic site where the medication first entered the body. For example, "left arm". | ||||
Control | 0..1 | ||||
Binding | For example codes, see SNOMED CT Anatomical Structure for Administration Site Codes A coded concept describing the site location the medicine enters into or onto the body | ||||
Type | CodeableConcept | ||||
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension body-site-instance. May be a summary code, or a reference to a very precise definition of the location, or both. | ||||
53. 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. | ||||
Control | 0..1 | ||||
Binding | For example codes, see SNOMED CT 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 | ||||
54. MedicationAdministration.dosage.route.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
55. MedicationAdministration.dosage.route.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on MedicationAdministration.dosage.route.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
56. MedicationAdministration.dosage.route.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Slicing | This element introduces a set of slices on MedicationAdministration.dosage.route.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
57. MedicationAdministration.dosage.route.coding:snomedCT | |||||
SliceName | snomedCT | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..1 | ||||
Binding | For example codes, see Care Connect Medication Dosage Route A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
58. MedicationAdministration.dosage.route.coding:snomedCT.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
59. MedicationAdministration.dosage.route.coding:snomedCT.extension | |||||
Definition | An Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on MedicationAdministration.dosage.route.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
60. MedicationAdministration.dosage.route.coding:snomedCT.extension:SnomedCTDescriptionId | |||||
SliceName | SnomedCTDescriptionId | ||||
Definition | The SNOMED CT Description ID for the display. | ||||
Control | 0..1 | ||||
Type | Extension(Extension-coding-sctdescid) (Complex Extension) | ||||
61. MedicationAdministration.dosage.route.coding:snomedCT.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Fixed Value | http://snomed.info/sct | ||||
62. MedicationAdministration.dosage.route.coding:snomedCT.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
63. MedicationAdministration.dosage.route.coding:snomedCT.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
64. MedicationAdministration.dosage.route.coding:snomedCT.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
65. MedicationAdministration.dosage.route.coding:snomedCT.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
66. MedicationAdministration.dosage.route.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
67. 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. | ||||
Control | 0..1 | ||||
Binding | For example codes, see SNOMED CT Administration Method Codes A coded concept describing the technique by which the medicine is administered | ||||
Type | CodeableConcept | ||||
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. | ||||
68. 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. | ||||
Control | 0..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
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. | ||||
69. 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. | ||||
Control | 0..1 | ||||
Type | Choice of: Ratio, Quantity(SimpleQuantity) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
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. | ||||
70. MedicationAdministration.eventHistory | |||||
Definition | A summary of the events of interest that have occurred, such as when the administration was verified. | ||||
Control | 0..* | ||||
Type | Reference(Provenance) | ||||
Comments | This may 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. |