Jump to

• Request
• Response

Get a list of medication requests

get

/MedicationRequest

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of medication requests that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• intent: string
  The intent of the prescriptions.
• patient: string
  The patient who has the prescriptions.
• status: string
  The status of the prescriptions.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/MedicationRequest"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/MedicationRequest"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object MedicationRequest
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/MedicationRequest"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : MedicationRequest

Type: object

Show Source

• authoredOn: string (date-time)
  (USCDI) When the request was initially authored.
• category: array category
  (USCDI) The type of medication usage.
• dispenseRequest: dispenseRequest
  (USCDI) The medication supply authorization.
• dosageInstruction: array dosageInstruction
  (USCDI) How the medication should be taken.
• encounter: encounter
  (USCDI) The encounter created as part of the encounter, admission, or stay.
• id(required): string
• intent(required): string
  (USCDI) The following values are supported:

  • proposal
  • plan
  • order
  • original-order
  • reflex-order
  • filler-order
  • instance-order
  • option
• medicationCodeableConcept(required): medicationCodeableConcept
  (USCDI) The medication to be taken.
• reasonCode: array reasonCode
  (USCDI) The reason or indication for ordering or not ordering the medication.
• reasonReference: array reasonReference
  (USCDI) The U.S. Core condition or observation that supports the prescription.
• reportedBoolean: boolean
  (USCDI) The reported rather than primary record.
• requester: requester
  (USCDI) Who or what requested the medication.
• resourceType(required): string
  Allowed Values: [ "MedicationRequest" ]
• status(required): string
  (USCDI) The following values are supported:

  • active
  • on-hold
  • cancelled
  • completed
  • entered-in-error
  • stopped
  • draft
  • unknown
• subject(required): subject
  (USCDI) Who or what group the medication request is for.
• substitution: substitution
  Any restrictions on medication substitution.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "status",
        "intent",
        "medicationCodeableConcept",
        "subject"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "MedicationRequest"
            ]
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>active</code></li>\n    <li><code>on-hold</code></li>\n    <li><code>cancelled</code></li>\n    <li><code>completed</code></li>\n    <li><code>entered-in-error</code></li>\n    <li><code>stopped</code></li>\n    <li><code>draft</code></li>\n    <li><code>unknown</code></li>\n  </ul>\n"
        },
        "intent":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>proposal</code></li>\n    <li><code>plan</code></li>\n    <li><code>order</code></li>\n    <li><code>original-order</code></li>\n    <li><code>reflex-order</code></li>\n    <li><code>filler-order</code></li>\n    <li><code>instance-order</code></li>\n    <li><code>option</code></li>\n  </ul>\n"
        },
        "category":{
            "type":"array",
            "description":"(USCDI) The type of medication usage.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "reportedBoolean":{
            "type":"boolean",
            "description":"(USCDI) The reported rather than primary record."
        },
        "medicationCodeableConcept":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The medication to be taken."
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) Who or what group the medication request is for."
        },
        "encounter":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The encounter created as part of the encounter, admission, or stay."
        },
        "authoredOn":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) When the request was initially authored."
        },
        "requester":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) Who or what requested the medication."
        },
        "reasonCode":{
            "type":"array",
            "description":"(USCDI) The reason or indication for ordering or not ordering the medication.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "reasonReference":{
            "type":"array",
            "description":"(USCDI) The U.S. Core condition or observation that supports the prescription.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "dosageInstruction":{
            "type":"array",
            "description":"(USCDI) How the medication should be taken.",
            "items":{
                "$ref":"#/components/schemas/Dosage"
            }
        },
        "dispenseRequest":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MedicationRequestDispenseRequest"
                }
            ],
            "description":"(USCDI) The medication supply authorization."
        },
        "substitution":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MedicationRequestSubstitution"
                }
            ],
            "description":"Any restrictions on medication substitution."
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : category

Type: array

(USCDI) The type of medication usage.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"(USCDI) The type of medication usage.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : dispenseRequest

(USCDI) The medication supply authorization.

Match All

(USCDI) The medication supply authorization.

Show Source

• object MedicationRequestDispenseRequest

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MedicationRequestDispenseRequest"
        }
    ],
    "description":"(USCDI) The medication supply authorization."
}

Nested Schema : dosageInstruction

Type: array

(USCDI) How the medication should be taken.

Show Source

• Array of: object Dosage

