Introduction
This document aims to fully specify the transactions that will be used in Phase 1 of the RHEA Project. In this document the transaction specifications will be laid out for each planned transaction type. In this document we will specify transactions on two fronts. We will describe both the external API and internal APIs that the interoperability layer will support. These are explained below:
...
- Save Patient Encounter - Internal
- Query for previous patient encounters - Internal
- Get encounter - Internal
- Create patient in SHR - Internal
Client Registry - OpenEMPI
...
Terminology Service
Security
All RESTful endpoint of the External API will be secured using HTTPS and basic auth.
Error Messages
In the cases in which a transaction fails the standard HTTP response codes will be used to convey these error. In some cases a more detailed error is needed. These endpoint will return a XML document representing the error in the HTTP body. The document will have the following structure:
...