Create clinical note
curl --request POST \
--url https://api.clinikapi.com/v1/notes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"title": "<string>",
"content": "<string>",
"authorId": "<string>",
"encounterId": "<string>",
"contentType": "text/plain",
"category": "<string>",
"date": "<string>",
"relatesTo": [
{
"targetId": "<string>"
}
],
"securityLabel": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"authenticatorId": "<string>",
"custodianId": "<string>",
"servicePeriod": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"facilityType": "<string>",
"practiceSetting": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/notes"
payload = {
"patientId": "<string>",
"title": "<string>",
"content": "<string>",
"authorId": "<string>",
"encounterId": "<string>",
"contentType": "text/plain",
"category": "<string>",
"date": "<string>",
"relatesTo": [{ "targetId": "<string>" }],
"securityLabel": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"authenticatorId": "<string>",
"custodianId": "<string>",
"servicePeriod": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"facilityType": "<string>",
"practiceSetting": "<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>',
title: '<string>',
content: '<string>',
authorId: '<string>',
encounterId: '<string>',
contentType: 'text/plain',
category: '<string>',
date: '<string>',
relatesTo: [{targetId: '<string>'}],
securityLabel: [{system: '<string>', code: '<string>', display: '<string>'}],
authenticatorId: '<string>',
custodianId: '<string>',
servicePeriod: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
facilityType: '<string>',
practiceSetting: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/notes', 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/notes",
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>',
'title' => '<string>',
'content' => '<string>',
'authorId' => '<string>',
'encounterId' => '<string>',
'contentType' => 'text/plain',
'category' => '<string>',
'date' => '<string>',
'relatesTo' => [
[
'targetId' => '<string>'
]
],
'securityLabel' => [
[
'system' => '<string>',
'code' => '<string>',
'display' => '<string>'
]
],
'authenticatorId' => '<string>',
'custodianId' => '<string>',
'servicePeriod' => [
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z'
],
'facilityType' => '<string>',
'practiceSetting' => '<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/notes"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"authorId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"contentType\": \"text/plain\",\n \"category\": \"<string>\",\n \"date\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"securityLabel\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"authenticatorId\": \"<string>\",\n \"custodianId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"facilityType\": \"<string>\",\n \"practiceSetting\": \"<string>\"\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/notes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"authorId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"contentType\": \"text/plain\",\n \"category\": \"<string>\",\n \"date\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"securityLabel\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"authenticatorId\": \"<string>\",\n \"custodianId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"facilityType\": \"<string>\",\n \"practiceSetting\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/notes")
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 \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"authorId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"contentType\": \"text/plain\",\n \"category\": \"<string>\",\n \"date\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"securityLabel\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"authenticatorId\": \"<string>\",\n \"custodianId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"facilityType\": \"<string>\",\n \"practiceSetting\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyNotes
Create Note
POST
/
v1
/
notes
Create clinical note
curl --request POST \
--url https://api.clinikapi.com/v1/notes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"title": "<string>",
"content": "<string>",
"authorId": "<string>",
"encounterId": "<string>",
"contentType": "text/plain",
"category": "<string>",
"date": "<string>",
"relatesTo": [
{
"targetId": "<string>"
}
],
"securityLabel": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"authenticatorId": "<string>",
"custodianId": "<string>",
"servicePeriod": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"facilityType": "<string>",
"practiceSetting": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/notes"
payload = {
"patientId": "<string>",
"title": "<string>",
"content": "<string>",
"authorId": "<string>",
"encounterId": "<string>",
"contentType": "text/plain",
"category": "<string>",
"date": "<string>",
"relatesTo": [{ "targetId": "<string>" }],
"securityLabel": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"authenticatorId": "<string>",
"custodianId": "<string>",
"servicePeriod": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"facilityType": "<string>",
"practiceSetting": "<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>',
title: '<string>',
content: '<string>',
authorId: '<string>',
encounterId: '<string>',
contentType: 'text/plain',
category: '<string>',
date: '<string>',
relatesTo: [{targetId: '<string>'}],
securityLabel: [{system: '<string>', code: '<string>', display: '<string>'}],
authenticatorId: '<string>',
custodianId: '<string>',
servicePeriod: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
facilityType: '<string>',
practiceSetting: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/notes', 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/notes",
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>',
'title' => '<string>',
'content' => '<string>',
'authorId' => '<string>',
'encounterId' => '<string>',
'contentType' => 'text/plain',
'category' => '<string>',
'date' => '<string>',
'relatesTo' => [
[
'targetId' => '<string>'
]
],
'securityLabel' => [
[
'system' => '<string>',
'code' => '<string>',
'display' => '<string>'
]
],
'authenticatorId' => '<string>',
'custodianId' => '<string>',
'servicePeriod' => [
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z'
],
'facilityType' => '<string>',
'practiceSetting' => '<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/notes"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"authorId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"contentType\": \"text/plain\",\n \"category\": \"<string>\",\n \"date\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"securityLabel\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"authenticatorId\": \"<string>\",\n \"custodianId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"facilityType\": \"<string>\",\n \"practiceSetting\": \"<string>\"\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/notes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"authorId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"contentType\": \"text/plain\",\n \"category\": \"<string>\",\n \"date\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"securityLabel\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"authenticatorId\": \"<string>\",\n \"custodianId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"facilityType\": \"<string>\",\n \"practiceSetting\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/notes")
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 \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"authorId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"contentType\": \"text/plain\",\n \"category\": \"<string>\",\n \"date\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"securityLabel\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"authenticatorId\": \"<string>\",\n \"custodianId\": \"<string>\",\n \"servicePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"facilityType\": \"<string>\",\n \"practiceSetting\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Maximum string length:
500Maximum string length:
100000Practitioner who authored the note
Available options:
progress-note, discharge-summary, consultation-note, history-and-physical, operative-note, procedure-note, referral-note, transfer-summary, other Available options:
preliminary, final, amended Maximum string length:
100Relationships to other documents
Show child attributes
Show child attributes
Document security tags
Show child attributes
Show child attributes
Who authenticated the document (Practitioner ID)
Organization maintaining the document
Time period of the clinical service documented
Show child attributes
Show child attributes
Kind of facility where patient was seen
Maximum string length:
200Clinical specialty (e.g. cardiology, oncology)
Maximum string length:
200Response
201
Note created
⌘I