Create specimen
curl --request POST \
--url https://api.clinikapi.com/v1/specimens \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"type": "<string>",
"receivedTime": "<string>",
"parentIds": [
"<string>"
],
"requestIds": [
"<string>"
],
"collection": {
"collectorId": "<string>",
"collectedDateTime": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"method": "<string>",
"bodySite": "<string>"
},
"container": [
{
"description": "<string>",
"type": "<string>",
"capacity": {
"value": 123,
"unit": "<string>"
},
"specimenQuantity": {
"value": 123,
"unit": "<string>"
}
}
],
"condition": [
"<string>"
],
"note": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/specimens"
payload = {
"patientId": "<string>",
"type": "<string>",
"receivedTime": "<string>",
"parentIds": ["<string>"],
"requestIds": ["<string>"],
"collection": {
"collectorId": "<string>",
"collectedDateTime": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"method": "<string>",
"bodySite": "<string>"
},
"container": [
{
"description": "<string>",
"type": "<string>",
"capacity": {
"value": 123,
"unit": "<string>"
},
"specimenQuantity": {
"value": 123,
"unit": "<string>"
}
}
],
"condition": ["<string>"],
"note": "<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>',
type: '<string>',
receivedTime: '<string>',
parentIds: ['<string>'],
requestIds: ['<string>'],
collection: {
collectorId: '<string>',
collectedDateTime: '<string>',
quantity: {value: 123, unit: '<string>'},
method: '<string>',
bodySite: '<string>'
},
container: [
{
description: '<string>',
type: '<string>',
capacity: {value: 123, unit: '<string>'},
specimenQuantity: {value: 123, unit: '<string>'}
}
],
condition: ['<string>'],
note: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/specimens', 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/specimens",
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>',
'type' => '<string>',
'receivedTime' => '<string>',
'parentIds' => [
'<string>'
],
'requestIds' => [
'<string>'
],
'collection' => [
'collectorId' => '<string>',
'collectedDateTime' => '<string>',
'quantity' => [
'value' => 123,
'unit' => '<string>'
],
'method' => '<string>',
'bodySite' => '<string>'
],
'container' => [
[
'description' => '<string>',
'type' => '<string>',
'capacity' => [
'value' => 123,
'unit' => '<string>'
],
'specimenQuantity' => [
'value' => 123,
'unit' => '<string>'
]
]
],
'condition' => [
'<string>'
],
'note' => '<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/specimens"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"type\": \"<string>\",\n \"receivedTime\": \"<string>\",\n \"parentIds\": [\n \"<string>\"\n ],\n \"requestIds\": [\n \"<string>\"\n ],\n \"collection\": {\n \"collectorId\": \"<string>\",\n \"collectedDateTime\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"method\": \"<string>\",\n \"bodySite\": \"<string>\"\n },\n \"container\": [\n {\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"capacity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"specimenQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ],\n \"condition\": [\n \"<string>\"\n ],\n \"note\": \"<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/specimens")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"type\": \"<string>\",\n \"receivedTime\": \"<string>\",\n \"parentIds\": [\n \"<string>\"\n ],\n \"requestIds\": [\n \"<string>\"\n ],\n \"collection\": {\n \"collectorId\": \"<string>\",\n \"collectedDateTime\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"method\": \"<string>\",\n \"bodySite\": \"<string>\"\n },\n \"container\": [\n {\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"capacity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"specimenQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ],\n \"condition\": [\n \"<string>\"\n ],\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/specimens")
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 \"type\": \"<string>\",\n \"receivedTime\": \"<string>\",\n \"parentIds\": [\n \"<string>\"\n ],\n \"requestIds\": [\n \"<string>\"\n ],\n \"collection\": {\n \"collectorId\": \"<string>\",\n \"collectedDateTime\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"method\": \"<string>\",\n \"bodySite\": \"<string>\"\n },\n \"container\": [\n {\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"capacity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"specimenQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ],\n \"condition\": [\n \"<string>\"\n ],\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodySpecimens
Create Specimen
POST
/
v1
/
specimens
Create specimen
curl --request POST \
--url https://api.clinikapi.com/v1/specimens \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"type": "<string>",
"receivedTime": "<string>",
"parentIds": [
"<string>"
],
"requestIds": [
"<string>"
],
"collection": {
"collectorId": "<string>",
"collectedDateTime": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"method": "<string>",
"bodySite": "<string>"
},
"container": [
{
"description": "<string>",
"type": "<string>",
"capacity": {
"value": 123,
"unit": "<string>"
},
"specimenQuantity": {
"value": 123,
"unit": "<string>"
}
}
],
"condition": [
"<string>"
],
"note": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/specimens"
payload = {
"patientId": "<string>",
"type": "<string>",
"receivedTime": "<string>",
"parentIds": ["<string>"],
"requestIds": ["<string>"],
"collection": {
"collectorId": "<string>",
"collectedDateTime": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"method": "<string>",
"bodySite": "<string>"
},
"container": [
{
"description": "<string>",
"type": "<string>",
"capacity": {
"value": 123,
"unit": "<string>"
},
"specimenQuantity": {
"value": 123,
"unit": "<string>"
}
}
],
"condition": ["<string>"],
"note": "<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>',
type: '<string>',
receivedTime: '<string>',
parentIds: ['<string>'],
requestIds: ['<string>'],
collection: {
collectorId: '<string>',
collectedDateTime: '<string>',
quantity: {value: 123, unit: '<string>'},
method: '<string>',
bodySite: '<string>'
},
container: [
{
description: '<string>',
type: '<string>',
capacity: {value: 123, unit: '<string>'},
specimenQuantity: {value: 123, unit: '<string>'}
}
],
condition: ['<string>'],
note: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/specimens', 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/specimens",
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>',
'type' => '<string>',
'receivedTime' => '<string>',
'parentIds' => [
'<string>'
],
'requestIds' => [
'<string>'
],
'collection' => [
'collectorId' => '<string>',
'collectedDateTime' => '<string>',
'quantity' => [
'value' => 123,
'unit' => '<string>'
],
'method' => '<string>',
'bodySite' => '<string>'
],
'container' => [
[
'description' => '<string>',
'type' => '<string>',
'capacity' => [
'value' => 123,
'unit' => '<string>'
],
'specimenQuantity' => [
'value' => 123,
'unit' => '<string>'
]
]
],
'condition' => [
'<string>'
],
'note' => '<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/specimens"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"type\": \"<string>\",\n \"receivedTime\": \"<string>\",\n \"parentIds\": [\n \"<string>\"\n ],\n \"requestIds\": [\n \"<string>\"\n ],\n \"collection\": {\n \"collectorId\": \"<string>\",\n \"collectedDateTime\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"method\": \"<string>\",\n \"bodySite\": \"<string>\"\n },\n \"container\": [\n {\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"capacity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"specimenQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ],\n \"condition\": [\n \"<string>\"\n ],\n \"note\": \"<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/specimens")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"type\": \"<string>\",\n \"receivedTime\": \"<string>\",\n \"parentIds\": [\n \"<string>\"\n ],\n \"requestIds\": [\n \"<string>\"\n ],\n \"collection\": {\n \"collectorId\": \"<string>\",\n \"collectedDateTime\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"method\": \"<string>\",\n \"bodySite\": \"<string>\"\n },\n \"container\": [\n {\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"capacity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"specimenQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ],\n \"condition\": [\n \"<string>\"\n ],\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/specimens")
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 \"type\": \"<string>\",\n \"receivedTime\": \"<string>\",\n \"parentIds\": [\n \"<string>\"\n ],\n \"requestIds\": [\n \"<string>\"\n ],\n \"collection\": {\n \"collectorId\": \"<string>\",\n \"collectedDateTime\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"method\": \"<string>\",\n \"bodySite\": \"<string>\"\n },\n \"container\": [\n {\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"capacity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"specimenQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ],\n \"condition\": [\n \"<string>\"\n ],\n \"note\": \"<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:
128Available options:
available, unavailable, unsatisfactory Maximum string length:
200Maximum string length:
50Maximum array length:
10Maximum string length:
128Maximum array length:
10Maximum string length:
128Show child attributes
Show child attributes
Maximum array length:
20Show child attributes
Show child attributes
Maximum array length:
10Maximum string length:
200Maximum string length:
5000Response
201
Specimen created
⌘I