API Documentation

Go back
Documentation Powered by ReDoc

Common Backend (1.0)

Download OpenAPI specification:Download

Niels Vermaut: niels.vermaut@teamntime.com License: proprietary

The common backend for TNT2 documentation

The common backend for TNT operations

Authentication

Access Leases

Create access lease

Request Body schema: application/json
access_lease_role
string
subject_type
string
subject_id
string <uuid>
user_security_context_id
string or null <uuid>
access_lease_localised_role
string or null

Responses

Request samples

Content type
application/json
{
  • "access_lease_role": "string",
  • "subject_type": "string",
  • "subject_id": "80e197be-61ad-4068-b4ff-a483fb5c18f9",
  • "user_security_context_id": "a52822a0-5321-454f-b240-37c86b4234f9",
  • "access_lease_localised_role": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get all access lease settings

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

User Security Contexts

List user security contexts

List all user security contexts

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Get user security context

Get a single user security context

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "results": {
    }
}

Care Demands

Fetch all Care Demands for a Department

path Parameters
departmentId
required
string
query Parameters
pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

range[starts]
string
range[ends]
string
includes[department]
string
expect_state[summed_by_department_stay]
string

When given, the response will include the sums of Care Demand minutes_per_24_hours per Department Stay

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Care Demand Profiles

Fetch CareProfile by name

Fetches a Care Profile by name.

A Care Profile is the blueprint used for how we apply Care Demand to a Patient.

A Care Profile has a relation to Definitions, these Definitions define how Care Demand is applied.

If you are not passing the query arguments, this might be semantically different since the decisions of which Definitions might be used might change.

path Parameters
careProfileName
required
string
query Parameters
query[patient_id]
string

Specifies for which patient the care profle is fetched, if empty this will be ignored

query[department_id]
string

Specifies for which department the care profle is fetched, if empty this will be ignored

includes[definitions]
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "result": {
    },
  • "includes": {
    }
}

Care Ratings

Fetch all Care Ratings for a Department

path Parameters
departmentId
required
string
query Parameters
pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

range[starts]
string
range[ends]
string
includes[department]
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Department Stays

Fetch all Department Stays for a Department

path Parameters
departmentId
required
string
query Parameters
pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

range[starts]
string
range[ends]
string
includes[beds]
string
includes[patients]
string
includes[care_demands]
string
Deprecated

Use separate endpoint /departments/{departmentId}/care_demands

includes[care_ratings]
string
Deprecated

Use separate endpoint /departments/{departmentId}/care_ratings

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Fetch all Temporary Transfers for a Department

path Parameters
departmentId
required
string
query Parameters
pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

range[starts]
string <date-time>
range[ends]
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Fetch Department Stays for a Hospital Stay

path Parameters
hospitalStayId
required
string
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Department Stay Activities

Get department stay activities

path Parameters
departmentStayId
required
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "includes": {
    }
}

Get department stay activities for hospital stay

path Parameters
departmentStayId
required
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "includes": {
    }
}

Hospital Stays

Create HospitalStay

Creates a HospitalStay

A HospitalStay can be an open ended registration of a Patient that will be at a Hospital from a certain date.

Request Body schema: application/json
hospital_id
required
string <uuid>
patient_id
required
string <uuid>
from_at
required
string <date-time>

ISO_8601

planned_exit_at
string or null <date-time>
confirmed_exit_at
string or null <date-time>
treatment_ids
Array of strings <uuid> >= 0 items

Not yet implemented

Responses

Request samples

