Profiles & Operations Index > Medication Administration Read
Operation: MedicationAdministration Read
MedicationAdministration read is simple RESTful interactions. This represents an HTTP GET specifying the id of a single MedicationAdministration instance from the FHIR Client Application to retrieve that MedicationAdministration from the DHDR.
Interaction Diagram
Actor: Client Application
Role: Requests a specific MedicationAdministration record based on a known resouce ID from the DHDR Solution.
Actor: DHDR Solution
Role: Returns a specific MedicationAdministration corresponding to the resource ID specified by the Client Application.
Specification
The FHIR DHDR specification is based on the HL7 FHIR R4 Search operation.
MedicationAdministration Read Request
The MedicationAdministration Read Request is an HTTP GET operation to retrieve one MedicationAdministration record by resource "id".
GET [base]/MedicationAdministration/{id}
Example:
Client invokes a Read request for id = 94066C2D3E7D30. Then request (i.e. Query String) will be as follow:
GET [base]/MedicationAdministration/94066C2D3E7D30
Medication Administration Profiles
- Medication Administration
- MedicationRequest Preacription
- Medication
- Patient
- Practitioner
- Organization (Hospital)
- PractitionerRole
- Location
- Encounter
- OperationOutcome
Extensions
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 |
---|---|---|---|---|---|
MedicationAdministration Get by ID | Success - Return resources | 200 | |||
MedicationAdministration Get by ID | HTTP (Gateway) request author header is missing | 400 | required | error | HTTP (Gateway) request authorization header is missing |
MedicationAdministration Get by ID | Gateway header content is invalid | 400 | structure | error | Gateway authorization header content is invalid |
MedicationAdministration Get by ID | Gateway medications context header is missing transaction identifier | 400 | required | error | HTTP (Gateway) request transaction identifier header is missing |
MedicationAdministration Get by ID | Gateway medications context header is missing UAO identifier | 400 | required | error | Gateway authorization header is missing UAO identifier |
MedicationAdministration Get by ID | Gateway medications context header is missing UAO identifier type | 400 | required | error | Gateway authorization header is missing UAO identifier type |
MedicationAdministration Get by ID | Gateway medications context header is missing NAME identifier | 400 | required | error | Gateway authorization header is missing SUB identifier |
MedicationAdministration Get by ID | Administration 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. |
MedicationAdministration Get by ID | Medication Administration with requested ID is not found | 404 | not-found | error | Not found: Medication Administration with requested Resource ID |
MedicationAdministration Get by ID | Medication Administration 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 |
MedicationAdministration Get by ID | Unhandled Exception | 500 | |||
MedicationAdministration Get by ID | X-GtwyOriginalRequestUriMasked missing | 400 | required | error | HTTP (Gateway) request Original Request Uri Masked is missing |
MedicationAdministration 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 Administration Single Event | XML / JSON |
OperationOutcome | XML / JSON |