Create Patient

POST

api

patient

cURL

curl --request POST \
  --url https://forecaster.cairhealth.com/api/patient \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "name": "<string>",
  "dob": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "zip": "<string>"
  }
}
'

import requests

url = "https://forecaster.cairhealth.com/api/patient"

payload = {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "name": "<string>",
    "dob": "<string>",
    "email": "<string>",
    "phone_number": "<string>",
    "address": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "state": "<string>",
        "zip": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    name: '<string>',
    dob: '<string>',
    email: '<string>',
    phone_number: '<string>',
    address: {
      city: '<string>',
      country: '<string>',
      line1: '<string>',
      line2: '<string>',
      state: '<string>',
      zip: '<string>'
    }
  })
};

fetch('https://forecaster.cairhealth.com/api/patient', 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://forecaster.cairhealth.com/api/patient",
  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([
    'id' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'name' => '<string>',
    'dob' => '<string>',
    'email' => '<string>',
    'phone_number' => '<string>',
    'address' => [
        'city' => '<string>',
        'country' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'state' => '<string>',
        'zip' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://forecaster.cairhealth.com/api/patient"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://forecaster.cairhealth.com/api/patient")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://forecaster.cairhealth.com/api/patient")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "data": {
    "patientId": "<string>",
    "patientFhirId": "<string>"
  }
}

Overview

Creates a patient record. id, first_name, and last_name are required; all other fields are optional. id is the patient’s external id, the same identifier used by the professional claim endpoints, so a patient created here can be reused in later claim submissions. This endpoint manages demographic data only. Insurance/policy data is not accepted — a body containing a policies field (or any unknown field) is rejected with a 400.

Authentication

JWT Bearer token from /api/token.

Request Body

string

required

External patient id.

string

required

Patient’s first name.

string

required

Patient’s last name.

string

Patient’s full name.

string

One of male, female, other, or unknown.

string

Date of birth in yyyy-MM-dd format.

string

Patient email address.

string

Patient phone number.

object

Patient address with line1, line2, city, state, zip, and country.

Example

curl -X POST "https://forecaster.cairhealth.com/api/patient" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "EXT-PAT-123",
    "first_name": "Jane",
    "last_name": "Doe",
    "gender": "female",
    "dob": "1990-01-02",
    "email": "jane@example.com",
    "phone_number": "555-1234",
    "address": {
      "line1": "1 Main St",
      "city": "Springfield",
      "state": "IL",
      "zip": "62704",
      "country": "US"
    }
  }'

Response

{
  "success": true,
  "message": "Patient created successfully",
  "data": {
    "patientId": "EXT-PAT-123",
    "patientFhirId": "fhir-patient-id"
  }
}

Returns 409 Conflict when a patient with the same id already exists. Use PUT /api/patient/{patientId} to update an existing patient.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Patient demographics. id is the external patient id, keyed by the Cair customer-patient-id naming system (https://fhir.cairhealth.com/fhir/identifier/customer-patient-id)

string

required

External patient id

first_name

string

required

Patient's first name

last_name

string

required

Patient's last name

name

string | null

Patient's full name

gender

enum<string> | null

Patient gender

Available options:

male,

female,

other,

unknown

dob

string | null

Date of birth, yyyy-MM-dd

string | null

Patient email address

phone_number

string | null

Patient phone number

address

object

Patient address

Show child attributes

Response

Patient created successfully

success

boolean

message

string

data

object

Show child attributes

cURL

curl --request POST \
  --url https://forecaster.cairhealth.com/api/patient \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "name": "<string>",
  "dob": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "zip": "<string>"
  }
}
'

import requests

url = "https://forecaster.cairhealth.com/api/patient"

payload = {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "name": "<string>",
    "dob": "<string>",
    "email": "<string>",
    "phone_number": "<string>",
    "address": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "state": "<string>",
        "zip": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    name: '<string>',
    dob: '<string>',
    email: '<string>',
    phone_number: '<string>',
    address: {
      city: '<string>',
      country: '<string>',
      line1: '<string>',
      line2: '<string>',
      state: '<string>',
      zip: '<string>'
    }
  })
};

fetch('https://forecaster.cairhealth.com/api/patient', 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://forecaster.cairhealth.com/api/patient",
  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([
    'id' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'name' => '<string>',
    'dob' => '<string>',
    'email' => '<string>',
    'phone_number' => '<string>',
    'address' => [
        'city' => '<string>',
        'country' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'state' => '<string>',
        'zip' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://forecaster.cairhealth.com/api/patient"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://forecaster.cairhealth.com/api/patient")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://forecaster.cairhealth.com/api/patient")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "data": {
    "patientId": "<string>",
    "patientFhirId": "<string>"
  }
}

Overview

API Authentication

Eligibility

Enrollments/Providers

Claims

Claim AI Actions

Patient Chart Analysis

Patient Payments

Patients

Webhooks

AI Phone Calls

Overview

Authentication

Request Body

Example

Response

Authorizations

Body

Response

​Overview

​Authentication

​Request Body

​Example

​Response

Authorizations

Body

Response

Overview

Authentication

Request Body

Example

Response