Content type
application/json
{
  • "hospital_id": "9091f0c1-dac3-4e2a-8866-e1b660434f40",
  • "patient_id": "9091f0c1-dac3-4e2a-8866-e1b660434f40",
  • "from_at": "2022-08-09T17:13:33+02:00",
  • "planned_exit_at": "2022-08-10T17:13:33+02:00",
  • "confirmed_exit_at": "2022-08-10T17:13:33+02:00",
  • "treatment_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Create DepartmentStay

Creates a DepartmentStay. A DepartmentStay describes an open ended Patient residing at a Department from a certain date.

For each HospitalStay, there can be only one open ended DepartmentStay.

By default, the API will respond with a 409 Conflict when one exists and you try to create another. The Query parameter allow_side_effects will update the previous DepartmentStay with the date given in the from_at. However, when the conflict is the result of a non-open ended DepartmentStay, the allow_side_effects Query Parameter will do nothing.

query Parameters
allow_side_effects
boolean
Default: false
Request Body schema: application/json
hospital_stay_id
required
string <uuid>
bed_id
string or null <uuid>
from_at
required
string <date-time>

ISO_8601

confirmed_exit_at
string or null

ISO_8601

Responses

Request samples

Content type
application/json
{
  • "hospital_stay_id": "9091f0c1-dac3-4e2a-8866-e1b660434f40",
  • "bed_id": "00283e89-698b-4f87-b9b6-06d370a4f9be",
  • "from_at": "2022-08-09T17:13:33+02:00",
  • "confirmed_exit_at": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

List Patient Interventions for Hospital Stay

path Parameters
hospitalStayId
required
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Parameter Groups

List Parameter groups

query Parameters
query[only_if_has_parameters_without_capability]
boolean

Can be true, all other values are ignored and interpreted as null

query[has_exactly_one_source_department]
string

Responses

Response samples

Content type
application/json
{
  • "results": {
    },
  • "state": {
    }
}

Get parameter group by id

path Parameters
id
required
string
query Parameters
includes[parameters]
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "includes": {
    }
}

Create parameter

path Parameters
parameterGroupId
required
string
Request Body schema: application/json
minutes_per_24_hours
integer
day_index
integer
capability_id
string or null <uuid>
start_time
string <time>
end_time
string <time>

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
{
  • "result": {
    },
  • "state": {
    }
}

Update parameter

path Parameters
parameterGroupId
required
string
parameterId
required
string
Request Body schema: application/json
minutes_per_24_hours
integer
day_index
integer
capability_id
string or null <uuid>
start_time
string <time>
end_time
string <time>
should_be_sliced_by_daypart
boolean
version
integer

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
{
  • "result": {
    }
}

Patient Interventions

Extra Care Options

Create ExtraCareOption

Request Body schema: application/json
name
string
minutes_per_24_hours
integer
hospital_id
string <uuid>
department_id
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "minutes_per_24_hours": 0,
  • "hospital_id": "b2658506-542b-413c-8700-f31c8dc45952",
  • "department_id": "094fb5f1-8160-46ea-8cec-010c4b44e054"
}

Day Parts

List DayParts

Returns configured DayParts of an application.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create Day Part

Creates a day part for a tenant

Request Body schema: application/json
name
required
string
abbreviation
required
string
from_time
required
string
to_time
required
string
is_to_time_on_next_day
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "name": "Early",
  • "abbreviation": "Early",
  • "from_time": "07:00:00",
  • "to_time": "14:59:59",
  • "is_to_time_on_next_day": false
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Replace DayPart

Replace the day part with the updated information, this will also update the DayPartKpiThresholds for that DayPart

path Parameters
id
required
string
Request Body schema: application/json
name
required
string
abbreviation
required
string
from_time
required
string
to_time
required
string
is_to_time_on_next_day
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "abbreviation": "string",
  • "from_time": "string",
  • "to_time": "string",
  • "is_to_time_on_next_day": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "abbreviation": "string",
  • "from_time": "07:00:00",
  • "to_time": "17:00",
  • "created_at": "2019-08-24T14:15:22Z",
  • "preceding_day_part": {
    },
  • "applies_from": "2019-08-24T14:15:22Z",
  • "applies_until": "2019-08-24T14:15:22Z",
  • "deleted": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Day Part KPI Thresholds

List DayPartKpiThresholds

Returns all DayPartKpiThresholds

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Delete DayPartKpiThreshold

Delete a specific day part KPI threshold

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
Example
No-token
No-token
No-id-token
{
  • "message": "No access token was sent in the header Authorization"
}

Update DayPartKpiThreshold

Update a specific day part KPI threshold

path Parameters
id
required
string
Request Body schema: application/json
kpi_slug
required
string
type
required
string
Enum: "target_value" "range_value"
name
required
string
color
required
string
target_value
number <float>

Required when type is target_value

range_value_starts
number <float>

Required when type is range_value

range_value_ends
number <float>

Required when type is range_value

level
string
Enum: "critical" "warning" "ok"

Responses

Request samples

