Check-ins and Appointments

Server

List appointments

GET

https://accounts.multitenant.slade360.co.ke

/api/scheduling/appointments

Get objects from the DB/cache.

List appointments › query Parameters

appointment_status

string

Multiple values may be separated by commas.

appointment_type

string

CHECKUP - A routine check-up, such as an annual physical
EMERGENCY - Emergency appointment
FOLLOWUP - A follow up visit from a previous appointment
ROUTINE - Routine appointment
WALKIN - A previously unscheduled walk-in visit

branch_id

string

cancellation_reason

string

cluster_id

string

created

string

created_by

string

department_id

string

description

string

end

string

format

string

from_date

string

id

string

ordering

string

Which field to use when ordering the results.

organisation

string

page

string

A page number within the paginated result set.

page_size

string

Number of results to return per page.

patient

string

priority

string

ASAP - As soon as possible, next highest priority after emergency
EMERGENCY - An unforeseen combination of circumstances or the resulting state that calls for immediate action
PREOP - Indicates that a service is to be performed prior to a scheduled surgery. When ordering a service and using the pre-op priority, a check is done to see the amount of time that must be allowed for performance of the service.
ROUTINE - Routine service, do at usual work hours

reason

string

schedule_actor

string

Multiple values may be separated by commas.

schedule_id

string

Multiple values may be separated by commas.

search

string

A search term.

slot

string

start

string

to_date

string

updated

string

updated_by

string

workstation_id

string

List appointments › Responses

200

Untitled Response

count

string

object[]

next

string

previous

string

GET/api/scheduling/appointments

curl https://accounts.multitenant.slade360.co.ke/api/scheduling/appointments \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "results": [
    {
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "end": "<dateTime>",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "patient": "<uuid>",
      "patient_details": {
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "customer_id": "<uuid>",
        "file_number": "<integer>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "patient_id": "<string>",
        "person": {
          "age": {
            "esse85": "<integer>",
            "Lorem_d": "<integer>"
          },
          "consent": {
            "consent_type": "EMAIL_HEALTH_EDUCATION",
            "created": "<dateTime>",
            "created_by": "<uuid>",
            "created_by_name": "<string>",
            "id": "<uuid>",
            "organisation": "<uuid>",
            "person": "<uuid>",
            "updated": "<dateTime>",
            "updated_by": "<uuid>",
            "updated_by_name": "<string>",
            "verification_type": "HUMAN",
            "workstation_id": "<uuid>",
            "department_id": "<uuid>",
            "branch_id": "<uuid>",
            "cluster_id": "<uuid>",
            "active": "<boolean>",
            "status": "VERIFIED",
            "effective_from": "<dateTime>",
            "effective_to": "<dateTime>",
            "captured_by": "<uuid>",
            "otp": "<uuid>"
          },
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "email": "<string>",
          "first_name": "<string>",
          "global_health_id": "<string>",
          "id": "<uuid>",
          "id_document_type": "<string>",
          "id_value": "<string>",
          "last_name": "<string>",
          "organisation": "<uuid>",
          "person_display": "<string>",
          "person_ids": [
            {
              "created_by_name": "<string>",
              "id": "<uuid>",
              "id_document_type": "householdNumber",
              "id_value": "<string>",
              "updated_by_name": "<string>",
              "active": "<boolean>"
            },
            {
              "created_by_name": "<string>",
              "id": "<uuid>",
              "id_document_type": "militaryID",
              "id_value": "<string>",
              "updated_by_name": "<string>",
              "active": "<boolean>"
            }
          ],
          "phone_number": "<string>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "person_contacts": [
            {
              "contact_type": "email",
              "created": "<dateTime>",
              "created_by": "<uuid>",
              "created_by_name": "<string>",
              "id": "<uuid>",
              "organisation": "<uuid>",
              "updated": "<dateTime>",
              "updated_by": "<uuid>",
              "updated_by_name": "<string>",
              "workstation_id": "<uuid>",
              "department_id": "<uuid>",
              "branch_id": "<uuid>",
              "cluster_id": "<uuid>",
              "active": "<boolean>",
              "contact": "<string>",
              "verified": "<boolean>",
              "consent_to_contact_given": "<boolean>",
              "is_primary_contact": "<boolean>",
              "person": "<uuid>"
            },
            {
              "contact_type": "phone_number",
              "created": "<dateTime>",
              "created_by": "<uuid>",
              "created_by_name": "<string>",
              "id": "<uuid>",
              "organisation": "<uuid>",
              "updated": "<dateTime>",
              "updated_by": "<uuid>",
              "updated_by_name": "<string>",
              "workstation_id": "<uuid>",
              "department_id": "<uuid>",
              "branch_id": "<uuid>",
              "cluster_id": "<uuid>",
              "active": "<boolean>",
              "contact": "<string>",
              "verified": "<boolean>",
              "consent_to_contact_given": "<boolean>",
              "is_primary_contact": "<boolean>",
              "person": "<uuid>"
            }
          ],
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "other_names": "<string>",
          "date_of_birth": "<date>",
          "title": "<string>",
          "gender": "OTHER",
          "deceased": "<boolean>",
          "language": "fr",
          "metadata": {
            "nullable": true
          },
          "associated_region": "<uuid>"
        },
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "vitals_reference_ranges": {
          "culpa7d": [
            "<string>",
            "<string>"
          ],
          "occaecat_d": [
            "<string>",
            "<string>"
          ],
          "nostrud_454": [
            "<string>",
            "<string>"
          ]
        },
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>",
        "global_health_id": "<string>",
        "health_crm_sync_status": "FAILED",
        "clinical_id": "<uuid>",
        "source": "UPLOAD",
        "expected_delivery_date": "<date>"
      },
      "reason_display": "<string>",
      "sched_actor": "PRACTITIONER",
      "sched_description": "<string>",
      "sched_id": "<uuid>",
      "sched_specialty": "GENERAL SURGERY",
      "slot": "<uuid>",
      "start": "<dateTime>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "appointment_status": "PROPOSED",
      "appointment_type": "EMERGENCY",
      "reason": "<string>",
      "cancellation_reason": "<string>",
      "description": "<string>",
      "priority": "ASAP"
    },
    {
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "end": "<dateTime>",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "patient": "<uuid>",
      "patient_details": {
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "customer_id": "<uuid>",
        "file_number": "<integer>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "patient_id": "<string>",
        "person": {
          "age": {
            "officia_e": "<integer>",
            "nisi_8": "<integer>"
          },
          "consent": {
            "consent_type": "SMS_HEALTH_EDUCATION",
            "created": "<dateTime>",
            "created_by": "<uuid>",
            "created_by_name": "<string>",
            "id": "<uuid>",
            "organisation": "<uuid>",
            "person": "<uuid>",
            "updated": "<dateTime>",
            "updated_by": "<uuid>",
            "updated_by_name": "<string>",
            "verification_type": "HUMAN",
            "workstation_id": "<uuid>",
            "department_id": "<uuid>",
            "branch_id": "<uuid>",
            "cluster_id": "<uuid>",
            "active": "<boolean>",
            "status": "VERIFIED",
            "effective_from": "<dateTime>",
            "effective_to": "<dateTime>",
            "captured_by": "<uuid>",
            "otp": "<uuid>"
          },
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "email": "<string>",
          "first_name": "<string>",
          "global_health_id": "<string>",
          "id": "<uuid>",
          "id_document_type": "<string>",
          "id_value": "<string>",
          "last_name": "<string>",
          "organisation": "<uuid>",
          "person_display": "<string>",
          "person_ids": [
            {
              "created_by_name": "<string>",
              "id": "<uuid>",
              "id_document_type": "shaNumber",
              "id_value": "<string>",
              "updated_by_name": "<string>",
              "active": "<boolean>"
            },
            {
              "created_by_name": "<string>",
              "id": "<uuid>",
              "id_document_type": "householdNumber",
              "id_value": "<string>",
              "updated_by_name": "<string>",
              "active": "<boolean>"
            }
          ],
          "phone_number": "<string>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "person_contacts": [
            {
              "contact_type": "phone_number",
              "created": "<dateTime>",
              "created_by": "<uuid>",
              "created_by_name": "<string>",
              "id": "<uuid>",
              "organisation": "<uuid>",
              "updated": "<dateTime>",
              "updated_by": "<uuid>",
              "updated_by_name": "<string>",
              "workstation_id": "<uuid>",
              "department_id": "<uuid>",
              "branch_id": "<uuid>",
              "cluster_id": "<uuid>",
              "active": "<boolean>",
              "contact": "<string>",
              "verified": "<boolean>",
              "consent_to_contact_given": "<boolean>",
              "is_primary_contact": "<boolean>",
              "person": "<uuid>"
            },
            {
              "contact_type": "email",
              "created": "<dateTime>",
              "created_by": "<uuid>",
              "created_by_name": "<string>",
              "id": "<uuid>",
              "organisation": "<uuid>",
              "updated": "<dateTime>",
              "updated_by": "<uuid>",
              "updated_by_name": "<string>",
              "workstation_id": "<uuid>",
              "department_id": "<uuid>",
              "branch_id": "<uuid>",
              "cluster_id": "<uuid>",
              "active": "<boolean>",
              "contact": "<string>",
              "verified": "<boolean>",
              "consent_to_contact_given": "<boolean>",
              "is_primary_contact": "<boolean>",
              "person": "<uuid>"
            }
          ],
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "other_names": "<string>",
          "date_of_birth": "<date>",
          "title": "<string>",
          "gender": "OTHER",
          "deceased": "<boolean>",
          "language": "sw",
          "metadata": {
            "nullable": true
          },
          "associated_region": "<uuid>"
        },
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "vitals_reference_ranges": {
          "consequat_78_": [
            "<string>",
            "<string>"
          ],
          "eu_3d": [
            "<string>",
            "<string>"
          ],
          "dolorf3": [
            "<string>",
            "<string>"
          ]
        },
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>",
        "global_health_id": "<string>",
        "health_crm_sync_status": "PENDING",
        "clinical_id": "<uuid>",
        "source": "USSD_SELF_ENROLLMENT",
        "expected_delivery_date": "<date>"
      },
      "reason_display": "<string>",
      "sched_actor": "PRACTITIONER",
      "sched_description": "<string>",
      "sched_id": "<uuid>",
      "sched_specialty": "PUBLIC HEALTH",
      "slot": "<uuid>",
      "start": "<dateTime>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "appointment_status": "PROPOSED",
      "appointment_type": "EMERGENCY",
      "reason": "<string>",
      "cancellation_reason": "<string>",
      "description": "<string>",
      "priority": "PREOP"
    }
  ],
  "next": "<uri>",
  "previous": "<uri>"
}

