Create patient
curl --request POST \
--url https://api.clinikapi.com/v1/patients \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"email": "[email protected]",
"phone": "<string>",
"birthDate": "<string>",
"address": {
"line": [
"<string>"
],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"maritalStatus": "<string>",
"photo": {
"url": "<string>",
"data": "<string>",
"contentType": "<string>"
},
"contact": [
{
"relationship": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"email": "[email protected]",
"address": {
"line": [
"<string>"
],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
],
"languages": [
{
"language": "<string>",
"preferred": true
}
],
"generalPractitionerId": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/patients"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "[email protected]",
"phone": "<string>",
"birthDate": "<string>",
"address": {
"line": ["<string>"],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"maritalStatus": "<string>",
"photo": {
"url": "<string>",
"data": "<string>",
"contentType": "<string>"
},
"contact": [
{
"relationship": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"email": "[email protected]",
"address": {
"line": ["<string>"],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
],
"languages": [
{
"language": "<string>",
"preferred": True
}
],
"generalPractitionerId": "<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({
firstName: '<string>',
lastName: '<string>',
email: '[email protected]',
phone: '<string>',
birthDate: '<string>',
address: {
line: ['<string>'],
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
},
maritalStatus: '<string>',
photo: {url: '<string>', data: '<string>', contentType: '<string>'},
contact: [
{
relationship: '<string>',
firstName: '<string>',
lastName: '<string>',
phone: '<string>',
email: '[email protected]',
address: {
line: ['<string>'],
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
}
}
],
languages: [{language: '<string>', preferred: true}],
generalPractitionerId: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/patients', 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/patients",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '[email protected]',
'phone' => '<string>',
'birthDate' => '<string>',
'address' => [
'line' => [
'<string>'
],
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'maritalStatus' => '<string>',
'photo' => [
'url' => '<string>',
'data' => '<string>',
'contentType' => '<string>'
],
'contact' => [
[
'relationship' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>',
'email' => '[email protected]',
'address' => [
'line' => [
'<string>'
],
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
]
]
],
'languages' => [
[
'language' => '<string>',
'preferred' => true
]
],
'generalPractitionerId' => '<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/patients"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"maritalStatus\": \"<string>\",\n \"photo\": {\n \"url\": \"<string>\",\n \"data\": \"<string>\",\n \"contentType\": \"<string>\"\n },\n \"contact\": [\n {\n \"relationship\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ],\n \"languages\": [\n {\n \"language\": \"<string>\",\n \"preferred\": true\n }\n ],\n \"generalPractitionerId\": \"<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/patients")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"maritalStatus\": \"<string>\",\n \"photo\": {\n \"url\": \"<string>\",\n \"data\": \"<string>\",\n \"contentType\": \"<string>\"\n },\n \"contact\": [\n {\n \"relationship\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ],\n \"languages\": [\n {\n \"language\": \"<string>\",\n \"preferred\": true\n }\n ],\n \"generalPractitionerId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/patients")
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 \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"maritalStatus\": \"<string>\",\n \"photo\": {\n \"url\": \"<string>\",\n \"data\": \"<string>\",\n \"contentType\": \"<string>\"\n },\n \"contact\": [\n {\n \"relationship\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ],\n \"languages\": [\n {\n \"language\": \"<string>\",\n \"preferred\": true\n }\n ],\n \"generalPractitionerId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": "<unknown>",
"meta": {
"requestId": "req_k8f3a7x2",
"timestamp": "2023-11-07T05:31:56Z",
"status": 200,
"rateLimitTotal": 123,
"rateLimitRemaining": 123,
"rateLimitReset": 123
}
}{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>",
"issues": [
{
"severity": "<string>",
"code": "<string>",
"diagnostics": "<string>"
}
]
}Patients
Create Patient
POST
/
v1
/
patients
Create patient
curl --request POST \
--url https://api.clinikapi.com/v1/patients \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"email": "[email protected]",
"phone": "<string>",
"birthDate": "<string>",
"address": {
"line": [
"<string>"
],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"maritalStatus": "<string>",
"photo": {
"url": "<string>",
"data": "<string>",
"contentType": "<string>"
},
"contact": [
{
"relationship": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"email": "[email protected]",
"address": {
"line": [
"<string>"
],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
],
"languages": [
{
"language": "<string>",
"preferred": true
}
],
"generalPractitionerId": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/patients"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "[email protected]",
"phone": "<string>",
"birthDate": "<string>",
"address": {
"line": ["<string>"],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"maritalStatus": "<string>",
"photo": {
"url": "<string>",
"data": "<string>",
"contentType": "<string>"
},
"contact": [
{
"relationship": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"email": "[email protected]",
"address": {
"line": ["<string>"],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
],
"languages": [
{
"language": "<string>",
"preferred": True
}
],
"generalPractitionerId": "<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({
firstName: '<string>',
lastName: '<string>',
email: '[email protected]',
phone: '<string>',
birthDate: '<string>',
address: {
line: ['<string>'],
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
},
maritalStatus: '<string>',
photo: {url: '<string>', data: '<string>', contentType: '<string>'},
contact: [
{
relationship: '<string>',
firstName: '<string>',
lastName: '<string>',
phone: '<string>',
email: '[email protected]',
address: {
line: ['<string>'],
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
}
}
],
languages: [{language: '<string>', preferred: true}],
generalPractitionerId: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/patients', 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/patients",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '[email protected]',
'phone' => '<string>',
'birthDate' => '<string>',
'address' => [
'line' => [
'<string>'
],
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'maritalStatus' => '<string>',
'photo' => [
'url' => '<string>',
'data' => '<string>',
'contentType' => '<string>'
],
'contact' => [
[
'relationship' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>',
'email' => '[email protected]',
'address' => [
'line' => [
'<string>'
],
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
]
]
],
'languages' => [
[
'language' => '<string>',
'preferred' => true
]
],
'generalPractitionerId' => '<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/patients"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"maritalStatus\": \"<string>\",\n \"photo\": {\n \"url\": \"<string>\",\n \"data\": \"<string>\",\n \"contentType\": \"<string>\"\n },\n \"contact\": [\n {\n \"relationship\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ],\n \"languages\": [\n {\n \"language\": \"<string>\",\n \"preferred\": true\n }\n ],\n \"generalPractitionerId\": \"<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/patients")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"maritalStatus\": \"<string>\",\n \"photo\": {\n \"url\": \"<string>\",\n \"data\": \"<string>\",\n \"contentType\": \"<string>\"\n },\n \"contact\": [\n {\n \"relationship\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ],\n \"languages\": [\n {\n \"language\": \"<string>\",\n \"preferred\": true\n }\n ],\n \"generalPractitionerId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/patients")
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 \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"maritalStatus\": \"<string>\",\n \"photo\": {\n \"url\": \"<string>\",\n \"data\": \"<string>\",\n \"contentType\": \"<string>\"\n },\n \"contact\": [\n {\n \"relationship\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ],\n \"languages\": [\n {\n \"language\": \"<string>\",\n \"preferred\": true\n }\n ],\n \"generalPractitionerId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": "<unknown>",
"meta": {
"requestId": "req_k8f3a7x2",
"timestamp": "2023-11-07T05:31:56Z",
"status": 200,
"rateLimitTotal": 123,
"rateLimitRemaining": 123,
"rateLimitReset": 123
}
}{
"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
Maximum string length:
100Maximum string length:
100Maximum string length:
20Available options:
male, female, other, unknown Date of birth (YYYY-MM-DD)
Show child attributes
Show child attributes
Marital status (married, single, divorced, widowed)
Maximum string length:
50Show child attributes
Show child attributes
Emergency contacts / next of kin
Maximum array length:
10Show child attributes
Show child attributes
Languages the patient speaks
Maximum array length:
20Show child attributes
Show child attributes
Reference to the patient's GP (Practitioner ID)
⌘I