{
    "type":"array",
    "description":"(USCDI) How the medication should be taken.",
    "items":{
        "$ref":"#/components/schemas/Dosage"
    }
}

Nested Schema : encounter

(USCDI) The encounter created as part of the encounter, admission, or stay.

Match All

(USCDI) The encounter created as part of the encounter, admission, or stay.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The encounter created as part of the encounter, admission, or stay."
}

Nested Schema : medicationCodeableConcept

(USCDI) The medication to be taken.

Match All

(USCDI) The medication to be taken.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The medication to be taken."
}

Nested Schema : reasonCode

Type: array

(USCDI) The reason or indication for ordering or not ordering the medication.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"(USCDI) The reason or indication for ordering or not ordering the medication.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : reasonReference

Type: array

(USCDI) The U.S. Core condition or observation that supports the prescription.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"(USCDI) The U.S. Core condition or observation that supports the prescription.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : requester

(USCDI) Who or what requested the medication.

Match All

(USCDI) Who or what requested the medication.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) Who or what requested the medication."
}

Nested Schema : subject

(USCDI) Who or what group the medication request is for.

Match All

(USCDI) Who or what group the medication request is for.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) Who or what group the medication request is for."
}

Nested Schema : substitution

Any restrictions on medication substitution.

Match All

Any restrictions on medication substitution.

Show Source

• object MedicationRequestSubstitution

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MedicationRequestSubstitution"
        }
    ],
    "description":"Any restrictions on medication substitution."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : MedicationRequestDispenseRequest

Type: object

Show Source

• numberOfRepeatsAllowed: integer
  (USCDI) The number of refills authorized.
• quantity: quantity
  (USCDI) The amount of medication to supply per dispense.

{
    "type":"object",
    "properties":{
        "numberOfRepeatsAllowed":{
            "type":"integer",
            "description":"(USCDI) The number of refills authorized."
        },
        "quantity":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Quantity"
                }
            ],
            "description":"(USCDI) The amount of medication to supply per dispense."
        }
    }
}

Nested Schema : quantity

(USCDI) The amount of medication to supply per dispense.

Match All

(USCDI) The amount of medication to supply per dispense.

Show Source

• object Quantity

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Quantity"
        }
    ],
    "description":"(USCDI) The amount of medication to supply per dispense."
}

Nested Schema : Quantity

Type: object

Show Source

• code: string
• system: string (uri)
• unit: string
• value: number

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string"
        },
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        }
    }
}

Nested Schema : Dosage

Type: object

Show Source

• doseAndRate: array doseAndRate
  (USCDI) The amount of medication administered.
• text: string
  (USCDI) The free-text dosage instructions, for example, SIG.
• timing: object timing
  (USCDI) When the medication should be administered.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"(USCDI) The free-text dosage instructions, for example, SIG."
        },
        "timing":{
            "type":"object",
            "description":"(USCDI) When the medication should be administered."
        },
        "doseAndRate":{
            "type":"array",
            "description":"(USCDI) The amount of medication administered.",
            "items":{
                "$ref":"#/components/schemas/DosageDoseAndRate"
            }
        }
    }
}

Nested Schema : doseAndRate

Type: array

(USCDI) The amount of medication administered.

Show Source

• Array of: object DosageDoseAndRate

{
    "type":"array",
    "description":"(USCDI) The amount of medication administered.",
    "items":{
        "$ref":"#/components/schemas/DosageDoseAndRate"
    }
}

Nested Schema : timing

Type: object

(USCDI) When the medication should be administered.

Nested Schema : DosageDoseAndRate

Type: object

Show Source

• doseQuantity: doseQuantity
  (USCDI) The amount of medication per dose.

{
    "type":"object",
    "properties":{
        "doseQuantity":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Quantity"
                }
            ],
            "description":"(USCDI) The amount of medication per dose."
        }
    }
}

Nested Schema : doseQuantity

(USCDI) The amount of medication per dose.

Match All

(USCDI) The amount of medication per dose.

Show Source

• object Quantity

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Quantity"
        }
    ],
    "description":"(USCDI) The amount of medication per dose."
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : MedicationRequestSubstitution

Type: object

Show Source

• allowedBoolean(required): boolean
  Whether substitution is allowed.

{
    "type":"object",
    "required":[
        "allowedBoolean"
    ],
    "properties":{
        "allowedBoolean":{
            "type":"boolean",
            "description":"Whether substitution is allowed."
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top