Content type
application/json
{
  • "kpi_slug": "string",
  • "type": "target_value",
  • "name": "string",
  • "color": "string",
  • "target_value": 0,
  • "range_value_starts": 0,
  • "range_value_ends": 0,
  • "level": "critical"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

List DayPartKpiThresholds for Department

Returns the DayPartKpiThresholds uniquely configured for a Department. This endpoint will not return DayPartKpiThresholds configured on the Venue or Hospital that should apply on a Department.

path Parameters
departmentId
required
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create DayPartKpiThreshold for Department request

Create a daypart_kpi_threshold

path Parameters
departmentId
required
string
kpiSlug
required
string
Request Body schema:
application/json
application/json
application/xml
type
required
string
Enum: "range_value" "target_value"
name
string
color
string
target_value
number <float>

Required when type is target_value

range_value_starts
number <float>

Required when type is range_value

range_value_ends
number <float>

Required when type is range_value

day_part_id
required
string <uuid>

Responses

Request samples

Content type
application/json
application/json
application/xml
{
  • "type": "range_value",
  • "name": "string",
  • "color": "string",
  • "target_value": 0,
  • "range_value_starts": 0,
  • "range_value_ends": 0,
  • "day_part_id": "d3f47ddf-d579-4abc-892b-8ae35571bf6f"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

List DayPartKpiThresholds for Department by Slug

Returns the DayPartKpiThresholds uniquely configured for a Department. This endpoint will not return DayPartKpiThresholds configured on the Venue or Hospital that should apply on a Department.

path Parameters
departmentId
required
string
kpiSlug
required
string
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Request Body schema: application/json
include_inheritance
boolean

Responses

Request samples

Content type
application/json
{
  • "include_inheritance": true
}

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "state": {
    }
}

List DayPartKpiThresholds for Venue

Returns the DayPartKpiThresholds uniquely configured for a Venue. This endpoint will not return DayPartKpiThresholds configured on a Hospital that should apply on a Venue.

path Parameters
venueId
required
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

List DayPartKpiThresholds for Hospital

Returns the DayPartsKpiThresholds configured for a Hospital.

path Parameters
hospitalId
required
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Department Configuration

List kpi definition preferences for dashboard for a department

path Parameters
departmentId
required
string
type
required
string
Enum: "primary-kpis" "secondary-kpis"

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Default Capability Splits

List all default capability splits of a department

path Parameters
departmentId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

post-department-departmentId-default_capability_split

Create a DefaultCapabilitySplit for a department

path Parameters
departmentId
required
string
Request Body schema: application/json
split_percentage
number <float>
capability_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "split_percentage": 0,
  • "capability_id": "9da5e075-205b-4e46-9854-c4586fb11057"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

External IDs

List External Ids

Lists all external ids registered in the application.

This allows an external service to query if a certain object is already registered in the application.

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

query[internal_type]
string

Allows you to filter on the internal type.

query[internal_id]
string

Allows you to filter on the internal id.

query[include_deleted]
boolean

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create ExternalId

Create an External Id

Request Body schema: application/json
internal_type
required
string
internal_id
required
string <uuid>
external_system_id
required
string
external_id
required
string
created_in_external_system_at
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "internal_type": "string",
  • "internal_id": "c13c6907-8dc3-4479-a9ee-0b258d87c410",
  • "external_system_id": "string",
  • "external_id": "string",
  • "created_in_external_system_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Delete ExternalId

Delete an externalId

Responses

Beds

Create a new bed

Creates a bed

Request Body schema: application/json
room_id
string <uuid>
name
string
external_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "room_id": "05451321-18e1-4bfa-aa22-dfd0080cc120",
  • "name": "string",
  • "external_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Update a bed

path Parameters
bedId
required
string <uuid>
Request Body schema: application/json
name
string
room_id
string <uuid>
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "room_id": "05451321-18e1-4bfa-aa22-dfd0080cc120",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Departments

List Departments

Returns all Departments registered under a tenant

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

query[ids]
array

Array of department ids that you want returned. This field is optional

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create Department

Creates a department.

A department is place where patients receive care.

Request Body schema: application/json
name
required
string <= 255 characters
abbreviation
required
string <= 5 characters
type
required
string
Enum: "ward" "system" "admin" "specialty" "surgery" "maternity" "reservation" "leave_long_term" "leave_short_term" "day_clinic" "flexible_staff"

Describes the type of department

venue_id
required
string <uuid>
external_ids
required
Array of strings >= 0 items unique

List of ids by which you already identify the hospital. This allows us to connect data from multiple systems.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "abbreviation": "strin",
  • "type": "ward",
  • "venue_id": "9091f0c1-dac3-4e2a-8866-e1b660434f40",
  • "external_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Fetch department

Fetches one department

path Parameters
id
required
string
query Parameters
includes[]=rooms
string

Includes the rooms for the department

includes[]=beds
string

Includes the beds for the rooms in the department

Responses

Response samples

Content type
application/json
Example
Example without includes
Example without includes
Example with includes
{
  • "result": {
    },
  • "includes": { }
}

Department Groups

List Department Groups

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create DepartmentGroup

Creates a department group.

A department group is an arbitrary collection of departments. These allow you to group departments by any means you deem useful.

Request Body schema: application/json
name
required
string
department_ids
required
Array of strings <uuid> non-empty unique
hospital_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "department_ids": [
    ],
  • "hospital_id": "b2658506-542b-413c-8700-f31c8dc45952"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get Department Group

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Add department to department group

path Parameters
departmentGroupId
required
string <uuid>
Request Body schema: application/json
department_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "department_id": "094fb5f1-8160-46ea-8cec-010c4b44e054"
}