json

application/json

Create appointment

POST

https://accounts.multitenant.slade360.co.ke

/api/scheduling/appointments

Create and persist single or multiple records.

Create appointment › Headers

X-Workstation

string

X-Cluster

string

X-Branch

string

X-Department

string

Create appointment › Request Body

patient

string

slot

string

start

string · date-time

end

string · date-time

Create appointment › Responses

Untitled Response

created

string

created_by

string

created_by_name

string

end

string

id

string

organisation

string

patient

string

object

array

reason_display

string

sched_actor

string

sched_description

string

sched_id

string

sched_specialty

string

slot

string

start

string

updated

string

updated_by

string

updated_by_name

string

workstation_id

string

department_id

string

branch_id

string

cluster_id

string

active

string

appointment_status

string

appointment_type

string

reason

string

cancellation_reason

string

description

string

priority

string

POST/api/scheduling/appointments

curl https://accounts.multitenant.slade360.co.ke/api/scheduling/appointments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "patient": "dfc2bda4-e1a0-44b5-a51b-efd27fd5780f",
  "slot": "e104bab2-a3c6-4956-8b0d-8259a138d0a0",
  "start": "2023-04-21T12:00:00+03:00",
  "end": "2023-04-21T12:10:00+03:00"
}'

Example Request Body

{
  "patient": "dfc2bda4-e1a0-44b5-a51b-efd27fd5780f",
  "slot": "e104bab2-a3c6-4956-8b0d-8259a138d0a0",
  "start": "2023-04-21T12:00:00+03:00",
  "end": "2023-04-21T12:10:00+03:00"
}

json

application/json

Example Responses

{
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "created_by_name": "<string>",
  "end": "<dateTime>",
  "id": "<uuid>",
  "organisation": "<uuid>",
  "patient": "<uuid>",
  "patient_details": {
    "created": "<dateTime>",
    "created_by": "<uuid>",
    "customer_id": "<uuid>",
    "file_number": "<integer>",
    "id": "<uuid>",
    "organisation": "<uuid>",
    "patient_id": "<string>",
    "person": {
      "age": {
        "ullamco_a": "<integer>"
      },
      "consent": {
        "consent_type": "SMS_COMMUNICATION",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "person": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "updated_by_name": "<string>",
        "verification_type": "USSD",
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>",
        "status": "REJECTED",
        "effective_from": "<dateTime>",
        "effective_to": "<dateTime>",
        "captured_by": "<uuid>",
        "otp": "<uuid>"
      },
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "email": "<string>",
      "first_name": "<string>",
      "global_health_id": "<string>",
      "id": "<uuid>",
      "id_document_type": "<string>",
      "id_value": "<string>",
      "last_name": "<string>",
      "organisation": "<uuid>",
      "person_display": "<string>",
      "person_ids": [
        {
          "created_by_name": "<string>",
          "id": "<uuid>",
          "id_document_type": "nationalID",
          "id_value": "<string>",
          "updated_by_name": "<string>",
          "active": "<boolean>"
        },
        {
          "created_by_name": "<string>",
          "id": "<uuid>",
          "id_document_type": "payerID",
          "id_value": "<string>",
          "updated_by_name": "<string>",
          "active": "<boolean>"
        }
      ],
      "phone_number": "<string>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "person_contacts": [
        {
          "contact_type": "email",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "created_by_name": "<string>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "updated_by_name": "<string>",
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "contact": "<string>",
          "verified": "<boolean>",
          "consent_to_contact_given": "<boolean>",
          "is_primary_contact": "<boolean>",
          "person": "<uuid>"
        },
        {
          "contact_type": "phone_number",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "created_by_name": "<string>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "updated_by_name": "<string>",
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "contact": "<string>",
          "verified": "<boolean>",
          "consent_to_contact_given": "<boolean>",
          "is_primary_contact": "<boolean>",
          "person": "<uuid>"
        }
      ],
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "other_names": "<string>",
      "date_of_birth": "<date>",
      "title": "<string>",
      "gender": "OTHER",
      "deceased": "<boolean>",
      "language": "fr",
      "metadata": {
        "nullable": true
      },
      "associated_region": "<uuid>"
    },
    "updated": "<dateTime>",
    "updated_by": "<uuid>",
    "vitals_reference_ranges": {
      "ullamcod5": [
        "<string>",
        "<string>"
      ],
      "animd_": [
        "<string>",
        "<string>"
      ],
      "magna6ed": [
        "<string>",
        "<string>"
      ],
      "dolor_d": [
        "<string>",
        "<string>"
      ]
    },
    "workstation_id": "<uuid>",
    "department_id": "<uuid>",
    "branch_id": "<uuid>",
    "cluster_id": "<uuid>",
    "active": "<boolean>",
    "global_health_id": "<string>",
    "health_crm_sync_status": "SUCCESS",
    "clinical_id": "<uuid>",
    "source": "USSD_SELF_ENROLLMENT",
    "expected_delivery_date": "<date>"
  },
  "pending_reminders": [],
  "reason_display": "<string>",
  "sched_actor": "PRACTITIONER",
  "sched_description": "<string>",
  "sched_id": "<uuid>",
  "sched_specialty": "DERMATOLOGY  INTERNAL MEDICINE",
  "slot": "<uuid>",
  "start": "<dateTime>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "updated_by_name": "<string>",
  "workstation_id": "<uuid>",
  "department_id": "<uuid>",
  "branch_id": "<uuid>",
  "cluster_id": "<uuid>",
  "active": "<boolean>",
  "appointment_status": "PENDING",
  "appointment_type": "FOLLOWUP",
  "reason": "<string>",
  "cancellation_reason": "<string>",
  "description": "<string>",
  "priority": "PREOP"
}

