TasksV3

Create task

Beta
POST
https://api.joincandidhealth.com/api/tasks/v3

Request

This endpoint expects an object.
encounter_id
UUID
task_type
enum
description
string
work_queue_id
string
blocks_claim_submission
optional boolean
assignee_user_id
optional UUID
category
optional enum

Response

This endpoint return an object.
task_id
UUID
encounter_id
UUID
task_type
enum
description
string
blocks_claim_submission
boolean
external_id
string
patient_name
string
patient_external_id
string
status
enum
notes
list of objects
created_at
datetime
updated_at
datetime
The time of most recent update to the task only
agg_updated_at
datetime
The time of most recent update to the task or any of its notes
date_of_service
date
assignments
list of objects
payer_name
optional string
payer_id
optional string
category
optional enum
POST
/api/tasks/v3
curl -X POST https://api.joincandidhealth.com/api/tasks/v3 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"task_type": "CUSTOMER_DATA_REQUEST",
"description": "string",
"work_queue_id": "string"
}'
Response
{
"task_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"task_type": "CUSTOMER_DATA_REQUEST",
"description": "string",
"blocks_claim_submission": true,
"external_id": "string",
"patient_name": "string",
"patient_external_id": "string",
"status": "finished",
"notes": [
{
"task_note_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"text": "string",
"created_at": "2023-01-01T00:00:00Z",
"author_name": "string",
"author_organization_name": "string"
}
],
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-01T00:00:00Z",
"agg_updated_at": "2023-01-01T00:00:00Z",
"date_of_service": "2023-01-01",
"assignments": [
{
"task_assignment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"assignee_user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
],
"payer_name": "string",
"payer_id": "string",
"category": "other"
}