API Reference

Revenue Tags

Retrieves a list of revenue tags registered with a provider

URL: <base_url>/providers/<provider_id>/revenue-tags

Method: GET

{ "success": true, "message": "Revenue tags were successfully retrieved", "data": [ { "id": 1, "uuid": "c64a28f4-643f-4bdd-9db0-a76a20bbe982", "created_at": "2022-03-01T21:43:52.766517Z", "is_deleted": false, "modified_at": "2022-03-01T21:43:52.766538Z", "display": "Other", "is_core": true, "created_by": 1, "organization": "951ce6e6-abf8-4cd1-9986-36505a512b7e" } ], "errors": null }

Subscription Types

Retrieves a list of types of billing subscriptions frequencies for healthcare services.

URL: <base_url>/providers/valueset/service-subscription-type

Method: GET

[ { "code": "Daily", "display": "Daily" }, { "code": "Weekly", "display": "Monthly" }, { "code": "Bi-weekly", "display": "Bi-weekly" }, { "code": "Monthly", "display": "Monthly" } ]

Device Types

Retrieves a list of diagnostic device types

URL: <base_url>/providers/valueset/device-types

Method: GET

Note: This API endpoint retrieves all 1000 device types at once

[ { "code": "SPINE_BOARD", "display": "Spine board" }, { "code": "BONE_PLATE", "display": "Bone plate" }, { "code": "AIR_RECEIVER", "display": "Air receiver" }, { "code": "ATOMIZER", "display": "Atomizer" }, ... 996 more items ]

Ward types

Retrieves a list of types of wards that can be operated at a provider.
Note: "Other" is associated to uncategorized wards

URL: <base_url>/providers/valueset/ward-type

Method: GET

[ { "code": "General", "display": "General" }, { "code": "Labor", "display": "Labor" }, { "code": "ICU", "display": "ICU" }, { "code": "NICU", "display": "NICU" }, { "code": "Other", "display": "Other" } ]

IPD Vitals Unit Types

URL: {{base_url}}/providers/valueset/ipd-vitals-unit-type
Method: GET

[ { "code": "RESPIRATORY_RATE", "display": "Respiratory rate", "type": "text", "scores": [ { "display": "Less than 9", "high": 9, "low": null, "value": 2 }, { "display": "9-14", "high": 14, "low": 9, "value": 0 }, { "display": "15-20", "high": 20, "low": 15, "value": 1 }, { "display": "21-29", "high": 29, "low": 21, "value": 2 }, { "display": "More than 29", "high": null, "low": 29, "value": 3 } ] }, { "code": "HEART_RATE", "display": "Heart rate", "type": "text", "scores": [ { "display": "Less than 41", "high": 41, "low": null, "value": 2 }, { "display": "41-50", "high": 50, "low": 41, "value": 1 }, { "display": "51-100", "high": 100, "low": 51, "value": 0 }, { "display": "101-110", "high": 110, "low": 101, "value": 1 }, { "display": "111-129", "high": 129, "low": 111, "value": 2 }, { "display": "More than 129", "high": null, "low": 129, "value": 3 } ] }, { "code": "BLOOD_PRESSURE", "display": "mmHg", "type": "text" }, { "code": "Temperature", "display": "°C", "type": "text", "scores": [ { "display": "Less than 35", "high": null, "low": 35, "value": 2 }, { "display": "35-38.4", "high": 38.4, "low": 35, "value": 0 }, { "display": "38.5 or more", "high": null, "low": 38.5, "value": 2 } ] }, { "code": "SBP", "display": "SBP", "type": "text", "scores": [ { "display": "Less than 71", "high": 71, "low": null, "value": 3 }, { "display": "71-80", "high": 80, "low": 71, "value": 2 }, { "display": "81-100", "high": 100, "low": 81, "value": 1 }, { "display": "101-199", "high": 199, "low": 101, "value": 0 }, { "display": "More than 199", "high": null, "low": 199, "value": 2 } ] }, { "code": "OXYGEN_SATURATION", "display": "SPO2", "type": "text" }, { "code": "BLOOD_SUGAR", "display": "Blood sugar", "type": "text" }, { "code": "WEIGHT_KG", "display": "kg", "type": "text" }, { "code": "HEIGHT_CM", "display": "cm", "type": "text" }, { "code": "BMI", "display": "kg/m2", "type": "text" }, { "code": "AVPU", "display": "A.V.P.U", "type": "select", "scores": [ { "display": "Alert", "value": 0 }, { "display": "Reacts to Voice", "value": 1 }, { "display": "Reacts to Pain", "value": 2 }, { "display": "Unresponsive", "value": 3 } ] }, { "code": "MOBILITY", "display": "Mobility status", "type": "select", "scores": [ { "display": "Walking", "value": 0 }, { "display": "With help", "value": 1 }, { "display": "Stretcher/immobile", "value": 2 } ] }, { "code": "TRAUMA", "display": "Trauma status", "type": "select", "scores": [ { "display": "No", "value": 0 }, { "display": "Yes", "value": 1 } ] }, { "code": "DISCRIMINATOR", "display": "Discriminator" } ]

