Drs® Enterprise - FHIR®© API Documentation
Introduction
Fast Healthcare Interoperability Resources, or FHIR, is a standard way of defining an API for healthcare resources. More information can be found at the FHIR website.
The Drs Enterprise FHIR API is a RESTful implementation for an API. At a high level this means several things.
- FHIR is resource-based. The resources are healthcare or related resources, for example patient medication. All resources have an identifier that can be used to access or reference them.
-
FHIR resources are accessed through HTTP and use the HTTP
verbs. For example, to retrieve a resource you do a
GET, and so forth.
| http://<hosturl>/FHIR/<databasename>/Patient/123 |
The Patient part of the URL is an example of a primary resource.
Authorization and Registration for Patient Access
Registration, and Authentication can be requested from the practice by the client whereby, upon successful application, the practice will set up a user in their Drs® Entreprise system.
Check with the practice office.
The username and password provided by the practice office will be sent via a secure messaging system (e.g. secure e-mail).
API Call Return Type And Structure
All API calls to the Drs® FHIR®© Service return as follows:
Call Return Type: String
Call Return Format/Structure: XML or JSON, depending on the return format requested by the client.
Each FHIR resource is returned along with a Patient Demographics section for easy identification of patient data.
Notes
Patient Smoking Status and Birth Sex data are to be found in the Social History section.
Laboratory Tests and Results are grouped together in the same section (Laboratory Test And Results Observation).
Some sections allow the use of date range filtering, such as lab results and immunizations. Other sections that are deemed as medically relevant data, such as medical history, allergies and problems, do not have date range filtering and as such, all patient data is returned for these sections.