Remove department from department group

path Parameters
departmentGroupId
required
string <uuid>
departmentId
required
string <uuid>

Responses

Hospitals

List Hospital Entities

Returns all Hospital Entities registered for a hospital.

This endpoint does not support any filtering

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Create HospitalEntity

This endpoint allows you to create hospital_entities.

Hospital entities describe legal hospital entities and allows you to define multiple independant hospitals in one instance of Team n time, but still share configuration.

Request Body schema: application/json
name
required
string <= 255 characters
abbreviation
required
string <= 5 characters
logo_uri
string or null <uri>

Allows you to pass an image logo that will be shown in certain places in the UI. Should be publicly accessible.

is_main_hospital
boolean
Default: true

If no hospital exists in the database, this will be set to true.

Defines if the hospital will be used as the default where a hospitalId is not specified.

external_ids
required
Array of strings >= 0 items unique

List of ids by which you already identify the hospital. This allows us to connect data from multiple systems.

Responses

Request samples

Content type
application/json
{
  • "name": "ACME Hospital",
  • "abbreviation": "ACME",
  • "logo_uri": "http://example.com/logo.png",
  • "is_main_hospital": true,
  • "external_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get Hospital entity

Allows you to fetch one hospital entity and supports the following includes:

  • venues
  • departments: returns all departments under the venues of the hospital entity

The id expects a uuid or the supported alias main. This alias will return the hospital that is set as the main hospital.

path Parameters
id
required
string
query Parameters
includes[venues]
string

Will include the venues of the hospital when set

includes[departments]
string

Will include the departments of venues under a hospital

Request Body schema: application/json
object (HospitalEntity)

The model describes a Hospital as its legal entity

object or null

Responses

Request samples

Content type
application/json
{
  • "result": {
    },
  • "includes": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "includes": {
    }
}

List all Venues for a Hospital Entity

Lists all Venues for a Hospital Entity

path Parameters
hospitalEntityId
required
string
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

includes[venues.departments]
boolean

When set, it will include all departments for a Venue

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Create Venue

Creates a venue.

A venue is a physical location bound by geography.

Request Body schema: application/json
name
required
string <= 255 characters
abbreviation
required
string <= 5 characters
hospital_entity_id
required
string <uuid>

References a hospital entity

external_ids
required
Array of strings >= 0 items unique

List of ids by which you already identify the hospital. This allows us to connect data from multiple systems.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "abbreviation": "strin",
  • "hospital_entity_id": "9091f0c1-dac3-4e2a-8866-e1b660434f40",
  • "external_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Rooms

Create a room

Request Body schema: application/json
name
string
department_id
string <uuid>
external_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "department_id": "094fb5f1-8160-46ea-8cec-010c4b44e054",
  • "external_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

List all beds in a room

path Parameters
roomId
required
string <uuid>
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Venues

List Venues

Returns all venues registered to a tenant

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

includes[departments]
boolean

If set, it will return the departments for a venue

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

List all Departments for a Venue

Lists all Departments for a Venue

path Parameters
venueId
required
string
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Dependencies

KPIs

List KPIs

Returns all configured KPIs in the application

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Fetch KPI result

Fetches a KPI for a department

path Parameters
slug
required
string
query Parameters
query[department_id]
required
array

Gives the ID for which the KPI should be calculated

range[starts]
required
string <date-time>
range[ends]
required
string <date-time>
kpi[resolution]
required
string

ISO 8601 Duration string

includes[daypart_kpi_thresholds]
string

When set in the request, it will include the thresholds that need to be rendered

from_draft_id
string <uuid>

Optional draft id you can pass to calculate kpi's with draft worklogs included in the calculation

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Fetch Monthly KPI result

Fetches a KPI for a department for a month

path Parameters
kpiSlug
required
string
query Parameters
query[department_id]
required
array

Gives the ID for which the KPI should be calculated

range[year_starts]
required
integer <date-time> >= 1970
range[year_ends]
required
integer <date-time> >= 1970
kpi[resolution]
required
string
range[month_index]
required
integer [ 1 .. 12 ]

The index for the month

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

KPI Exports

Returns all the created kpi exports for a tenant

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create KPI Export

Creates a KPI Export

Request Body schema: application/json
object

Describes the KPI you are requesting to be exported

object
object (Range)

Represents a time range

Responses

Request samples

Content type
application/json
{
  • "kpi": {
    },
  • "query": {
    },
  • "range": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "state": {
    }
}

Fetch KPI Export

path Parameters
exportId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "state": {
    }
}

