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.
Interaction Diagram
Medication Dispense Retrieval will fetch a specific Medication Dispense record from the DHDR solution database.
Read Medication Transaction
Actor: Client Application
Role: Requests a specific MedicationDispense record based on a known resouce ID from the DHDR Solution.
Actor: DHDR Solution
Role: Returns a specific MedicationDispense corresponding to the resource ID specified by the Client Application.
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
ca-on-medications-ext-quantity-remaining (Dispense Remaining Quantity Extension)
ca-on-medications-ext-refills-remaining (Dispense Remaining Refills Extension)
ca-on-medications-ext-compound-indicator (Drug Compound Indicator Extension)
ca-on-medications-ext-monitored-drug-indicator (Monitored Drug Extension)
Expected Behavior
See Response Handling page for a complete listig 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 header is missing |
MedicationDispense Get by ID | Gateway medications context header is missing UAO identifier | 400 | required | error | Gateway authorization header is missing UAO identifier |
MedicationDispense Get by ID | Gateway medications context header is missing UAO identifier type | 400 | required | error | Gateway authorization header is missing UAO identifier type |
MedicationDispense Get by ID | Gateway medications context header is missing NAME 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 | Medication Dispense is blocked by consent directive | 200 | suppressed | warning | Access to Drug and Pharmacy Service Information has been blocked by the Patient OperationOutcome diagnostics CONSENT_EXISTS |
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 |
MedicationDispense Get by ID | Gateway authorization header is missing ISS | 400 | required | error | Gateway authorization header is missing ISS identifier |
Examples of a read response can be found below
Resource | Example |
---|---|
Medication Dispense Single Event | XML / JSON |
OperationOutcome | XML / JSON |