Skip to main content
POST
/
v1
/
care-teams
Create care team
curl --request POST \
  --url https://api.clinikapi.com/v1/care-teams \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "category": [
    "<string>"
  ],
  "patientId": "<string>",
  "encounterId": "<string>",
  "period": {
    "start": "<string>",
    "end": "<string>"
  },
  "participant": [
    {
      "memberId": "<string>",
      "role": "<string>",
      "onBehalfOfId": "<string>",
      "period": {
        "start": "<string>",
        "end": "<string>"
      }
    }
  ],
  "reasonCode": [
    "<string>"
  ],
  "managingOrganizationIds": [
    "<string>"
  ],
  "phone": "<string>",
  "email": "<string>",
  "note": "<string>"
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
name
string
required
Maximum string length: 500
status
enum<string>
Available options:
proposed,
active,
suspended,
inactive
category
string[]
Maximum array length: 10
Maximum string length: 200
patientId
string
Maximum string length: 128
encounterId
string
Maximum string length: 128
period
object
participant
object[]
Maximum array length: 50
reasonCode
string[]
Maximum array length: 10
Maximum string length: 500
managingOrganizationIds
string[]
Maximum array length: 10
Maximum string length: 128
phone
string
Maximum string length: 20
email
string
Maximum string length: 200
note
string
Maximum string length: 5000

Response

201

Care team created