KPI Definitions

KPI Calculations

Fetch dependencies for KPI Calculations

This endpoint fetches all the kpi calculations that the given kpi calculation depends on.

path Parameters
kpiCalculationId
required
string
query Parameters
includes[kpi_calculation]
string

Will include the given kpi calculation

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "includes": {
    }
}

Rankings

Fetch ranking for hospital

query Parameters
kpi[resolution]
string
query[department_id]
string
range[starts]
string
range[ends]
string

Responses

Response samples

Content type
application/json
{ }

Reports

Fetch Report

Returns a report by Report Definition alias. The Report Definition alias can be its id or its abbreviation.

path Parameters
reportDefinitionAlias
required
string
query Parameters
range[starts_at]
required
string <date-time>
range[ends_at_exclusive]
required
string <date-time>
resolution[value]
string

Overrides the resolution set in the report definition

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Report Definitions

List ReportDefinitions

Lists all Report Definitions registered in the application.

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Fetch Report Definition

Returns a Report Definition by alias. The alias can be its id or its abbreviation.

path Parameters
reportDefinitionAlias
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Patients

Fetch Department Stays for Patient

path Parameters
patientId
required
string
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

range[starts]
string <date-time>
range[ends]
string or null <date-time>

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Fetch Temporary Transfers for Patient

path Parameters
patientId
required
string
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

range[starts]
string <date-time>
range[ends]
string or null <date-time>

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Create Patient

Creates a new patient.

Request Body schema: application/json
first_name
string or null <= 255 characters
last_name
string or null
applies_from
string or null <date-time>

ISO_8601

date_of_birth
string

If you want to anonymise the date_of_birth of a patient, please use YEAR/01/01 so we have an indication for the Statistical module.

gender
string <= 1 characters
Enum: "M" "V" "X"

Responses

Request samples

Content type
application/json
{
  • "first_name": "William",
  • "last_name": "Wallace",
  • "applies_from": "2022-08-10T10:31:24+02:00",
  • "date_of_birth": "2022-08-10T10:31:24+02:00",
  • "gender": "M"
}

List Patients

Lists all Patients

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

List HospitalStays for Patient

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Create a support question

Request Body schema: application/json
department_id
required
string <uuid>
support_question_reason_id
required
string <uuid>
comment
required
string <= 255 characters
required
object

Responses

Request samples

