Create imaging study
curl --request POST \
--url https://api.clinikapi.com/v1/imaging-studies \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"encounterId": "<string>",
"modality": [
"<string>"
],
"started": "<string>",
"referrerId": "<string>",
"interpreterIds": [
"<string>"
],
"numberOfSeries": 123,
"numberOfInstances": 123,
"procedureCode": [
"<string>"
],
"locationId": "<string>",
"reasonCode": [
"<string>"
],
"description": "<string>",
"note": "<string>",
"basedOn": [
"<string>"
],
"series": [
{
"uid": "<string>",
"modality": "<string>",
"number": 123,
"description": "<string>",
"numberOfInstances": 123,
"bodySite": "<string>",
"laterality": "<string>",
"started": "<string>"
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/imaging-studies"
payload = {
"patientId": "<string>",
"encounterId": "<string>",
"modality": ["<string>"],
"started": "<string>",
"referrerId": "<string>",
"interpreterIds": ["<string>"],
"numberOfSeries": 123,
"numberOfInstances": 123,
"procedureCode": ["<string>"],
"locationId": "<string>",
"reasonCode": ["<string>"],
"description": "<string>",
"note": "<string>",
"basedOn": ["<string>"],
"series": [
{
"uid": "<string>",
"modality": "<string>",
"number": 123,
"description": "<string>",
"numberOfInstances": 123,
"bodySite": "<string>",
"laterality": "<string>",
"started": "<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>',
encounterId: '<string>',
modality: ['<string>'],
started: '<string>',
referrerId: '<string>',
interpreterIds: ['<string>'],
numberOfSeries: 123,
numberOfInstances: 123,
procedureCode: ['<string>'],
locationId: '<string>',
reasonCode: ['<string>'],
description: '<string>',
note: '<string>',
basedOn: ['<string>'],
series: [
{
uid: '<string>',
modality: '<string>',
number: 123,
description: '<string>',
numberOfInstances: 123,
bodySite: '<string>',
laterality: '<string>',
started: '<string>'
}
]
})
};
fetch('https://api.clinikapi.com/v1/imaging-studies', 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/imaging-studies",
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>',
'encounterId' => '<string>',
'modality' => [
'<string>'
],
'started' => '<string>',
'referrerId' => '<string>',
'interpreterIds' => [
'<string>'
],
'numberOfSeries' => 123,
'numberOfInstances' => 123,
'procedureCode' => [
'<string>'
],
'locationId' => '<string>',
'reasonCode' => [
'<string>'
],
'description' => '<string>',
'note' => '<string>',
'basedOn' => [
'<string>'
],
'series' => [
[
'uid' => '<string>',
'modality' => '<string>',
'number' => 123,
'description' => '<string>',
'numberOfInstances' => 123,
'bodySite' => '<string>',
'laterality' => '<string>',
'started' => '<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/imaging-studies"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"modality\": [\n \"<string>\"\n ],\n \"started\": \"<string>\",\n \"referrerId\": \"<string>\",\n \"interpreterIds\": [\n \"<string>\"\n ],\n \"numberOfSeries\": 123,\n \"numberOfInstances\": 123,\n \"procedureCode\": [\n \"<string>\"\n ],\n \"locationId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"series\": [\n {\n \"uid\": \"<string>\",\n \"modality\": \"<string>\",\n \"number\": 123,\n \"description\": \"<string>\",\n \"numberOfInstances\": 123,\n \"bodySite\": \"<string>\",\n \"laterality\": \"<string>\",\n \"started\": \"<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/imaging-studies")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"modality\": [\n \"<string>\"\n ],\n \"started\": \"<string>\",\n \"referrerId\": \"<string>\",\n \"interpreterIds\": [\n \"<string>\"\n ],\n \"numberOfSeries\": 123,\n \"numberOfInstances\": 123,\n \"procedureCode\": [\n \"<string>\"\n ],\n \"locationId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"series\": [\n {\n \"uid\": \"<string>\",\n \"modality\": \"<string>\",\n \"number\": 123,\n \"description\": \"<string>\",\n \"numberOfInstances\": 123,\n \"bodySite\": \"<string>\",\n \"laterality\": \"<string>\",\n \"started\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/imaging-studies")
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 \"encounterId\": \"<string>\",\n \"modality\": [\n \"<string>\"\n ],\n \"started\": \"<string>\",\n \"referrerId\": \"<string>\",\n \"interpreterIds\": [\n \"<string>\"\n ],\n \"numberOfSeries\": 123,\n \"numberOfInstances\": 123,\n \"procedureCode\": [\n \"<string>\"\n ],\n \"locationId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"series\": [\n {\n \"uid\": \"<string>\",\n \"modality\": \"<string>\",\n \"number\": 123,\n \"description\": \"<string>\",\n \"numberOfInstances\": 123,\n \"bodySite\": \"<string>\",\n \"laterality\": \"<string>\",\n \"started\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyImaging Studies
Create Imaging Study
POST
/
v1
/
imaging-studies
Create imaging study
curl --request POST \
--url https://api.clinikapi.com/v1/imaging-studies \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"encounterId": "<string>",
"modality": [
"<string>"
],
"started": "<string>",
"referrerId": "<string>",
"interpreterIds": [
"<string>"
],
"numberOfSeries": 123,
"numberOfInstances": 123,
"procedureCode": [
"<string>"
],
"locationId": "<string>",
"reasonCode": [
"<string>"
],
"description": "<string>",
"note": "<string>",
"basedOn": [
"<string>"
],
"series": [
{
"uid": "<string>",
"modality": "<string>",
"number": 123,
"description": "<string>",
"numberOfInstances": 123,
"bodySite": "<string>",
"laterality": "<string>",
"started": "<string>"
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/imaging-studies"
payload = {
"patientId": "<string>",
"encounterId": "<string>",
"modality": ["<string>"],
"started": "<string>",
"referrerId": "<string>",
"interpreterIds": ["<string>"],
"numberOfSeries": 123,
"numberOfInstances": 123,
"procedureCode": ["<string>"],
"locationId": "<string>",
"reasonCode": ["<string>"],
"description": "<string>",
"note": "<string>",
"basedOn": ["<string>"],
"series": [
{
"uid": "<string>",
"modality": "<string>",
"number": 123,
"description": "<string>",
"numberOfInstances": 123,
"bodySite": "<string>",
"laterality": "<string>",
"started": "<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>',
encounterId: '<string>',
modality: ['<string>'],
started: '<string>',
referrerId: '<string>',
interpreterIds: ['<string>'],
numberOfSeries: 123,
numberOfInstances: 123,
procedureCode: ['<string>'],
locationId: '<string>',
reasonCode: ['<string>'],
description: '<string>',
note: '<string>',
basedOn: ['<string>'],
series: [
{
uid: '<string>',
modality: '<string>',
number: 123,
description: '<string>',
numberOfInstances: 123,
bodySite: '<string>',
laterality: '<string>',
started: '<string>'
}
]
})
};
fetch('https://api.clinikapi.com/v1/imaging-studies', 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/imaging-studies",
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>',
'encounterId' => '<string>',
'modality' => [
'<string>'
],
'started' => '<string>',
'referrerId' => '<string>',
'interpreterIds' => [
'<string>'
],
'numberOfSeries' => 123,
'numberOfInstances' => 123,
'procedureCode' => [
'<string>'
],
'locationId' => '<string>',
'reasonCode' => [
'<string>'
],
'description' => '<string>',
'note' => '<string>',
'basedOn' => [
'<string>'
],
'series' => [
[
'uid' => '<string>',
'modality' => '<string>',
'number' => 123,
'description' => '<string>',
'numberOfInstances' => 123,
'bodySite' => '<string>',
'laterality' => '<string>',
'started' => '<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/imaging-studies"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"modality\": [\n \"<string>\"\n ],\n \"started\": \"<string>\",\n \"referrerId\": \"<string>\",\n \"interpreterIds\": [\n \"<string>\"\n ],\n \"numberOfSeries\": 123,\n \"numberOfInstances\": 123,\n \"procedureCode\": [\n \"<string>\"\n ],\n \"locationId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"series\": [\n {\n \"uid\": \"<string>\",\n \"modality\": \"<string>\",\n \"number\": 123,\n \"description\": \"<string>\",\n \"numberOfInstances\": 123,\n \"bodySite\": \"<string>\",\n \"laterality\": \"<string>\",\n \"started\": \"<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/imaging-studies")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"modality\": [\n \"<string>\"\n ],\n \"started\": \"<string>\",\n \"referrerId\": \"<string>\",\n \"interpreterIds\": [\n \"<string>\"\n ],\n \"numberOfSeries\": 123,\n \"numberOfInstances\": 123,\n \"procedureCode\": [\n \"<string>\"\n ],\n \"locationId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"series\": [\n {\n \"uid\": \"<string>\",\n \"modality\": \"<string>\",\n \"number\": 123,\n \"description\": \"<string>\",\n \"numberOfInstances\": 123,\n \"bodySite\": \"<string>\",\n \"laterality\": \"<string>\",\n \"started\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/imaging-studies")
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 \"encounterId\": \"<string>\",\n \"modality\": [\n \"<string>\"\n ],\n \"started\": \"<string>\",\n \"referrerId\": \"<string>\",\n \"interpreterIds\": [\n \"<string>\"\n ],\n \"numberOfSeries\": 123,\n \"numberOfInstances\": 123,\n \"procedureCode\": [\n \"<string>\"\n ],\n \"locationId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"series\": [\n {\n \"uid\": \"<string>\",\n \"modality\": \"<string>\",\n \"number\": 123,\n \"description\": \"<string>\",\n \"numberOfInstances\": 123,\n \"bodySite\": \"<string>\",\n \"laterality\": \"<string>\",\n \"started\": \"<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, available, cancelled Maximum string length:
128Maximum string length:
128Maximum array length:
20Maximum string length:
50Maximum string length:
50Maximum string length:
128Maximum array length:
10Maximum string length:
128Maximum array length:
10Maximum string length:
500Maximum string length:
128Maximum array length:
10Maximum string length:
500Maximum string length:
2000Maximum string length:
5000Maximum array length:
10Maximum string length:
128Maximum array length:
50Show child attributes
Show child attributes
Response
201
Imaging study created
⌘I