Create care team
curl --request POST \
--url https://api.clinikapi.com/v1/care-teams \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"category": [
"<string>"
],
"patientId": "<string>",
"encounterId": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
},
"participant": [
{
"memberId": "<string>",
"role": "<string>",
"onBehalfOfId": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
}
}
],
"reasonCode": [
"<string>"
],
"managingOrganizationIds": [
"<string>"
],
"phone": "<string>",
"email": "<string>",
"note": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/care-teams"
payload = {
"name": "<string>",
"category": ["<string>"],
"patientId": "<string>",
"encounterId": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
},
"participant": [
{
"memberId": "<string>",
"role": "<string>",
"onBehalfOfId": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
}
}
],
"reasonCode": ["<string>"],
"managingOrganizationIds": ["<string>"],
"phone": "<string>",
"email": "<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({
name: '<string>',
category: ['<string>'],
patientId: '<string>',
encounterId: '<string>',
period: {start: '<string>', end: '<string>'},
participant: [
{
memberId: '<string>',
role: '<string>',
onBehalfOfId: '<string>',
period: {start: '<string>', end: '<string>'}
}
],
reasonCode: ['<string>'],
managingOrganizationIds: ['<string>'],
phone: '<string>',
email: '<string>',
note: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/care-teams', 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/care-teams",
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([
'name' => '<string>',
'category' => [
'<string>'
],
'patientId' => '<string>',
'encounterId' => '<string>',
'period' => [
'start' => '<string>',
'end' => '<string>'
],
'participant' => [
[
'memberId' => '<string>',
'role' => '<string>',
'onBehalfOfId' => '<string>',
'period' => [
'start' => '<string>',
'end' => '<string>'
]
]
],
'reasonCode' => [
'<string>'
],
'managingOrganizationIds' => [
'<string>'
],
'phone' => '<string>',
'email' => '<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/care-teams"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"participant\": [\n {\n \"memberId\": \"<string>\",\n \"role\": \"<string>\",\n \"onBehalfOfId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"managingOrganizationIds\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"note\": \"<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/care-teams")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"participant\": [\n {\n \"memberId\": \"<string>\",\n \"role\": \"<string>\",\n \"onBehalfOfId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"managingOrganizationIds\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/care-teams")
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 \"name\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"participant\": [\n {\n \"memberId\": \"<string>\",\n \"role\": \"<string>\",\n \"onBehalfOfId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"managingOrganizationIds\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyCare Teams
Create Care Team
POST
/
v1
/
care-teams
Create care team
curl --request POST \
--url https://api.clinikapi.com/v1/care-teams \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"category": [
"<string>"
],
"patientId": "<string>",
"encounterId": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
},
"participant": [
{
"memberId": "<string>",
"role": "<string>",
"onBehalfOfId": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
}
}
],
"reasonCode": [
"<string>"
],
"managingOrganizationIds": [
"<string>"
],
"phone": "<string>",
"email": "<string>",
"note": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/care-teams"
payload = {
"name": "<string>",
"category": ["<string>"],
"patientId": "<string>",
"encounterId": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
},
"participant": [
{
"memberId": "<string>",
"role": "<string>",
"onBehalfOfId": "<string>",
"period": {
"start": "<string>",
"end": "<string>"
}
}
],
"reasonCode": ["<string>"],
"managingOrganizationIds": ["<string>"],
"phone": "<string>",
"email": "<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({
name: '<string>',
category: ['<string>'],
patientId: '<string>',
encounterId: '<string>',
period: {start: '<string>', end: '<string>'},
participant: [
{
memberId: '<string>',
role: '<string>',
onBehalfOfId: '<string>',
period: {start: '<string>', end: '<string>'}
}
],
reasonCode: ['<string>'],
managingOrganizationIds: ['<string>'],
phone: '<string>',
email: '<string>',
note: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/care-teams', 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/care-teams",
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([
'name' => '<string>',
'category' => [
'<string>'
],
'patientId' => '<string>',
'encounterId' => '<string>',
'period' => [
'start' => '<string>',
'end' => '<string>'
],
'participant' => [
[
'memberId' => '<string>',
'role' => '<string>',
'onBehalfOfId' => '<string>',
'period' => [
'start' => '<string>',
'end' => '<string>'
]
]
],
'reasonCode' => [
'<string>'
],
'managingOrganizationIds' => [
'<string>'
],
'phone' => '<string>',
'email' => '<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/care-teams"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"participant\": [\n {\n \"memberId\": \"<string>\",\n \"role\": \"<string>\",\n \"onBehalfOfId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"managingOrganizationIds\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"note\": \"<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/care-teams")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"participant\": [\n {\n \"memberId\": \"<string>\",\n \"role\": \"<string>\",\n \"onBehalfOfId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"managingOrganizationIds\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/care-teams")
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 \"name\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"participant\": [\n {\n \"memberId\": \"<string>\",\n \"role\": \"<string>\",\n \"onBehalfOfId\": \"<string>\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"managingOrganizationIds\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Maximum string length:
500Available options:
proposed, active, suspended, inactive Maximum array length:
10Maximum string length:
200Maximum string length:
128Maximum string length:
128Show child attributes
Show child attributes
Maximum array length:
50Show child attributes
Show child attributes
Maximum array length:
10Maximum string length:
500Maximum array length:
10Maximum string length:
128Maximum string length:
20Maximum string length:
200Maximum string length:
5000Response
201
Care team created
⌘I