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

escribeHOST API Documentation

https://ehr.demo.escribe.com/ehr-qa/api

Authentication

Authentication is required to use the API.
To authenticate, send HTTP POST to https://ehr.demo.escribe.com/ehr-qa/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.demo.escribe.com/ehr-qa/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.demo.escribe.com/ehr-qa/api/patientinfo/patient/id?firstName=john&lastName=doe'
The patient identifier is returned in the HTTP response:
12345678

API Methods

Patient

Patient's identifier lookup
GET /patientinfo/patient/id Patient's identifier lookup

Patient API

Information about patient
GET /{patientId}/ccds/api/medications Patient's medications
GET /{patientId}/ccds/api/problems Patient's problems
GET /{patientId}/ccds/api/procedures Patient's procedures
GET /{patientId}/ccds/api/smoking-status Patient's smoking status
GET /{patientId}/ccds/api/laboratory-results Patient's laboratory results
GET /{patientId}/ccds/api/all-patient-data All patient's data
GET /{patientId}/ccds/api/goals Patient's goals
GET /{patientId}/ccds/api/laboratory-tests Patient's laboratory tests
GET /{patientId}/ccds/api/assessment-and-plan-of-treatment Patient's assessment and plan of treatment
GET /{patientId}/ccds/api/immunizations Patient's immunizations
GET /{patientId}/ccds/api/vital-signs Patient's vital signs
GET /{patientId}/ccds/api/udi-for-implantable-device Patient's unique device identifier(s) for implantable device
GET /{patientId}/ccds/api/medication-allergies Patient's medication allergies
GET /{patientId}/ccds/api/health-concerns Patient's health concerns
GET /{patientId}/ccds/api/patient-info Patient's personal information
GET /{patientId}/ccds/api/care-team-members Patient's care team members