Upsert Patient (forgiving)
curl --request POST \
--url https://api.example.com/v1/patients/upsert \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"external_id": {
"type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "<string>",
"gender": "<string>",
"phone_number": "<string>",
"additional_phone_number": "<string>",
"email": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"comments": "<string>",
"workflow_stage_id": "<string>",
"assigned_user_id": "<string>",
"location_id": "<string>",
"organization_id": "<string>",
"tags": [
"<string>"
],
"referral": {
"physician_name": "<string>",
"physician_email": "<string>",
"physician_phone": "<string>",
"physician_fax": "<string>",
"physician_group": "<string>",
"physician_npi": "<string>",
"physician_address": "<string>",
"physician_address_2": "<string>",
"physician_city": "<string>",
"physician_zip": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"location_id": "<string>",
"icd_codes": [
"<string>"
],
"service_types": [],
"file_id": "<string>"
},
"payors": [
{
"insurance_id": "<string>",
"insurance_display_name": "<string>",
"payor_responsibility": "primary",
"insured_member_id": "<string>",
"external_id": "<string>",
"group_number": "<string>",
"group_description": "<string>",
"coverage_from": "2023-12-25",
"coverage_to": "2023-12-25",
"plan_name": "<string>",
"plan_type": "<string>",
"eligibility_check_comment": "<string>",
"subscriber": {
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"dob": "2023-11-07T05:31:56Z",
"insured_member_id": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"zip": "<string>"
},
"subscriber_id": "<string>",
"services": [
{
"verification_benefits_status": "pending",
"verification_dates": [
"2023-11-07T05:31:56Z"
],
"verification_benefits_comment": "<string>",
"pre_cert_name": "<string>",
"pre_cert_phone_number": "<string>",
"pre_cert_fax": "<string>",
"pre_cert_url": "<string>",
"pre_cert_penalty": "<string>",
"pre_cert_email": "<string>",
"sca_instructions": "<string>",
"claim_address": "<string>",
"oon_reimbursement_rate": 123,
"eligibility_check_id": "<string>",
"carve_out_insurer_id": "<string>",
"location_id": "<string>",
"rep_name": "<string>",
"call_reference_number": "<string>",
"called_phone_number": "<string>",
"location_rates": [
{
"covered_in_network": true,
"covered_out_network": true,
"copay_in_network": 123,
"copay_out_network": 123,
"co_insurance_in_network": 123,
"co_insurance_out_network": 123,
"auth_required_in_network": true,
"auth_required_out_network": true,
"auth_required_at_visit_in_network": 123,
"auth_required_at_visit_out_network": 123,
"mnr_required_in_network": true,
"mnr_required_out_network": true,
"mnr_required_at_visit_in_network": 123,
"mnr_required_at_visit_out_network": 123,
"deductible_apply_in_network": true,
"deductible_apply_out_network": true,
"oop_apply_in_network": true,
"oop_apply_out_network": true,
"copay_applies_to_oop_max_in_network": true,
"copay_applies_to_oop_max_out_network": true,
"dollar_limit_in_network": 123,
"dollar_limit_out_network": 123,
"dollar_limit_remaining_in_network": 123,
"dollar_limit_remaining_out_network": 123,
"visit_limit_in_network": 123,
"visit_limit_out_network": 123,
"visit_limit_remaining_in_network": 123,
"visit_limit_remaining_out_network": 123,
"id": "<string>"
}
]
}
],
"insurance_name": "<string>"
}
],
"custom_fields": {}
}
'import requests
url = "https://api.example.com/v1/patients/upsert"
payload = {
"external_id": {
"type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "<string>",
"gender": "<string>",
"phone_number": "<string>",
"additional_phone_number": "<string>",
"email": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"comments": "<string>",
"workflow_stage_id": "<string>",
"assigned_user_id": "<string>",
"location_id": "<string>",
"organization_id": "<string>",
"tags": ["<string>"],
"referral": {
"physician_name": "<string>",
"physician_email": "<string>",
"physician_phone": "<string>",
"physician_fax": "<string>",
"physician_group": "<string>",
"physician_npi": "<string>",
"physician_address": "<string>",
"physician_address_2": "<string>",
"physician_city": "<string>",
"physician_zip": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"location_id": "<string>",
"icd_codes": ["<string>"],
"service_types": [],
"file_id": "<string>"
},
"payors": [
{
"insurance_id": "<string>",
"insurance_display_name": "<string>",
"payor_responsibility": "primary",
"insured_member_id": "<string>",
"external_id": "<string>",
"group_number": "<string>",
"group_description": "<string>",
"coverage_from": "2023-12-25",
"coverage_to": "2023-12-25",
"plan_name": "<string>",
"plan_type": "<string>",
"eligibility_check_comment": "<string>",
"subscriber": {
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"dob": "2023-11-07T05:31:56Z",
"insured_member_id": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"zip": "<string>"
},
"subscriber_id": "<string>",
"services": [
{
"verification_benefits_status": "pending",
"verification_dates": ["2023-11-07T05:31:56Z"],
"verification_benefits_comment": "<string>",
"pre_cert_name": "<string>",
"pre_cert_phone_number": "<string>",
"pre_cert_fax": "<string>",
"pre_cert_url": "<string>",
"pre_cert_penalty": "<string>",
"pre_cert_email": "<string>",
"sca_instructions": "<string>",
"claim_address": "<string>",
"oon_reimbursement_rate": 123,
"eligibility_check_id": "<string>",
"carve_out_insurer_id": "<string>",
"location_id": "<string>",
"rep_name": "<string>",
"call_reference_number": "<string>",
"called_phone_number": "<string>",
"location_rates": [
{
"covered_in_network": True,
"covered_out_network": True,
"copay_in_network": 123,
"copay_out_network": 123,
"co_insurance_in_network": 123,
"co_insurance_out_network": 123,
"auth_required_in_network": True,
"auth_required_out_network": True,
"auth_required_at_visit_in_network": 123,
"auth_required_at_visit_out_network": 123,
"mnr_required_in_network": True,
"mnr_required_out_network": True,
"mnr_required_at_visit_in_network": 123,
"mnr_required_at_visit_out_network": 123,
"deductible_apply_in_network": True,
"deductible_apply_out_network": True,
"oop_apply_in_network": True,
"oop_apply_out_network": True,
"copay_applies_to_oop_max_in_network": True,
"copay_applies_to_oop_max_out_network": True,
"dollar_limit_in_network": 123,
"dollar_limit_out_network": 123,
"dollar_limit_remaining_in_network": 123,
"dollar_limit_remaining_out_network": 123,
"visit_limit_in_network": 123,
"visit_limit_out_network": 123,
"visit_limit_remaining_in_network": 123,
"visit_limit_remaining_out_network": 123,
"id": "<string>"
}
]
}
],
"insurance_name": "<string>"
}
],
"custom_fields": {}
}
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({
external_id: {type_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'},
first_name: '<string>',
last_name: '<string>',
middle_name: '<string>',
date_of_birth: '<string>',
gender: '<string>',
phone_number: '<string>',
additional_phone_number: '<string>',
email: '<string>',
address: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
comments: '<string>',
workflow_stage_id: '<string>',
assigned_user_id: '<string>',
location_id: '<string>',
organization_id: '<string>',
tags: ['<string>'],
referral: {
physician_name: '<string>',
physician_email: '<string>',
physician_phone: '<string>',
physician_fax: '<string>',
physician_group: '<string>',
physician_npi: '<string>',
physician_address: '<string>',
physician_address_2: '<string>',
physician_city: '<string>',
physician_zip: '<string>',
start_date: '2023-12-25',
end_date: '2023-12-25',
location_id: '<string>',
icd_codes: ['<string>'],
service_types: [],
file_id: '<string>'
},
payors: [
{
insurance_id: '<string>',
insurance_display_name: '<string>',
payor_responsibility: 'primary',
insured_member_id: '<string>',
external_id: '<string>',
group_number: '<string>',
group_description: '<string>',
coverage_from: '2023-12-25',
coverage_to: '2023-12-25',
plan_name: '<string>',
plan_type: '<string>',
eligibility_check_comment: '<string>',
subscriber: {
first_name: '<string>',
last_name: '<string>',
middle_name: '<string>',
dob: '2023-11-07T05:31:56Z',
insured_member_id: '<string>',
address: '<string>',
address2: '<string>',
city: '<string>',
zip: '<string>'
},
subscriber_id: '<string>',
services: [
{
verification_benefits_status: 'pending',
verification_dates: ['2023-11-07T05:31:56Z'],
verification_benefits_comment: '<string>',
pre_cert_name: '<string>',
pre_cert_phone_number: '<string>',
pre_cert_fax: '<string>',
pre_cert_url: '<string>',
pre_cert_penalty: '<string>',
pre_cert_email: '<string>',
sca_instructions: '<string>',
claim_address: '<string>',
oon_reimbursement_rate: 123,
eligibility_check_id: '<string>',
carve_out_insurer_id: '<string>',
location_id: '<string>',
rep_name: '<string>',
call_reference_number: '<string>',
called_phone_number: '<string>',
location_rates: [
{
covered_in_network: true,
covered_out_network: true,
copay_in_network: 123,
copay_out_network: 123,
co_insurance_in_network: 123,
co_insurance_out_network: 123,
auth_required_in_network: true,
auth_required_out_network: true,
auth_required_at_visit_in_network: 123,
auth_required_at_visit_out_network: 123,
mnr_required_in_network: true,
mnr_required_out_network: true,
mnr_required_at_visit_in_network: 123,
mnr_required_at_visit_out_network: 123,
deductible_apply_in_network: true,
deductible_apply_out_network: true,
oop_apply_in_network: true,
oop_apply_out_network: true,
copay_applies_to_oop_max_in_network: true,
copay_applies_to_oop_max_out_network: true,
dollar_limit_in_network: 123,
dollar_limit_out_network: 123,
dollar_limit_remaining_in_network: 123,
dollar_limit_remaining_out_network: 123,
visit_limit_in_network: 123,
visit_limit_out_network: 123,
visit_limit_remaining_in_network: 123,
visit_limit_remaining_out_network: 123,
id: '<string>'
}
]
}
],
insurance_name: '<string>'
}
],
custom_fields: {}
})
};
fetch('https://api.example.com/v1/patients/upsert', 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.example.com/v1/patients/upsert",
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([
'external_id' => [
'type_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'value' => '<string>'
],
'first_name' => '<string>',
'last_name' => '<string>',
'middle_name' => '<string>',
'date_of_birth' => '<string>',
'gender' => '<string>',
'phone_number' => '<string>',
'additional_phone_number' => '<string>',
'email' => '<string>',
'address' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'comments' => '<string>',
'workflow_stage_id' => '<string>',
'assigned_user_id' => '<string>',
'location_id' => '<string>',
'organization_id' => '<string>',
'tags' => [
'<string>'
],
'referral' => [
'physician_name' => '<string>',
'physician_email' => '<string>',
'physician_phone' => '<string>',
'physician_fax' => '<string>',
'physician_group' => '<string>',
'physician_npi' => '<string>',
'physician_address' => '<string>',
'physician_address_2' => '<string>',
'physician_city' => '<string>',
'physician_zip' => '<string>',
'start_date' => '2023-12-25',
'end_date' => '2023-12-25',
'location_id' => '<string>',
'icd_codes' => [
'<string>'
],
'service_types' => [
],
'file_id' => '<string>'
],
'payors' => [
[
'insurance_id' => '<string>',
'insurance_display_name' => '<string>',
'payor_responsibility' => 'primary',
'insured_member_id' => '<string>',
'external_id' => '<string>',
'group_number' => '<string>',
'group_description' => '<string>',
'coverage_from' => '2023-12-25',
'coverage_to' => '2023-12-25',
'plan_name' => '<string>',
'plan_type' => '<string>',
'eligibility_check_comment' => '<string>',
'subscriber' => [
'first_name' => '<string>',
'last_name' => '<string>',
'middle_name' => '<string>',
'dob' => '2023-11-07T05:31:56Z',
'insured_member_id' => '<string>',
'address' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'zip' => '<string>'
],
'subscriber_id' => '<string>',
'services' => [
[
'verification_benefits_status' => 'pending',
'verification_dates' => [
'2023-11-07T05:31:56Z'
],
'verification_benefits_comment' => '<string>',
'pre_cert_name' => '<string>',
'pre_cert_phone_number' => '<string>',
'pre_cert_fax' => '<string>',
'pre_cert_url' => '<string>',
'pre_cert_penalty' => '<string>',
'pre_cert_email' => '<string>',
'sca_instructions' => '<string>',
'claim_address' => '<string>',
'oon_reimbursement_rate' => 123,
'eligibility_check_id' => '<string>',
'carve_out_insurer_id' => '<string>',
'location_id' => '<string>',
'rep_name' => '<string>',
'call_reference_number' => '<string>',
'called_phone_number' => '<string>',
'location_rates' => [
[
'covered_in_network' => true,
'covered_out_network' => true,
'copay_in_network' => 123,
'copay_out_network' => 123,
'co_insurance_in_network' => 123,
'co_insurance_out_network' => 123,
'auth_required_in_network' => true,
'auth_required_out_network' => true,
'auth_required_at_visit_in_network' => 123,
'auth_required_at_visit_out_network' => 123,
'mnr_required_in_network' => true,
'mnr_required_out_network' => true,
'mnr_required_at_visit_in_network' => 123,
'mnr_required_at_visit_out_network' => 123,
'deductible_apply_in_network' => true,
'deductible_apply_out_network' => true,
'oop_apply_in_network' => true,
'oop_apply_out_network' => true,
'copay_applies_to_oop_max_in_network' => true,
'copay_applies_to_oop_max_out_network' => true,
'dollar_limit_in_network' => 123,
'dollar_limit_out_network' => 123,
'dollar_limit_remaining_in_network' => 123,
'dollar_limit_remaining_out_network' => 123,
'visit_limit_in_network' => 123,
'visit_limit_out_network' => 123,
'visit_limit_remaining_in_network' => 123,
'visit_limit_remaining_out_network' => 123,
'id' => '<string>'
]
]
]
],
'insurance_name' => '<string>'
]
],
'custom_fields' => [
]
]),
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.example.com/v1/patients/upsert"
payload := strings.NewReader("{\n \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"workflow_stage_id\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"payors\": [\n {\n \"insurance_id\": \"<string>\",\n \"insurance_display_name\": \"<string>\",\n \"payor_responsibility\": \"primary\",\n \"insured_member_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"group_number\": \"<string>\",\n \"group_description\": \"<string>\",\n \"coverage_from\": \"2023-12-25\",\n \"coverage_to\": \"2023-12-25\",\n \"plan_name\": \"<string>\",\n \"plan_type\": \"<string>\",\n \"eligibility_check_comment\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"insured_member_id\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"subscriber_id\": \"<string>\",\n \"services\": [\n {\n \"verification_benefits_status\": \"pending\",\n \"verification_dates\": [\n \"2023-11-07T05:31:56Z\"\n ],\n \"verification_benefits_comment\": \"<string>\",\n \"pre_cert_name\": \"<string>\",\n \"pre_cert_phone_number\": \"<string>\",\n \"pre_cert_fax\": \"<string>\",\n \"pre_cert_url\": \"<string>\",\n \"pre_cert_penalty\": \"<string>\",\n \"pre_cert_email\": \"<string>\",\n \"sca_instructions\": \"<string>\",\n \"claim_address\": \"<string>\",\n \"oon_reimbursement_rate\": 123,\n \"eligibility_check_id\": \"<string>\",\n \"carve_out_insurer_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rep_name\": \"<string>\",\n \"call_reference_number\": \"<string>\",\n \"called_phone_number\": \"<string>\",\n \"location_rates\": [\n {\n \"covered_in_network\": true,\n \"covered_out_network\": true,\n \"copay_in_network\": 123,\n \"copay_out_network\": 123,\n \"co_insurance_in_network\": 123,\n \"co_insurance_out_network\": 123,\n \"auth_required_in_network\": true,\n \"auth_required_out_network\": true,\n \"auth_required_at_visit_in_network\": 123,\n \"auth_required_at_visit_out_network\": 123,\n \"mnr_required_in_network\": true,\n \"mnr_required_out_network\": true,\n \"mnr_required_at_visit_in_network\": 123,\n \"mnr_required_at_visit_out_network\": 123,\n \"deductible_apply_in_network\": true,\n \"deductible_apply_out_network\": true,\n \"oop_apply_in_network\": true,\n \"oop_apply_out_network\": true,\n \"copay_applies_to_oop_max_in_network\": true,\n \"copay_applies_to_oop_max_out_network\": true,\n \"dollar_limit_in_network\": 123,\n \"dollar_limit_out_network\": 123,\n \"dollar_limit_remaining_in_network\": 123,\n \"dollar_limit_remaining_out_network\": 123,\n \"visit_limit_in_network\": 123,\n \"visit_limit_out_network\": 123,\n \"visit_limit_remaining_in_network\": 123,\n \"visit_limit_remaining_out_network\": 123,\n \"id\": \"<string>\"\n }\n ]\n }\n ],\n \"insurance_name\": \"<string>\"\n }\n ],\n \"custom_fields\": {}\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.example.com/v1/patients/upsert")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"workflow_stage_id\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"payors\": [\n {\n \"insurance_id\": \"<string>\",\n \"insurance_display_name\": \"<string>\",\n \"payor_responsibility\": \"primary\",\n \"insured_member_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"group_number\": \"<string>\",\n \"group_description\": \"<string>\",\n \"coverage_from\": \"2023-12-25\",\n \"coverage_to\": \"2023-12-25\",\n \"plan_name\": \"<string>\",\n \"plan_type\": \"<string>\",\n \"eligibility_check_comment\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"insured_member_id\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"subscriber_id\": \"<string>\",\n \"services\": [\n {\n \"verification_benefits_status\": \"pending\",\n \"verification_dates\": [\n \"2023-11-07T05:31:56Z\"\n ],\n \"verification_benefits_comment\": \"<string>\",\n \"pre_cert_name\": \"<string>\",\n \"pre_cert_phone_number\": \"<string>\",\n \"pre_cert_fax\": \"<string>\",\n \"pre_cert_url\": \"<string>\",\n \"pre_cert_penalty\": \"<string>\",\n \"pre_cert_email\": \"<string>\",\n \"sca_instructions\": \"<string>\",\n \"claim_address\": \"<string>\",\n \"oon_reimbursement_rate\": 123,\n \"eligibility_check_id\": \"<string>\",\n \"carve_out_insurer_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rep_name\": \"<string>\",\n \"call_reference_number\": \"<string>\",\n \"called_phone_number\": \"<string>\",\n \"location_rates\": [\n {\n \"covered_in_network\": true,\n \"covered_out_network\": true,\n \"copay_in_network\": 123,\n \"copay_out_network\": 123,\n \"co_insurance_in_network\": 123,\n \"co_insurance_out_network\": 123,\n \"auth_required_in_network\": true,\n \"auth_required_out_network\": true,\n \"auth_required_at_visit_in_network\": 123,\n \"auth_required_at_visit_out_network\": 123,\n \"mnr_required_in_network\": true,\n \"mnr_required_out_network\": true,\n \"mnr_required_at_visit_in_network\": 123,\n \"mnr_required_at_visit_out_network\": 123,\n \"deductible_apply_in_network\": true,\n \"deductible_apply_out_network\": true,\n \"oop_apply_in_network\": true,\n \"oop_apply_out_network\": true,\n \"copay_applies_to_oop_max_in_network\": true,\n \"copay_applies_to_oop_max_out_network\": true,\n \"dollar_limit_in_network\": 123,\n \"dollar_limit_out_network\": 123,\n \"dollar_limit_remaining_in_network\": 123,\n \"dollar_limit_remaining_out_network\": 123,\n \"visit_limit_in_network\": 123,\n \"visit_limit_out_network\": 123,\n \"visit_limit_remaining_in_network\": 123,\n \"visit_limit_remaining_out_network\": 123,\n \"id\": \"<string>\"\n }\n ]\n }\n ],\n \"insurance_name\": \"<string>\"\n }\n ],\n \"custom_fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/patients/upsert")
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 \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"workflow_stage_id\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"payors\": [\n {\n \"insurance_id\": \"<string>\",\n \"insurance_display_name\": \"<string>\",\n \"payor_responsibility\": \"primary\",\n \"insured_member_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"group_number\": \"<string>\",\n \"group_description\": \"<string>\",\n \"coverage_from\": \"2023-12-25\",\n \"coverage_to\": \"2023-12-25\",\n \"plan_name\": \"<string>\",\n \"plan_type\": \"<string>\",\n \"eligibility_check_comment\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"insured_member_id\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"subscriber_id\": \"<string>\",\n \"services\": [\n {\n \"verification_benefits_status\": \"pending\",\n \"verification_dates\": [\n \"2023-11-07T05:31:56Z\"\n ],\n \"verification_benefits_comment\": \"<string>\",\n \"pre_cert_name\": \"<string>\",\n \"pre_cert_phone_number\": \"<string>\",\n \"pre_cert_fax\": \"<string>\",\n \"pre_cert_url\": \"<string>\",\n \"pre_cert_penalty\": \"<string>\",\n \"pre_cert_email\": \"<string>\",\n \"sca_instructions\": \"<string>\",\n \"claim_address\": \"<string>\",\n \"oon_reimbursement_rate\": 123,\n \"eligibility_check_id\": \"<string>\",\n \"carve_out_insurer_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rep_name\": \"<string>\",\n \"call_reference_number\": \"<string>\",\n \"called_phone_number\": \"<string>\",\n \"location_rates\": [\n {\n \"covered_in_network\": true,\n \"covered_out_network\": true,\n \"copay_in_network\": 123,\n \"copay_out_network\": 123,\n \"co_insurance_in_network\": 123,\n \"co_insurance_out_network\": 123,\n \"auth_required_in_network\": true,\n \"auth_required_out_network\": true,\n \"auth_required_at_visit_in_network\": 123,\n \"auth_required_at_visit_out_network\": 123,\n \"mnr_required_in_network\": true,\n \"mnr_required_out_network\": true,\n \"mnr_required_at_visit_in_network\": 123,\n \"mnr_required_at_visit_out_network\": 123,\n \"deductible_apply_in_network\": true,\n \"deductible_apply_out_network\": true,\n \"oop_apply_in_network\": true,\n \"oop_apply_out_network\": true,\n \"copay_applies_to_oop_max_in_network\": true,\n \"copay_applies_to_oop_max_out_network\": true,\n \"dollar_limit_in_network\": 123,\n \"dollar_limit_out_network\": 123,\n \"dollar_limit_remaining_in_network\": 123,\n \"dollar_limit_remaining_out_network\": 123,\n \"visit_limit_in_network\": 123,\n \"visit_limit_out_network\": 123,\n \"visit_limit_remaining_in_network\": 123,\n \"visit_limit_remaining_out_network\": 123,\n \"id\": \"<string>\"\n }\n ]\n }\n ],\n \"insurance_name\": \"<string>\"\n }\n ],\n \"custom_fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"patient": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"phone_number": "<string>",
"additional_phone_number": "<string>",
"email": "<string>",
"date_of_birth": "2023-12-25",
"gender": "male",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "alabama",
"zip": "<string>",
"workflow_stage_id": "<string>",
"assigned_user_id": "<string>",
"location_id": "<string>",
"organization_id": "<string>",
"created_from": "form",
"active": true,
"version": 1,
"first_communication_at": "2023-11-07T05:31:56Z",
"has_sync_completed": true,
"custom_fields": {},
"comments": "<string>",
"tags": [
{
"id": "<string>",
"name": "<string>"
}
],
"workflow_stage": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"actions": [
"verify_insurance"
],
"order": 123,
"description": "<string>"
},
"assigned_user": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"referrals": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"physician_name": "<string>",
"physician_email": "<string>",
"physician_phone": "<string>",
"physician_fax": "<string>",
"physician_group": "<string>",
"physician_npi": "<string>",
"physician_address": "<string>",
"physician_address_2": "<string>",
"physician_city": "<string>",
"physician_state": "alabama",
"physician_zip": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"location_id": "<string>",
"icd_codes": [
"<string>"
],
"service_types": [
"medical_care"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"payors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"patient_id": "<string>",
"insurance_id": "<string>",
"coverage_chain_id": "<string>",
"insurance_display_name": "<string>",
"subscriber_id": "<string>",
"external_id": "<string>",
"relationship_to_subscriber": "spouse",
"insured_member_id": "<string>",
"group_number": "<string>",
"group_description": "<string>",
"medicaid_id": "<string>",
"payor_responsibility": "primary",
"coverage_from": "2023-11-07T05:31:56Z",
"coverage_to": "2023-11-07T05:31:56Z",
"provider_network_status": "unknown",
"cbh_status": "active",
"plan_funding_type": "fully_funded",
"plan_name": "<string>",
"plan_type": "01",
"plan_renewal_date_type": "calendar_year",
"benefit_period_end_date": "2023-12-25",
"cob_on_file": true,
"cob_last_verified_at": "2023-11-07T05:31:56Z",
"has_other_active_coverage": true,
"cob_other_coverages": [
{
"name": "<string>",
"position": "primary"
}
],
"out_of_state_benefits": true,
"out_of_state_benefits_comments": "<string>",
"in_grace_period": true,
"last_payment_date": "2023-12-25",
"is_cobra_coverage": true,
"deductible_apply_to_oop": true,
"eligibility_check_status": "pending",
"eligibility_check_comment": "<string>",
"eligibility_check_date": "2023-11-07T05:31:56Z",
"eligibility_version": 0,
"individual_deductible_policy_in_network": 123,
"individual_deductible_policy_out_network": 123,
"individual_deductible_remaining_in_network": 123,
"individual_deductible_remaining_out_network": 123,
"family_deductible_policy_in_network": 123,
"family_deductible_policy_out_network": 123,
"family_deductible_remaining_in_network": 123,
"family_deductible_remaining_out_network": 123,
"individual_oop_max_policy_in_network": 123,
"individual_oop_max_policy_out_network": 123,
"individual_oop_max_remaining_in_network": 123,
"individual_oop_max_remaining_out_network": 123,
"family_oop_max_policy_in_network": 123,
"family_oop_max_policy_out_network": 123,
"family_oop_max_remaining_in_network": 123,
"family_oop_max_remaining_out_network": 123,
"benefits_related_entities": [
{}
],
"ai_summary": "<string>",
"ai_summary_generated_at": "2023-11-07T05:31:56Z",
"patient": {},
"insurance": {},
"subscriber": {},
"services": [
{
"copay_in_network": 25,
"created_at": "2024-01-15T10:30:00Z",
"eligibility_check_status": "ELIGIBLE",
"id": "550e8400-e29b-41d4-a716-446655440014",
"payor_id": "550e8400-e29b-41d4-a716-446655440012",
"service_type": "PT",
"updated_at": "2024-01-15T10:30:00Z",
"verification_benefits_status": "VERIFIED"
}
],
"active": true,
"version": 1
}
],
"external_id_values": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>",
"external_id_type": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
},
"matched": true,
"created": true,
"match_reason": "external_id",
"dropped_fields": [
"<string>"
],
"payor_results": [
{
"outcome": "created",
"payor_responsibility": "primary",
"submitted_insurance_name": "<string>",
"resolved_insurance_id": "<string>",
"resolved_insurance_name": "<string>",
"trading_partner_service_id": "<string>",
"payor_id": "<string>",
"coverage_chain_id": "<string>",
"resolution_method": "canonical_name",
"reason_code": "insurance_name_missing",
"message": "<string>"
}
]
}{
"type": "validation_error",
"code": "invalid_parameter",
"message": "Field validation failed",
"param": "phone_number"
}Patients
Upsert Patient (forgiving)
Forgiving upsert for integration partners. Normalizes phone / email / date_of_birth and silently drops unparseable values (reported via dropped_fields). Matches existing patients in priority: external_id → demographics → phone + fuzzy name → email + fuzzy name. Overwrites all provided non-null fields on match (except phone_number once first communication has occurred — that lock is respected and the field is silently dropped). When external_id is supplied, the returned patient is guaranteed to carry it: a pre-existing different value for that type is overwritten and the old→new transition is recorded in the patient activity log (visible in the History panel).
POST
/
v1
/
patients
/
upsert
Upsert Patient (forgiving)
curl --request POST \
--url https://api.example.com/v1/patients/upsert \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"external_id": {
"type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "<string>",
"gender": "<string>",
"phone_number": "<string>",
"additional_phone_number": "<string>",
"email": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"comments": "<string>",
"workflow_stage_id": "<string>",
"assigned_user_id": "<string>",
"location_id": "<string>",
"organization_id": "<string>",
"tags": [
"<string>"
],
"referral": {
"physician_name": "<string>",
"physician_email": "<string>",
"physician_phone": "<string>",
"physician_fax": "<string>",
"physician_group": "<string>",
"physician_npi": "<string>",
"physician_address": "<string>",
"physician_address_2": "<string>",
"physician_city": "<string>",
"physician_zip": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"location_id": "<string>",
"icd_codes": [
"<string>"
],
"service_types": [],
"file_id": "<string>"
},
"payors": [
{
"insurance_id": "<string>",
"insurance_display_name": "<string>",
"payor_responsibility": "primary",
"insured_member_id": "<string>",
"external_id": "<string>",
"group_number": "<string>",
"group_description": "<string>",
"coverage_from": "2023-12-25",
"coverage_to": "2023-12-25",
"plan_name": "<string>",
"plan_type": "<string>",
"eligibility_check_comment": "<string>",
"subscriber": {
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"dob": "2023-11-07T05:31:56Z",
"insured_member_id": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"zip": "<string>"
},
"subscriber_id": "<string>",
"services": [
{
"verification_benefits_status": "pending",
"verification_dates": [
"2023-11-07T05:31:56Z"
],
"verification_benefits_comment": "<string>",
"pre_cert_name": "<string>",
"pre_cert_phone_number": "<string>",
"pre_cert_fax": "<string>",
"pre_cert_url": "<string>",
"pre_cert_penalty": "<string>",
"pre_cert_email": "<string>",
"sca_instructions": "<string>",
"claim_address": "<string>",
"oon_reimbursement_rate": 123,
"eligibility_check_id": "<string>",
"carve_out_insurer_id": "<string>",
"location_id": "<string>",
"rep_name": "<string>",
"call_reference_number": "<string>",
"called_phone_number": "<string>",
"location_rates": [
{
"covered_in_network": true,
"covered_out_network": true,
"copay_in_network": 123,
"copay_out_network": 123,
"co_insurance_in_network": 123,
"co_insurance_out_network": 123,
"auth_required_in_network": true,
"auth_required_out_network": true,
"auth_required_at_visit_in_network": 123,
"auth_required_at_visit_out_network": 123,
"mnr_required_in_network": true,
"mnr_required_out_network": true,
"mnr_required_at_visit_in_network": 123,
"mnr_required_at_visit_out_network": 123,
"deductible_apply_in_network": true,
"deductible_apply_out_network": true,
"oop_apply_in_network": true,
"oop_apply_out_network": true,
"copay_applies_to_oop_max_in_network": true,
"copay_applies_to_oop_max_out_network": true,
"dollar_limit_in_network": 123,
"dollar_limit_out_network": 123,
"dollar_limit_remaining_in_network": 123,
"dollar_limit_remaining_out_network": 123,
"visit_limit_in_network": 123,
"visit_limit_out_network": 123,
"visit_limit_remaining_in_network": 123,
"visit_limit_remaining_out_network": 123,
"id": "<string>"
}
]
}
],
"insurance_name": "<string>"
}
],
"custom_fields": {}
}
'import requests
url = "https://api.example.com/v1/patients/upsert"
payload = {
"external_id": {
"type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "<string>",
"gender": "<string>",
"phone_number": "<string>",
"additional_phone_number": "<string>",
"email": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"comments": "<string>",
"workflow_stage_id": "<string>",
"assigned_user_id": "<string>",
"location_id": "<string>",
"organization_id": "<string>",
"tags": ["<string>"],
"referral": {
"physician_name": "<string>",
"physician_email": "<string>",
"physician_phone": "<string>",
"physician_fax": "<string>",
"physician_group": "<string>",
"physician_npi": "<string>",
"physician_address": "<string>",
"physician_address_2": "<string>",
"physician_city": "<string>",
"physician_zip": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"location_id": "<string>",
"icd_codes": ["<string>"],
"service_types": [],
"file_id": "<string>"
},
"payors": [
{
"insurance_id": "<string>",
"insurance_display_name": "<string>",
"payor_responsibility": "primary",
"insured_member_id": "<string>",
"external_id": "<string>",
"group_number": "<string>",
"group_description": "<string>",
"coverage_from": "2023-12-25",
"coverage_to": "2023-12-25",
"plan_name": "<string>",
"plan_type": "<string>",
"eligibility_check_comment": "<string>",
"subscriber": {
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"dob": "2023-11-07T05:31:56Z",
"insured_member_id": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"zip": "<string>"
},
"subscriber_id": "<string>",
"services": [
{
"verification_benefits_status": "pending",
"verification_dates": ["2023-11-07T05:31:56Z"],
"verification_benefits_comment": "<string>",
"pre_cert_name": "<string>",
"pre_cert_phone_number": "<string>",
"pre_cert_fax": "<string>",
"pre_cert_url": "<string>",
"pre_cert_penalty": "<string>",
"pre_cert_email": "<string>",
"sca_instructions": "<string>",
"claim_address": "<string>",
"oon_reimbursement_rate": 123,
"eligibility_check_id": "<string>",
"carve_out_insurer_id": "<string>",
"location_id": "<string>",
"rep_name": "<string>",
"call_reference_number": "<string>",
"called_phone_number": "<string>",
"location_rates": [
{
"covered_in_network": True,
"covered_out_network": True,
"copay_in_network": 123,
"copay_out_network": 123,
"co_insurance_in_network": 123,
"co_insurance_out_network": 123,
"auth_required_in_network": True,
"auth_required_out_network": True,
"auth_required_at_visit_in_network": 123,
"auth_required_at_visit_out_network": 123,
"mnr_required_in_network": True,
"mnr_required_out_network": True,
"mnr_required_at_visit_in_network": 123,
"mnr_required_at_visit_out_network": 123,
"deductible_apply_in_network": True,
"deductible_apply_out_network": True,
"oop_apply_in_network": True,
"oop_apply_out_network": True,
"copay_applies_to_oop_max_in_network": True,
"copay_applies_to_oop_max_out_network": True,
"dollar_limit_in_network": 123,
"dollar_limit_out_network": 123,
"dollar_limit_remaining_in_network": 123,
"dollar_limit_remaining_out_network": 123,
"visit_limit_in_network": 123,
"visit_limit_out_network": 123,
"visit_limit_remaining_in_network": 123,
"visit_limit_remaining_out_network": 123,
"id": "<string>"
}
]
}
],
"insurance_name": "<string>"
}
],
"custom_fields": {}
}
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({
external_id: {type_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'},
first_name: '<string>',
last_name: '<string>',
middle_name: '<string>',
date_of_birth: '<string>',
gender: '<string>',
phone_number: '<string>',
additional_phone_number: '<string>',
email: '<string>',
address: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
comments: '<string>',
workflow_stage_id: '<string>',
assigned_user_id: '<string>',
location_id: '<string>',
organization_id: '<string>',
tags: ['<string>'],
referral: {
physician_name: '<string>',
physician_email: '<string>',
physician_phone: '<string>',
physician_fax: '<string>',
physician_group: '<string>',
physician_npi: '<string>',
physician_address: '<string>',
physician_address_2: '<string>',
physician_city: '<string>',
physician_zip: '<string>',
start_date: '2023-12-25',
end_date: '2023-12-25',
location_id: '<string>',
icd_codes: ['<string>'],
service_types: [],
file_id: '<string>'
},
payors: [
{
insurance_id: '<string>',
insurance_display_name: '<string>',
payor_responsibility: 'primary',
insured_member_id: '<string>',
external_id: '<string>',
group_number: '<string>',
group_description: '<string>',
coverage_from: '2023-12-25',
coverage_to: '2023-12-25',
plan_name: '<string>',
plan_type: '<string>',
eligibility_check_comment: '<string>',
subscriber: {
first_name: '<string>',
last_name: '<string>',
middle_name: '<string>',
dob: '2023-11-07T05:31:56Z',
insured_member_id: '<string>',
address: '<string>',
address2: '<string>',
city: '<string>',
zip: '<string>'
},
subscriber_id: '<string>',
services: [
{
verification_benefits_status: 'pending',
verification_dates: ['2023-11-07T05:31:56Z'],
verification_benefits_comment: '<string>',
pre_cert_name: '<string>',
pre_cert_phone_number: '<string>',
pre_cert_fax: '<string>',
pre_cert_url: '<string>',
pre_cert_penalty: '<string>',
pre_cert_email: '<string>',
sca_instructions: '<string>',
claim_address: '<string>',
oon_reimbursement_rate: 123,
eligibility_check_id: '<string>',
carve_out_insurer_id: '<string>',
location_id: '<string>',
rep_name: '<string>',
call_reference_number: '<string>',
called_phone_number: '<string>',
location_rates: [
{
covered_in_network: true,
covered_out_network: true,
copay_in_network: 123,
copay_out_network: 123,
co_insurance_in_network: 123,
co_insurance_out_network: 123,
auth_required_in_network: true,
auth_required_out_network: true,
auth_required_at_visit_in_network: 123,
auth_required_at_visit_out_network: 123,
mnr_required_in_network: true,
mnr_required_out_network: true,
mnr_required_at_visit_in_network: 123,
mnr_required_at_visit_out_network: 123,
deductible_apply_in_network: true,
deductible_apply_out_network: true,
oop_apply_in_network: true,
oop_apply_out_network: true,
copay_applies_to_oop_max_in_network: true,
copay_applies_to_oop_max_out_network: true,
dollar_limit_in_network: 123,
dollar_limit_out_network: 123,
dollar_limit_remaining_in_network: 123,
dollar_limit_remaining_out_network: 123,
visit_limit_in_network: 123,
visit_limit_out_network: 123,
visit_limit_remaining_in_network: 123,
visit_limit_remaining_out_network: 123,
id: '<string>'
}
]
}
],
insurance_name: '<string>'
}
],
custom_fields: {}
})
};
fetch('https://api.example.com/v1/patients/upsert', 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.example.com/v1/patients/upsert",
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([
'external_id' => [
'type_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'value' => '<string>'
],
'first_name' => '<string>',
'last_name' => '<string>',
'middle_name' => '<string>',
'date_of_birth' => '<string>',
'gender' => '<string>',
'phone_number' => '<string>',
'additional_phone_number' => '<string>',
'email' => '<string>',
'address' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'comments' => '<string>',
'workflow_stage_id' => '<string>',
'assigned_user_id' => '<string>',
'location_id' => '<string>',
'organization_id' => '<string>',
'tags' => [
'<string>'
],
'referral' => [
'physician_name' => '<string>',
'physician_email' => '<string>',
'physician_phone' => '<string>',
'physician_fax' => '<string>',
'physician_group' => '<string>',
'physician_npi' => '<string>',
'physician_address' => '<string>',
'physician_address_2' => '<string>',
'physician_city' => '<string>',
'physician_zip' => '<string>',
'start_date' => '2023-12-25',
'end_date' => '2023-12-25',
'location_id' => '<string>',
'icd_codes' => [
'<string>'
],
'service_types' => [
],
'file_id' => '<string>'
],
'payors' => [
[
'insurance_id' => '<string>',
'insurance_display_name' => '<string>',
'payor_responsibility' => 'primary',
'insured_member_id' => '<string>',
'external_id' => '<string>',
'group_number' => '<string>',
'group_description' => '<string>',
'coverage_from' => '2023-12-25',
'coverage_to' => '2023-12-25',
'plan_name' => '<string>',
'plan_type' => '<string>',
'eligibility_check_comment' => '<string>',
'subscriber' => [
'first_name' => '<string>',
'last_name' => '<string>',
'middle_name' => '<string>',
'dob' => '2023-11-07T05:31:56Z',
'insured_member_id' => '<string>',
'address' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'zip' => '<string>'
],
'subscriber_id' => '<string>',
'services' => [
[
'verification_benefits_status' => 'pending',
'verification_dates' => [
'2023-11-07T05:31:56Z'
],
'verification_benefits_comment' => '<string>',
'pre_cert_name' => '<string>',
'pre_cert_phone_number' => '<string>',
'pre_cert_fax' => '<string>',
'pre_cert_url' => '<string>',
'pre_cert_penalty' => '<string>',
'pre_cert_email' => '<string>',
'sca_instructions' => '<string>',
'claim_address' => '<string>',
'oon_reimbursement_rate' => 123,
'eligibility_check_id' => '<string>',
'carve_out_insurer_id' => '<string>',
'location_id' => '<string>',
'rep_name' => '<string>',
'call_reference_number' => '<string>',
'called_phone_number' => '<string>',
'location_rates' => [
[
'covered_in_network' => true,
'covered_out_network' => true,
'copay_in_network' => 123,
'copay_out_network' => 123,
'co_insurance_in_network' => 123,
'co_insurance_out_network' => 123,
'auth_required_in_network' => true,
'auth_required_out_network' => true,
'auth_required_at_visit_in_network' => 123,
'auth_required_at_visit_out_network' => 123,
'mnr_required_in_network' => true,
'mnr_required_out_network' => true,
'mnr_required_at_visit_in_network' => 123,
'mnr_required_at_visit_out_network' => 123,
'deductible_apply_in_network' => true,
'deductible_apply_out_network' => true,
'oop_apply_in_network' => true,
'oop_apply_out_network' => true,
'copay_applies_to_oop_max_in_network' => true,
'copay_applies_to_oop_max_out_network' => true,
'dollar_limit_in_network' => 123,
'dollar_limit_out_network' => 123,
'dollar_limit_remaining_in_network' => 123,
'dollar_limit_remaining_out_network' => 123,
'visit_limit_in_network' => 123,
'visit_limit_out_network' => 123,
'visit_limit_remaining_in_network' => 123,
'visit_limit_remaining_out_network' => 123,
'id' => '<string>'
]
]
]
],
'insurance_name' => '<string>'
]
],
'custom_fields' => [
]
]),
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.example.com/v1/patients/upsert"
payload := strings.NewReader("{\n \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"workflow_stage_id\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"payors\": [\n {\n \"insurance_id\": \"<string>\",\n \"insurance_display_name\": \"<string>\",\n \"payor_responsibility\": \"primary\",\n \"insured_member_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"group_number\": \"<string>\",\n \"group_description\": \"<string>\",\n \"coverage_from\": \"2023-12-25\",\n \"coverage_to\": \"2023-12-25\",\n \"plan_name\": \"<string>\",\n \"plan_type\": \"<string>\",\n \"eligibility_check_comment\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"insured_member_id\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"subscriber_id\": \"<string>\",\n \"services\": [\n {\n \"verification_benefits_status\": \"pending\",\n \"verification_dates\": [\n \"2023-11-07T05:31:56Z\"\n ],\n \"verification_benefits_comment\": \"<string>\",\n \"pre_cert_name\": \"<string>\",\n \"pre_cert_phone_number\": \"<string>\",\n \"pre_cert_fax\": \"<string>\",\n \"pre_cert_url\": \"<string>\",\n \"pre_cert_penalty\": \"<string>\",\n \"pre_cert_email\": \"<string>\",\n \"sca_instructions\": \"<string>\",\n \"claim_address\": \"<string>\",\n \"oon_reimbursement_rate\": 123,\n \"eligibility_check_id\": \"<string>\",\n \"carve_out_insurer_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rep_name\": \"<string>\",\n \"call_reference_number\": \"<string>\",\n \"called_phone_number\": \"<string>\",\n \"location_rates\": [\n {\n \"covered_in_network\": true,\n \"covered_out_network\": true,\n \"copay_in_network\": 123,\n \"copay_out_network\": 123,\n \"co_insurance_in_network\": 123,\n \"co_insurance_out_network\": 123,\n \"auth_required_in_network\": true,\n \"auth_required_out_network\": true,\n \"auth_required_at_visit_in_network\": 123,\n \"auth_required_at_visit_out_network\": 123,\n \"mnr_required_in_network\": true,\n \"mnr_required_out_network\": true,\n \"mnr_required_at_visit_in_network\": 123,\n \"mnr_required_at_visit_out_network\": 123,\n \"deductible_apply_in_network\": true,\n \"deductible_apply_out_network\": true,\n \"oop_apply_in_network\": true,\n \"oop_apply_out_network\": true,\n \"copay_applies_to_oop_max_in_network\": true,\n \"copay_applies_to_oop_max_out_network\": true,\n \"dollar_limit_in_network\": 123,\n \"dollar_limit_out_network\": 123,\n \"dollar_limit_remaining_in_network\": 123,\n \"dollar_limit_remaining_out_network\": 123,\n \"visit_limit_in_network\": 123,\n \"visit_limit_out_network\": 123,\n \"visit_limit_remaining_in_network\": 123,\n \"visit_limit_remaining_out_network\": 123,\n \"id\": \"<string>\"\n }\n ]\n }\n ],\n \"insurance_name\": \"<string>\"\n }\n ],\n \"custom_fields\": {}\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.example.com/v1/patients/upsert")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"workflow_stage_id\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"payors\": [\n {\n \"insurance_id\": \"<string>\",\n \"insurance_display_name\": \"<string>\",\n \"payor_responsibility\": \"primary\",\n \"insured_member_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"group_number\": \"<string>\",\n \"group_description\": \"<string>\",\n \"coverage_from\": \"2023-12-25\",\n \"coverage_to\": \"2023-12-25\",\n \"plan_name\": \"<string>\",\n \"plan_type\": \"<string>\",\n \"eligibility_check_comment\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"insured_member_id\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"subscriber_id\": \"<string>\",\n \"services\": [\n {\n \"verification_benefits_status\": \"pending\",\n \"verification_dates\": [\n \"2023-11-07T05:31:56Z\"\n ],\n \"verification_benefits_comment\": \"<string>\",\n \"pre_cert_name\": \"<string>\",\n \"pre_cert_phone_number\": \"<string>\",\n \"pre_cert_fax\": \"<string>\",\n \"pre_cert_url\": \"<string>\",\n \"pre_cert_penalty\": \"<string>\",\n \"pre_cert_email\": \"<string>\",\n \"sca_instructions\": \"<string>\",\n \"claim_address\": \"<string>\",\n \"oon_reimbursement_rate\": 123,\n \"eligibility_check_id\": \"<string>\",\n \"carve_out_insurer_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rep_name\": \"<string>\",\n \"call_reference_number\": \"<string>\",\n \"called_phone_number\": \"<string>\",\n \"location_rates\": [\n {\n \"covered_in_network\": true,\n \"covered_out_network\": true,\n \"copay_in_network\": 123,\n \"copay_out_network\": 123,\n \"co_insurance_in_network\": 123,\n \"co_insurance_out_network\": 123,\n \"auth_required_in_network\": true,\n \"auth_required_out_network\": true,\n \"auth_required_at_visit_in_network\": 123,\n \"auth_required_at_visit_out_network\": 123,\n \"mnr_required_in_network\": true,\n \"mnr_required_out_network\": true,\n \"mnr_required_at_visit_in_network\": 123,\n \"mnr_required_at_visit_out_network\": 123,\n \"deductible_apply_in_network\": true,\n \"deductible_apply_out_network\": true,\n \"oop_apply_in_network\": true,\n \"oop_apply_out_network\": true,\n \"copay_applies_to_oop_max_in_network\": true,\n \"copay_applies_to_oop_max_out_network\": true,\n \"dollar_limit_in_network\": 123,\n \"dollar_limit_out_network\": 123,\n \"dollar_limit_remaining_in_network\": 123,\n \"dollar_limit_remaining_out_network\": 123,\n \"visit_limit_in_network\": 123,\n \"visit_limit_out_network\": 123,\n \"visit_limit_remaining_in_network\": 123,\n \"visit_limit_remaining_out_network\": 123,\n \"id\": \"<string>\"\n }\n ]\n }\n ],\n \"insurance_name\": \"<string>\"\n }\n ],\n \"custom_fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/patients/upsert")
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 \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"workflow_stage_id\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"payors\": [\n {\n \"insurance_id\": \"<string>\",\n \"insurance_display_name\": \"<string>\",\n \"payor_responsibility\": \"primary\",\n \"insured_member_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"group_number\": \"<string>\",\n \"group_description\": \"<string>\",\n \"coverage_from\": \"2023-12-25\",\n \"coverage_to\": \"2023-12-25\",\n \"plan_name\": \"<string>\",\n \"plan_type\": \"<string>\",\n \"eligibility_check_comment\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"insured_member_id\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"subscriber_id\": \"<string>\",\n \"services\": [\n {\n \"verification_benefits_status\": \"pending\",\n \"verification_dates\": [\n \"2023-11-07T05:31:56Z\"\n ],\n \"verification_benefits_comment\": \"<string>\",\n \"pre_cert_name\": \"<string>\",\n \"pre_cert_phone_number\": \"<string>\",\n \"pre_cert_fax\": \"<string>\",\n \"pre_cert_url\": \"<string>\",\n \"pre_cert_penalty\": \"<string>\",\n \"pre_cert_email\": \"<string>\",\n \"sca_instructions\": \"<string>\",\n \"claim_address\": \"<string>\",\n \"oon_reimbursement_rate\": 123,\n \"eligibility_check_id\": \"<string>\",\n \"carve_out_insurer_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rep_name\": \"<string>\",\n \"call_reference_number\": \"<string>\",\n \"called_phone_number\": \"<string>\",\n \"location_rates\": [\n {\n \"covered_in_network\": true,\n \"covered_out_network\": true,\n \"copay_in_network\": 123,\n \"copay_out_network\": 123,\n \"co_insurance_in_network\": 123,\n \"co_insurance_out_network\": 123,\n \"auth_required_in_network\": true,\n \"auth_required_out_network\": true,\n \"auth_required_at_visit_in_network\": 123,\n \"auth_required_at_visit_out_network\": 123,\n \"mnr_required_in_network\": true,\n \"mnr_required_out_network\": true,\n \"mnr_required_at_visit_in_network\": 123,\n \"mnr_required_at_visit_out_network\": 123,\n \"deductible_apply_in_network\": true,\n \"deductible_apply_out_network\": true,\n \"oop_apply_in_network\": true,\n \"oop_apply_out_network\": true,\n \"copay_applies_to_oop_max_in_network\": true,\n \"copay_applies_to_oop_max_out_network\": true,\n \"dollar_limit_in_network\": 123,\n \"dollar_limit_out_network\": 123,\n \"dollar_limit_remaining_in_network\": 123,\n \"dollar_limit_remaining_out_network\": 123,\n \"visit_limit_in_network\": 123,\n \"visit_limit_out_network\": 123,\n \"visit_limit_remaining_in_network\": 123,\n \"visit_limit_remaining_out_network\": 123,\n \"id\": \"<string>\"\n }\n ]\n }\n ],\n \"insurance_name\": \"<string>\"\n }\n ],\n \"custom_fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"patient": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"phone_number": "<string>",
"additional_phone_number": "<string>",
"email": "<string>",
"date_of_birth": "2023-12-25",
"gender": "male",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "alabama",
"zip": "<string>",
"workflow_stage_id": "<string>",
"assigned_user_id": "<string>",
"location_id": "<string>",
"organization_id": "<string>",
"created_from": "form",
"active": true,
"version": 1,
"first_communication_at": "2023-11-07T05:31:56Z",
"has_sync_completed": true,
"custom_fields": {},
"comments": "<string>",
"tags": [
{
"id": "<string>",
"name": "<string>"
}
],
"workflow_stage": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"actions": [
"verify_insurance"
],
"order": 123,
"description": "<string>"
},
"assigned_user": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"referrals": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"physician_name": "<string>",
"physician_email": "<string>",
"physician_phone": "<string>",
"physician_fax": "<string>",
"physician_group": "<string>",
"physician_npi": "<string>",
"physician_address": "<string>",
"physician_address_2": "<string>",
"physician_city": "<string>",
"physician_state": "alabama",
"physician_zip": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"location_id": "<string>",
"icd_codes": [
"<string>"
],
"service_types": [
"medical_care"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"payors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"patient_id": "<string>",
"insurance_id": "<string>",
"coverage_chain_id": "<string>",
"insurance_display_name": "<string>",
"subscriber_id": "<string>",
"external_id": "<string>",
"relationship_to_subscriber": "spouse",
"insured_member_id": "<string>",
"group_number": "<string>",
"group_description": "<string>",
"medicaid_id": "<string>",
"payor_responsibility": "primary",
"coverage_from": "2023-11-07T05:31:56Z",
"coverage_to": "2023-11-07T05:31:56Z",
"provider_network_status": "unknown",
"cbh_status": "active",
"plan_funding_type": "fully_funded",
"plan_name": "<string>",
"plan_type": "01",
"plan_renewal_date_type": "calendar_year",
"benefit_period_end_date": "2023-12-25",
"cob_on_file": true,
"cob_last_verified_at": "2023-11-07T05:31:56Z",
"has_other_active_coverage": true,
"cob_other_coverages": [
{
"name": "<string>",
"position": "primary"
}
],
"out_of_state_benefits": true,
"out_of_state_benefits_comments": "<string>",
"in_grace_period": true,
"last_payment_date": "2023-12-25",
"is_cobra_coverage": true,
"deductible_apply_to_oop": true,
"eligibility_check_status": "pending",
"eligibility_check_comment": "<string>",
"eligibility_check_date": "2023-11-07T05:31:56Z",
"eligibility_version": 0,
"individual_deductible_policy_in_network": 123,
"individual_deductible_policy_out_network": 123,
"individual_deductible_remaining_in_network": 123,
"individual_deductible_remaining_out_network": 123,
"family_deductible_policy_in_network": 123,
"family_deductible_policy_out_network": 123,
"family_deductible_remaining_in_network": 123,
"family_deductible_remaining_out_network": 123,
"individual_oop_max_policy_in_network": 123,
"individual_oop_max_policy_out_network": 123,
"individual_oop_max_remaining_in_network": 123,
"individual_oop_max_remaining_out_network": 123,
"family_oop_max_policy_in_network": 123,
"family_oop_max_policy_out_network": 123,
"family_oop_max_remaining_in_network": 123,
"family_oop_max_remaining_out_network": 123,
"benefits_related_entities": [
{}
],
"ai_summary": "<string>",
"ai_summary_generated_at": "2023-11-07T05:31:56Z",
"patient": {},
"insurance": {},
"subscriber": {},
"services": [
{
"copay_in_network": 25,
"created_at": "2024-01-15T10:30:00Z",
"eligibility_check_status": "ELIGIBLE",
"id": "550e8400-e29b-41d4-a716-446655440014",
"payor_id": "550e8400-e29b-41d4-a716-446655440012",
"service_type": "PT",
"updated_at": "2024-01-15T10:30:00Z",
"verification_benefits_status": "VERIFIED"
}
],
"active": true,
"version": 1
}
],
"external_id_values": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>",
"external_id_type": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
},
"matched": true,
"created": true,
"match_reason": "external_id",
"dropped_fields": [
"<string>"
],
"payor_results": [
{
"outcome": "created",
"payor_responsibility": "primary",
"submitted_insurance_name": "<string>",
"resolved_insurance_id": "<string>",
"resolved_insurance_name": "<string>",
"trading_partner_service_id": "<string>",
"payor_id": "<string>",
"coverage_chain_id": "<string>",
"resolution_method": "canonical_name",
"reason_code": "insurance_name_missing",
"message": "<string>"
}
]
}{
"type": "validation_error",
"code": "invalid_parameter",
"message": "Field validation failed",
"param": "phone_number"
}Authorizations
APIKeyHeaderHTTPBearer
Body
application/json
Forgiving upsert request — every field optional, no throwing validators.
The service normalizes and silently drops unparseable phone / email / DOB values. The post-normalization invariant (phone OR full demographics) is checked there as well.
External identifier from the integration. Used as the highest-priority match key.
Show child attributes
Show child attributes
DOB in any of: YYYY-MM-DD, YYYYMMDD, MM/DD/YYYY, MM-DD-YYYY, MM/DD/YY. Unparseable values are dropped.
Company location ID. Foreign IDs are dropped.
Company organization ID. Foreign or inactive IDs are dropped.
Nested referral creation for patient creation.
Same referral the /v1/referrals endpoints take, minus patient_id (the
patient is the one being created) and plus file_id.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Patient creation source enum matching Prisma
Available options:
form, call, api, file, sms, fax, chat_agent, manual, bulk_import, eligibility, prior_auth Response
Successful Response
Response — 200 OK for both create and update (idempotent semantics).
Patient resource response model.
Show child attributes
Show child attributes
True if an existing patient was found and updated
True if a new patient was created
Which match tier resolved the patient. None when created=True.
Available options:
external_id, demographics, phone_fuzzy_name, email_fuzzy_name Fields the request supplied that were silently dropped during normalization (unparseable phone/email/DOB, or external_id conflict, or phone-immutability lock).
Show child attributes
Show child attributes