The Task object.
Name | Type | Description |
---|---|---|
id | UUID | A unique identifier. |
title | string | |
description | string? | |
completed_at | DateTime? | Date and time, in ISO 8601 format, when the task was completed. |
priority | "URGENT" | "HIGH" | "MEDIUM" | "LOW"? | |
patient_id | UUID? | A unique identifier. |
author | Author(id: UUID, gender: "MALE" | "FEMALE"?, first_name: string, last_name: string, phone: string?, email: string?, prefix: string?, title: string?, timezone: string?, roles: "ADMINISTRATOR" | "PRACTITIONER" | "REVIEWER"[], biography: string?, metadata: JSON?, ephemeral_avatar_url: undefined?, self_login_enabled: boolean) | The Provider object. |
assigned_provider_id | UUID? | A unique identifier. |
is_assigned_to_patient | boolean? | |
medical_order_id | UUID? | The id of the medical order to which the task is linked. |
metadata | JSON? | You can use this parameter to attach key-value data to the object. All values must be of type string. |
Example
{
"id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"title": "Take a rest",
"description": "Once a day",
"completed_at": "2022-03-10T19:16:23.456Z",
"priority": "URGENT",
"patient_id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"author": {
"id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"gender": "FEMALE",
"first_name": "Jane",
"last_name": "Doe",
"phone": "+33612356789",
"email": "example_string",
"prefix": "Pr",
"title": "Professor",
"timezone": "Europe/Paris",
"roles": [
"ADMINISTRATOR"
],
"biography": "Dr John Doe, MD is a graduate of George Washington University School of Medicine.",
"metadata": {
"example_key": "example_string"
},
"ephemeral_avatar_url": {
"url": "https://example.com",
"expires_at": "2022-06-24T14:36:22"
},
"self_login_enabled": true
},
"assigned_provider_id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"is_assigned_to_patient": true,
"medical_order_id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"metadata": {
"example_key": "example_string"
}
}