json

application/json

List scheduling slots

GET

https://accounts.multitenant.slade360.co.ke

/api/scheduling/slots

List available slots.

This is NOT a pure GET as it creates slots when the start & schedule_id filters are provided and no slots are available for that particular day.

List scheduling slots › query Parameters

branch_id

string

cluster_id

string

created

string

created_by

string

department_id

string

end

string

format

string

from_date

string

id

string

ordering

string

Which field to use when ordering the results.

organisation

string

page

string

A page number within the paginated result set.

page_size

string

Number of results to return per page.

schedule

string

schedule_id

string

Multiple values may be separated by commas.

search

string

A search term.

start

string

status

string

Multiple values may be separated by commas.

to_date

string

updated

string

updated_by

string

workstation_id

string

List scheduling slots › Responses

200

Untitled Response

count

string

object[]

next

string

previous

string

GET/api/scheduling/slots

curl https://accounts.multitenant.slade360.co.ke/api/scheduling/slots \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "results": [
    {
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "end": "<dateTime>",
      "id": "<uuid>",
      "is_available": "<boolean>",
      "is_busy": "<boolean>",
      "organisation": "<uuid>",
      "schedule": "<uuid>",
      "start": "<dateTime>",
      "status_display": "<string>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "status": "FREE"
    },
    {
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "end": "<dateTime>",
      "id": "<uuid>",
      "is_available": "<boolean>",
      "is_busy": "<boolean>",
      "organisation": "<uuid>",
      "schedule": "<uuid>",
      "start": "<dateTime>",
      "status_display": "<string>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "status": "BUSY_TENTATIVE"
    }
  ],
  "next": "<uri>",
  "previous": "<uri>"
}

json

application/json

Creste schedule slot

POST

https://accounts.multitenant.slade360.co.ke

/api/scheduling/slots

Create and persist single or multiple records.

Creste schedule slot › query Parameters

format

string

Creste schedule slot › Request Body

end

string

organisation

string

schedule

string

start

string

updated_by

string

workstation_id

string

department_id

string

branch_id

string

cluster_id

string

active

string

status

string

created

integer

created_by

number

created_by_name

integer

Creste schedule slot › Responses

Untitled Response

created

string

created_by

string

created_by_name

string

end

string

id

string

is_available

string

is_busy

string

organisation

string

schedule

string

start

string

status_display

string

updated

string

updated_by

string

updated_by_name

string

workstation_id

string

department_id

string

branch_id

string

cluster_id

string

active

string

status

string

POST/api/scheduling/slots

curl https://accounts.multitenant.slade360.co.ke/api/scheduling/slots \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'sessionid: <api-key>' \
  --data '{
  "end": "<dateTime>",
  "organisation": "<uuid>",
  "schedule": "<uuid>",
  "start": "<dateTime>",
  "updated_by": "<uuid>",
  "workstation_id": "<uuid>",
  "department_id": "<uuid>",
  "branch_id": "<uuid>",
  "cluster_id": "<uuid>",
  "active": "<boolean>",
  "status": "BUSY_TENTATIVE",
  "created": 60647010,
  "created_by": -15673717.309878036,
  "created_by_name": -83422286
}'

Example Request Body

{
  "end": "<dateTime>",
  "organisation": "<uuid>",
  "schedule": "<uuid>",
  "start": "<dateTime>",
  "updated_by": "<uuid>",
  "workstation_id": "<uuid>",
  "department_id": "<uuid>",
  "branch_id": "<uuid>",
  "cluster_id": "<uuid>",
  "active": "<boolean>",
  "status": "BUSY_TENTATIVE",
  "created": 60647010,
  "created_by": -15673717.309878036,
  "created_by_name": -83422286
}

json

application/json

Example Responses

{
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "created_by_name": "<string>",
  "end": "<dateTime>",
  "id": "<uuid>",
  "is_available": "<boolean>",
  "is_busy": "<boolean>",
  "organisation": "<uuid>",
  "schedule": "<uuid>",
  "start": "<dateTime>",
  "status_display": "<string>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "updated_by_name": "<string>",
  "workstation_id": "<uuid>",
  "department_id": "<uuid>",
  "branch_id": "<uuid>",
  "cluster_id": "<uuid>",
  "active": "<boolean>",
  "status": "BUSY_TENTATIVE"
}

json

application/json

List practitioners

GET

https://accounts.multitenant.slade360.co.ke

/api/practitioners/practitioners

Practitioner view.

List practitioners › query Parameters

branch_id

string

cluster_id

string

created

string

created_by

string

department_id

string

format

string

id

string

ordering

string

Which field to use when ordering the results.

organisation

string

page

string

A page number within the paginated result set.

page_size

string

Number of results to return per page.

person

string

qualification

string

