diff --git a/content/millennium/r4/clinical/medications/medication-administration.md b/content/millennium/r4/clinical/medications/medication-administration.md index 347e937cc..d8feb1fcb 100644 --- a/content/millennium/r4/clinical/medications/medication-administration.md +++ b/content/millennium/r4/clinical/medications/medication-administration.md @@ -9,9 +9,9 @@ title: MedicationAdministration | R4 API ## Overview -The Medication Administration resource provides information about medications and vaccines administered to a patient or consumed by a patient including injections, intravenous solutions, and self administered oral medications. +The MedicationAdministration resource provides information about medications administered to a patient or consumed by a patient including injections, intravenous solutions, and self-administered oral medications. You can use this resource to search for full administration details for vaccinations administered by the current healthcare system. For historically administered vaccines, or vaccines administered by other healthcare disciplines, care settings, or regions, you must use the [`Immunization`] resource to create or retrieve information. -* **IMPORTANT NOTE**: Infuse or Bolus administration results for continuous infusion orders may require additional calculations to determine the actual amount of medication administered per ingredient. An additional calculation is required when the dosage dose does not equal the contained Medication ingredient strength denominator. In this case, calculate the ratio between the ingredient’s numerator divided by the denominator and multiply by dosage dose. This will be the actual amount of medication administered. +* **Important:** Infuse or bolus administration results for continuous infusion orders may require additional calculations to determine the actual amount of medication administered per ingredient. An additional calculation is required when the dosage dose does not equal the [contained] Medication ingredient strength denominator. In this case, calculate the ratio between the ingredient’s numerator divided by the denominator and multiply by dosage dose. This result is the actual amount of medication administered. The following fields are returned if valued: @@ -32,6 +32,15 @@ The following fields are returned if valued: * [Dose](https://hl7.org/fhir/r4/medicationadministration-definitions.html#MedicationAdministration.dosage.dose){:target="_blank"} * [Rate](https://hl7.org/fhir/r4/medicationadministration-definitions.html#MedicationAdministration.dosage.rate){:target="_blank"} +* MedicationAdministration.medication may be a reference to a [contained] Medication when the Medication cannot be represented by a [CodeableConcept] because it contains a unique combination of ingredients. Medications in the system always exist in the context of a medication administration and cannot be referenced independently. + + +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. + ## Terminology Bindings <%= terminology_table(:medication_administration, :r4) %> @@ -48,42 +57,44 @@ The following fields are returned if valued: All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}` - ID | Value\[x] Type | Description ------------------------------------------------------------|------------------------------------------------------------------|---------------------------------------------------------------- - `infuse-over-time` | [`Quantity`](https://hl7.org/fhir/r4/datatypes.html#quantity) | The length of time in minutes it took to infuse a medication. + ID | Value\[x] Type | Description +--------------------|---------------------------------------------------------------|-------------------------------------------------------------- + `infuse-over-time` | [`Quantity`](https://hl7.org/fhir/r4/datatypes.html#quantity) | The length of time in minutes it took to infuse a medication. ## Search -Search for MedicationAdministrations that meet supplied query parameters: +Search for medication administrations that meet supplied query parameters. GET /MedicationAdministration?:parameters -_Implementation Notes_ - -* MedicationAdministration.medication may be a reference to a contained Medication when the Medication cannot be represented by a CodeableConcept because it contains a unique combination of ingredients. Medications in the system always exist within the context of a MedicationAdministration and cannot be referenced independently. - -* IMPORTANT NOTE: Infuse or Bolus administration results for continuous infusion orders may require additional calculations to determine the actual amount of medication administered per ingredient. An additional calculation is required when the dosage dose does not equal the contained Medication ingredient strength denominator. In this case, calculate the ratio between the ingredient’s numerator divided by the denominator and multiply by dosage dose. This will be the actual amount of medication administered. - ### Authorization Types -<%= authorization_types(provider: true, patient: false, system: true) %> +<%= authorization_types(provider: true, patient: true, system: true) %> ### Parameters - Name | Required? | Type | Description -------------------------|--------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - `_id` | This, or `patient` | [`token`] | The logical resource id associated with the resource. Example: `_id=12345` - `patient` | This, or `_id` | [`reference`] | The specific patient to return MedicationAdministrations for. Example: `patient=1234` - `status` | N | [`token`] | The [status] of the medication administration event. May be a list separated by commas. Example: `status=completed,not-done` - `performer` | N | [`reference`] | The identity of the individual who administered the medication. May be a list separated by commas. Example: `performer=1245,7659` - `effective-time` | N | [`date`] | An date-time range when administration happened. Must include a time. Example: `effective-time=ge2014-05-19T20:54:02.000Z` - `_count` | N | [`number`] | The maximum number of results to include in a page. Example: `50` - -Notes: - -* `effective-time` parameter may be provided - * once with a prefix `ge` or `gt` or `le` or `lt`. Example: `effective-time=ge2014-05-19T20:54:02.000Z` - * twice with the prefixes `ge`, `gt`, `le`, `lt`. Example: `effective-time=ge2014-05-19T20:54:02.000Z&effective-time=le2014-05-20T20:54:02.000Z` + Name | Required? | Type | Description +------------------|---------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. It may be a list separated by commas. This parameter is required if the `patient` parameter is not used. Example: `_id=12345` + `patient` | Conditionally | [`reference`] | The specific patient to return medication administrations for. This parameter is required if the `_id` parameter is not used. Example: `patient=1234` + `status` | No | [`token`] | The status of the medication administration event. It may be a list separated by commas. Example: `status=completed,not-done` + `performer` | No | [`reference`] | The logical resource ID of the practitioner who administered the medication. It may be a list separated by commas. Example: `performer=1245,7659` + `effective-time` | No | [`dateTime`] | A date range for when the administration happened. Example: `effective-time=ge2014-05-19T20:54:02.000Z` + [`_count`] | No | [`number`] | The maximum number of results to include on a page. Example: `50` + +_Notes_ + +- When searching with the `_id` parameter + - It must not be provided with any other parameters. +- When searching with the `effective-time` parameter: + - For a single `effective-time` occurrence: + - It must be provided with a `ge`, `gt`, `le`, or `lt` prefix to imply the date range for an administrations search. + - The time component is required. + - Example: `effective-time=ge2014-05-19T20:54:02.000Z` + - For two `effective-time` occurences: + - It must be provided once with the `le` or `lt` prefix, and once with the `ge` or `gt` prefix to search for administrations within the given upper and lower timestamps, respectively. + - The time component is required for both parameters. + - Example: `effective-time=ge2014-05-19T20:54:02.000Z&effective-time=le2014-05-20T20:54:02.000Z` ### Headers @@ -99,27 +110,16 @@ Notes: <%= headers status: 200 %> <%= json(:R4_MEDICATION_ADMINISTRATION_BUNDLE) %> -<%= disclaimer %> - -### Errors -The common [errors] and [OperationOutcomes] may be returned. +## Retrieve by ID -## Retrieve by id - -List an individual MedicationAdministration by its id: +List an individual medication administration by its ID. GET /MedicationAdministration/:id -_Implementation Notes_ - -* MedicationAdministration.medication may be a reference to a contained Medication when the Medication cannot be represented by a CodeableConcept because it contains a unique combination of ingredients. Medications in the system always exist within the context of a MedicationAdministration and cannot be be referenced independently. - -* IMPORTANT NOTE: Infuse or Bolus administration results for continuous infusion orders may require additional calculations to determine the actual amount of medication administered per ingredient. An additional calculation is required when the dosage dose does not equal the contained Medication ingredient strength denominator. In this case, calculate the ratio between the ingredient’s numerator divided by the denominator and multiply by dosage dose. This will be the actual amount of medication administered. - ### Authorization Types -<%= authorization_types(provider: true, patient: false, system: true) %> +<%= authorization_types(provider: true, patient: true, system: true) %> ### Headers @@ -135,20 +135,16 @@ _Implementation Notes_ <%= headers status: 200 %> <%= json(:R4_MEDICATION_ADMINISTRATION_ENTRY) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. [`reference`]: http://hl7.org/fhir/R4/search.html#reference [`token`]: http://hl7.org/fhir/R4/search.html#token [`date`]: http://hl7.org/fhir/R4/search.html#date +[`dateTime`]: https://hl7.org/fhir/r4/datatypes.html#dateTime [`_count`]: http://hl7.org/fhir/R4/search.html#count [`number`]: http://hl7.org/fhir/R4/search.html#number -[`CodeableConcept`]: http://hl7.org/fhir/R4/datatypes.html#codeableconcept +[CodeableConcept]: http://hl7.org/fhir/R4/datatypes.html#codeableconcept [contained]: http://hl7.org/fhir/R4/references.html#contained -[MedicationAdministration.medication]: http://hl7.org/fhir/R4/medicationadministration-definitions.html#MedicationAdministration.medication_x_ [errors]: ../../../#client-errors [OperationOutcomes]: ../../../#operation-outcomes [Infuse Over Time]: #custom-extensions +[`Immunization`]: ../immunization/#overview