Content type
application/json
{
  • "department_id": "094fb5f1-8160-46ea-8cec-010c4b44e054",
  • "support_question_reason_id": "40352663-b04a-405e-a91f-722c156860e9",
  • "comment": "string",
  • "range": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Patient Interventions

Transfers

Fetch Temporary Transfers

This endpoint allows you to fetch multiple Temporary Transfers for a list of Department Stays.

De facto, all department stays should be from the same department, but this is not enforced on the endpoint.

The maximum amount of department_stay_ids that is supported is 250.

If you pass an id that is not a UUID, you will receive a 400.

If you pass an id that does not exist, it will not affect the status code, but as expected, no temporary transfers will be returned for that id.

query Parameters
query[department_stay_ids]
array

The list of department stays you want to query for

range[starts]
string
range[ends]
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create Temporary Transfer

Creates a temporary transfer for a Patient in a Department (defined by a DepartmentStay).

Request Body schema: application/json
from_at
required
string <date-time>

ISO_8601

until_at
required
string <date-time>

Until inclusive. ISO_8601

department_stay_id
required
string <uuid>
to_department_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "from_at": "2022-08-09T17:13:33+02:00",
  • "until_at": "2022-08-09T20:13:33+02:00",
  • "department_stay_id": "9091f0c1-dac3-4e2a-8866-e1b660434f40",
  • "to_department_id": "e6d29d16-850f-46b4-b707-f975d02e7685"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Issues

List issues

Get a list of issues, which can be filtered on states and department_ids

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

query[department_ids][]
string

Returns issues with given department_ids

query[states][]
string

Returns issues with given states

includes[]
string
range[starts]
string
range[end]
string
Request Body schema: application/json
Array of objects (Issue) [ items ]
object
object or null

Responses

Request samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Get Issue

Get Issue

path Parameters
id
required
string
query Parameters
includes[]
string

Responses

Response samples

Content type
application/json
{
  • "results": {
    },
  • "includes": {
    }
}

Resolve an issue

Resolve issues, including the reason an issue is resolved

path Parameters
id
required
string
Request Body schema: application/json
description
string
resolution_state
string
Enum: "fully" "partially" "from_user_indication"
resolved_by_type
string or null
Enum: "care_demand" "department_stay" "planning" "user"
resolved_by_id
string or null

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "resolution_state": "fully",
  • "resolved_by_type": "care_demand",
  • "resolved_by_id": "string"
}

List Warnings for issue

List Warnings for issue

path Parameters
id
required
string
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

includes[]
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Create Comment for Issue

Create Comment for Issue

path Parameters
id
required
string
Request Body schema: application/json
comment
required
string
creator_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Planning Drafts

Create planning draft

Request Body schema:
application/json
application/json
application/xml

The draft object can contain more stuff but only the values present in draftStaffWorklog will be mapped to a staff worklog (rest will be saved in the draft but ignored when creating an actual staff worklog)

name
string
object

Responses

Request samples

Content type
application/json
application/json
application/xml
{
  • "name": "string",
  • "draft": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Update planning draft

path Parameters
id
required
string
Request Body schema: application/json

The draft object can contain more stuff but only the values present in draftStaffWorklog will be mapped to a staff worklog (rest will be saved in the draft but ignored when creating an actual staff worklog)

name
string
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "draft": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Delete planning draft

path Parameters
id
required
string

Responses

Claim the ownership of the planning draft

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get all your planning drafts

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get your latest planning drafts

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Convert draft to actual entities

Creates entities based on the planning draft and then deletes the planning draft

path Parameters
id
required
string <uuid>

Also supports last alias

Responses

Staff Adoption Candidates

Create Staff Adoption Candidate

Through this endpoint a staff member can be added to the pool of Staff Adoption Candidates so it can possibly be added to another department in a hospital.

Request Body schema: application/json
staff_member_id
required
string <uuid>
source_department_id
required
string <uuid>

The department where the staff member is originally from

staff_worklog_id
string <uuid>

The staff worklog that this staff adoption candidate will remove when adopted.

from_at
required
string <date-time>
until_at
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "staff_member_id": "5855f16b-074a-431e-acd2-59c8978555e4",
  • "source_department_id": "477cbcb9-1c5c-4f5e-ae3d-6fbe4d7bf585",
  • "staff_worklog_id": "f60bd96e-1dfb-461f-85f8-bf79ef775be8",
  • "from_at": "2019-08-24T14:15:22Z",
  • "until_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "includes": {
    }
}

Fetch Staff Adoption Candidates by Staff Group

path Parameters
staffGroupId
required
string <uuid>
query Parameters
range[starts]
string <date-time>
range[ends]
string <date-time>
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

includes[staff_members]
string
includes[resulting_staff_worklogs]
string
includes[source_departments]
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Fetch Staff Adoption Candidates by Staff Member

path Parameters
staffMemberId
required
string
query Parameters
range[starts]
string <date-time>
range[ends]
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create StaffWorklog from staff adoption candidate

Creates a Staff Worklog from a staff adoption candidate. In this way you adopt the staff adoption candidate

path Parameters
staffAdoptionCandidateId
required
string
Request Body schema: application/json
from_at
required
string
until_at
required
string
at_department_id
required
string
staff_function_id
required
string
staff_group_id
required
string
comment
required
string or null <= 255 characters
source
required
string
Enum: "planning" "support_question"