OPHTHALMOLOGY - OPHTHALMOLOGY
INTERNAL MEDICINE - INTERNAL MEDICINE
CLINICAL PATHOLOGY - CLINICAL PATHOLOGY
CONSERVATIVE DENTISTRY - CONSERVATIVE DENTISTRY
GENERAL SURGERY PLASTIC SURGERY - GENERAL SURGERY PLASTIC SURGERY
MICROBIOLOGY - MICROBIOLOGY
ORAL PATHOLOGY - ORAL PATHOLOGY
GENERAL SURGERY PAEDIATRIC SURGERY - GENERAL SURGERY PAEDIATRIC SURGERY
OBSTETRICS AND GYNAECOLOGY ONCOLOGY/RADIOTHERAPY - OBSTETRICS AND GYNAECOLOGY ONCOLOGY/RADIOTHERAPY
ENDODONTICS - ENDODONTICS
RADIOLOGY - RADIOLOGY
NEPHROLOGY - NEPHROLOGY
EMERGENCY MEDICINE - EMERGENCY MEDICINE
EAR NOSE AND THROAT (ENT SURGERY) - EAR NOSE AND THROAT (ENT SURGERY)
PAEDIATRIC SURGERY - PAEDIATRIC SURGERY
ONCOLOGY - ONCOLOGY
PROSTHETIC DENTISTRY - PROSTHETIC DENTISTRY
OBSTETRICS AND GYNAECOLOGY - OBSTETRICS AND GYNAECOLOGY
PUBLIC HEALTH - PUBLIC HEALTH
OCCUPATIONAL MEDICINE - OCCUPATIONAL MEDICINE
GENERAL PATHOLOGY - GENERAL PATHOLOGY
NEUROSURGERY - NEUROSURGERY
DIABETOLOGY - DIABETOLOGY
CLINICAL MEDICAL GENETICS - CLINICAL MEDICAL GENETICS
GENERAL PRACTITIONER - GENERAL PRACTITIONER
NEUROLOGY - NEUROLOGY
PROSTHODONTICS - PROSTHODONTICS
DERMATOLOGY INTERNAL MEDICINE - DERMATOLOGY INTERNAL MEDICINE
ORTHOPAEDICS - ORTHOPAEDICS
BIOMATERIALS SCIENCE - BIOMATERIALS SCIENCE
ORTHOPAEDICS AND TRAUMA SURGERY - ORTHOPAEDICS AND TRAUMA SURGERY
RADIOTHERAPY - RADIOTHERAPY
PAEDIATRIC DENTISTRY - PAEDIATRIC DENTISTRY
INTERNAL MEDICINE ONCOLOGY/RADIOTHERAPY - INTERNAL MEDICINE ONCOLOGY/RADIOTHERAPY
ORTHODONTICS - ORTHODONTICS
RESTORATIVE DENTISTRY - RESTORATIVE DENTISTRY
GENERAL SURGERY - GENERAL SURGERY
ORAL AND MAXILLOFACIAL SURGERY - ORAL AND MAXILLOFACIAL SURGERY
DERMATOLOGY - DERMATOLOGY
PSYCHIATRY - PSYCHIATRY
GENERAL SURGERY ORTHOPAEDICS - GENERAL SURGERY ORTHOPAEDICS
DENTAL - DENTAL
ORTHOPAEDIC SURGERY - ORTHOPAEDIC SURGERY
DENTAL RADIOLOGY - DENTAL RADIOLOGY
PERIODONTOLOGY - PERIODONTOLOGY
FAMILY MEDICINE - FAMILY MEDICINE
PALLIATIVE MEDICINE - PALLIATIVE MEDICINE
PLASTIC SURGERY - PLASTIC SURGERY
PAEDIATRICS AND CHILD HEALTH - PAEDIATRICS AND CHILD HEALTH
ANAESTHESIA - ANAESTHESIA
CARDIOLOGIST - CARDIOLOGIST
UROLOGIST - UROLOGIST
PSYCHOLOGIST - PSYCHOLOGIST
PHYSIOTHERAPIST - PHYSIOTHERAPIST
FUNCTIONAL MEDICINE - FUNCTIONAL MEDICINE
CARDIOTHORACIC SURGEON - CARDIOTHORACIC SURGEON
HIV/AIDS SPECIALIST - HIV/AIDS SPECIALIST
FAMILY THERAPIST - FAMILY THERAPIST
PATHOLOGY - PATHOLOGY
NUTRITIONIST - NUTRITIONIST
PHYSICIAN - PHYSICIAN
MCH - Mother and Child Health
OTHER - OTHER

search

string

A search term.

updated

string

updated_by

string

workstation_id

string

List practitioners › Responses

200

Untitled Response

count

string

object[]

next

string

previous

string

GET/api/practitioners/practitioners

curl https://accounts.multitenant.slade360.co.ke/api/practitioners/practitioners \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "results": [
    {
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "person": {
        "age": {
          "nulla_758": "<integer>",
          "occaecatf7b": "<integer>",
          "laboris_4a": "<integer>"
        },
        "consent": {
          "consent_type": "SMS_COMMUNICATION",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "created_by_name": "<string>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "person": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "updated_by_name": "<string>",
          "verification_type": "USSD",
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "status": "VERIFIED",
          "effective_from": "<dateTime>",
          "effective_to": "<dateTime>",
          "captured_by": "<uuid>",
          "otp": "<uuid>"
        },
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "email": "<string>",
        "first_name": "<string>",
        "global_health_id": "<string>",
        "id": "<uuid>",
        "id_document_type": "<string>",
        "id_value": "<string>",
        "last_name": "<string>",
        "organisation": "<uuid>",
        "person_display": "<string>",
        "person_ids": [
          {
            "created_by_name": "<string>",
            "id": "<uuid>",
            "id_document_type": "householdNumber",
            "id_value": "<string>",
            "updated_by_name": "<string>",
            "active": "<boolean>"
          },
          {
            "created_by_name": "<string>",
            "id": "<uuid>",
            "id_document_type": "nationalID",
            "id_value": "<string>",
            "updated_by_name": "<string>",
            "active": "<boolean>"
          }
        ],
        "phone_number": "<string>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "person_contacts": [
          {
            "contact_type": "phone_number",
            "created": "<dateTime>",
            "created_by": "<uuid>",
            "created_by_name": "<string>",
            "id": "<uuid>",
            "organisation": "<uuid>",
            "updated": "<dateTime>",
            "updated_by": "<uuid>",
            "updated_by_name": "<string>",
            "workstation_id": "<uuid>",
            "department_id": "<uuid>",
            "branch_id": "<uuid>",
            "cluster_id": "<uuid>",
            "active": "<boolean>",
            "contact": "<string>",
            "verified": "<boolean>",
            "consent_to_contact_given": "<boolean>",
            "is_primary_contact": "<boolean>",
            "person": "<uuid>"
          },
          {
            "contact_type": "email",
            "created": "<dateTime>",
            "created_by": "<uuid>",
            "created_by_name": "<string>",
            "id": "<uuid>",
            "organisation": "<uuid>",
            "updated": "<dateTime>",
            "updated_by": "<uuid>",
            "updated_by_name": "<string>",
            "workstation_id": "<uuid>",
            "department_id": "<uuid>",
            "branch_id": "<uuid>",
            "cluster_id": "<uuid>",
            "active": "<boolean>",
            "contact": "<string>",
            "verified": "<boolean>",
            "consent_to_contact_given": "<boolean>",
            "is_primary_contact": "<boolean>",
            "person": "<uuid>"
          }
        ],
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>",
        "other_names": "<string>",
        "date_of_birth": "<date>",
        "title": "<string>",
        "gender": "MALE",
        "deceased": "<boolean>",
        "language": "en",
        "metadata": {
          "nullable": true
        },
        "associated_region": "<uuid>"
      },
      "qualification": "CLINICAL PATHOLOGY",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>"
    },
    {
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "person": {
        "age": {
          "mollite": "<integer>",
          "nulla_30": "<integer>"
        },
        "consent": {
          "consent_type": "SMS_HEALTH_EDUCATION",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "created_by_name": "<string>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "person": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "updated_by_name": "<string>",
          "verification_type": "HUMAN",
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "status": "VERIFIED",
          "effective_from": "<dateTime>",
          "effective_to": "<dateTime>",
          "captured_by": "<uuid>",
          "otp": "<uuid>"
        },
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "email": "<string>",
        "first_name": "<string>",
        "global_health_id": "<string>",
        "id": "<uuid>",
        "id_document_type": "<string>",
        "id_value": "<string>",
        "last_name": "<string>",
        "organisation": "<uuid>",
        "person_display": "<string>",
        "person_ids": [
          {
            "created_by_name": "<string>",
            "id": "<uuid>",
            "id_document_type": "passportID",
            "id_value": "<string>",
            "updated_by_name": "<string>",
            "active": "<boolean>"
          },
          {
            "created_by_name": "<string>",
            "id": "<uuid>",
            "id_document_type": "alienID",
            "id_value": "<string>",
            "updated_by_name": "<string>",
            "active": "<boolean>"
          }
        ],
        "phone_number": "<string>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "person_contacts": [
          {
            "contact_type": "email",
            "created": "<dateTime>",
            "created_by": "<uuid>",
            "created_by_name": "<string>",
            "id": "<uuid>",
            "organisation": "<uuid>",
            "updated": "<dateTime>",
            "updated_by": "<uuid>",
            "updated_by_name": "<string>",
            "workstation_id": "<uuid>",
            "department_id": "<uuid>",
            "branch_id": "<uuid>",
            "cluster_id": "<uuid>",
            "active": "<boolean>",
            "contact": "<string>",
            "verified": "<boolean>",
            "consent_to_contact_given": "<boolean>",
            "is_primary_contact": "<boolean>",
            "person": "<uuid>"
          },
          {
            "contact_type": "phone_number",
            "created": "<dateTime>",
            "created_by": "<uuid>",
            "created_by_name": "<string>",
            "id": "<uuid>",
            "organisation": "<uuid>",
            "updated": "<dateTime>",
            "updated_by": "<uuid>",
            "updated_by_name": "<string>",
            "workstation_id": "<uuid>",
            "department_id": "<uuid>",
            "branch_id": "<uuid>",
            "cluster_id": "<uuid>",
            "active": "<boolean>",
            "contact": "<string>",
            "verified": "<boolean>",
            "consent_to_contact_given": "<boolean>",
            "is_primary_contact": "<boolean>",
            "person": "<uuid>"
          }
        ],
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>",
        "other_names": "<string>",
        "date_of_birth": "<date>",
        "title": "<string>",
        "gender": "FEMALE",
        "deceased": "<boolean>",
        "language": "sw",
        "metadata": {
          "nullable": true
        },
        "associated_region": "<uuid>"
      },
      "qualification": "OPHTHALMOLOGY",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>"
    }
  ],
  "next": "<uri>",
  "previous": "<uri>"
}

