Patients (v3)
Minimum CorEMR Version: 6.4.0
Patients
This webservice allows clients to manage patient information inside the CorEMR system. It can be used to retrieve and edit patients, as well as all of their applicable fields and data.
Patient Endpoints
Action
REST Verb
Route
Description
Read
GET
/ws/v3/patients/Gets list of non-deleted patients current in the system.
Read
GET
/ws/v3/patients/{external_id}Get details on specific patient with given external_id
Create
POST
/ws/v3/patients/Create a new patient.
Update
POST
/ws/v3/patients/{external_id}Update an existing patient.
GET Return Fields
Return Field
Datatype Filter Note
external_id
String
Unique Patient Request identifier.
facility
String
String representation of patient facility. Note that this is different from the post facilty field, which requires the integer ID representation of the facility.
agency
Integer
Jail agency.
agency_id
String
Jail agency's string identifier.
fname
String
Patient first name.
mname
String
Patient middle name.
lname
String
Patient last name.
dob
DateTime
Patient's data of birth, formatted as YYYY-MM-DD 00:00:00.000
sex
String
Patient's sex assigned at birth.
allergies
String
List of known patient allergies.
ssn
String
Patient social security number.
race
String
Patient race.
ethnicity
String
Patient ethnicity.
height
integer
Patient height in inches.
weight
String
Patient weight in pounds.
eye_color
String
Patient eye color.
hair_color
String
Patient hair color.
address1
String
Patient's primary address.
address2
String
Patient's secondary address.
city
String
Patient's city correlating to address1
state
String
Patient's state correlating to address1
zipcode
String
Patient's zipcode correlating to address1
custom1 - custom9
String
Setup by client within CorEMR.
POST Fields
Field
Datatype Required
Default
Notes
external_id
String
Unique Patient Request identifier.
facility
Integer
Location where patient is to be admitted.
agency
Integer
O
Default Jurisdiction
Jail Agency
billing_agency
Integer
O
Default Billing
Agency used for billing when sent to pharmacy.
fname
String
Patient first name
lname
String
Patient last name
sex
String
Patient sex assigned at birth, 'M' or 'F'
dob
DateTime
Patient date of birth. Formatted in ISO8601 format.
booking_no
String
Patient booking number
booking_date
DateTime
Patient booking date. Formatted in ISO8601 format.
ssn
String
O
Patient Social Security Number
agency_id
String
O
ID at patient's jurisdictional agency.
billing_id
String
O
ID at patient's billing agency.
aka
String
O
Patient nickname
mname
String
O
Patient middle name
work_status
String
O
Patient work status
language
String
O
Patient primary language
race
String
O
address
String
O
Patient primary residence
photo_link
Filepath
O
Filepath to patient photo
eye_color
String
O
hair_color
String
O
body_build
String
O
skin_tone
String
O
citizenship
String
O
military_branch
String
O
education_level
String
O
religion
String
O
infirmary
Boolean
O
Flag indicating whether patient is in the infirmary, 1 for yes, 0 for no.
inf_level
Integer
O
Level of patient when in the infirmary
searchable
Boolean
O
Flag indicating whether patient is searchable, 1 for yes, 0 for no.
height
Integer
O
Height of patient in inches
weight
Integer
O
Weight of patient in pounds
phone
String
O
Primary phone of patient. Can include dashes if desired.
ethnicity
String
O
Hispanic or Non-Hispanic
address2
String
O
Secondary street address for patient
city
String
O
City of primary patient residence
state
String
O
State of primary patient residence
zipcode
String
O
Zipcode of primary patient residence
birth_country
String
O
Patient country of birth
mother_fname
String
O
Patient's Mother's first name
mother_mname
String
O
Patient's Mother's middle name
mother_lname
String
O
Patient's Mother's last name
mother_maiden
String
O
Patient's Mother's maiden name
current_location
String
O
Patient's current location
assigned_location
String
O
Patient's assigned location. Note that a separator value must be used and be unique and consistant through
Patient Bookings
Booking Endpoints
Action
REST Verb
Route
Description
Read
GET
/ws/v3/patients/{external_id}/bookings/Get list of patient bookings for specified patient.
Read
GET
/ws/v3/patients/{external_id}/bookings/{number}Get details on specified patient booking.
Create
POST
/ws/v3/patients/{external_id}/bookings/Create an assigned patient booking.
Update
POST
/ws/v3/patients/{external_id}/bookings/{number}Update an existing patient booking.
GET Return Fields
/ws/patients/{external_id}/bookings/
Return Field
Datatype Filter Note
facility
String
String representation of patient facility. Note that this is different from the post facilty field, which requires the integer ID representation of the facility.
number
String
Booking number.
date
String
Booking's creation date as a string, formatted as YYYY-MM-DD 00:00:00.000
active
Integer
Boolean stating whether the booking is currently active or not. 0 for false, 1 for true
release
String
Booking's end date as a string, formatted as YYYY-MM-DD 00:00:00.000
temporary
Integer
Boolean stating whether the booking is temporary or not. 0 for false, 1 for true
POST Fields
Field
Datatype Required
Default
Notes
booking_no
String
Unique patient booking identifier.
date
DateTime
Patient booking date. Formatted in ISO8601 format.
active
Boolean
O
FALSE
Flag indicating whether the booking is currently active, 1 for yes, 0 for no.
facility
String
O
Patient's facility
Facility the booking is set for.
temporary
Boolean
O
FALSE
Flag indicating whether the booking is temporary, 1 for yes, 0 for no.
facility_created
String
O
Facility or patient's facility
Facility the booking was created in.
facility_completed
String
O
Facility the booking was completed in.
release
DateTime
O
Patient booking release date. Formatted in ISO8601 format.
Photos
This webservice allows adding a new image to use on the patient's chart as their photo.
Photo Endpoints
Action
REST Verb
Route
Description
Add
POST
/ws/v3/patients/{external_id}/photos/Adds a new photo to use for the patient's current photo. Old photos are not retained.
POST Fields
Field
Datatype Add
Read
Notes
blob
String
Base64-encoded image in JPEG, PNG, or GIF format.