When in doubt, choose planning.

Responses

Request samples

Content type
application/json
{
  • "from_at": "string",
  • "until_at": "string",
  • "at_department_id": "string",
  • "staff_function_id": "string",
  • "staff_group_id": "string",
  • "comment": "string",
  • "source": "planning"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Support Questions

Fetch all Support Questions

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create SupportQuestionReason

Create a Support Question Reason

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Update Support Question Reason

Update a SupportQuestionReason

path Parameters
id
required
string
Request Body schema: application/json
name
required
string
active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get support questions

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

range[starts]
required
string <date-time>
range[ends]
required
string <date-time>
query[status]
string
Enum: "created" "seen" "responded"

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create a support question

path Parameters
id
required
string
Request Body schema: application/json
support_question_status
required
string
Enum: "created" "seen" "responded"
note
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "support_question_status": "created",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get support questions

path Parameters
id
required
string
query Parameters
includes[responses]
string
Enum: "created" "seen" "responded"

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "includes": {
    }
}

Expertises

Get expertises

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create expertise

Request Body schema: application/json
name
required
string
hospital_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hospital_id": "b2658506-542b-413c-8700-f31c8dc45952"
}

Edit expertise

path Parameters
id
required
string <uuid>
Request Body schema: application/json
name
required
string
hospital_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hospital_id": "b2658506-542b-413c-8700-f31c8dc45952"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Add expertise to staff member

path Parameters
id
required
string
Request Body schema: application/json
expertise_id
string <uuid>
certified_at
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "expertise_id": "d7d42c56-3633-4f38-9d89-5da09af3f144",
  • "certified_at": "2019-08-24T14:15:22Z"
}

Get staff members expertises for expertise

path Parameters
id
required
string
query Parameters
includes[staff_members]
any

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "includes": {
    }
}

Get staff adoption candidates for expertise

Retrieve a list of staff adoption candidates with a certain expertise

path Parameters
id
required
string
query Parameters
includes[staff_members]
any
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "includes": {
    }
}

Staff Breaks

List staff breaks

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

range[starts]
required
string <date-time>
range[ends]
required
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Fetch staff break

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "includes": {
    }
}

List staff breaks for staff member

path Parameters
staff_member_id
required
string
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

range[starts]
string <date-time>
range[ends]
string <date-time>
includes[staff_member]
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Staff Functions

Fetch all Staff Functions

Fetches all staff functions.

Note: For now pagination parameters are ignored.

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create StaffFunction

Creates a StaffFunction.

A StaffFunction should always have a parent, since Team n time supplies defaults that you need to match StaffFunctions under. The parent groups are essential to matching supply and demand.

Request Body schema: application/json
parent_id
required
string <uuid>

a StaffFunction id

name
required
string <= 255 characters
description
required
string
weight
integer <int32> [ 1 .. 1000 ]
Default: 100

Higher is earlier in sorting

Responses

Request samples

Content type
application/json
{
  • "parent_id": "9091f0c1-dac3-4e2a-8866-e1b660434f40",
  • "name": "string",
  • "description": "string",
  • "weight": 100
}

Fetch Staff Function

Fetches a single staff function.

path Parameters
staffFunctionId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Update staff function parent

path Parameters
staffFunctionId
required
string
Request Body schema: application/json
parent_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Staff Groups

List Staff Groups

List all staff groups

query Parameters
is_flexible
boolean
flexible_staff_type
string
Enum: "roaming_staff" "staff_adoption_candidates" "external_staff"
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

includes[]
string
Enum: "departments" "hospitals"

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Create a Staff Group

Allows you to create a new staff group

Request Body schema: application/json
name
required
string
hospital_id
required
string <uuid>
department_id
string or null <uuid>
is_flexible
required
boolean

Should be true when flexible_staff_type is defined

flexible_staff_type
string or null
Enum: "roaming_staff" "staff_adoption_candidates" "external_staff"
is_default_for_flexible_staff_type
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hospital_id": "b2658506-542b-413c-8700-f31c8dc45952",
  • "department_id": "094fb5f1-8160-46ea-8cec-010c4b44e054",
  • "is_flexible": true,
  • "flexible_staff_type": "roaming_staff",
  • "is_default_for_flexible_staff_type": false
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Fetch Staff Group