json

application/json

Create practitioner

POST

https://accounts.multitenant.slade360.co.ke

/api/practitioners/practitioners

Create and persist single or multiple records.

Create practitioner › Headers

X-Workstation

string

X-Cluster

string

X-department

string

X-Branch

string

Create practitioner › Request Body

object

title

string

qualification

string

Create practitioner › Responses

Untitled Response

created

string

created_by

string

id

string

organisation

string

object

qualification

string

updated

string

updated_by

string

workstation_id

string

department_id

string

branch_id

string

cluster_id

string

active

string

POST/api/practitioners/practitioners

curl https://accounts.multitenant.slade360.co.ke/api/practitioners/practitioners \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "person": {
    "person_contacts": [
      {
        "contact_type": "phone_number",
        "contact": "+254789056789"
      }
    ],
    "title": "Mr",
    "first_name": "Clifford",
    "other_names": "",
    "last_name": "Obonyo",
    "person_ids": [],
    "person_photos": []
  },
  "title": "Mr",
  "qualification": "ONCOLOGY"
}'

Example Request Body

{
  "person": {
    "person_contacts": [
      {
        "contact_type": "phone_number",
        "contact": "+254789056789"
      }
    ],
    "title": "Mr",
    "first_name": "Clifford",
    "other_names": "",
    "last_name": "Obonyo",
    "person_ids": [],
    "person_photos": []
  },
  "title": "Mr",
  "qualification": "ONCOLOGY"
}

json

application/json

Example Responses

{
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "id": "<uuid>",
  "organisation": "<uuid>",
  "person": {
    "age": {
      "labore_bc1": "<integer>",
      "labore_0f": "<integer>"
    },
    "consent": {
      "consent_type": "SMS_COMMUNICATION",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "person": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "verification_type": "USSD",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "status": "VERIFIED",
      "effective_from": "<dateTime>",
      "effective_to": "<dateTime>",
      "captured_by": "<uuid>",
      "otp": "<uuid>"
    },
    "created": "<dateTime>",
    "created_by": "<uuid>",
    "email": "<string>",
    "first_name": "<string>",
    "global_health_id": "<string>",
    "id": "<uuid>",
    "id_document_type": "<string>",
    "id_value": "<string>",
    "last_name": "<string>",
    "organisation": "<uuid>",
    "person_display": "<string>",
    "person_ids": [
      {
        "created_by_name": "<string>",
        "id": "<uuid>",
        "id_document_type": "householdNumber",
        "id_value": "<string>",
        "updated_by_name": "<string>",
        "active": "<boolean>"
      },
      {
        "created_by_name": "<string>",
        "id": "<uuid>",
        "id_document_type": "alienID",
        "id_value": "<string>",
        "updated_by_name": "<string>",
        "active": "<boolean>"
      }
    ],
    "phone_number": "<string>",
    "updated": "<dateTime>",
    "updated_by": "<uuid>",
    "person_contacts": [
      {
        "contact_type": "email",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "updated_by_name": "<string>",
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>",
        "contact": "<string>",
        "verified": "<boolean>",
        "consent_to_contact_given": "<boolean>",
        "is_primary_contact": "<boolean>",
        "person": "<uuid>"
      },
      {
        "contact_type": "phone_number",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "updated_by_name": "<string>",
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>",
        "contact": "<string>",
        "verified": "<boolean>",
        "consent_to_contact_given": "<boolean>",
        "is_primary_contact": "<boolean>",
        "person": "<uuid>"
      }
    ],
    "workstation_id": "<uuid>",
    "department_id": "<uuid>",
    "branch_id": "<uuid>",
    "cluster_id": "<uuid>",
    "active": "<boolean>",
    "other_names": "<string>",
    "date_of_birth": "<date>",
    "title": "<string>",
    "gender": "MALE",
    "deceased": "<boolean>",
    "language": "en",
    "metadata": {
      "nullable": true
    },
    "associated_region": "<uuid>"
  },
  "qualification": "PSYCHOLOGIST",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "workstation_id": "<uuid>",
  "department_id": "<uuid>",
  "branch_id": "<uuid>",
  "cluster_id": "<uuid>",
  "active": "<boolean>"
}

json

application/json

List clinics

GET

https://accounts.multitenant.slade360.co.ke

/api/scheduling/schedules

Get objects from the DB/cache.

List clinics › query Parameters

actor

string

Multiple values may be separated by commas.

branch_id

string

cluster_id

string

created

string

created_by

string

department_id

string

description

string

format

string

id

string

ordering

string

Which field to use when ordering the results.

organisation

string

page

string

A page number within the paginated result set.

page_size

string

Number of results to return per page.

practitioner

string

search

string

A search term.

slot_duration

string

specialty

string

Multiple values may be separated by commas.

updated

string

updated_by

string

workstation_id

string

List clinics › Responses

200

Untitled Response

count

string

object[]

next

string

previous

string

GET/api/scheduling/schedules

