Skip to main content
POST
/
v1
/
goals
Create goal
curl --request POST \
  --url https://api.clinikapi.com/v1/goals \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "description": "<string>",
  "patientId": "<string>",
  "category": [
    "<string>"
  ],
  "startDate": "<string>",
  "target": [
    {
      "measure": "<string>",
      "detailString": "<string>",
      "detailQuantity": {
        "value": 123,
        "unit": "<string>"
      },
      "dueDate": "<string>"
    }
  ],
  "statusDate": "<string>",
  "statusReason": "<string>",
  "expressedById": "<string>",
  "addressesIds": [
    "<string>"
  ],
  "note": "<string>",
  "outcomeCode": [
    "<string>"
  ]
}
'

Authorizations

​
x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
​
lifecycleStatus
enum<string>
required
Available options:
proposed,
planned,
accepted,
active,
on-hold,
completed,
cancelled,
rejected
​
description
string
required
Maximum string length: 2000
​
patientId
string
required
Maximum string length: 128
​
achievementStatus
enum<string>
Available options:
in-progress,
improving,
worsening,
no-change,
achieved,
sustaining,
not-achieved,
no-progress,
not-attainable
​
category
string[]
Maximum array length: 10
Maximum string length: 200
​
priority
enum<string>
Available options:
high-priority,
medium-priority,
low-priority
​
startDate
string
​
target
object[]
Maximum array length: 20
​
statusDate
string
​
statusReason
string
Maximum string length: 2000
​
expressedById
string
Maximum string length: 128
​
addressesIds
string[]
Maximum array length: 20
Maximum string length: 200
​
note
string
Maximum string length: 5000
​
outcomeCode
string[]
Maximum array length: 20
Maximum string length: 500

Response

201

Goal created