Create risk assessment
curl --request POST \
--url https://api.clinikapi.com/v1/risk-assessments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"encounterId": "<string>",
"method": "<string>",
"code": "<string>",
"occurrenceDateTime": "<string>",
"conditionId": "<string>",
"performerId": "<string>",
"reasonCode": [
"<string>"
],
"prediction": [
{
"outcome": "<string>",
"probabilityDecimal": 0.5,
"qualitativeRisk": "<string>",
"relativeRisk": 123,
"rationale": "<string>"
}
],
"mitigation": "<string>",
"note": "<string>",
"basedOnId": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/risk-assessments"
payload = {
"patientId": "<string>",
"encounterId": "<string>",
"method": "<string>",
"code": "<string>",
"occurrenceDateTime": "<string>",
"conditionId": "<string>",
"performerId": "<string>",
"reasonCode": ["<string>"],
"prediction": [
{
"outcome": "<string>",
"probabilityDecimal": 0.5,
"qualitativeRisk": "<string>",
"relativeRisk": 123,
"rationale": "<string>"
}
],
"mitigation": "<string>",
"note": "<string>",
"basedOnId": "<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>',
method: '<string>',
code: '<string>',
occurrenceDateTime: '<string>',
conditionId: '<string>',
performerId: '<string>',
reasonCode: ['<string>'],
prediction: [
{
outcome: '<string>',
probabilityDecimal: 0.5,
qualitativeRisk: '<string>',
relativeRisk: 123,
rationale: '<string>'
}
],
mitigation: '<string>',
note: '<string>',
basedOnId: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/risk-assessments', 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/risk-assessments",
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>',
'method' => '<string>',
'code' => '<string>',
'occurrenceDateTime' => '<string>',
'conditionId' => '<string>',
'performerId' => '<string>',
'reasonCode' => [
'<string>'
],
'prediction' => [
[
'outcome' => '<string>',
'probabilityDecimal' => 0.5,
'qualitativeRisk' => '<string>',
'relativeRisk' => 123,
'rationale' => '<string>'
]
],
'mitigation' => '<string>',
'note' => '<string>',
'basedOnId' => '<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/risk-assessments"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"method\": \"<string>\",\n \"code\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"conditionId\": \"<string>\",\n \"performerId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"prediction\": [\n {\n \"outcome\": \"<string>\",\n \"probabilityDecimal\": 0.5,\n \"qualitativeRisk\": \"<string>\",\n \"relativeRisk\": 123,\n \"rationale\": \"<string>\"\n }\n ],\n \"mitigation\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOnId\": \"<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/risk-assessments")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"method\": \"<string>\",\n \"code\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"conditionId\": \"<string>\",\n \"performerId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"prediction\": [\n {\n \"outcome\": \"<string>\",\n \"probabilityDecimal\": 0.5,\n \"qualitativeRisk\": \"<string>\",\n \"relativeRisk\": 123,\n \"rationale\": \"<string>\"\n }\n ],\n \"mitigation\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOnId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/risk-assessments")
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 \"method\": \"<string>\",\n \"code\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"conditionId\": \"<string>\",\n \"performerId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"prediction\": [\n {\n \"outcome\": \"<string>\",\n \"probabilityDecimal\": 0.5,\n \"qualitativeRisk\": \"<string>\",\n \"relativeRisk\": 123,\n \"rationale\": \"<string>\"\n }\n ],\n \"mitigation\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOnId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyRisk Assessments
Create Risk Assessment
POST
/
v1
/
risk-assessments
Create risk assessment
curl --request POST \
--url https://api.clinikapi.com/v1/risk-assessments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"encounterId": "<string>",
"method": "<string>",
"code": "<string>",
"occurrenceDateTime": "<string>",
"conditionId": "<string>",
"performerId": "<string>",
"reasonCode": [
"<string>"
],
"prediction": [
{
"outcome": "<string>",
"probabilityDecimal": 0.5,
"qualitativeRisk": "<string>",
"relativeRisk": 123,
"rationale": "<string>"
}
],
"mitigation": "<string>",
"note": "<string>",
"basedOnId": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/risk-assessments"
payload = {
"patientId": "<string>",
"encounterId": "<string>",
"method": "<string>",
"code": "<string>",
"occurrenceDateTime": "<string>",
"conditionId": "<string>",
"performerId": "<string>",
"reasonCode": ["<string>"],
"prediction": [
{
"outcome": "<string>",
"probabilityDecimal": 0.5,
"qualitativeRisk": "<string>",
"relativeRisk": 123,
"rationale": "<string>"
}
],
"mitigation": "<string>",
"note": "<string>",
"basedOnId": "<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>',
method: '<string>',
code: '<string>',
occurrenceDateTime: '<string>',
conditionId: '<string>',
performerId: '<string>',
reasonCode: ['<string>'],
prediction: [
{
outcome: '<string>',
probabilityDecimal: 0.5,
qualitativeRisk: '<string>',
relativeRisk: 123,
rationale: '<string>'
}
],
mitigation: '<string>',
note: '<string>',
basedOnId: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/risk-assessments', 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/risk-assessments",
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>',
'method' => '<string>',
'code' => '<string>',
'occurrenceDateTime' => '<string>',
'conditionId' => '<string>',
'performerId' => '<string>',
'reasonCode' => [
'<string>'
],
'prediction' => [
[
'outcome' => '<string>',
'probabilityDecimal' => 0.5,
'qualitativeRisk' => '<string>',
'relativeRisk' => 123,
'rationale' => '<string>'
]
],
'mitigation' => '<string>',
'note' => '<string>',
'basedOnId' => '<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/risk-assessments"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"method\": \"<string>\",\n \"code\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"conditionId\": \"<string>\",\n \"performerId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"prediction\": [\n {\n \"outcome\": \"<string>\",\n \"probabilityDecimal\": 0.5,\n \"qualitativeRisk\": \"<string>\",\n \"relativeRisk\": 123,\n \"rationale\": \"<string>\"\n }\n ],\n \"mitigation\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOnId\": \"<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/risk-assessments")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"method\": \"<string>\",\n \"code\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"conditionId\": \"<string>\",\n \"performerId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"prediction\": [\n {\n \"outcome\": \"<string>\",\n \"probabilityDecimal\": 0.5,\n \"qualitativeRisk\": \"<string>\",\n \"relativeRisk\": 123,\n \"rationale\": \"<string>\"\n }\n ],\n \"mitigation\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOnId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/risk-assessments")
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 \"method\": \"<string>\",\n \"code\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"conditionId\": \"<string>\",\n \"performerId\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"prediction\": [\n {\n \"outcome\": \"<string>\",\n \"probabilityDecimal\": 0.5,\n \"qualitativeRisk\": \"<string>\",\n \"relativeRisk\": 123,\n \"rationale\": \"<string>\"\n }\n ],\n \"mitigation\": \"<string>\",\n \"note\": \"<string>\",\n \"basedOnId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
registered, preliminary, final, amended Maximum string length:
128Maximum string length:
128Maximum string length:
200Maximum string length:
200Maximum string length:
30Maximum string length:
128Maximum string length:
128Maximum array length:
10Maximum string length:
500Maximum array length:
20Show child attributes
Show child attributes
Maximum string length:
5000Maximum string length:
5000Maximum string length:
128Response
201
Risk assessment created
⌘I