The Patient360 retrieval API ($p360-retrieve) allows a user to retrieve a patient's clinical records from all connected national health networks. These networks include legacy networks such as CommonWell, Carequality and eHealth Exchange, as well as the established QHINs (Qualified Health Information Networks). The process for retrieving a patient's clinical records is documented below.
Health Gorilla RESTful API is based on FHIR protocol version STU3 and R4. Some custom resource profiles are defined and extension mechanism is used to introduce new attributes and operations that are absent in the original protocol.
Health Gorilla implements SMART-on-FHIR profile and uses Oauth 2.0 framework framework for authentication and authorization. You need to obtain an access token and include it into the request to access the desired API endpoint.
Before querying for clinical records, the desired patient must exist within your tenant in Health Gorilla. If you have previously created the patient in the tenant and do not have the patient's HG ID (FHIR resource ID) stored in your system, the HG ID can be retrieved using the SEARCH Patient FHIR API. The patient's HG ID will be found in the id attribute of the Patient resource.
If the patient has not been created in your tenant in Health Gorilla, you will need to create the patient using the CREATE Patient FHIR API. Upon a successful POST, the patient's HG ID will be returned in the response header.location attribute. In the below example, 73227b65649e308d91c98824 is the HG ID of the newly created patient.
To initiate the query/retrieval of a patient's clinical records, the $p360-retrieve method will be used on the DocumentReference FHIR endpoint using the patient's HG ID. The $p360-retrieve method must be executed asynchronously by including the Prefer:respond-async header. A RequestResult URL will be returned in the response header.locationattribute. This RequestResult URL will be called to retrieve the outcome of the $p360-retrieve process. For more information, see Async Requests in Health Gorilla API.
The RequestResult URL from the previous step must be called to retrieve the outcome of the async p360 query. Your access token should be included in the request header. The following response status codes might be returned depending on the status of the query.
c80f0f1006