curl https://accounts.multitenant.slade360.co.ke/api/scheduling/schedules \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "results": [
    {
      "availability": {
        "irure_22b": [
          {
            "nostrud9": "<time>"
          },
          {
            "aliqua_3": "<time>",
            "nisi9": "<time>"
          }
        ],
        "Excepteur_3": [
          {
            "quis0d": "<time>",
            "Excepteur6": "<time>"
          },
          {
            "in1_9": "<time>"
          }
        ]
      },
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "practitioner_data": {
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "person": {
          "age": {
            "Ut_4d": "<integer>",
            "sedc": "<integer>",
            "quis2a": "<integer>"
          },
          "consent": {
            "consent_type": "EMAIL_HEALTH_EDUCATION",
            "created": "<dateTime>",
            "created_by": "<uuid>",
            "created_by_name": "<string>",
            "id": "<uuid>",
            "organisation": "<uuid>",
            "person": "<uuid>",
            "updated": "<dateTime>",
            "updated_by": "<uuid>",
            "updated_by_name": "<string>",
            "verification_type": "HUMAN",
            "workstation_id": "<uuid>",
            "department_id": "<uuid>",
            "branch_id": "<uuid>",
            "cluster_id": "<uuid>",
            "active": "<boolean>",
            "status": "REJECTED",
            "effective_from": "<dateTime>",
            "effective_to": "<dateTime>",
            "captured_by": "<uuid>",
            "otp": "<uuid>"
          },
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "email": "<string>",
          "first_name": "<string>",
          "global_health_id": "<string>",
          "id": "<uuid>",
          "id_document_type": "<string>",
          "id_value": "<string>",
          "last_name": "<string>",
          "organisation": "<uuid>",
          "person_display": "<string>",
          "person_ids": [
            {
              "created_by_name": "<string>",
              "id": "<uuid>",
              "id_document_type": "householdNumber",
              "id_value": "<string>",
              "updated_by_name": "<string>",
              "active": "<boolean>"
            },
            {
              "created_by_name": "<string>",
              "id": "<uuid>",
              "id_document_type": "alienID",
              "id_value": "<string>",
              "updated_by_name": "<string>",
              "active": "<boolean>"
            }
          ],
          "phone_number": "<string>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "person_contacts": [
            {
              "contact_type": "phone_number",
              "created": "<dateTime>",
              "created_by": "<uuid>",
              "created_by_name": "<string>",
              "id": "<uuid>",
              "organisation": "<uuid>",
              "updated": "<dateTime>",
              "updated_by": "<uuid>",
              "updated_by_name": "<string>",
              "workstation_id": "<uuid>",
              "department_id": "<uuid>",
              "branch_id": "<uuid>",
              "cluster_id": "<uuid>",
              "active": "<boolean>",
              "contact": "<string>",
              "verified": "<boolean>",
              "consent_to_contact_given": "<boolean>",
              "is_primary_contact": "<boolean>",
              "person": "<uuid>"
            },
            {
              "contact_type": "email",
              "created": "<dateTime>",
              "created_by": "<uuid>",
              "created_by_name": "<string>",
              "id": "<uuid>",
              "organisation": "<uuid>",
              "updated": "<dateTime>",
              "updated_by": "<uuid>",
              "updated_by_name": "<string>",
              "workstation_id": "<uuid>",
              "department_id": "<uuid>",
              "branch_id": "<uuid>",
              "cluster_id": "<uuid>",
              "active": "<boolean>",
              "contact": "<string>",
              "verified": "<boolean>",
              "consent_to_contact_given": "<boolean>",
              "is_primary_contact": "<boolean>",
              "person": "<uuid>"
            }
          ],
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "other_names": "<string>",
          "date_of_birth": "<date>",
          "title": "<string>",
          "gender": "FEMALE",
          "deceased": "<boolean>",
          "language": "en",
          "metadata": {
            "nullable": true
          },
          "associated_region": "<uuid>"
        },
        "qualification": "OCCUPATIONAL MEDICINE",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>"
      },
      "queue": "<uuid>",
      "slot_duration": "<integer>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "actor": "HEALTHCARE_SERVICE",
      "specialty": "NEPHROLOGY",
      "description": "<string>",
      "practitioner": "<uuid>"
    },
    {
      "availability": {
        "exercitation092": [
          {
            "nisi_2": "<time>"
          },
          {
            "Ut80d": "<time>",
            "in_da0": "<time>"
          }
        ],
        "amet339": [
          {
            "laboref": "<time>",
            "ex_4ef": "<time>"
          },
          {
            "nullaa": "<time>",
            "voluptate5": "<time>",
            "aliqua_1": "<time>",
            "Ut77": "<time>"
          }
        ]
      },
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "practitioner_data": {
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "person": {
          "age": {
            "fugiat7": "<integer>",
            "anim_cd9": "<integer>",
            "laborisea6": "<integer>",
            "fugiat_06": "<integer>",
            "in_db1": "<integer>"
          },
          "consent": {
            "consent_type": "SMS_COMMUNICATION",
            "created": "<dateTime>",
            "created_by": "<uuid>",
            "created_by_name": "<string>",
            "id": "<uuid>",
            "organisation": "<uuid>",
            "person": "<uuid>",
            "updated": "<dateTime>",
            "updated_by": "<uuid>",
            "updated_by_name": "<string>",
            "verification_type": "OTP",
            "workstation_id": "<uuid>",
            "department_id": "<uuid>",
            "branch_id": "<uuid>",
            "cluster_id": "<uuid>",
            "active": "<boolean>",
            "status": "REJECTED",
            "effective_from": "<dateTime>",
            "effective_to": "<dateTime>",
            "captured_by": "<uuid>",
            "otp": "<uuid>"
          },
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "email": "<string>",
          "first_name": "<string>",
          "global_health_id": "<string>",
          "id": "<uuid>",
          "id_document_type": "<string>",
          "id_value": "<string>",
          "last_name": "<string>",
          "organisation": "<uuid>",
          "person_display": "<string>",
          "person_ids": [
            {
              "created_by_name": "<string>",
              "id": "<uuid>",
              "id_document_type": "passportID",
              "id_value": "<string>",
              "updated_by_name": "<string>",
              "active": "<boolean>"
            },
            {
              "created_by_name": "<string>",
              "id": "<uuid>",
              "id_document_type": "shaNumber",
              "id_value": "<string>",
              "updated_by_name": "<string>",
              "active": "<boolean>"
            }
          ],
          "phone_number": "<string>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "person_contacts": [
            {
              "contact_type": "email",
              "created": "<dateTime>",
              "created_by": "<uuid>",
              "created_by_name": "<string>",
              "id": "<uuid>",
              "organisation": "<uuid>",
              "updated": "<dateTime>",
              "updated_by": "<uuid>",
              "updated_by_name": "<string>",
              "workstation_id": "<uuid>",
              "department_id": "<uuid>",
              "branch_id": "<uuid>",
              "cluster_id": "<uuid>",
              "active": "<boolean>",
              "contact": "<string>",
              "verified": "<boolean>",
              "consent_to_contact_given": "<boolean>",
              "is_primary_contact": "<boolean>",
              "person": "<uuid>"
            },
            {
              "contact_type": "phone_number",
              "created": "<dateTime>",
              "created_by": "<uuid>",
              "created_by_name": "<string>",
              "id": "<uuid>",
              "organisation": "<uuid>",
              "updated": "<dateTime>",
              "updated_by": "<uuid>",
              "updated_by_name": "<string>",
              "workstation_id": "<uuid>",
              "department_id": "<uuid>",
              "branch_id": "<uuid>",
              "cluster_id": "<uuid>",
              "active": "<boolean>",
              "contact": "<string>",
              "verified": "<boolean>",
              "consent_to_contact_given": "<boolean>",
              "is_primary_contact": "<boolean>",
              "person": "<uuid>"
            }
          ],
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "other_names": "<string>",
          "date_of_birth": "<date>",
          "title": "<string>",
          "gender": "OTHER",
          "deceased": "<boolean>",
          "language": "en",
          "metadata": {
            "nullable": true
          },
          "associated_region": "<uuid>"
        },
        "qualification": "NEUROSURGERY",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>"
      },
      "queue": "<uuid>",
      "slot_duration": "<integer>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "actor": "PRACTITIONER",
      "specialty": "GENERAL PRACTITIONER",
      "description": "<string>",
      "practitioner": "<uuid>"
    }
  ],
  "next": "<uri>",
  "previous": "<uri>"
}

