Create device use statement
curl --request POST \
--url https://api.clinikapi.com/v1/device-use-statements \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"deviceId": "<string>",
"timingDateTime": "<string>",
"timingPeriod": {
"start": "<string>",
"end": "<string>"
},
"recordedOn": "<string>",
"sourceId": "<string>",
"reasonCode": [
"<string>"
],
"bodySite": "<string>",
"note": "<string>",
"basedOn": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/device-use-statements"
payload = {
"patientId": "<string>",
"deviceId": "<string>",
"timingDateTime": "<string>",
"timingPeriod": {
"start": "<string>",
"end": "<string>"
},
"recordedOn": "<string>",
"sourceId": "<string>",
"reasonCode": ["<string>"],
"bodySite": "<string>",
"note": "<string>",
"basedOn": ["<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>',
deviceId: '<string>',
timingDateTime: '<string>',
timingPeriod: {start: '<string>', end: '<string>'},
recordedOn: '<string>',
sourceId: '<string>',
reasonCode: ['<string>'],
bodySite: '<string>',
note: '<string>',
basedOn: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/device-use-statements', 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/device-use-statements",
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>',
'deviceId' => '<string>',
'timingDateTime' => '<string>',
'timingPeriod' => [
'start' => '<string>',
'end' => '<string>'
],
'recordedOn' => '<string>',
'sourceId' => '<string>',
'reasonCode' => [
'<string>'
],
'bodySite' => '<string>',
'note' => '<string>',
'basedOn' => [
'<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/device-use-statements"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"deviceId\": \"<string>\",\n \"timingDateTime\": \"<string>\",\n \"timingPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"recordedOn\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\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/device-use-statements")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"deviceId\": \"<string>\",\n \"timingDateTime\": \"<string>\",\n \"timingPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"recordedOn\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/device-use-statements")
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 \"deviceId\": \"<string>\",\n \"timingDateTime\": \"<string>\",\n \"timingPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"recordedOn\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyDevice Use Statements
Create Device Use Statement
POST
/
v1
/
device-use-statements
Create device use statement
curl --request POST \
--url https://api.clinikapi.com/v1/device-use-statements \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"deviceId": "<string>",
"timingDateTime": "<string>",
"timingPeriod": {
"start": "<string>",
"end": "<string>"
},
"recordedOn": "<string>",
"sourceId": "<string>",
"reasonCode": [
"<string>"
],
"bodySite": "<string>",
"note": "<string>",
"basedOn": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/device-use-statements"
payload = {
"patientId": "<string>",
"deviceId": "<string>",
"timingDateTime": "<string>",
"timingPeriod": {
"start": "<string>",
"end": "<string>"
},
"recordedOn": "<string>",
"sourceId": "<string>",
"reasonCode": ["<string>"],
"bodySite": "<string>",
"note": "<string>",
"basedOn": ["<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>',
deviceId: '<string>',
timingDateTime: '<string>',
timingPeriod: {start: '<string>', end: '<string>'},
recordedOn: '<string>',
sourceId: '<string>',
reasonCode: ['<string>'],
bodySite: '<string>',
note: '<string>',
basedOn: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/device-use-statements', 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/device-use-statements",
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>',
'deviceId' => '<string>',
'timingDateTime' => '<string>',
'timingPeriod' => [
'start' => '<string>',
'end' => '<string>'
],
'recordedOn' => '<string>',
'sourceId' => '<string>',
'reasonCode' => [
'<string>'
],
'bodySite' => '<string>',
'note' => '<string>',
'basedOn' => [
'<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/device-use-statements"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"deviceId\": \"<string>\",\n \"timingDateTime\": \"<string>\",\n \"timingPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"recordedOn\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\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/device-use-statements")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"deviceId\": \"<string>\",\n \"timingDateTime\": \"<string>\",\n \"timingPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"recordedOn\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/device-use-statements")
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 \"deviceId\": \"<string>\",\n \"timingDateTime\": \"<string>\",\n \"timingPeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"recordedOn\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
active, completed, on-hold, intended, stopped, not-done Maximum string length:
128Maximum string length:
128Show child attributes
Show child attributes
Maximum string length:
128Maximum array length:
20Maximum string length:
500Maximum string length:
200Maximum string length:
5000Maximum array length:
20Maximum string length:
200Response
201
Device use statement created
⌘I