Create lab report
curl --request POST \
--url https://api.clinikapi.com/v1/labs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"code": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"effectiveDateTime": "2023-11-07T05:31:56Z",
"effectivePeriod": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"resultIds": [
"<string>"
],
"category": "<string>",
"conclusion": "<string>",
"conclusionCodes": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"performer": "<string>",
"resultsInterpreter": "<string>",
"specimenIds": [
"<string>"
],
"presentedForm": [
{
"contentType": "<string>",
"data": "<string>",
"url": "<string>",
"title": "<string>"
}
],
"basedOn": [
"<string>"
],
"media": [
{
"comment": "<string>",
"linkId": "<string>"
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/labs"
payload = {
"code": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"effectiveDateTime": "2023-11-07T05:31:56Z",
"effectivePeriod": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"resultIds": ["<string>"],
"category": "<string>",
"conclusion": "<string>",
"conclusionCodes": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"performer": "<string>",
"resultsInterpreter": "<string>",
"specimenIds": ["<string>"],
"presentedForm": [
{
"contentType": "<string>",
"data": "<string>",
"url": "<string>",
"title": "<string>"
}
],
"basedOn": ["<string>"],
"media": [
{
"comment": "<string>",
"linkId": "<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({
code: '<string>',
patientId: '<string>',
encounterId: '<string>',
effectiveDateTime: '2023-11-07T05:31:56Z',
effectivePeriod: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
resultIds: ['<string>'],
category: '<string>',
conclusion: '<string>',
conclusionCodes: [{system: '<string>', code: '<string>', display: '<string>'}],
performer: '<string>',
resultsInterpreter: '<string>',
specimenIds: ['<string>'],
presentedForm: [
{contentType: '<string>', data: '<string>', url: '<string>', title: '<string>'}
],
basedOn: ['<string>'],
media: [{comment: '<string>', linkId: '<string>'}]
})
};
fetch('https://api.clinikapi.com/v1/labs', 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/labs",
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([
'code' => '<string>',
'patientId' => '<string>',
'encounterId' => '<string>',
'effectiveDateTime' => '2023-11-07T05:31:56Z',
'effectivePeriod' => [
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z'
],
'resultIds' => [
'<string>'
],
'category' => '<string>',
'conclusion' => '<string>',
'conclusionCodes' => [
[
'system' => '<string>',
'code' => '<string>',
'display' => '<string>'
]
],
'performer' => '<string>',
'resultsInterpreter' => '<string>',
'specimenIds' => [
'<string>'
],
'presentedForm' => [
[
'contentType' => '<string>',
'data' => '<string>',
'url' => '<string>',
'title' => '<string>'
]
],
'basedOn' => [
'<string>'
],
'media' => [
[
'comment' => '<string>',
'linkId' => '<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/labs"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"effectivePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"resultIds\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"conclusion\": \"<string>\",\n \"conclusionCodes\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"performer\": \"<string>\",\n \"resultsInterpreter\": \"<string>\",\n \"specimenIds\": [\n \"<string>\"\n ],\n \"presentedForm\": [\n {\n \"contentType\": \"<string>\",\n \"data\": \"<string>\",\n \"url\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"media\": [\n {\n \"comment\": \"<string>\",\n \"linkId\": \"<string>\"\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/labs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"effectivePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"resultIds\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"conclusion\": \"<string>\",\n \"conclusionCodes\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"performer\": \"<string>\",\n \"resultsInterpreter\": \"<string>\",\n \"specimenIds\": [\n \"<string>\"\n ],\n \"presentedForm\": [\n {\n \"contentType\": \"<string>\",\n \"data\": \"<string>\",\n \"url\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"media\": [\n {\n \"comment\": \"<string>\",\n \"linkId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/labs")
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 \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"effectivePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"resultIds\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"conclusion\": \"<string>\",\n \"conclusionCodes\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"performer\": \"<string>\",\n \"resultsInterpreter\": \"<string>\",\n \"specimenIds\": [\n \"<string>\"\n ],\n \"presentedForm\": [\n {\n \"contentType\": \"<string>\",\n \"data\": \"<string>\",\n \"url\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"media\": [\n {\n \"comment\": \"<string>\",\n \"linkId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyLabs
Create Lab Report
POST
/
v1
/
labs
Create lab report
curl --request POST \
--url https://api.clinikapi.com/v1/labs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"code": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"effectiveDateTime": "2023-11-07T05:31:56Z",
"effectivePeriod": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"resultIds": [
"<string>"
],
"category": "<string>",
"conclusion": "<string>",
"conclusionCodes": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"performer": "<string>",
"resultsInterpreter": "<string>",
"specimenIds": [
"<string>"
],
"presentedForm": [
{
"contentType": "<string>",
"data": "<string>",
"url": "<string>",
"title": "<string>"
}
],
"basedOn": [
"<string>"
],
"media": [
{
"comment": "<string>",
"linkId": "<string>"
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/labs"
payload = {
"code": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"effectiveDateTime": "2023-11-07T05:31:56Z",
"effectivePeriod": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"resultIds": ["<string>"],
"category": "<string>",
"conclusion": "<string>",
"conclusionCodes": [
{
"system": "<string>",
"code": "<string>",
"display": "<string>"
}
],
"performer": "<string>",
"resultsInterpreter": "<string>",
"specimenIds": ["<string>"],
"presentedForm": [
{
"contentType": "<string>",
"data": "<string>",
"url": "<string>",
"title": "<string>"
}
],
"basedOn": ["<string>"],
"media": [
{
"comment": "<string>",
"linkId": "<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({
code: '<string>',
patientId: '<string>',
encounterId: '<string>',
effectiveDateTime: '2023-11-07T05:31:56Z',
effectivePeriod: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
resultIds: ['<string>'],
category: '<string>',
conclusion: '<string>',
conclusionCodes: [{system: '<string>', code: '<string>', display: '<string>'}],
performer: '<string>',
resultsInterpreter: '<string>',
specimenIds: ['<string>'],
presentedForm: [
{contentType: '<string>', data: '<string>', url: '<string>', title: '<string>'}
],
basedOn: ['<string>'],
media: [{comment: '<string>', linkId: '<string>'}]
})
};
fetch('https://api.clinikapi.com/v1/labs', 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/labs",
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([
'code' => '<string>',
'patientId' => '<string>',
'encounterId' => '<string>',
'effectiveDateTime' => '2023-11-07T05:31:56Z',
'effectivePeriod' => [
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z'
],
'resultIds' => [
'<string>'
],
'category' => '<string>',
'conclusion' => '<string>',
'conclusionCodes' => [
[
'system' => '<string>',
'code' => '<string>',
'display' => '<string>'
]
],
'performer' => '<string>',
'resultsInterpreter' => '<string>',
'specimenIds' => [
'<string>'
],
'presentedForm' => [
[
'contentType' => '<string>',
'data' => '<string>',
'url' => '<string>',
'title' => '<string>'
]
],
'basedOn' => [
'<string>'
],
'media' => [
[
'comment' => '<string>',
'linkId' => '<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/labs"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"effectivePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"resultIds\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"conclusion\": \"<string>\",\n \"conclusionCodes\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"performer\": \"<string>\",\n \"resultsInterpreter\": \"<string>\",\n \"specimenIds\": [\n \"<string>\"\n ],\n \"presentedForm\": [\n {\n \"contentType\": \"<string>\",\n \"data\": \"<string>\",\n \"url\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"media\": [\n {\n \"comment\": \"<string>\",\n \"linkId\": \"<string>\"\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/labs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"effectivePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"resultIds\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"conclusion\": \"<string>\",\n \"conclusionCodes\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"performer\": \"<string>\",\n \"resultsInterpreter\": \"<string>\",\n \"specimenIds\": [\n \"<string>\"\n ],\n \"presentedForm\": [\n {\n \"contentType\": \"<string>\",\n \"data\": \"<string>\",\n \"url\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"media\": [\n {\n \"comment\": \"<string>\",\n \"linkId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/labs")
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 \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"effectiveDateTime\": \"2023-11-07T05:31:56Z\",\n \"effectivePeriod\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"resultIds\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"conclusion\": \"<string>\",\n \"conclusionCodes\": [\n {\n \"system\": \"<string>\",\n \"code\": \"<string>\",\n \"display\": \"<string>\"\n }\n ],\n \"performer\": \"<string>\",\n \"resultsInterpreter\": \"<string>\",\n \"specimenIds\": [\n \"<string>\"\n ],\n \"presentedForm\": [\n {\n \"contentType\": \"<string>\",\n \"data\": \"<string>\",\n \"url\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"basedOn\": [\n \"<string>\"\n ],\n \"media\": [\n {\n \"comment\": \"<string>\",\n \"linkId\": \"<string>\"\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:
registered, partial, preliminary, final, amended, corrected, appended, cancelled When the report is clinically relevant (point in time)
When the report is clinically relevant (time range)
Show child attributes
Show child attributes
Observation IDs included in this report
LAB, RAD, PAT
Maximum string length:
5000Show child attributes
Show child attributes
Practitioner who performed the diagnostic
Practitioner who interpreted results
Show child attributes
Show child attributes
ServiceRequest IDs this report is based on
Media/images linked to this report
Show child attributes
Show child attributes
Response
201
Lab report created
⌘I