Skip to main content
POST
/
v1
/
care-plans
Create care plan
curl --request POST \
  --url https://api.clinikapi.com/v1/care-plans \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "patientId": "<string>",
  "encounterId": "<string>",
  "title": "<string>",
  "description": "<string>",
  "category": [
    "<string>"
  ],
  "period": {
    "start": "<string>",
    "end": "<string>"
  },
  "created": "<string>",
  "authorId": "<string>",
  "contributorIds": [
    "<string>"
  ],
  "careTeamIds": [
    "<string>"
  ],
  "addressesIds": [
    "<string>"
  ],
  "goalIds": [
    "<string>"
  ],
  "note": "<string>",
  "activity": [
    {
      "description": "<string>",
      "status": "<string>",
      "code": "<string>",
      "scheduledString": "<string>",
      "performerId": "<string>",
      "referenceId": "<string>"
    }
  ],
  "basedOn": [
    "<string>"
  ],
  "replaces": [
    "<string>"
  ],
  "partOf": [
    "<string>"
  ]
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
draft,
active,
on-hold,
revoked,
completed
intent
enum<string>
required
Available options:
proposal,
plan,
order,
option
patientId
string
required
Maximum string length: 128
encounterId
string
Maximum string length: 128
title
string
Maximum string length: 500
description
string
Maximum string length: 5000
category
string[]
Maximum array length: 10
Maximum string length: 200
period
object
created
string
Maximum string length: 50
authorId
string
Maximum string length: 128
contributorIds
string[]
Maximum array length: 20
Maximum string length: 128
careTeamIds
string[]
Maximum array length: 20
Maximum string length: 128
addressesIds
string[]
Maximum array length: 20
Maximum string length: 128
goalIds
string[]
Maximum array length: 20
Maximum string length: 128
note
string
Maximum string length: 5000
activity
object[]
Maximum array length: 50
basedOn
string[]
Maximum array length: 10
Maximum string length: 128
replaces
string[]
Maximum array length: 10
Maximum string length: 128
partOf
string[]
Maximum array length: 10
Maximum string length: 128

Response

201

Care plan created