The diagram below shows the relationships between the major data objects available within the PainChek API:
Object |
Description |
Links |
Comment |
---|---|---|---|
Patient |
A patient is a record of a person who gets assessed by PainChek. The term patient is used, although in reality, we could be referring to "patient", "resident" or "client". |
comment, assessment and admission records link back to the patient |
|
Admission |
Admissions allow the location of a patient to be recorded |
admissions belong to a patient |
|
Assessment |
An assessment is a recording a pain assessment performed for a patient. |
assessments belong to a patient and are linked to the device that the assessment was performed on. |
The API provides access to view the assessments created on devices running the PainChek app |
Comment |
A comment is a note recorded directly against a patient.NB: It's also possible to records notes for an assessment. |
comments belong to a patient and are linked to the device that the comment was created on. |
|
Site |
A site is a location/facility/institution that a patient can be located in (i.e. where they live or the hospital in which that they are being treated). |
sites belong to a license and get linked to a patient via an admission record |
The data model able shows the "site" object as "institution". "Institution" is a legacy term for sites, but both mean the same thing. |
Users |
Users are people (or systems) authorised to access the PainChek system. |
users belong to a license and (optionally) are linked to a site |
Users are omitted from the above diagram (for clarity) |
License |
A license grants access to the PainChek system |
patient, device and site records link back to the license |
This object is documented for informational purposes only - there is no ability to manage your license via the API |
Device |
Devices are the devices that the PainChek application runs on - i.e. the Android or iOS devices that are used the capture assessments and manage patients |
comment and assessment records link back to a device |
This object is documented for informational purposes only - there is typically little need to manage devices via the API |