Add an appointment
curl --request POST \
--url https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"doctorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"medReferralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appointmentDate": "2023-12-25",
"appointmentTime": "<string>",
"attended": true,
"primaryInjuryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relatedInjuryIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"insuranceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments"
payload = {
"doctorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"medReferralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appointmentDate": "2023-12-25",
"appointmentTime": "<string>",
"attended": True,
"primaryInjuryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relatedInjuryIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"insuranceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
doctorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
providerLocationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
medReferralId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
appointmentDate: '2023-12-25',
appointmentTime: '<string>',
attended: true,
primaryInjuryId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
relatedInjuryIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
insuranceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments', 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.casexchange.com/api/public/v1/med-cases/{caseId}/appointments",
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([
'doctorId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'providerLocationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'medReferralId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'appointmentDate' => '2023-12-25',
'appointmentTime' => '<string>',
'attended' => true,
'primaryInjuryId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'relatedInjuryIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'insuranceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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.casexchange.com/api/public/v1/med-cases/{caseId}/appointments"
payload := strings.NewReader("{\n \"doctorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"providerLocationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"medReferralId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appointmentDate\": \"2023-12-25\",\n \"appointmentTime\": \"<string>\",\n \"attended\": true,\n \"primaryInjuryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relatedInjuryIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"insuranceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.casexchange.com/api/public/v1/med-cases/{caseId}/appointments")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"doctorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"providerLocationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"medReferralId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appointmentDate\": \"2023-12-25\",\n \"appointmentTime\": \"<string>\",\n \"attended\": true,\n \"primaryInjuryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relatedInjuryIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"insuranceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments")
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 \"doctorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"providerLocationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"medReferralId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appointmentDate\": \"2023-12-25\",\n \"appointmentTime\": \"<string>\",\n \"attended\": true,\n \"primaryInjuryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relatedInjuryIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"insuranceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"medCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"medReferralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"treatingProviderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"doctorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"doctor": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"title": "<string>"
},
"location": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"appointmentDate": "2023-12-25",
"appointmentTime": "<string>",
"attended": true,
"cancelledAt": "2023-11-07T05:31:56Z",
"category": "initial",
"source": "manual",
"premierStatus": "CHECKED_IN",
"isHistorical": true,
"primaryInjuryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relatedInjuryIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"insuranceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totalBilled": "<string>",
"totalPaid": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}Med Appointments
Add an appointment
Requires a provider-scoped key (cxpp_) at STANDARD tier. Firm and admin keys receive 403 wrong_scope. Restricted-access practices receive 403 restricted_access. Supplying a medReferralId that belongs to another practice is refused as 404 not_found. Fires the same notifications, activity and appointment.created webhook as an in-app create. A duplicate of a Premier-synced appointment returns 409 conflict with existingAppointmentId.
POST
/
med-cases
/
{caseId}
/
appointments
Add an appointment
curl --request POST \
--url https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"doctorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"medReferralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appointmentDate": "2023-12-25",
"appointmentTime": "<string>",
"attended": true,
"primaryInjuryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relatedInjuryIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"insuranceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments"
payload = {
"doctorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"medReferralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appointmentDate": "2023-12-25",
"appointmentTime": "<string>",
"attended": True,
"primaryInjuryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relatedInjuryIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"insuranceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
doctorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
providerLocationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
medReferralId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
appointmentDate: '2023-12-25',
appointmentTime: '<string>',
attended: true,
primaryInjuryId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
relatedInjuryIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
insuranceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments', 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.casexchange.com/api/public/v1/med-cases/{caseId}/appointments",
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([
'doctorId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'providerLocationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'medReferralId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'appointmentDate' => '2023-12-25',
'appointmentTime' => '<string>',
'attended' => true,
'primaryInjuryId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'relatedInjuryIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'insuranceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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.casexchange.com/api/public/v1/med-cases/{caseId}/appointments"
payload := strings.NewReader("{\n \"doctorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"providerLocationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"medReferralId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appointmentDate\": \"2023-12-25\",\n \"appointmentTime\": \"<string>\",\n \"attended\": true,\n \"primaryInjuryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relatedInjuryIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"insuranceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.casexchange.com/api/public/v1/med-cases/{caseId}/appointments")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"doctorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"providerLocationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"medReferralId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appointmentDate\": \"2023-12-25\",\n \"appointmentTime\": \"<string>\",\n \"attended\": true,\n \"primaryInjuryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relatedInjuryIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"insuranceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments")
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 \"doctorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"providerLocationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"medReferralId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appointmentDate\": \"2023-12-25\",\n \"appointmentTime\": \"<string>\",\n \"attended\": true,\n \"primaryInjuryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relatedInjuryIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"insuranceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"medCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"medReferralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"treatingProviderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"doctorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"doctor": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"title": "<string>"
},
"location": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"appointmentDate": "2023-12-25",
"appointmentTime": "<string>",
"attended": true,
"cancelledAt": "2023-11-07T05:31:56Z",
"category": "initial",
"source": "manual",
"premierStatus": "CHECKED_IN",
"isHistorical": true,
"primaryInjuryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relatedInjuryIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"insuranceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totalBilled": "<string>",
"totalPaid": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.
Path Parameters
Med case UUID
Body
application/json
From GET /me/doctors
From GET /me/locations
Defaults to your practice's most active referral on the case
Pattern:
^([01]\d|2[0-3]):[0-5]\d(:[0-5]\d)?$Available options:
initial, follow_up, imaging, treatment, other Maximum array length:
50