Jump to

• Request
• Response

Get a list of medication requests

get

/MedicationRequest

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

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

Request

Query Parameters

• -timing-boundsPeriod: string
  The date and time that should fall within MedicationRequest.dosageInstruction.timing.repeat.boundsPeriod when the medication should be given to the patient. The value must use the ge prefix.
• _count: string
  The maximum number of results per page.
• _id: string
  The logical resource ID.
• _include: string
  The inclusion of referenced resources.
• _lastUpdated: string
  The last updated date used to filter results.
• _revinclude: string
  The inclusion of related Provenance resources.

  Allowed Values: [ "Provenance:target" ]
• intent: string
  The medication request intent used to filter results.
• patient: string
  The reference to a patient associated with the medication request.
• status: string
  The medication request status used to filter results.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The 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":{
                "$ref":"#/components/schemas/BundleEntryForMedicationRequest"
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object BundleEntryForMedicationRequest

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

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

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

Nested Schema : BundleEntryForMedicationRequest

Type: object

Show Source

• fullUrl: string
• resource: object MedicationRequest
  The FHIR R4 MedicationRequest resource.
• search: object BundleEntrySearch

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

Nested Schema : MedicationRequest

Type: object

The FHIR R4 MedicationRequest resource.

Show Source

• authoredOn: string (date-time)
• category: array category
• courseOfTherapyType: object CodeableConcept
• dispenseRequest: object DispenseRequestForMedicationRequest
  The FHIR medication request dispense request.
• dosageInstruction: array dosageInstruction
• encounter: object ReferenceForMedicationRequest
  The FHIR reference.
• extension: array extension
• id(required): string
• intent: string
• medicationReference: object ReferenceForMedicationRequest
  The FHIR reference.
• meta: object meta
  The FHIR meta.
• note: array note
• priority: string
• priorPrescription: object ReferenceForMedicationRequest
  The FHIR reference.
• reasonCode: array reasonCode
• reportedBoolean: boolean
• requester: object ReferenceForMedicationRequest
  The FHIR reference.
• resourceType(required): string
  Allowed Values: [ "MedicationRequest" ]
• status: string
• statusReason: object CodeableConcept
• subject: object ReferenceForMedicationRequest
  The FHIR reference.
• substitution: object SubstitutionForMedicationRequest
  The FHIR medication request substitution.
• text: object Narrative

{
    "type":"object",
    "description":"The FHIR R4 MedicationRequest resource.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "MedicationRequest"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "description":"The FHIR meta.",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForMedicationRequest"
            }
        },
        "status":{
            "type":"string"
        },
        "statusReason":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "intent":{
            "type":"string"
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "priority":{
            "type":"string"
        },
        "reportedBoolean":{
            "type":"boolean"
        },
        "medicationReference":{
            "$ref":"#/components/schemas/ReferenceForMedicationRequest"
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForMedicationRequest"
        },
        "encounter":{
            "$ref":"#/components/schemas/ReferenceForMedicationRequest"
        },
        "authoredOn":{
            "type":"string",
            "format":"date-time"
        },
        "requester":{
            "$ref":"#/components/schemas/ReferenceForMedicationRequest"
        },
        "reasonCode":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "courseOfTherapyType":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "note":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AnnotationForMedicationRequest"
            }
        },
        "dosageInstruction":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DosageForMedicationRequest"
            }
        },
        "dispenseRequest":{
            "$ref":"#/components/schemas/DispenseRequestForMedicationRequest"
        },
        "substitution":{
            "$ref":"#/components/schemas/SubstitutionForMedicationRequest"
        },
        "priorPrescription":{
            "$ref":"#/components/schemas/ReferenceForMedicationRequest"
        }
    },
    "required":[
        "resourceType",
        "id"
    ]
}

Nested Schema : BundleEntrySearch

Type: object

Show Source

• mode: string

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

Nested Schema : category

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : DispenseRequestForMedicationRequest

Type: object

The FHIR medication request dispense request.

Show Source

• numberOfRepeatsAllowed: integer
• performer: object ReferenceForMedicationRequest
  The FHIR reference.
• quantity: object Quantity
• validityPeriod: object PeriodForMedicationRequest
  The FHIR period.

{
    "type":"object",
    "description":"The FHIR medication request dispense request.",
    "properties":{
        "validityPeriod":{
            "$ref":"#/components/schemas/PeriodForMedicationRequest"
        },
        "numberOfRepeatsAllowed":{
            "type":"integer"
        },
        "quantity":{
            "$ref":"#/components/schemas/Quantity"
        },
        "performer":{
            "$ref":"#/components/schemas/ReferenceForMedicationRequest"
        }
    }
}

Nested Schema : dosageInstruction

Type: array

Show Source

• Array of: object DosageForMedicationRequest
  The FHIR dosage.

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

Nested Schema : ReferenceForMedicationRequest

