Create document
curl --request POST \
--url https://api.clinikapi.com/v1/documents \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"type": "<string>",
"patientId": "<string>",
"practitionerId": "<string>",
"title": "<string>",
"sections": [
{
"title": "<string>",
"text": "<string>",
"code": "<string>",
"resourceIds": [
"<string>"
],
"authorId": "<string>",
"sections": [
{
"title": "<string>",
"code": "<string>",
"text": "<string>"
}
]
}
],
"category": [
"<string>"
],
"encounterId": "<string>",
"date": "2023-11-07T05:31:56Z",
"attester": [
{
"time": "2023-11-07T05:31:56Z",
"partyId": "<string>"
}
],
"custodianId": "<string>",
"relatesTo": [
{
"targetId": "<string>"
}
],
"event": [
{
"code": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"period": {
"start": "<string>",
"end": "<string>"
},
"detailIds": [
"<string>"
]
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/documents"
payload = {
"type": "<string>",
"patientId": "<string>",
"practitionerId": "<string>",
"title": "<string>",
"sections": [
{
"title": "<string>",
"text": "<string>",
"code": "<string>",
"resourceIds": ["<string>"],
"authorId": "<string>",
"sections": [
{
"title": "<string>",
"code": "<string>",
"text": "<string>"
}
]
}
],
"category": ["<string>"],
"encounterId": "<string>",
"date": "2023-11-07T05:31:56Z",
"attester": [
{
"time": "2023-11-07T05:31:56Z",
"partyId": "<string>"
}
],
"custodianId": "<string>",
"relatesTo": [{ "targetId": "<string>" }],
"event": [
{
"code": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"period": {
"start": "<string>",
"end": "<string>"
},
"detailIds": ["<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({
type: '<string>',
patientId: '<string>',
practitionerId: '<string>',
title: '<string>',
sections: [
{
title: '<string>',
text: '<string>',
code: '<string>',
resourceIds: ['<string>'],
authorId: '<string>',
sections: [{title: '<string>', code: '<string>', text: '<string>'}]
}
],
category: ['<string>'],
encounterId: '<string>',
date: '2023-11-07T05:31:56Z',
attester: [{time: '2023-11-07T05:31:56Z', partyId: '<string>'}],
custodianId: '<string>',
relatesTo: [{targetId: '<string>'}],
event: [
{
code: [{system: '<string>', code: '<string>', display: '<string>'}],
period: {start: '<string>', end: '<string>'},
detailIds: ['<string>']
}
]
})
};
fetch('https://api.clinikapi.com/v1/documents', 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/documents",
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([
'type' => '<string>',
'patientId' => '<string>',
'practitionerId' => '<string>',
'title' => '<string>',
'sections' => [
[
'title' => '<string>',
'text' => '<string>',
'code' => '<string>',
'resourceIds' => [
'<string>'
],
'authorId' => '<string>',
'sections' => [
[
'title' => '<string>',
'code' => '<string>',
'text' => '<string>'
]
]
]
],
'category' => [
'<string>'
],
'encounterId' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'attester' => [
[
'time' => '2023-11-07T05:31:56Z',
'partyId' => '<string>'
]
],
'custodianId' => '<string>',
'relatesTo' => [
[
'targetId' => '<string>'
]
],
'event' => [
[
'code' => [
[
'system' => '<string>',
'code' => '<string>',
'display' => '<string>'
]
],
'period' => [
'start' => '<string>',
'end' => '<string>'
],
'detailIds' => [
'<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/documents"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"title\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"code\": \"<string>\",\n \"resourceIds\": [\n \"<string>\"\n ],\n \"authorId\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ]\n }\n ],\n \"category\": [\n \"<string>\"\n ],\n \"encounterId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"attester\": [\n {\n \"time\": \"2023-11-07T05:31:56Z\",\n \"partyId\": \"<string>\"\n }\n ],\n \"custodianId\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"event\": [\n {\n \"code\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"detailIds\": [\n \"<string>\"\n ]\n }\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/documents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"title\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"code\": \"<string>\",\n \"resourceIds\": [\n \"<string>\"\n ],\n \"authorId\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ]\n }\n ],\n \"category\": [\n \"<string>\"\n ],\n \"encounterId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"attester\": [\n {\n \"time\": \"2023-11-07T05:31:56Z\",\n \"partyId\": \"<string>\"\n }\n ],\n \"custodianId\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"event\": [\n {\n \"code\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"detailIds\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/documents")
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 \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"title\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"code\": \"<string>\",\n \"resourceIds\": [\n \"<string>\"\n ],\n \"authorId\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ]\n }\n ],\n \"category\": [\n \"<string>\"\n ],\n \"encounterId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"attester\": [\n {\n \"time\": \"2023-11-07T05:31:56Z\",\n \"partyId\": \"<string>\"\n }\n ],\n \"custodianId\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"event\": [\n {\n \"code\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"detailIds\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyDocuments
Create Document
POST
/
v1
/
documents
Create document
curl --request POST \
--url https://api.clinikapi.com/v1/documents \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"type": "<string>",
"patientId": "<string>",
"practitionerId": "<string>",
"title": "<string>",
"sections": [
{
"title": "<string>",
"text": "<string>",
"code": "<string>",
"resourceIds": [
"<string>"
],
"authorId": "<string>",
"sections": [
{
"title": "<string>",
"code": "<string>",
"text": "<string>"
}
]
}
],
"category": [
"<string>"
],
"encounterId": "<string>",
"date": "2023-11-07T05:31:56Z",
"attester": [
{
"time": "2023-11-07T05:31:56Z",
"partyId": "<string>"
}
],
"custodianId": "<string>",
"relatesTo": [
{
"targetId": "<string>"
}
],
"event": [
{
"code": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"period": {
"start": "<string>",
"end": "<string>"
},
"detailIds": [
"<string>"
]
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/documents"
payload = {
"type": "<string>",
"patientId": "<string>",
"practitionerId": "<string>",
"title": "<string>",
"sections": [
{
"title": "<string>",
"text": "<string>",
"code": "<string>",
"resourceIds": ["<string>"],
"authorId": "<string>",
"sections": [
{
"title": "<string>",
"code": "<string>",
"text": "<string>"
}
]
}
],
"category": ["<string>"],
"encounterId": "<string>",
"date": "2023-11-07T05:31:56Z",
"attester": [
{
"time": "2023-11-07T05:31:56Z",
"partyId": "<string>"
}
],
"custodianId": "<string>",
"relatesTo": [{ "targetId": "<string>" }],
"event": [
{
"code": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"period": {
"start": "<string>",
"end": "<string>"
},
"detailIds": ["<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({
type: '<string>',
patientId: '<string>',
practitionerId: '<string>',
title: '<string>',
sections: [
{
title: '<string>',
text: '<string>',
code: '<string>',
resourceIds: ['<string>'],
authorId: '<string>',
sections: [{title: '<string>', code: '<string>', text: '<string>'}]
}
],
category: ['<string>'],
encounterId: '<string>',
date: '2023-11-07T05:31:56Z',
attester: [{time: '2023-11-07T05:31:56Z', partyId: '<string>'}],
custodianId: '<string>',
relatesTo: [{targetId: '<string>'}],
event: [
{
code: [{system: '<string>', code: '<string>', display: '<string>'}],
period: {start: '<string>', end: '<string>'},
detailIds: ['<string>']
}
]
})
};
fetch('https://api.clinikapi.com/v1/documents', 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/documents",
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([
'type' => '<string>',
'patientId' => '<string>',
'practitionerId' => '<string>',
'title' => '<string>',
'sections' => [
[
'title' => '<string>',
'text' => '<string>',
'code' => '<string>',
'resourceIds' => [
'<string>'
],
'authorId' => '<string>',
'sections' => [
[
'title' => '<string>',
'code' => '<string>',
'text' => '<string>'
]
]
]
],
'category' => [
'<string>'
],
'encounterId' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'attester' => [
[
'time' => '2023-11-07T05:31:56Z',
'partyId' => '<string>'
]
],
'custodianId' => '<string>',
'relatesTo' => [
[
'targetId' => '<string>'
]
],
'event' => [
[
'code' => [
[
'system' => '<string>',
'code' => '<string>',
'display' => '<string>'
]
],
'period' => [
'start' => '<string>',
'end' => '<string>'
],
'detailIds' => [
'<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/documents"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"title\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"code\": \"<string>\",\n \"resourceIds\": [\n \"<string>\"\n ],\n \"authorId\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ]\n }\n ],\n \"category\": [\n \"<string>\"\n ],\n \"encounterId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"attester\": [\n {\n \"time\": \"2023-11-07T05:31:56Z\",\n \"partyId\": \"<string>\"\n }\n ],\n \"custodianId\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"event\": [\n {\n \"code\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"detailIds\": [\n \"<string>\"\n ]\n }\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/documents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"title\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"code\": \"<string>\",\n \"resourceIds\": [\n \"<string>\"\n ],\n \"authorId\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ]\n }\n ],\n \"category\": [\n \"<string>\"\n ],\n \"encounterId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"attester\": [\n {\n \"time\": \"2023-11-07T05:31:56Z\",\n \"partyId\": \"<string>\"\n }\n ],\n \"custodianId\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"event\": [\n {\n \"code\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"detailIds\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/documents")
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 \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"practitionerId\": \"<string>\",\n \"title\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"code\": \"<string>\",\n \"resourceIds\": [\n \"<string>\"\n ],\n \"authorId\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"code\": \"<string>\",\n \"text\": \"<string>\"\n }\n ]\n }\n ],\n \"category\": [\n \"<string>\"\n ],\n \"encounterId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"attester\": [\n {\n \"time\": \"2023-11-07T05:31:56Z\",\n \"partyId\": \"<string>\"\n }\n ],\n \"custodianId\": \"<string>\",\n \"relatesTo\": [\n {\n \"targetId\": \"<string>\"\n }\n ],\n \"event\": [\n {\n \"code\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"detailIds\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
preliminary, final, amended Document type (discharge-summary, referral-letter, care-plan, etc.)
Maximum string length:
100Maximum string length:
500Required array length:
1 - 50 elementsShow child attributes
Show child attributes
Document categories for classification
Maximum string length:
200N (normal), R (restricted), V (very restricted)
Available options:
N, R, V Who attested to the accuracy of the document
Show child attributes
Show child attributes
Organization maintaining the document
Relationships to other compositions/documents
Show child attributes
Show child attributes
Clinical services being documented
Show child attributes
Show child attributes
Response
201
Document created
⌘I