Create Task

curl --request POST \
  --url https://api.decodahealth.com/task \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "status": "OPEN",
  "priority": "NORMAL",
  "startDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "patientId": "<string>",
  "assigneeId": "<string>",
  "teamId": "<string>",
  "locationId": "<string>",
  "targetNoteId": "<string>",
  "targetFaxId": "<string>",
  "targetDocumentId": "<string>",
  "sourceNoteId": "<string>",
  "sourceTaskSuggestionId": "<string>"
}
'

import requests

url = "https://api.decodahealth.com/task"

payload = {
    "title": "<string>",
    "description": "<string>",
    "status": "OPEN",
    "priority": "NORMAL",
    "startDate": "2023-11-07T05:31:56Z",
    "dueDate": "2023-11-07T05:31:56Z",
    "patientId": "<string>",
    "assigneeId": "<string>",
    "teamId": "<string>",
    "locationId": "<string>",
    "targetNoteId": "<string>",
    "targetFaxId": "<string>",
    "targetDocumentId": "<string>",
    "sourceNoteId": "<string>",
    "sourceTaskSuggestionId": "<string>"
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    description: '<string>',
    status: 'OPEN',
    priority: 'NORMAL',
    startDate: '2023-11-07T05:31:56Z',
    dueDate: '2023-11-07T05:31:56Z',
    patientId: '<string>',
    assigneeId: '<string>',
    teamId: '<string>',
    locationId: '<string>',
    targetNoteId: '<string>',
    targetFaxId: '<string>',
    targetDocumentId: '<string>',
    sourceNoteId: '<string>',
    sourceTaskSuggestionId: '<string>'
  })
};

fetch('https://api.decodahealth.com/task', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/task",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'status' => 'OPEN',
    'priority' => 'NORMAL',
    'startDate' => '2023-11-07T05:31:56Z',
    'dueDate' => '2023-11-07T05:31:56Z',
    'patientId' => '<string>',
    'assigneeId' => '<string>',
    'teamId' => '<string>',
    'locationId' => '<string>',
    'targetNoteId' => '<string>',
    'targetFaxId' => '<string>',
    'targetDocumentId' => '<string>',
    'sourceNoteId' => '<string>',
    'sourceTaskSuggestionId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/task"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"OPEN\",\n  \"priority\": \"NORMAL\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"patientId\": \"<string>\",\n  \"assigneeId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"targetNoteId\": \"<string>\",\n  \"targetFaxId\": \"<string>\",\n  \"targetDocumentId\": \"<string>\",\n  \"sourceNoteId\": \"<string>\",\n  \"sourceTaskSuggestionId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/task")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"OPEN\",\n  \"priority\": \"NORMAL\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"patientId\": \"<string>\",\n  \"assigneeId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"targetNoteId\": \"<string>\",\n  \"targetFaxId\": \"<string>\",\n  \"targetDocumentId\": \"<string>\",\n  \"sourceNoteId\": \"<string>\",\n  \"sourceTaskSuggestionId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/task")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"OPEN\",\n  \"priority\": \"NORMAL\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"patientId\": \"<string>\",\n  \"assigneeId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"targetNoteId\": \"<string>\",\n  \"targetFaxId\": \"<string>\",\n  \"targetDocumentId\": \"<string>\",\n  \"sourceNoteId\": \"<string>\",\n  \"sourceTaskSuggestionId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "title": "<string>",
  "status": "OPEN",
  "priority": "URGENT",
  "creatorId": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "patientId": "<string>",
  "opportunityId": "<string>",
  "assigneeId": "<string>",
  "teamId": "<string>",
  "locationId": "<string>",
  "targetNoteId": "<string>",
  "targetFaxId": "<string>",
  "targetDocumentId": "<string>",
  "sourceNoteId": "<string>",
  "completedById": "<string>",
  "completedDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "patient": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "assignee": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "team": {
    "id": "<string>",
    "name": "<string>"
  },
  "creator": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "carePlan": {
    "carePlanId": "<string>",
    "stepNumber": 123,
    "carePlanName": "<string>",
    "status": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

task

Create Task

curl --request POST \
  --url https://api.decodahealth.com/task \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "status": "OPEN",
  "priority": "NORMAL",
  "startDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "patientId": "<string>",
  "assigneeId": "<string>",
  "teamId": "<string>",
  "locationId": "<string>",
  "targetNoteId": "<string>",
  "targetFaxId": "<string>",
  "targetDocumentId": "<string>",
  "sourceNoteId": "<string>",
  "sourceTaskSuggestionId": "<string>"
}
'

import requests

url = "https://api.decodahealth.com/task"

payload = {
    "title": "<string>",
    "description": "<string>",
    "status": "OPEN",
    "priority": "NORMAL",
    "startDate": "2023-11-07T05:31:56Z",
    "dueDate": "2023-11-07T05:31:56Z",
    "patientId": "<string>",
    "assigneeId": "<string>",
    "teamId": "<string>",
    "locationId": "<string>",
    "targetNoteId": "<string>",
    "targetFaxId": "<string>",
    "targetDocumentId": "<string>",
    "sourceNoteId": "<string>",
    "sourceTaskSuggestionId": "<string>"
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    description: '<string>',
    status: 'OPEN',
    priority: 'NORMAL',
    startDate: '2023-11-07T05:31:56Z',
    dueDate: '2023-11-07T05:31:56Z',
    patientId: '<string>',
    assigneeId: '<string>',
    teamId: '<string>',
    locationId: '<string>',
    targetNoteId: '<string>',
    targetFaxId: '<string>',
    targetDocumentId: '<string>',
    sourceNoteId: '<string>',
    sourceTaskSuggestionId: '<string>'
  })
};