Type: object

The FHIR reference.

Show Source

• display: string
• extension: array extension
• reference: string

{
    "type":"object",
    "description":"The FHIR reference.",
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForMedicationRequest"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForMedicationRequest
  The FHIR extension.

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

Nested Schema : meta

Type: object

The FHIR meta.

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "description":"The FHIR meta.",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : note

Type: array

Show Source

• Array of: object AnnotationForMedicationRequest
  The FHIR annotation.

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

Nested Schema : reasonCode

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : SubstitutionForMedicationRequest

Type: object

The FHIR medication request substitution.

Show Source

• allowedBoolean: boolean

{
    "type":"object",
    "description":"The FHIR medication request substitution.",
    "properties":{
        "allowedBoolean":{
            "type":"boolean"
        }
    }
}

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : Quantity

Type: object

Show Source

• code: string
• comparator: string
• system: string
• unit: string
• value: number

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

Nested Schema : PeriodForMedicationRequest

Type: object

The FHIR period.

Show Source

• end: string (date-time)
• extension: array extension
• start: string (date-time)

{
    "type":"object",
    "description":"The FHIR period.",
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForMedicationRequest"
            }
        },
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForMedicationRequest
  The FHIR extension.

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

Nested Schema : ExtensionForMedicationRequest

Type: object

The FHIR extension.

Show Source

• url: string
• valueCode: string
• valueCodeableConcept: object CodeableConcept
• valueString: string

{
    "type":"object",
    "description":"The FHIR extension.",
    "properties":{
        "url":{
            "type":"string"
        },
        "valueString":{
            "type":"string"
        },
        "valueCode":{
            "type":"string"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : DosageForMedicationRequest

Type: object

The FHIR dosage.

Show Source

• additionalInstruction: array additionalInstruction
• asNeededBoolean: boolean
• asNeededCodeableConcept: object CodeableConcept
• doseAndRate: array doseAndRate
• extension: array extension
• patientInstruction: string
• route: object CodeableConcept
• site: object CodeableConcept
• text: string
• timing: object TimingForMedicationRequest
  The FHIR timing.

{
    "type":"object",
    "description":"The FHIR dosage.",
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForMedicationRequest"
            }
        },
        "text":{
            "type":"string"
        },
        "additionalInstruction":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "patientInstruction":{
            "type":"string"
        },
        "timing":{
            "$ref":"#/components/schemas/TimingForMedicationRequest"
        },
        "asNeededCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "asNeededBoolean":{
            "type":"boolean"
        },
        "site":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "route":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "doseAndRate":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DoseAndRate"
            }
        }
    }
}

Nested Schema : additionalInstruction

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : doseAndRate

Type: array

Show Source

• Array of: object DoseAndRate

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

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForMedicationRequest
  The FHIR extension.

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

Nested Schema : TimingForMedicationRequest

Type: object

The FHIR timing.

Show Source

• code: object CodeableConcept
• repeat: object TimingRepeatForMedicationRequest
  The FHIR timing repeat.

{
    "type":"object",
    "description":"The FHIR timing.",
    "properties":{
        "repeat":{
            "$ref":"#/components/schemas/TimingRepeatForMedicationRequest"
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : DoseAndRate

Type: object

Show Source

• doseQuantity: object Quantity
• rateQuantity: object Quantity

{
    "type":"object",
    "properties":{
        "doseQuantity":{
            "$ref":"#/components/schemas/Quantity"
        },
        "rateQuantity":{
            "$ref":"#/components/schemas/Quantity"
        }
    }
}

Nested Schema : TimingRepeatForMedicationRequest

Type: object

The FHIR timing repeat.

Show Source

• boundsPeriod: object PeriodForMedicationRequest
  The FHIR period.
• count: integer
• duration: number
• durationUnit: string
• when: array when

{
    "type":"object",
    "description":"The FHIR timing repeat.",
    "properties":{
        "boundsPeriod":{
            "$ref":"#/components/schemas/PeriodForMedicationRequest"
        },
        "count":{
            "type":"integer"
        },
        "duration":{
            "type":"number"
        },
        "durationUnit":{
            "type":"string"
        },
        "when":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : when

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForMedicationRequest
  The FHIR extension.

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

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

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

Nested Schema : AnnotationForMedicationRequest

Type: object

The FHIR annotation.

Show Source

• authorReference: object ReferenceForMedicationRequest
  The FHIR reference.
• text: string
• time: string (date-time)

{
    "type":"object",
    "description":"The FHIR annotation.",
    "properties":{
        "authorReference":{
            "$ref":"#/components/schemas/ReferenceForMedicationRequest"
        },
        "time":{
            "type":"string",
            "format":"date-time"
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]

  The link relation.
• url: string
  The link URL.

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ],
            "description":"The link relation."
        },
        "url":{
            "type":"string",
            "description":"The link URL."
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top