REST API
v1.0.7
We provide an HTTP REST API to allow clients to manage patients, patient sessions and room/sensor/department data. All endpoints of this API can be called using the access token generated by the client ID-secret pair. Please see the Authentication guide to learn more about how to generate the access token.
get
http://localhost:20001
/api/v1/sensors/{referenceKey}
Find sensor by reference key
put
http://localhost:20001
/api/v1/sensors/{referenceKey}
Update sensor
delete
http://localhost:20001
/api/v1/sensors/{referenceKey}
Delete sensor by reference key
patch
http://localhost:20001
/api/v1/sensors/{referenceKey}
Update sensor with only changed fields. This is useful for updating the record without any credential change.
get
http://localhost:20001
/api/v1/rooms/{referenceKey}
Find room by reference key
put
http://localhost:20001
/api/v1/rooms/{referenceKey}
Update room
delete
http://localhost:20001
/api/v1/rooms/{referenceKey}
Delete room by reference key
get
http://localhost:20001
/api/v1/patients/{referenceKey}
Returns all patients in the hospital
put
http://localhost:20001
/api/v1/patients/{referenceKey}
Update patient
delete
http://localhost:20001
/api/v1/patients/{referenceKey}
Delete patient by reference key
get
http://localhost:20001
/api/v1/departments/{referenceKey}
Find department by reference key
put
http://localhost:20001
/api/v1/departments/{referenceKey}
Update department
delete
http://localhost:20001
/api/v1/departments/{referenceKey}
Delete department by reference key
get
http://localhost:20001
/api/v1/sensors
Find all sensors
post
http://localhost:20001
/api/v1/sensors
Create sensor
get
http://localhost:20001
/api/v1/rooms
Find all rooms
post
http://localhost:20001
/api/v1/rooms
Create room
get
http://localhost:20001
/api/v1/patients
Returns all patients in the hospital
post
http://localhost:20001
/api/v1/patients
Create patient
get
http://localhost:20001
/api/v1/patient-sessions
Find all active patient sessions
post
http://localhost:20001
/api/v1/patient-sessions
Creates/starts a patient session. This will also create related department, room, sensor & patient data if necessary.
get
http://localhost:20001
/api/v1/departments
Find all departments
post
http://localhost:20001
/api/v1/departments
Create department
patch
http://localhost:20001
/api/v1/patients/{referenceKey}/leave
Makes a patient leave the room
patch
http://localhost:20001
/api/v1/patients/{referenceKey}/discharge
Discharges a patient
patch
http://localhost:20001
/api/v1/patients/{patientReferenceKey}/transfer/{roomReferenceKey}
Transfers a patient to another room.
patch
http://localhost:20001
/api/v1/patients/{patientReferenceKey}/admit/{roomReferenceKey}
Admits a patient to a room.
patch
http://localhost:20001
/api/v1/patient-sessions/{sessionReferenceKey}/session-standby
Puts a patient's session on standby (No further patient-related data is processed when standby is active).
patch
http://localhost:20001
/api/v1/patient-sessions/{sessionReferenceKey}/session-resume
Resumes a patient's session.
get
http://localhost:20001
/api/v1/patient-sessions/{sessionReferenceKey}
Get an active patient session by its reference key
delete
http://localhost:20001
/api/v1/patient-sessions/{sessionReferenceKey}
Ends an ongoing patient session. This doesn't delete related department, room, sensor & patient data
get
http://localhost:20001
/api/v1/patient-sessions/patient/{patientReferenceKey}
Get an active patient session by its related patient reference key
patch
http://localhost:20001
/api/v1/notifications/{notificationReferenceKey}/unresolve
Reverts a resolved notification.
patch
http://localhost:20001
/api/v1/notifications/{notificationReferenceKey}/resolve
Resolves a notification.
Last modified 1mo ago