fetch('https://api.decodahealth.com/task', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/task",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'status' => 'OPEN',
    'priority' => 'NORMAL',
    'startDate' => '2023-11-07T05:31:56Z',
    'dueDate' => '2023-11-07T05:31:56Z',
    'patientId' => '<string>',
    'assigneeId' => '<string>',
    'teamId' => '<string>',
    'locationId' => '<string>',
    'targetNoteId' => '<string>',
    'targetFaxId' => '<string>',
    'targetDocumentId' => '<string>',
    'sourceNoteId' => '<string>',
    'sourceTaskSuggestionId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/task"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"OPEN\",\n  \"priority\": \"NORMAL\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"patientId\": \"<string>\",\n  \"assigneeId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"targetNoteId\": \"<string>\",\n  \"targetFaxId\": \"<string>\",\n  \"targetDocumentId\": \"<string>\",\n  \"sourceNoteId\": \"<string>\",\n  \"sourceTaskSuggestionId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/task")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"OPEN\",\n  \"priority\": \"NORMAL\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"patientId\": \"<string>\",\n  \"assigneeId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"targetNoteId\": \"<string>\",\n  \"targetFaxId\": \"<string>\",\n  \"targetDocumentId\": \"<string>\",\n  \"sourceNoteId\": \"<string>\",\n  \"sourceTaskSuggestionId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/task")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"OPEN\",\n  \"priority\": \"NORMAL\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"patientId\": \"<string>\",\n  \"assigneeId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"targetNoteId\": \"<string>\",\n  \"targetFaxId\": \"<string>\",\n  \"targetDocumentId\": \"<string>\",\n  \"sourceNoteId\": \"<string>\",\n  \"sourceTaskSuggestionId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "title": "<string>",
  "status": "OPEN",
  "priority": "URGENT",
  "creatorId": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "patientId": "<string>",
  "opportunityId": "<string>",
  "assigneeId": "<string>",
  "teamId": "<string>",
  "locationId": "<string>",
  "targetNoteId": "<string>",
  "targetFaxId": "<string>",
  "targetDocumentId": "<string>",
  "sourceNoteId": "<string>",
  "completedById": "<string>",
  "completedDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "patient": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "assignee": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "team": {
    "id": "<string>",
    "name": "<string>"
  },
  "creator": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "carePlan": {
    "carePlanId": "<string>",
    "stepNumber": 123,
    "carePlanName": "<string>",
    "status": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Body

application/json

title

string

required

The title of the task

Minimum string length: 1

description

string | null

Detailed description of the task

status

enum<string>

default:OPEN

The status of the task

Available options:

OPEN,

IN_PROGRESS,

COMPLETED,

CANCELLED

priority

enum<string>

default:NORMAL

The priority of the task

Available options:

URGENT,

HIGH,

NORMAL,

LOW

startDate

string<date-time> | null

When the task should appear on the list

dueDate

string<date-time> | null

When the task is due

patientId

string | null

The patient this task is linked to

assigneeId

string | null

The provider assigned to this task

teamId

string | null

The team to assign this task to for load-balanced resolution

locationId

string | null

The location this task is associated with

targetNoteId

string | null

A note this task is to act on (e.g. a sign-off request); auto-completed when the note is signed off

targetFaxId

string | null

A fax this task is to act on (e.g. a 'Review fax' task); deep-links the task to that fax

targetDocumentId

string | null

A document this task is to act on (a sign-off request); auto-completed when the document is signed off

sourceNoteId

string | null

The note this task originated from (an accepted AI scribe suggestion). Provenance and deep-link only: unlike target_note_id it is NOT auto-completed on sign-off and is not part of the target_* mutual exclusion

sourceTaskSuggestionId

string | null

The AI scribe suggestion this task was accepted from; stamped so its card flips to 'Task created'

Response

Successful Response

string

required

title

string

required

status

enum<string>

required

Available options:

OPEN,

IN_PROGRESS,

COMPLETED,

CANCELLED

priority

enum<string>

required

Available options:

URGENT,

HIGH,

NORMAL,

LOW

creatorId

string

required

createdDate

string<date-time>

required

description

string | null

startDate

string<date-time> | null

dueDate

string<date-time> | null

patientId

string | null

opportunityId

string | null

assigneeId

string | null

teamId

string | null

locationId

string | null

targetNoteId

string | null

targetFaxId

string | null

targetDocumentId

string | null

sourceNoteId

string | null

completedById

string | null

completedDate

string<date-time> | null

updatedDate

string<date-time> | null

patient

PatientRef · object | null

Minimal patient reference for task display (id and name only).

Show child attributes

assignee

ProviderTiny · object | null

Show child attributes

team

TeamRef · object | null

Minimal team reference for task display.

Show child attributes

creator

ProviderTiny · object | null

Show child attributes

carePlan

CarePlanStepTiny · object | null

Minimal care-plan step reference for task/event display.

Show child attributes

Getting Started

API Guides

Patient Management

Billing & Payments

Catalog & Inventory

Growth

Clinical & Scheduling

Communications

Platform

Create Task

Headers

Body

Response