Create assessment
curl --request POST \
--url https://api.clinikapi.com/v1/assessments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"summary": "<string>",
"statusReason": "<string>",
"encounterId": "<string>",
"practitionerId": "<string>",
"code": "<string>",
"description": "<string>",
"findings": [
{
"code": "<string>",
"text": "<string>",
"basis": "<string>"
}
],
"note": "<string>",
"effectiveDateTime": "2023-11-07T05:31:56Z",
"date": "2023-11-07T05:31:56Z",
"previousAssessmentId": "<string>",
"problemIds": [
"<string>"
],
"investigations": [
{
"name": "<string>",
"itemIds": [
"<string>"
]
}
],
"protocol": [
"<string>"
],
"prognosis": [
{
"code": "<string>",
"text": "<string>"
}
],
"supportingInfoIds": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/assessments"
payload = {
"patientId": "<string>",
"summary": "<string>",
"statusReason": "<string>",
"encounterId": "<string>",
"practitionerId": "<string>",
"code": "<string>",
"description": "<string>",
"findings": [
{
"code": "<string>",
"text": "<string>",
"basis": "<string>"
}
],
"note": "<string>",
"effectiveDateTime": "2023-11-07T05:31:56Z",
"date": "2023-11-07T05:31:56Z",
"previousAssessmentId": "<string>",
"problemIds": ["<string>"],
"investigations": [
{
"name": "<string>",
"itemIds": ["<string>"]
}
],
"protocol": ["<string>"],
"prognosis": [
{
"code": "<string>",
"text": "<string>"
}
],
"supportingInfoIds": ["<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>',
summary: '<string>',
statusReason: '<string>',
encounterId: '<string>',
practitionerId: '<string>',
code: '<string>',
description: '<string>',
findings: [{code: '<string>', text: '<string>', basis: '<string>'}],
note: '<string>',
effectiveDateTime: '2023-11-07T05:31:56Z',
date: '2023-11-07T05:31:56Z',
previousAssessmentId: '<string>',
problemIds: ['<string>'],
investigations: [{name: '<string>', itemIds: ['<string>']}],
protocol: ['<string>'],
prognosis: [{code: '<string>', text: '<string>'}],
supportingInfoIds: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/assessments', 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/assessments",
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>',
'summary' => '<string>',
'statusReason' => '<string>',
'encounterId' => '<string>',
'practitionerId' => '<string>',
'code' => '<string>',
'description' => '<string>',
'findings' => [
[
'code' => '<string>',
'text' => '<string>',
'basis' => '<string>'
]
],
'note' => '<string>',
'effectiveDateTime' => '2023-11-07T05:31:56Z',
'date' => '2023-11-07T05:31:56Z',
'previousAssessmentId' => '<string>',
'problemIds' => [
'<string>'
],
'investigations' => [
[
'name' => '<string>',
'itemIds' => [
'<string>'
]
]
],
'protocol' => [
'<string>'
],
'prognosis' => [
[
'code' => '<string>',
'text' => '<string>'
]
],
'supportingInfoIds' => [
'<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/assessments"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"summary\": \"<string>\",\n \"statusReason\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"findings\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\",\n \"basis\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"previousAssessmentId\": \"<string>\",\n \"problemIds\": [\n \"<string>\"\n ],\n \"investigations\": [\n {\n \"name\": \"<string>\",\n \"itemIds\": [\n \"<string>\"\n ]\n }\n ],\n \"protocol\": [\n \"<string>\"\n ],\n \"prognosis\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"supportingInfoIds\": [\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/assessments")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"summary\": \"<string>\",\n \"statusReason\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"findings\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\",\n \"basis\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"previousAssessmentId\": \"<string>\",\n \"problemIds\": [\n \"<string>\"\n ],\n \"investigations\": [\n {\n \"name\": \"<string>\",\n \"itemIds\": [\n \"<string>\"\n ]\n }\n ],\n \"protocol\": [\n \"<string>\"\n ],\n \"prognosis\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"supportingInfoIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/assessments")
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 \"summary\": \"<string>\",\n \"statusReason\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"findings\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\",\n \"basis\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"previousAssessmentId\": \"<string>\",\n \"problemIds\": [\n \"<string>\"\n ],\n \"investigations\": [\n {\n \"name\": \"<string>\",\n \"itemIds\": [\n \"<string>\"\n ]\n }\n ],\n \"protocol\": [\n \"<string>\"\n ],\n \"prognosis\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"supportingInfoIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyAssessments
Create Assessment
POST
/
v1
/
assessments
Create assessment
curl --request POST \
--url https://api.clinikapi.com/v1/assessments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"summary": "<string>",
"statusReason": "<string>",
"encounterId": "<string>",
"practitionerId": "<string>",
"code": "<string>",
"description": "<string>",
"findings": [
{
"code": "<string>",
"text": "<string>",
"basis": "<string>"
}
],
"note": "<string>",
"effectiveDateTime": "2023-11-07T05:31:56Z",
"date": "2023-11-07T05:31:56Z",
"previousAssessmentId": "<string>",
"problemIds": [
"<string>"
],
"investigations": [
{
"name": "<string>",
"itemIds": [
"<string>"
]
}
],
"protocol": [
"<string>"
],
"prognosis": [
{
"code": "<string>",
"text": "<string>"
}
],
"supportingInfoIds": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/assessments"
payload = {
"patientId": "<string>",
"summary": "<string>",
"statusReason": "<string>",
"encounterId": "<string>",
"practitionerId": "<string>",
"code": "<string>",
"description": "<string>",
"findings": [
{
"code": "<string>",
"text": "<string>",
"basis": "<string>"
}
],
"note": "<string>",
"effectiveDateTime": "2023-11-07T05:31:56Z",
"date": "2023-11-07T05:31:56Z",
"previousAssessmentId": "<string>",
"problemIds": ["<string>"],
"investigations": [
{
"name": "<string>",
"itemIds": ["<string>"]
}
],
"protocol": ["<string>"],
"prognosis": [
{
"code": "<string>",
"text": "<string>"
}
],
"supportingInfoIds": ["<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>',
summary: '<string>',
statusReason: '<string>',
encounterId: '<string>',
practitionerId: '<string>',
code: '<string>',
description: '<string>',
findings: [{code: '<string>', text: '<string>', basis: '<string>'}],
note: '<string>',
effectiveDateTime: '2023-11-07T05:31:56Z',
date: '2023-11-07T05:31:56Z',
previousAssessmentId: '<string>',
problemIds: ['<string>'],
investigations: [{name: '<string>', itemIds: ['<string>']}],
protocol: ['<string>'],
prognosis: [{code: '<string>', text: '<string>'}],
supportingInfoIds: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/assessments', 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/assessments",
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>',
'summary' => '<string>',
'statusReason' => '<string>',
'encounterId' => '<string>',
'practitionerId' => '<string>',
'code' => '<string>',
'description' => '<string>',
'findings' => [
[
'code' => '<string>',
'text' => '<string>',
'basis' => '<string>'
]
],
'note' => '<string>',
'effectiveDateTime' => '2023-11-07T05:31:56Z',
'date' => '2023-11-07T05:31:56Z',
'previousAssessmentId' => '<string>',
'problemIds' => [
'<string>'
],
'investigations' => [
[
'name' => '<string>',
'itemIds' => [
'<string>'
]
]
],
'protocol' => [
'<string>'
],
'prognosis' => [
[
'code' => '<string>',
'text' => '<string>'
]
],
'supportingInfoIds' => [
'<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/assessments"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"summary\": \"<string>\",\n \"statusReason\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"findings\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\",\n \"basis\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"previousAssessmentId\": \"<string>\",\n \"problemIds\": [\n \"<string>\"\n ],\n \"investigations\": [\n {\n \"name\": \"<string>\",\n \"itemIds\": [\n \"<string>\"\n ]\n }\n ],\n \"protocol\": [\n \"<string>\"\n ],\n \"prognosis\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"supportingInfoIds\": [\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/assessments")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"summary\": \"<string>\",\n \"statusReason\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"findings\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\",\n \"basis\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"previousAssessmentId\": \"<string>\",\n \"problemIds\": [\n \"<string>\"\n ],\n \"investigations\": [\n {\n \"name\": \"<string>\",\n \"itemIds\": [\n \"<string>\"\n ]\n }\n ],\n \"protocol\": [\n \"<string>\"\n ],\n \"prognosis\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"supportingInfoIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/assessments")
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 \"summary\": \"<string>\",\n \"statusReason\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"findings\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\",\n \"basis\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"previousAssessmentId\": \"<string>\",\n \"problemIds\": [\n \"<string>\"\n ],\n \"investigations\": [\n {\n \"name\": \"<string>\",\n \"itemIds\": [\n \"<string>\"\n ]\n }\n ],\n \"protocol\": [\n \"<string>\"\n ],\n \"prognosis\": [\n {\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"supportingInfoIds\": [\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:
in-progress, completed Maximum string length:
5000Reason for current status
Maximum string length:
500Kind of assessment (initial-assessment, follow-up, discharge)
Maximum string length:
200Maximum string length:
2000Maximum array length:
50Show child attributes
Show child attributes
Maximum string length:
2000When the assessment was documented (defaults to now)
Reference to the previous assessment for this patient
Condition or AllergyIntolerance IDs being assessed
Sets of investigations (labs, imaging, questionnaires)
Maximum array length:
20Show child attributes
Show child attributes
Clinical protocol URIs followed
Prognosis codes (good, poor, guarded)
Maximum array length:
10Show child attributes
Show child attributes
Supporting information references
Response
201
Assessment created
⌘I