Profiles & Operations > Retrieve Encounter
Operation: Retrieve Encounter
Retrieve Encounter
This operation enables PoS system to retrieve an Encounter from acCDR FHIR server using a RESTful HTTP Read operation.
Scope
This transaction involves a request by PoS system to retrieve an Encounter from acCDR FHIR server by its ID.
For example, a physician who has access to acCDR is seeing a new patient and wants to see a specific visit for the patient with the known ID. The physician queries the acCDR FHIR server for the Encounter record associated with that patient. The server returns an Encounter record which is then displayed to the physician as a list. The PoS system is responsibile for displaying the Encounter record for the user to review.
Interaction Diagram
Actor: PoS System
Role: Requests a specific acCDR Encounter record from acCDR FHIR server based on the resource ID.
Actor: acCDR FHIR server
Role: Returns an Encounter instance with the resource ID specified by the PoS system.
Specification
This operation is based on FHIR R4 read operation.
Retrieve Encounter Operation
Retrieve Encounter operation is based on RESTful HTTP Read operation on the Encounter endpoint using HTTP GET.
GET [base]/Encounter/[id]
Query Response
If the query is valid and the Encounter record is found,acCDR FHIR server will return an Encounter resource. The encounter instance in the response will conform to the encounter profile defined in this implementation guide.
Examples
- Retrieve Encounter by resource ID 12345
GET [base]/Encounter/12345
Expected Behavior
See Response Handling page for additional response handling behaviour.
| Legend |
|---|
| code = OperationOutcome.issue.code |
| severity = OperationOutcome.issue.severity |
| details.coding.code=OperationOutcome.issue.details.coding.code |
| details.coding.display=OperationOutcome.issue.details.coding.display |
| details.text = OperationOutcome.issue.details.coding.text |
| HTTP Status | Scenario Description | severity | code | details.coding.code | details.coding.display | details.text |
|---|---|---|---|---|---|---|
| 200 OK | An encounter matching the specified id is found. Returns the matching encounter | |||||
| 200 OK | The encounter is found, but there is a consent block that prevents disclosure of patient data. Returns an OperationOutcome resource indicating that there is a consent block on the patient's record that prevents disclosure of patient data. | warning | suppressed | |||
| 400 Bad Request | Missing security token | error | required | Missing required security token: PIN | ||
| 401 Unauthorized | Failed authentication | error | security | Authorization is required for the interaction that was attempted | ||
| 404 Not Found | No encounter matching the specified identifier is found. Returns an OperationOutcome resource indicating an issue. | error | not-found | |||
| 406 Not Acceptable | The Accept header requested a format that the server does not support | error | not-supported | |||
| 422 Unprocessable Entity | FHIR validation errors such as invalid code, wrong date format, or violation of LOB defined business rules | Will vary depending on the error | Will vary depending on the error | OH-defined error code | OH-defined errror message | |
| 429 Too Many Requests | Rate Limit | error | throttled | Too Many Requests | ||
| 500 Internal Server Error | API validates the request but cannot return a valid response due to internal issues. | fatal | exception | Internal Error | ||
| 503 Service Unavailable | Indicates that the services has been temporarily taken down (on purpose) | |||||
| 504 Gateway Timeout | Downstream system(s) did not return timely response | error | timeout |