Home
API reference
FHIR® API
FHIR® resources
MedicationAdministration
_search

MedicationAdministration _search

post/MedicationAdministration/_search
Page View

This resource contains which medication was given and details about how it was administered to a patient during an inpatient stay.

You can review or retrieve administration details for a medication given to a patient.

_search

Query for details about how a medication was administered to a patient.

This is a flexible option with query parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/MedicationAdministration/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string' \
7
--data-urlencode 'effective=string' \
8
--data-urlencode 'status=string'

Request Body Schema

  • patient
    Array of string

    Returns administrations for a specific patient

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • effective
    Array of string

    The date or period when patient was administered the medication

  • status
    Array of string

    Status of the administration

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "MedicationAdministration",
9
        "id": "RedoxMedicationAdministrationExample",
10
        "identifier": [
11
          {
12
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
13
            "value": "1546937901"
14
          }
15
        ],
16
        "status": "completed",
17
        "medicationCodeableConcept": {
18
          "coding": [
19
            {
20
              "code": "573621",
21
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
22
              "display": "Albuterol 0.09 MG/ACTUAT inhalant solution"
23
            }
24
          ]
25
        },
26
        "subject": {
27
          "reference": "Patient/RedoxPatientExampleTimothy"
28
        },
29
        "effectiveDateTime": "2012-08-06T04:00:00.000Z",
30
        "dosage": {
31
          "route": {
32
            "text": "RESPIRATORY (INHALATION)",
33
            "coding": [
34
              {
35
                "code": "C38216",
36
                "system": "urn:oid:2.16.840.1.113883.3.26.1.1"
37
              }
38
            ]
39
          },
40
          "dose": {
41
            "value": 0.09,
42
            "unit": "mg/actuat"
43
          },
44
          "rateQuantity": {
45
            "value": 90,
46
            "unit": "ml/min"
47
          }
48
        }
49
      },
50
      "search": {
51
        "mode": "match"
52
      }
53
    }
54
  ]
55
}

    Response to a Medication Administration search operation

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of MedicationAdministration or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      Describes the event of a patient consuming or otherwise being administered a medication.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MedicationAdministration
      • status
        required, string

        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.

        Possible Values: in-progress, not-done, on-hold, completed, entered-in-error, stopped, unknown
      • subject
        required, object

        The person or animal or group receiving the medication.

        Must be a resource of type Patient.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • medicationCodeableConcept
        required, object

        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.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            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).

        • text
          string

          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.

      • effectiveDateTime
        required, string

        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.

        Only one of effectiveDateTime, effectivePeriod may be present.

      • effectivePeriod
        required, object

        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.

        Only one of effectiveDateTime, effectivePeriod may be present.

        • start
          string

          The start of the period. The boundary is inclusive.

        • end
          string

          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.

      • id
        string

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • identifier
        Array of object

        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.

        • extension
          Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

          • valueBoolean
            boolean

            A single value for the extension.

        • use
          string

          The purpose of this identifier.

          Possible Values: usual, official, temp, secondary, old (If known)
        • system
          string

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

        • value
          string

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      • statusReason
        Array of object

        A code indicating why the administration was not performed.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            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).

        • text
          string

          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.

      • context
        object

        The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.

        Must be a resource of type Encounter.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • dosage
        object

        Describes the medication dosage information details e.g. dose, rate, site, route, etc.

        • text
          string

          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.

        • route
          object

          A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.

          • coding
            Array of object

            A reference to a code defined by a terminology system.

            • system
              string

              The identification of the code system that defines the meaning of the symbol in the code.

            • code
              string

              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).

          • text
            string

            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.

        • dose

          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.

          See http://hl7.org/fhir/StructureDefinition/SimpleQuantity for more information

        • rateQuantity
          object

          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.

          • value
            number

            The value of the measured amount. The value includes an implicit precision in the presentation of the value.

          • system
            string

            The identification of the system that provides the coded form of the unit.

          • code
            string

            A computer processable form of the unit in some unit representation system.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the MedicationAdministration as matching the search parameters

        Value: match