About Authentication Example API Functions Patient Lookup GET /patientinfo/patient/id GET /patientinfo/{patientId} GET /patientsummary Encounters GET /{patientId}/ccds/api/list-encounters GET /{patientId}/ccds/api/encounter-ccds CCDS GET /{patientId}/ccds/api/all-patient-data GET /{patientId}/ccds/api/patient-info GET /{patientId}/ccds/api/smoking-status GET /{patientId}/ccds/api/problems GET /{patientId}/ccds/api/medications GET /{patientId}/ccds/api/medication-allergies GET /{patientId}/ccds/api/laboratory-tests GET /{patientId}/ccds/api/laboratory-results GET /{patientId}/ccds/api/vital-signs GET /{patientId}/ccds/api/procedures GET /{patientId}/ccds/api/care-team-members GET /{patientId}/ccds/api/immunizations GET /{patientId}/ccds/api/udi-for-implantable-device GET /{patientId}/ccds/api/assessment-and-plan-of-treatment GET /{patientId}/ccds/api/goals GET /{patientId}/ccds/api/health-concerns

escribeHOST API Documentation

https://ehr.escribe.com/ehr/api

Authentication

Authentication is required to use the API.
To authenticate, send HTTP POST to https://ehr.escribe.com/ehr/api/users/login with data 'username' and 'password'.
After logging in, you will receive a cookie, JSESSIONID, that must be used to make further authenticated API calls.

Example

This example demonstrates logging in and looking up a patient's identifier using their name.
The user's username is YOURUSERNAME and password is YOURPASSWORD. The patient's name is John Doe.
The example uses curl.

Step 1: Login (store JSESSIONID in a file named 'cookiejar')
curl -c cookiejar 'https://ehr.escribe.com/ehr/api/users/login' -d 'username=YOURUSERNAME&password=YOURPASSWORD'
Step 2: Get patient ID (using JSESSIONID stored in a file named 'cookiejar')
curl -b cookiejar 'https://ehr.escribe.com/ehr/api/patientinfo/patient/id?firstName=john&lastName=doe'
The patient identifier is returned in the HTTP response:
12345678

API Functions

Patient Lookup

Patient Lookup
GET /patientinfo/patient/id Lookup Patient ID
GET /patientinfo/{patientId} Fetch patient by ID
GET /patientsummary Patient Search

Encounters

Patient Encounters
GET /{patientId}/ccds/api/list-encounters Encounter IDs
GET /{patientId}/ccds/api/encounter-ccds Specific encounter (CCDS)

CCDS

Patient CCDS documents
GET /{patientId}/ccds/api/all-patient-data All patient data (CCDS)
GET /{patientId}/ccds/api/patient-info Personal info (CCDS)
GET /{patientId}/ccds/api/smoking-status Smoking status (CCDS)
GET /{patientId}/ccds/api/problems Problems (CCDS)
GET /{patientId}/ccds/api/medications Medications (CCDS)
GET /{patientId}/ccds/api/medication-allergies Medication allergies (CCDS)
GET /{patientId}/ccds/api/laboratory-tests Laboratory tests (CCDS)
GET /{patientId}/ccds/api/laboratory-results Laboratory results (CCDS)
GET /{patientId}/ccds/api/vital-signs Vital signs (CCDS)
GET /{patientId}/ccds/api/procedures Procedures (CCDS)
GET /{patientId}/ccds/api/care-team-members Care team members (CCDS)
GET /{patientId}/ccds/api/immunizations Immunizations (CCDS)
GET /{patientId}/ccds/api/udi-for-implantable-device UDI(s) for implantable device (CCDS)
GET /{patientId}/ccds/api/assessment-and-plan-of-treatment Assessment and plan of treatment (CCDS)
GET /{patientId}/ccds/api/goals Goals (CCDS)
GET /{patientId}/ccds/api/health-concerns Health concerns (CCDS)