Profiles & Operations Index > Medication Dispense Read

Operation: MedicationDispense Read

MedicationDispense read is simple RESTful interactions. This represents an HTTP GET specifying the id of a single MedicationDispense instance from the FHIR Client Application to retrieve that MedicationDispense from the DHDR.

Transaction: Read Medication Dispense Request/Response

Medication Dispense Read
    The transactions will:

  • Allow a client application to request a specific medication dispense record by specifying a Dispense ID
  • Allow the DHDR solution to return the appropriate MedicationDispense record
The medication dispense record that is returned will contain the information about the type of medication dispensed, the prescriber, the fulfilling pharmacist and the name of the pharmacy that dispensed it.
Retrieve Medication Transaction

Use Case Category: Read Medication Dispense

This describes the use case category for reading a specific medication dispense record, based on the DHDR Resource ID of the Medication Dispense (typically captured from a prior search operation).

Scenario Details: The User of the client application requests retrieval of a specific medication dispense information, using the DHDR Resource ID of the Medication Dispense.

Message Flow:

  1. “GET” MedicationDispense is sent from the client application to DHDR (via the Gateway), containing the query criteria in the URL string.
  2. DHDR (via the Gateway) responds with the read result, in the form of a FHIR Resource response.

Alternate Flow of Events:

  1. Unable to process the request due to a system-related or business-related issue, the Ontario Health Provider Gateway responds with an HTTP status code, and optionally an OperationOutcome resource.

Specification

The FHIR DHDR specification is based on the HL7 FHIR R4 Search operation.

MedicationDispense Read Request

The MedicationDispense Read Request is an HTTP GET operation to retrieve one MedicationDispense record by resource "id".

GET [base]/MedicationDispense/{id}

Example:

Client invokes a Read request for id = 94066C2D3E7D30. Then request (i.e. Query String) will be as follow:

GET [base]/MedicationDispense/94066C2D3E7D30

Medication Dispense Profiles

Extensions


Expected Behaviour

See Response Handling page for a complete listing of response codes

Operation Validation HTTP Response Code OpOutcome Code OpOutcome Severity OperationOutcome.details.text&OperationOutcome.text
MedicationDispense Get by ID Success - Return resources 200
MedicationDispense Get by ID HTTP (Gateway) request author header is missing 400 required error HTTP (Gateway) request authorization header is missing
MedicationDispense Get by ID Gateway header content is invalid 400 structure error Gateway authorization header content is invalid
MedicationDispense Get by ID Gateway medications context header is missing transaction identifier 400 required error HTTP (Gateway) request transaction identifier is missing
MedicationDispense Get by ID Gateway medications context header is missing login identifier 400 required error Gateway authorization header is missing SUB identifier
MedicationDispense Get by ID Dispense ID is missing 405 not-supported error "Get all" is not supported. Either Resource ID or search parameters have to be provided as per specification
MedicationDispense Get by ID Medication Dispense with requested ID is not found 404 not-found error Not found: Medication Dispense with requested Resource ID
MedicationDispense Get by ID Unhandled Exception 500
MedicationDispense Get by ID X-GtwyOriginalRequestUriMasked missing 400 required error HTTP (Gateway) request Original Request Uri Masked is missing


Examples of a search response can be found below

Resource Example
Medication XML / JSON
Medication Dispense Contained Resources XML / JSON
Organization (Dispensing Pharmacy) XML / JSON
Patient XML / JSON
Practitioner (Prescriber) XML / JSON
Practitioner (Dispensing Pharmacist) XML / JSON
OperationOutcome XML / JSON
OperationOutcome (COVaxON) XML / JSON