json

application/json

Create clinic

POST

https://accounts.multitenant.slade360.co.ke

/api/scheduling/schedules

Create a new schedule.

Payload format: { "description": "Dr. Jane Doe", "specialty": "GENERAL PRACTITIONER", "slot_duration": 30, "availability": { '0': [{"start": "08:00", "end": "17:00"}], # 0 is Monday '1': [{"start": "14:00", "end": "17:00"}], '2': [{"start": "08:00", "end": "17:00"}], '3': [ {"start": "08:00", "end": "12:00"}, {"start": "14:00", "end": "17:00"} ], '5': [], '6': [{"start": "10:00", "end": "12:00"}], } }

Create clinic › Headers

X-Workstation

string

X-Cluster

string

X-Branch

string

X-Department

string

Create clinic › Request Body

slot_duration

string · utc-millisec

object

description

string

specialty

string

practitioner

string

actor

string

Create clinic › Responses

Untitled Response

object

created

string

created_by

string

created_by_name

string

id

string

organisation

string

object

queue

string

slot_duration

string

updated

string

updated_by

string

updated_by_name

string

workstation_id

string

department_id

string

branch_id

string

cluster_id

string

active

string

actor

string

specialty

string

description

string

practitioner

string

POST/api/scheduling/schedules

curl https://accounts.multitenant.slade360.co.ke/api/scheduling/schedules \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "slot_duration": "15",
  "availability": {
    "0": [
      {
        "start": "09:00",
        "end": "17:00"
      }
    ],
    "1": [],
    "2": [],
    "3": [
      {
        "start": "09:00",
        "end": "17:00"
      }
    ],
    "4": [
      {
        "start": "09:00",
        "end": "17:00"
      }
    ],
    "5": [
      {
        "start": "09:00",
        "end": "17:00"
      }
    ],
    "6": [
      {
        "start": "09:00",
        "end": "17:00"
      }
    ]
  },
  "description": "Mr Cliff Obonyo",
  "specialty": "ONCOLOGY",
  "practitioner": "ee4f076c-1dcd-4b47-9def-ac95408cca52",
  "actor": "PRACTITIONER"
}'

Example Request Body

{
  "slot_duration": "15",
  "availability": {
    "0": [
      {
        "start": "09:00",
        "end": "17:00"
      }
    ],
    "1": [],
    "2": [],
    "3": [
      {
        "start": "09:00",
        "end": "17:00"
      }
    ],
    "4": [
      {
        "start": "09:00",
        "end": "17:00"
      }
    ],
    "5": [
      {
        "start": "09:00",
        "end": "17:00"
      }
    ],
    "6": [
      {
        "start": "09:00",
        "end": "17:00"
      }
    ]
  },
  "description": "Mr Cliff Obonyo",
  "specialty": "ONCOLOGY",
  "practitioner": "ee4f076c-1dcd-4b47-9def-ac95408cca52",
  "actor": "PRACTITIONER"
}

json

application/json

Example Responses

{
  "availability": {
    "do_1b": [
      {
        "cupidatat3f8": "<time>",
        "mollit_22": "<time>"
      },
      {
        "et_104": "<time>",
        "aliqua7f": "<time>"
      }
    ],
    "fugiate4": [
      {
        "cupidatatc_": "<time>",
        "aliqua613": "<time>"
      },
      {
        "et_c5": "<time>"
      }
    ],
    "proident0": [
      {
        "eiusmod_aa3": "<time>",
        "proident33e": "<time>",
        "sit7": "<time>"
      },
      {
        "veniam_053": "<time>"
      }
    ]
  },
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "created_by_name": "<string>",
  "id": "<uuid>",
  "organisation": "<uuid>",
  "practitioner_data": {
    "created": "<dateTime>",
    "created_by": "<uuid>",
    "id": "<uuid>",
    "organisation": "<uuid>",
    "person": {
      "age": {
        "laboris__": "<integer>"
      },
      "consent": {
        "consent_type": "SMS_HEALTH_EDUCATION",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "person": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "updated_by_name": "<string>",
        "verification_type": "OTP",
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>",
        "status": "VERIFIED",
        "effective_from": "<dateTime>",
        "effective_to": "<dateTime>",
        "captured_by": "<uuid>",
        "otp": "<uuid>"
      },
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "email": "<string>",
      "first_name": "<string>",
      "global_health_id": "<string>",
      "id": "<uuid>",
      "id_document_type": "<string>",
      "id_value": "<string>",
      "last_name": "<string>",
      "organisation": "<uuid>",
      "person_display": "<string>",
      "person_ids": [
        {
          "created_by_name": "<string>",
          "id": "<uuid>",
          "id_document_type": "passportID",
          "id_value": "<string>",
          "updated_by_name": "<string>",
          "active": "<boolean>"
        },
        {
          "created_by_name": "<string>",
          "id": "<uuid>",
          "id_document_type": "kraPIN",
          "id_value": "<string>",
          "updated_by_name": "<string>",
          "active": "<boolean>"
        }
      ],
      "phone_number": "<string>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "person_contacts": [
        {
          "contact_type": "phone_number",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "created_by_name": "<string>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "updated_by_name": "<string>",
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "contact": "<string>",
          "verified": "<boolean>",
          "consent_to_contact_given": "<boolean>",
          "is_primary_contact": "<boolean>",
          "person": "<uuid>"
        },
        {
          "contact_type": "phone_number",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "created_by_name": "<string>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "updated_by_name": "<string>",
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "contact": "<string>",
          "verified": "<boolean>",
          "consent_to_contact_given": "<boolean>",
          "is_primary_contact": "<boolean>",
          "person": "<uuid>"
        }
      ],
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "other_names": "<string>",
      "date_of_birth": "<date>",
      "title": "<string>",
      "gender": "MALE",
      "deceased": "<boolean>",
      "language": "en",
      "metadata": {
        "nullable": true
      },
      "associated_region": "<uuid>"
    },
    "qualification": "CLINICAL MEDICAL GENETICS",
    "updated": "<dateTime>",
    "updated_by": "<uuid>",
    "workstation_id": "<uuid>",
    "department_id": "<uuid>",
    "branch_id": "<uuid>",
    "cluster_id": "<uuid>",
    "active": "<boolean>"
  },
  "queue": "<uuid>",
  "slot_duration": "<integer>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "updated_by_name": "<string>",
  "workstation_id": "<uuid>",
  "department_id": "<uuid>",
  "branch_id": "<uuid>",
  "cluster_id": "<uuid>",
  "active": "<boolean>",
  "actor": "HEALTHCARE_SERVICE",
  "specialty": "ORAL PATHOLOGY",
  "description": "<string>",
  "practitioner": "<uuid>"
}

json

application/json

List queues

GET

https://accounts.multitenant.slade360.co.ke

/api/visits/queues

Get objects from the DB/cache.

List queues › query Parameters

branch_id

string

cluster_id

string

created

string

created_by

string

department_id

string

format

string

id

string

name

string

ordering

string

Which field to use when ordering the results.

organisation

string

page

string

A page number within the paginated result set.

page_size

string

Number of results to return per page.

practitioner

string

queue_type

string

Multiple values may be separated by commas.

schedule

string

schedule_actor

string

Multiple values may be separated by commas.

search

string

A search term.

updated

string

updated_by

string

workstation_id

string

List queues › Responses

