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>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/care-plans"
payload = {
"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>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>']
})
};
fetch('https://api.clinikapi.com/v1/care-plans', 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.clinikapi.com/v1/care-plans",
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([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.clinikapi.com/v1/care-plans"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"created\": \"<string>\",\n \"authorId\": \"<string>\",\n \"contributorIds\": [\n \"<string>\"\n ],\n \"careTeamIds\": [\n \"<string>\"\n ],\n \"addressesIds\": [\n \"<string>\"\n ],\n \"goalIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"activity\": [\n {\n \"description\": \"<string>\",\n \"status\": \"<string>\",\n \"code\": \"<string>\",\n \"scheduledString\": \"<string>\",\n \"performerId\": \"<string>\",\n \"referenceId\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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.clinikapi.com/v1/care-plans")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"created\": \"<string>\",\n \"authorId\": \"<string>\",\n \"contributorIds\": [\n \"<string>\"\n ],\n \"careTeamIds\": [\n \"<string>\"\n ],\n \"addressesIds\": [\n \"<string>\"\n ],\n \"goalIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"activity\": [\n {\n \"description\": \"<string>\",\n \"status\": \"<string>\",\n \"code\": \"<string>\",\n \"scheduledString\": \"<string>\",\n \"performerId\": \"<string>\",\n \"referenceId\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/care-plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"created\": \"<string>\",\n \"authorId\": \"<string>\",\n \"contributorIds\": [\n \"<string>\"\n ],\n \"careTeamIds\": [\n \"<string>\"\n ],\n \"addressesIds\": [\n \"<string>\"\n ],\n \"goalIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"activity\": [\n {\n \"description\": \"<string>\",\n \"status\": \"<string>\",\n \"code\": \"<string>\",\n \"scheduledString\": \"<string>\",\n \"performerId\": \"<string>\",\n \"referenceId\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyCare Plans
Create Care Plan
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>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/care-plans"
payload = {
"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>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>']
})
};
fetch('https://api.clinikapi.com/v1/care-plans', 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.clinikapi.com/v1/care-plans",
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([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.clinikapi.com/v1/care-plans"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"created\": \"<string>\",\n \"authorId\": \"<string>\",\n \"contributorIds\": [\n \"<string>\"\n ],\n \"careTeamIds\": [\n \"<string>\"\n ],\n \"addressesIds\": [\n \"<string>\"\n ],\n \"goalIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"activity\": [\n {\n \"description\": \"<string>\",\n \"status\": \"<string>\",\n \"code\": \"<string>\",\n \"scheduledString\": \"<string>\",\n \"performerId\": \"<string>\",\n \"referenceId\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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.clinikapi.com/v1/care-plans")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"created\": \"<string>\",\n \"authorId\": \"<string>\",\n \"contributorIds\": [\n \"<string>\"\n ],\n \"careTeamIds\": [\n \"<string>\"\n ],\n \"addressesIds\": [\n \"<string>\"\n ],\n \"goalIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"activity\": [\n {\n \"description\": \"<string>\",\n \"status\": \"<string>\",\n \"code\": \"<string>\",\n \"scheduledString\": \"<string>\",\n \"performerId\": \"<string>\",\n \"referenceId\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/care-plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"created\": \"<string>\",\n \"authorId\": \"<string>\",\n \"contributorIds\": [\n \"<string>\"\n ],\n \"careTeamIds\": [\n \"<string>\"\n ],\n \"addressesIds\": [\n \"<string>\"\n ],\n \"goalIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"activity\": [\n {\n \"description\": \"<string>\",\n \"status\": \"<string>\",\n \"code\": \"<string>\",\n \"scheduledString\": \"<string>\",\n \"performerId\": \"<string>\",\n \"referenceId\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\n ],\n \"partOf\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
draft, active, on-hold, revoked, completed Available options:
proposal, plan, order, option Maximum string length:
128Maximum string length:
128Maximum string length:
500Maximum string length:
5000Maximum array length:
10Maximum string length:
200Show child attributes
Show child attributes
Maximum string length:
50Maximum string length:
128Maximum array length:
20Maximum string length:
128Maximum array length:
20Maximum string length:
128Maximum array length:
20Maximum string length:
128Maximum array length:
20Maximum string length:
128Maximum string length:
5000Maximum array length:
50Show child attributes
Show child attributes
Maximum array length:
10Maximum string length:
128Maximum array length:
10Maximum string length:
128Maximum array length:
10Maximum string length:
128Response
201
Care plan created
⌘I