KPI Calculators (1.0)

Download OpenAPI specification:Download

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

The Calidos Teamntime KPI Calculator endpoints are responsible for the fast compute of the KPIs required for Team'n'Time 2

Describes the KPI Compute APIs for TeamnTime

Authentication

API Key

Security Scheme Type	API Key
Query parameter name:	API Key

operational

Fetch implementation details, not implemented yet

Returns some implementation details that allows developers to estimate how to use the API

Responses

Response samples

Content type

application/json

{"timeout_in_seconds": 0,
"avg_processed_events_per_second": 0
}

kpis

Request Patient Nurse Ratio

This endpoint allows you to request the Patient Nurse Ratio KPI.

Request Body schema: application/json

	object
	object

Responses

Request samples

Payload

Content type

application/json

{"parent_kpis": {"actual_patients": {"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
}
},
"actual_staffing": {"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
}
}
},
"cached_parent_kpis": {"actual_patients": { },
"actual_nursing": { }
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request Patient Care Ratio

This endpoint allows you to request the Patient Care Ratio KPI.

Request Body schema: application/json

	object
	object

Responses

Request samples

Payload

Content type

application/json

{"parent_kpis": {"actual_patients": {"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
}
},
"actual_staffing": {"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
}
}
},
"cached_parent_kpis": {"actual_patients": { },
"actual_staffing": { }
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request Bed occupation

This endpoint allows you to request the Patient Care Ratio KPI.

Request Body schema: application/json

	object
	object

Responses

Request samples

Payload

Content type

application/json

{"parent_kpis": {"actual_patients": {"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
}
},
"number_of_beds": {"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
}
}
},
"cached_parent_kpis": {"actual_patients": { },
"actual_staffing": { }
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request Absolute Care Weight

Request Body schema: application/json

Based off of CombinedKPIRequest

	object or null
	object
	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"parent_kpis": {"care_demand": {"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": { },
"overrides": [{ }
],
"implementation_details": {"cache": null
}
},
"actual_staffing": {"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": null,
"name": null
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"overrides": [{ }
],
"implementation_details": {"cache": null
}
}
},
"cached_parent_kpis": {"care_demand": { },
"actual_staffing": { }
},
"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Get Relative Care Weight KPI

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Get Historic Care Weight KPI

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request Number of patients

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request Number of admissions

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request Number of discharges

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request Number of absent patients

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request Number of interventions

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request Care Demand

This endpoint allows you to request the Care Demand KPI.

What will be returned here:

The Care Demand Sum (CareDemandSum) over 24 hours from the events being sent. Since Care Demand usually has equal ranges to eachother (like the range of a day part), the graphing information will only change when a new patient arrives on the department.
The Care Demand Remaining (CareDemandRemaining): The Care Demand - (the Care Demand * the percentage completed)
The Total Percentage Complete (TotalPercentageComplete): 1 - (Care Demand Remaining / Care Demand)

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request Actual Staffing

This endpoint allows you to request the Actual Staffing KPI.

The number of staff that is actually working at the Department. It may be staff that was planned at the Unit, or staff that is transferred to the Department from another Department where it was planned. The KPI will not receive events that correlate with Adoptions, but will only return events that describe the planning of the requested Department. For the transfers, another KPI will be used.

What will be returned here

The Actual Staffing in FTE (ActualStaffingFTE): This means how many actual people were working at the department
The Actual Staffing in CTE (ActualStaffingCTE): CTE = Care Time Equivalent, which expresses how efficient a certain staff member is in a certain department.

The CTE will only be calculated for one Capability. This capability will be sent in the context by cte_requested_capability_id. e.g.

The Staff Member has 5 capability efficiencies, but only the one in the request will be used. If the Staff Member does not have the capaibility efficiency, nor is it set on its Staff Function, the cte_default_capability_efficiency in the context should be used.

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request number of planned staff

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request number of roaming staff

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request number of ideal staff

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request number of beds

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

Request number of support questions

Request Body schema: application/json

	object (KPIRequest)
	object (Context) Context body
	object (ImplementationConcerns)

Responses

Request samples

Payload

Content type

application/json

{"request": {"request_type": "with_body",
"is_request_async": true,
"kpi_resolution": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"events": [{ }
],
"webhook": null,
"resources": null,
"cached_resources": null,
"representation": "by_weekday",
"requested_timezone": "string",
"query": null
},
"context": {"location_configuration": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "department"
},
"staff_members": [{"id": "string",
"name": "string",
"function": {"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
},
"capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
]
}
],
"functions": [{"id": "string",
"default_capability_efficiencies": [{"capability": {"id": "string",
"name": "string"
},
"efficiency": 0.65
}
],
"abbreviation": "string",
"name": "string"
}
],
"threshold_sorting": "asc",
"thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"ntc_thresholds": [{"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"applicable_time_range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"threshold_level": "string",
"threshold_weight": "excess",
"minimum_violation_time": 0,
"range_sensitivity": 0,
"should_trigger_alert": true,
"value_range": {"minimum": 0,
"maximum": 0
}
}
],
"grace_period_for_considering_attached_in_seconds": 0,
"cte_default_capability_id": "string",
"cte_requested_capability_id": "string",
"cte_default_capability_efficiency": 0,
"minutes_per_24_hours_for_workshift": 0,
"infinity_fallback_ratio": 0
},
"implementation_concerns": {"cache": null
}
}

Response samples

Content type

application/json

{"result": {"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
},
"state": {"sibling_kpis": [{"kpi_name": "string",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"kpi_resolution": "PT15M",
"datapoints_by_resolution_interval": [{"order": 0,
"interval": "string",
"range_starts": "string",
"range_ends": "string",
"calculated_values": [{"key": "minimum",
"value": 2.1,
"representation": "absolute"
},
{"key": "maximum",
"value": 4.3,
"representation": "absolute"
}
]
}
],
"calculated_at": "2019-08-24T14:15:22Z",
"cache_key": "median_patient_nurse__20210301T161509_0100__20210305T161509_0100__30m"
}
],
"violation_groups": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
],
"detected_violations": [{"violation_group_id": "99afe84a-c94f-4cbd-9206-4901abd7a480",
"day_part_kpi_threshold_id": "4adf6a95-fffe-44fc-b4ab-b16e0388d162",
"datapoints": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
],
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"datapoints_by_threshold_interval": [{"order": 0,
"datatype": "default",
"range": {"starts": "2019-08-24T14:15:22Z",
"ends": "2019-08-24T14:15:22Z"
},
"values": {"minimum": 0,
"maximum": 0,
"average": 0,
"median": 0,
"p75": 0,
"p95": 0,
"projected_low_threshold": 0,
"projected_middle_threshold": 0,
"projected_high_threshold": 0
}
}
]
}
]
}
}

external

Store KPI Result

Is implemented on common-backend, not to be implemented on the calculator.

path Parameters

required

string

query Parameters

is_for_cache

boolean

Request Body schema: application/json

Any request body sent as JSON will be cached.

object

Responses

Request samples

Payload

Content type

application/json

{ }