-
Notifications
You must be signed in to change notification settings - Fork 7
FHR API Documentation
ProjectEKA is a Federated Health Record Exchange. Our intention is to make the API documented such that it is self sufficient and explanatory. However in many cases, they need more elaboration and examples, which is not possible to do via OpenAPI specification (nor is it meant for).
In the WIKI, we hope to provide explanations, examples and common conventions about the APIs and expected behaviours.
You can find the API links here
As you know by now, the entire FHR Exchange relevant communications happen in a HTTP Async way, meaning you don't get the response as part of the HTTP request-response call, and not part of the response body - rather via a callback API - typically a corresponding on-action HTTP API call. All such response callback APIs (e.g. /on-discover), have an error attribute, which have a code and a message. The codes are described here. Note, only the ones relevant to the network are documented, for application/system specification error codes (e.g. Patient App), please refer to the reference implementation documentations.
These are codes that are used within the contract to express specific concepts. Reference implementations only demonstrate the means and usages of the codes, and not establish a standard. The standards themselves are to be defined by a competent authority, available publicly, and the codes in the reference systems should only reference/use such definitions. The codes are described here