MedicationStatement _search

post/MedicationStatement/_search
Page View

This resource contains one or more statements about a medication that a patient has taken, is currently taking, or may take in the future. A patient, related person, or clinician may make the statement(s).

The difference between this and MedicationAdministration is that MedicationStatement contains informal statements rather than official administration details, such as dosage or date/time of administration. The information likely isn’t as specific, since the statement might come from a patient’s account or a list that a related person may maintain for the patient.

You can review or retrieve a list of medication statements for a patient.

_search

Query for a list of medication statements given by or on behalf of 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

When querying for this resource, one of the following sets of parameters must always be sent. Additional parameters may be sent at any time.
  • patient

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/MedicationStatement/_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 'category=string' \
7
--data-urlencode 'effective=string'

Request Body Schema

  • patient
    Array of string

    The patient who is consuming the medication

  • category
    Array of string

    The categorization of the Medication Statement

  • effective
    Array of string

    The Date when patient was taking (or not taking) the medication

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": "MedicationStatement",
9
"id": "RedoxMedicationStatementCodeExample",
10
"identifier": [
11
{
12
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
13
"value": "587232495"
14
}
15
],
16
"status": "active",
17
"subject": {
18
"reference": "Patient/RedoxPatientExampleTimothy"
19
},
20
"effectivePeriod": {
21
"start": "2013-11-11T05:00:00.000Z"
22
},
23
"medicationCodeableConcept": {
24
"coding": [
25
{
26
"code": "104894",
27
"system": "http://www.nlm.nih.gov/research/umls/rxnorm"
28
},
29
{
30
"code": "0378-7732-93",
31
"system": "http://hl7.org/fhir/sid/ndc"
32
},
33
{
34
"code": "64695",
35
"system": "urn:oid:2.16.840.1.113883.6.253"
36
},
37
{
38
"code": "50250065007220",
39
"system": "urn:oid:2.16.840.1.113883.6.68"
40
},
41
{
42
"code": "64695",
43
"system": "urn:oid:2.16.840.1.113883.6.162"
44
}
45
],
46
"text": "Ondansetron 4 Mg Po Tbdp"
47
},
48
"reasonCode": [
49
{
50
"coding": [
51
{
52
"code": "422587007",
53
"system": "http://snomed.info/sct"
54
}
55
],
56
"text": "Nausea"
57
}
58
],
59
"dosage": [
60
{
61
"text": "one tablet every morning",
62
"asNeededBoolean": false,
63
"route": {
64
"coding": [
65
{
66
"code": "C38288",
67
"system": "urn:oid:2.16.840.1.113883.3.26.1.1",
68
"display": "Oral"
69
}
70
]
71
},
72
"doseAndRate": [
73
{
74
"doseQuantity": {
75
"value": 4,
76
"unit": "mg"
77
}
78
}
79
],
80
"timing": {
81
"repeat": {
82
"when": [
83
"MORN"
84
],
85
"boundsPeriod": {
86
"start": "2013-11-11T05:00:00.000Z"
87
}
88
}
89
}
90
}
91
]
92
},
93
"search": {
94
"mode": "match"
95
}
96
}
97
]
98
}

    Response to a MedicationStatement 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 MedicationStatement or Other

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

    • resource
      required, object

      A record of a medication that is being consumed by a patient

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MedicationStatement
      • status
        required, string

        A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.

        Possible Values: active, completed, entered-in-error, intended, stopped, on-hold, unknown, not-taken
      • subject
        required, object

        The patient who is/was taking 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 being 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.

        Only one of medicationCodeableConcept, medicationReference may be present.

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

      • medicationReference
        required, object

        Identifies the medication being 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.

        Only one of medicationCodeableConcept, medicationReference may be present.

        Must be a resource of type Medication.

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

      • 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 Statement 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

          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.

      • category
        object

        Indicates where the medication is expected to be consumed or administered.

        • 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 encounter or episode of care that establishes the context for this MedicationStatement.

        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.

      • informationSource
        object

        The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.

        Must reference one of the following types of resources:

        • Patient
        • Practitioner
        • PractitionerRole
        • RelatedPerson
        • Organization
        • 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.

      • reasonCode
        Array of object

        A reason for why the medication is being/was taken.

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

      • dosage
        Array of object

        Indicates how the medication is/was or should be taken by the patient.

        • text
          string

          Free text dosage instructions e.g. SIG.

        • timing
          object

          When medication should be administered.

          • repeat
            object

            A set of rules that describe when the event is scheduled.

            • frequency
              number

              The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.

            • frequencyMax
              number

              If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.

            • period
              number

              Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.

            • _period
              object

              This element contains extensions for period. Depending on the extensions present it could be used in place of period or contain additional information about period. See the extension element for more details on the possible extensions being sent.

              • extension
                Array of OriginalText or Other

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

                  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

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

                • url
                  required, string

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

                  Value: http://hl7.org/fhir/StructureDefinition/originalText
                • valueString
                  required, string

                  The original text

            • periodMax
              number

              If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.

            • _periodMax
              object

              This element contains extensions for periodMax. Depending on the extensions present it could be used in place of periodMax or contain additional information about periodMax. See the extension element for more details on the possible extensions being sent.

              • extension
                Array of OriginalText or Other

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

                  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

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

                • url
                  required, string

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

                  Value: http://hl7.org/fhir/StructureDefinition/originalText
                • valueString
                  required, string

                  The original text

            • periodUnit
              string

              The units of time for the period in UCUM units.

              Possible Values: s, min, h, d, wk, mo, a - unit of time (UCUM)
            • _periodUnit
              object

              This element contains extensions for periodUnit. Depending on the extensions present it could be used in place of periodUnit or contain additional information about periodUnit. See the extension element for more details on the possible extensions being sent.

              • extension
                Array of OriginalText or Other

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

                  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

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

                • url
                  required, string

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

                  Value: http://hl7.org/fhir/StructureDefinition/originalText
                • valueString
                  required, string

                  The original text

            • when
              Array of string

              An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

            • _when
              object

              This element contains extensions for when. Depending on the extensions present it could be used in place of when or contain additional information about when. See the extension element for more details on the possible extensions being sent.

              • extension
                Array of OriginalText or Other

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

                  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

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

                • url
                  required, string

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

                  Value: http://hl7.org/fhir/StructureDefinition/originalText
                • valueString
                  required, string

                  The original text

            • boundsPeriod
              object

              Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

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

        • route
          object

          How drug should enter body.

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

        • doseAndRate
          Array of object

          The amount of medication administered.

          • doseQuantity
            object

            Amount of medication per dose.

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

      • effectiveDateTime
        string

        The date/time or interval when the medication is/was/will be taken

        Only one of effectiveDateTime, effectivePeriod may be present.

      • effectivePeriod
        object

        The date/time or interval when the medication is/was/will be taken

        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.

    • search
      required, object

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

      • mode
        required, string

        Identifies the MedicationStatement as matching the search parameters

        Value: match