Create family member history
curl --request POST \
--url https://api.clinikapi.com/v1/family-history \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"relationship": "<string>",
"date": "2023-11-07T05:31:56Z",
"name": "<string>",
"sex": "<string>",
"bornDate": "<string>",
"ageString": "<string>",
"estimatedAge": true,
"deceasedBoolean": true,
"deceasedDate": "<string>",
"reasonCode": [
"<string>"
],
"note": "<string>",
"condition": [
{
"code": "<string>",
"outcome": "<string>",
"contributedToDeath": true,
"onsetString": "<string>",
"note": "<string>"
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/family-history"
payload = {
"patientId": "<string>",
"relationship": "<string>",
"date": "2023-11-07T05:31:56Z",
"name": "<string>",
"sex": "<string>",
"bornDate": "<string>",
"ageString": "<string>",
"estimatedAge": True,
"deceasedBoolean": True,
"deceasedDate": "<string>",
"reasonCode": ["<string>"],
"note": "<string>",
"condition": [
{
"code": "<string>",
"outcome": "<string>",
"contributedToDeath": True,
"onsetString": "<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>',
relationship: '<string>',
date: '2023-11-07T05:31:56Z',
name: '<string>',
sex: '<string>',
bornDate: '<string>',
ageString: '<string>',
estimatedAge: true,
deceasedBoolean: true,
deceasedDate: '<string>',
reasonCode: ['<string>'],
note: '<string>',
condition: [
{
code: '<string>',
outcome: '<string>',
contributedToDeath: true,
onsetString: '<string>',
note: '<string>'
}
]
})
};
fetch('https://api.clinikapi.com/v1/family-history', 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/family-history",
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>',
'relationship' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'sex' => '<string>',
'bornDate' => '<string>',
'ageString' => '<string>',
'estimatedAge' => true,
'deceasedBoolean' => true,
'deceasedDate' => '<string>',
'reasonCode' => [
'<string>'
],
'note' => '<string>',
'condition' => [
[
'code' => '<string>',
'outcome' => '<string>',
'contributedToDeath' => true,
'onsetString' => '<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/family-history"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"relationship\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"sex\": \"<string>\",\n \"bornDate\": \"<string>\",\n \"ageString\": \"<string>\",\n \"estimatedAge\": true,\n \"deceasedBoolean\": true,\n \"deceasedDate\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"condition\": [\n {\n \"code\": \"<string>\",\n \"outcome\": \"<string>\",\n \"contributedToDeath\": true,\n \"onsetString\": \"<string>\",\n \"note\": \"<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/family-history")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"relationship\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"sex\": \"<string>\",\n \"bornDate\": \"<string>\",\n \"ageString\": \"<string>\",\n \"estimatedAge\": true,\n \"deceasedBoolean\": true,\n \"deceasedDate\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"condition\": [\n {\n \"code\": \"<string>\",\n \"outcome\": \"<string>\",\n \"contributedToDeath\": true,\n \"onsetString\": \"<string>\",\n \"note\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/family-history")
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 \"relationship\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"sex\": \"<string>\",\n \"bornDate\": \"<string>\",\n \"ageString\": \"<string>\",\n \"estimatedAge\": true,\n \"deceasedBoolean\": true,\n \"deceasedDate\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"condition\": [\n {\n \"code\": \"<string>\",\n \"outcome\": \"<string>\",\n \"contributedToDeath\": true,\n \"onsetString\": \"<string>\",\n \"note\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>",
"issues": [
{
"severity": "<string>",
"code": "<string>",
"diagnostics": "<string>"
}
]
}Family History
Create Family History
POST
/
v1
/
family-history
Create family member history
curl --request POST \
--url https://api.clinikapi.com/v1/family-history \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"relationship": "<string>",
"date": "2023-11-07T05:31:56Z",
"name": "<string>",
"sex": "<string>",
"bornDate": "<string>",
"ageString": "<string>",
"estimatedAge": true,
"deceasedBoolean": true,
"deceasedDate": "<string>",
"reasonCode": [
"<string>"
],
"note": "<string>",
"condition": [
{
"code": "<string>",
"outcome": "<string>",
"contributedToDeath": true,
"onsetString": "<string>",
"note": "<string>"
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/family-history"
payload = {
"patientId": "<string>",
"relationship": "<string>",
"date": "2023-11-07T05:31:56Z",
"name": "<string>",
"sex": "<string>",
"bornDate": "<string>",
"ageString": "<string>",
"estimatedAge": True,
"deceasedBoolean": True,
"deceasedDate": "<string>",
"reasonCode": ["<string>"],
"note": "<string>",
"condition": [
{
"code": "<string>",
"outcome": "<string>",
"contributedToDeath": True,
"onsetString": "<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>',
relationship: '<string>',
date: '2023-11-07T05:31:56Z',
name: '<string>',
sex: '<string>',
bornDate: '<string>',
ageString: '<string>',
estimatedAge: true,
deceasedBoolean: true,
deceasedDate: '<string>',
reasonCode: ['<string>'],
note: '<string>',
condition: [
{
code: '<string>',
outcome: '<string>',
contributedToDeath: true,
onsetString: '<string>',
note: '<string>'
}
]
})
};
fetch('https://api.clinikapi.com/v1/family-history', 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/family-history",
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>',
'relationship' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'sex' => '<string>',
'bornDate' => '<string>',
'ageString' => '<string>',
'estimatedAge' => true,
'deceasedBoolean' => true,
'deceasedDate' => '<string>',
'reasonCode' => [
'<string>'
],
'note' => '<string>',
'condition' => [
[
'code' => '<string>',
'outcome' => '<string>',
'contributedToDeath' => true,
'onsetString' => '<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/family-history"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"relationship\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"sex\": \"<string>\",\n \"bornDate\": \"<string>\",\n \"ageString\": \"<string>\",\n \"estimatedAge\": true,\n \"deceasedBoolean\": true,\n \"deceasedDate\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"condition\": [\n {\n \"code\": \"<string>\",\n \"outcome\": \"<string>\",\n \"contributedToDeath\": true,\n \"onsetString\": \"<string>\",\n \"note\": \"<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/family-history")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"relationship\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"sex\": \"<string>\",\n \"bornDate\": \"<string>\",\n \"ageString\": \"<string>\",\n \"estimatedAge\": true,\n \"deceasedBoolean\": true,\n \"deceasedDate\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"condition\": [\n {\n \"code\": \"<string>\",\n \"outcome\": \"<string>\",\n \"contributedToDeath\": true,\n \"onsetString\": \"<string>\",\n \"note\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/family-history")
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 \"relationship\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"sex\": \"<string>\",\n \"bornDate\": \"<string>\",\n \"ageString\": \"<string>\",\n \"estimatedAge\": true,\n \"deceasedBoolean\": true,\n \"deceasedDate\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"condition\": [\n {\n \"code\": \"<string>\",\n \"outcome\": \"<string>\",\n \"contributedToDeath\": true,\n \"onsetString\": \"<string>\",\n \"note\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>",
"issues": [
{
"severity": "<string>",
"code": "<string>",
"diagnostics": "<string>"
}
]
}Authorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
partial, completed, health-unknown Relationship to patient (mother, father, sibling, etc.)
Maximum string length:
200Family member's name
Maximum string length:
200Maximum string length:
50Family member's birth date
Approximate age (e.g. "around 50")
Maximum string length:
100Maximum array length:
10Maximum string length:
500Maximum string length:
2000Maximum array length:
20Show child attributes
Show child attributes
Response
Family member history created
⌘I