200

Untitled Response

count

string

object[]

next

string

previous

string

GET/api/visits/queues

curl https://accounts.multitenant.slade360.co.ke/api/visits/queues \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "results": [
    {
      "active_visits": [
        "<uuid>",
        "<uuid>"
      ],
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "id": "<uuid>",
      "name": "<string>",
      "organisation": "<uuid>",
      "queue_type": "TRIAGE",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "practitioner": "<uuid>",
      "schedule": "<uuid>"
    },
    {
      "active_visits": [
        "<uuid>",
        "<uuid>"
      ],
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "id": "<uuid>",
      "name": "<string>",
      "organisation": "<uuid>",
      "queue_type": "OPTICAL",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "practitioner": "<uuid>",
      "schedule": "<uuid>"
    }
  ],
  "next": "<uri>",
  "previous": "<uri>"
}

json

application/json

Update queue status

PATCH

https://accounts.multitenant.slade360.co.ke

/api/visits/queues/{id}

Viewset for Queues.

Update queue status › path Parameters

id

string · required

(Required) A UUID string identifying this queue.

Update queue status › Headers

X-workstation

string

X-Cluster

string

X-Department

string

X-Branch

string

Update queue status › Request Body

active

boolean

Update queue status › Responses

200

Untitled Response

active_visits

string[]

created

string

created_by

string

created_by_name

string

id

string

name

string

organisation

string

queue_type

string

updated

string

updated_by

string

updated_by_name

string

workstation_id

string

department_id

string

branch_id

string

cluster_id

string

active

string

practitioner

string

schedule

string

PATCH/api/visits/queues/{id}

curl https://accounts.multitenant.slade360.co.ke/api/visits/queues/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "active": true
}'

Example Request Body

{
  "active": true
}

json

application/json

Example Responses

{
  "active_visits": [
    "<uuid>",
    "<uuid>"
  ],
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "created_by_name": "<string>",
  "id": "<uuid>",
  "name": "<string>",
  "organisation": "<uuid>",
  "queue_type": "PROSTATE CANCER SCREENING",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "updated_by_name": "<string>",
  "workstation_id": "<uuid>",
  "department_id": "<uuid>",
  "branch_id": "<uuid>",
  "cluster_id": "<uuid>",
  "active": "<boolean>",
  "practitioner": "<uuid>",
  "schedule": "<uuid>"
}

json

application/json

Block single clinic slot

GET

https://accounts.multitenant.slade360.co.ke

/api/scheduling/schedules/{id}/block_slots

Block slots for a given date, multiple dates, or specific hours of a day.

Block single clinic slot › path Parameters

id

string · required

(Required) A UUID string identifying this schedule.

Block single clinic slot › query Parameters

date

string

start_time

string

end_time

string

Block single clinic slot › Responses

200

Untitled Response

object

created

string

created_by

string

created_by_name

string

id

string

organisation

string

object

queue

string

slot_duration

string

updated

string

updated_by

string

updated_by_name

string

workstation_id

string

department_id

string

branch_id

string

cluster_id

string

active

string

actor

string

specialty

string

description

string

practitioner

string

GET/api/scheduling/schedules/{id}/block_slots

curl https://accounts.multitenant.slade360.co.ke/api/scheduling/schedules/:id/block_slots \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "availability": {
    "do_1b": [
      {
        "cupidatat3f8": "<time>",
        "mollit_22": "<time>"
      },
      {
        "et_104": "<time>",
        "aliqua7f": "<time>"
      }
    ],
    "fugiate4": [
      {
        "cupidatatc_": "<time>",
        "aliqua613": "<time>"
      },
      {
        "et_c5": "<time>"
      }
    ],
    "proident0": [
      {
        "eiusmod_aa3": "<time>",
        "proident33e": "<time>",
        "sit7": "<time>"
      },
      {
        "veniam_053": "<time>"
      }
    ]
  },
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "created_by_name": "<string>",
  "id": "<uuid>",
  "organisation": "<uuid>",
  "practitioner_data": {
    "created": "<dateTime>",
    "created_by": "<uuid>",
    "id": "<uuid>",
    "organisation": "<uuid>",
    "person": {
      "age": {
        "laboris__": "<integer>"
      },
      "consent": {
        "consent_type": "SMS_HEALTH_EDUCATION",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "person": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "updated_by_name": "<string>",
        "verification_type": "OTP",
        "workstation_id": "<uuid>",
        "department_id": "<uuid>",
        "branch_id": "<uuid>",
        "cluster_id": "<uuid>",
        "active": "<boolean>",
        "status": "VERIFIED",
        "effective_from": "<dateTime>",
        "effective_to": "<dateTime>",
        "captured_by": "<uuid>",
        "otp": "<uuid>"
      },
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "email": "<string>",
      "first_name": "<string>",
      "global_health_id": "<string>",
      "id": "<uuid>",
      "id_document_type": "<string>",
      "id_value": "<string>",
      "last_name": "<string>",
      "organisation": "<uuid>",
      "person_display": "<string>",
      "person_ids": [
        {
          "created_by_name": "<string>",
          "id": "<uuid>",
          "id_document_type": "passportID",
          "id_value": "<string>",
          "updated_by_name": "<string>",
          "active": "<boolean>"
        },
        {
          "created_by_name": "<string>",
          "id": "<uuid>",
          "id_document_type": "kraPIN",
          "id_value": "<string>",
          "updated_by_name": "<string>",
          "active": "<boolean>"
        }
      ],
      "phone_number": "<string>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "person_contacts": [
        {
          "contact_type": "phone_number",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "created_by_name": "<string>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "updated_by_name": "<string>",
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "contact": "<string>",
          "verified": "<boolean>",
          "consent_to_contact_given": "<boolean>",
          "is_primary_contact": "<boolean>",
          "person": "<uuid>"
        },
        {
          "contact_type": "phone_number",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "created_by_name": "<string>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "updated_by_name": "<string>",
          "workstation_id": "<uuid>",
          "department_id": "<uuid>",
          "branch_id": "<uuid>",
          "cluster_id": "<uuid>",
          "active": "<boolean>",
          "contact": "<string>",
          "verified": "<boolean>",
          "consent_to_contact_given": "<boolean>",
          "is_primary_contact": "<boolean>",
          "person": "<uuid>"
        }
      ],
      "workstation_id": "<uuid>",
      "department_id": "<uuid>",
      "branch_id": "<uuid>",
      "cluster_id": "<uuid>",
      "active": "<boolean>",
      "other_names": "<string>",
      "date_of_birth": "<date>",
      "title": "<string>",
      "gender": "MALE",
      "deceased": "<boolean>",
      "language": "en",
      "metadata": {
        "nullable": true
      },
      "associated_region": "<uuid>"
    },
    "qualification": "CLINICAL MEDICAL GENETICS",
    "updated": "<dateTime>",
    "updated_by": "<uuid>",
    "workstation_id": "<uuid>",
    "department_id": "<uuid>",
    "branch_id": "<uuid>",
    "cluster_id": "<uuid>",
    "active": "<boolean>"
  },
  "queue": "<uuid>",
  "slot_duration": "<integer>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "updated_by_name": "<string>",
  "workstation_id": "<uuid>",
  "department_id": "<uuid>",
  "branch_id": "<uuid>",
  "cluster_id": "<uuid>",
  "active": "<boolean>",
  "actor": "HEALTHCARE_SERVICE",
  "specialty": "ORAL PATHOLOGY",
  "description": "<string>",
  "practitioner": "<uuid>"
}

json

application/json

Patient Admin Communications