Fetch the details of a staff group

path Parameters
id
required
string
query Parameters
includes[]
string
Enum: "staff_members" "hospital" "department"

Responses

Response samples

Content type
application/json
{
  • "results": {
    },
  • "includes": {
    }
}

Update Staff Group

Update the information of a staff group

path Parameters
id
required
string
Request Body schema: application/json
name
string
is_default_for_flexible_staff_type
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "is_default_for_flexible_staff_type": false
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get staff members for staff group

Only calculates and includes minutes_left_per_staff_member in state of response when range_minutes starts and ends are filled in.

path Parameters
staffGroupId
required
string
query Parameters
includes[staff_group]
string
range_minutes[starts]
string <date-time>
range_minutes[ends]
string <date-time>
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "includes": {
    },
  • "state": {
    }
}

Staff Members

List StaffMembers

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    }
}

Create StaffMember

Creates a StaffMember

Request Body schema: application/json
staff_function_id
required
string <uuid>
first_name
string or null <= 255 characters
last_name
string or null <= 255 characters
email_address
required
string <email>
phone_number
string or null <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "staff_function_id": "9091f0c1-dac3-4e2a-8866-e1b660434f40",
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "user@example.com",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get a StaffMember

Gets one StaffMember

path Parameters
id
required
string
query Parameters
includes[staff_function]
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "includes": {
    }
}

Update a StaffMember

Update the information of a staff member

path Parameters
id
required
string
Request Body schema: application/json
staff_function_id
required
string <uuid>
email
required
string <email>
first_name
string or null <= 255 characters
last_name
string or null <= 255 characters
phonenumber
string or null <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "staff_function_id": "9091f0c1-dac3-4e2a-8866-e1b660434f40",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "phonenumber": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get expertises for staff member

path Parameters
id
required
string
query Parameters
includes[expertises]
any

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "includes": {
    }
}

Add expertise to staff member

path Parameters
id
required
string
Request Body schema: application/json
expertise_id
string <uuid>
certified_at
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "expertise_id": "d7d42c56-3633-4f38-9d89-5da09af3f144",
  • "certified_at": "2019-08-24T14:15:22Z"
}

Staff Worklogs

Fetch all Staff Worklogs for a Department

path Parameters
departmentId
required
string
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

range[starts]
string
range[ends]
string
includes[staff_members]
string
includes[department]
string
includes[staff_functions]
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Fetch all Staff Worklogs for a staff member

path Parameters
staffMemberId
required
string
query Parameters
range[starts]
string
range[ends]
string
includes[departments]
string
includes[staff_functions]
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Fetch all Staff Worklogs for a Staff Group

path Parameters
staffGroupId
required
string
query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

range[starts]
string
range[ends]
string
includes[staff_members]
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": {
    }
}

Create StaffWorklog

Creates a Staff Worklog

Request Body schema: application/json
staff_member_id
required
string
from_at
required
string
until_at
required
string
at_department_id
required
string
staff_function_id
string or null

If you want to override the StaffFunction that the StaffMember will execute there, pass an id here. When null, the StaffFunction of the StaffMember will be set

staff_group_id
string or null

If you want to override to which StaffGroup the StaffMember belongs for this StaffWorklog, pass an id. If empty, the StaffGroup of the StaffMember will be set

comment
required
string <= 255 characters
source
required
string
Enum: "planning" "support_question"

When in doubt, choose planning.

Responses

Request samples

Content type
application/json
{
  • "staff_member_id": "string",
  • "from_at": "string",
  • "until_at": "string",
  • "at_department_id": "string",
  • "staff_function_id": "string",
  • "staff_group_id": "string",
  • "comment": "string",
  • "source": "planning"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get staff worklogs for range

also includes minutes_left_per_staff_group

query Parameters
pagination[size]
required
integer [ 1 .. 250 ]

Returns how many items will be returned on a page

pagination[page]
required
integer

Returns which page index you are requesting. Starts at 0

includes[staff_members]
string
includes[staff_functions]
string
range[starts]
required
string <date-time>
range[ends]
required
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "state": {
    },
  • "includes": null
}

Health Checks

Healthcheck: data received

Fetches the information about the healthcheck data-received. This healthcheck tells the caller when was the last time data was received from our data agent installed at a hospital.

The garantuee of this attribute will not be 100% accurate, but representative enough to show when something is wrong with the data pipeline.

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}