Morse Fall Scale (Fall Risk Assessment)

URL: {{base_url}}/providers/valueset/morse-fall-scale
Method: GET

[ { "code": "HISTORY_OF_FALL", "display": "History of falling; immediate or within 3 months", "scores": [ { "display": "No", "value": 0 }, { "display": "Yes", "value": 25 } ] }, { "code": "SECONDARY_DIAGNOSIS", "display": "Secondary diagnosis (>= 2 medical diagnoses in chart)", "scores": [ { "display": "No", "value": 0 }, { "display": "Yes", "value": 15 } ] }, { "code": "AMBULATORY_AID", "display": "Ambulatory aid", "scores": [ { "display": "Bed rest/nurse assist", "value": 0 }, { "display": "Crutches/cane/walker", "value": 15 }, { "display": "Furniture", "value": 30 } ] }, { "code": "INTRAVENOUS_THERAPY", "display": "Intravenous Therapy/Heparin Lock", "scores": [ { "display": "No", "value": 0 }, { "display": "Yes", "value": 20 } ] }, { "code": "GAIT", "display": "Gait/Transferring", "scores": [ { "display": "Normal/bedrest/immobile", "value": 0 }, { "display": "Weak", "value": 10 }, { "display": "Impaired", "value": 20 } ] }, { "code": "MENTAL_STATUS", "display": " Mental status", "scores": [ { "display": "Oriented to own ability", "value": 0 }, { "display": "Forgets limitations", "value": 15 } ] } ]

TEWS triage configurations

URL: {{base_url}}/providers/valueset/tews
Method: GET

[ { "discriminator": "Target time to treat", "observations": [ { "observation": "Immediate", "TEWS": { "high": null, "low": 7 } }, { "observation": "Less than 10 min", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Less than 60 min", "TEWS": { "high": 4, "low": 3 } }, { "observation": "Less than 240 min", "TEWS": { "high": 2, "low": 0 } } ] }, { "discriminator": "Mechanism of injury", "observations": [ { "observation": "High energy transfer", "TEWS": { "high": 6, "low": 5 } } ] }, { "discriminator": "Presentation", "observations": [ { "observation": "Seizure - current", "TEWS": { "high": null, "low": 7 } }, { "observation": "Burn - face/ inhalation", "TEWS": { "high": null, "low": 7 } }, { "observation": "Hypoglycaemia - glucose less than 3", "TEWS": { "high": null, "low": 7 } }, { "observation": "Shortness of breath - acute", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Coughing blood", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Chest pain", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Haemorrhage - uncontrolled", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Seizure - post ictal", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Focal neurology - acute", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Level of consciousness reduced", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Psychosis/aggression", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Threatened limb", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Dislocation - other joint", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Fracture - compound", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Burn over 20%", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Burn - electrical", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Burn - circumferential", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Burn - chemical", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Poisoning/overdose", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Diabetic - glucose over 11 & ketonuria", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Vomiting - fresh blood", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Pregnancy and abdominal trauma or pain", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Haemorrhage - controlled", "TEWS": { "high": 4, "low": 3 } }, { "observation": "Dislocation - finger or toe", "TEWS": { "high": 4, "low": 3 } }, { "observation": "Fracture - closed", "TEWS": { "high": 4, "low": 3 } }, { "observation": "Burn - other", "TEWS": { "high": 4, "low": 3 } }, { "observation": "Abdominal pain", "TEWS": { "high": 4, "low": 3 } }, { "observation": "Diabetic - glucose over 17 (no ketonuria)", "TEWS": { "high": 4, "low": 3 } }, { "observation": "Vomiting - persistent", "TEWS": { "high": 4, "low": 3 } }, { "observation": "Pregnancy and PV bleed", "TEWS": { "high": 4, "low": 3 } }, { "observation": "All other patients", "TEWS": { "high": 2, "low": 0 } } ] }, { "discriminator": "Pain", "observations": [ { "observation": "Severe", "TEWS": { "high": 6, "low": 5 } }, { "observation": "Moderate", "TEWS": { "high": 4, "low": 3 } }, { "observation": "Mild", "TEWS": { "high": 2, "low": 0 } } ] } ]