for Developers
Electronic Health Records (EHR) Integration
This describes all the API methods to sync data with Bifrost. Data includes patient information for records and diagnostic reports generated by clinicians.
Base URL
https://api.bifrost.health/api/emr
Methods
Add Patients to Bifrost
This method is to sync patient information from EHR to Bifrost. It is critical as it reduces the need for manual entry of patient information and avoids associated errors that may occur
Path
/patients/add
Method
POST
Request
Content-Type
application/json
Body
Json format for objects in "patients" array
Response
Code: 200
New patient records added successfully and matched Bifrost records updated
Content returned:
Code: 400
Failed to add all patient records
Code: 401
Invalid tenant ID provided
Retrieve Patients from Bifrost
This method is to retrieve patient information from Bifrost to match exported reports.
Path
/patients/export
Method
POST
Request
Content-Type
application/json
Body
Response
Code: 200
All patient details retrieved successfully
Content returned:
Json format for objects in array
Json format for objects in "payments" array
Code: 400
Failed to retrieve all patient details
Code: 401
Invalid tenant ID provided
Export Reports from Bifrost
This method is to export all PDF reports uploaded for Bifrost-powered systems after clinical review.
Path
/results/export
Method
POST
Request
Content-Type
application/json
Body
Response
Code: 200
All reports matching search parameters retrieved successfully
Returned content:
Json format for objects in "reports" array
Code: 401
Invalid tenant ID provided
List All Partner Organizations
This method is to list all organizations that the EHR represents or is partnered with.
Path
/organizations/list
Method
POST
Request
Content-Type
application/json
Body
Code: 200
List of organizations retrieved successfully
Returned content:
Code: 401
Invalid tenant ID provided
Suggested Workflow
Preferred
Alternate
