Update Patient

PUT

api

patient

{patientId}

cURL

curl --request PUT \
  --url https://forecaster.cairhealth.com/api/patient/{patientId} \
  --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/{patientId}"

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.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  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/{patientId}', 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/{patientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  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/{patientId}"

	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("PUT", 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.put("https://forecaster.cairhealth.com/api/patient/{patientId}")
  .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/{patientId}")

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

request = Net::HTTP::Put.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

Updates a patient’s demographic fields, preserving all other data on the resource (identifiers, contacts, links, flags, etc.). Demographics present in the body are merged onto the existing record:

firstName/lastName always update the name.
gender, dob, and address update only when provided.
email and phone_number replace their respective telecom entries while preserving other channels (e.g. fax).

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.

Path Parameters

string

required

External patient id. Must match the id in the request body.

Request Body

string

required

External patient id (must match the path parameter).

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 PUT "https://forecaster.cairhealth.com/api/patient/EXT-PAT-123" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "EXT-PAT-123",
    "first_name": "Jane",
    "last_name": "Doe",
    "phone_number": "555-9999"
  }'

Response

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

Returns 404 when no patient matches the external id.

Authorizations

Authorization

string

header

required

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

Path Parameters

patientId

string

required

External patient id (must match body id)

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 updated successfully

success

boolean

message

string

data

object

Show child attributes

cURL

curl --request PUT \
  --url https://forecaster.cairhealth.com/api/patient/{patientId} \
  --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/{patientId}"

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.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  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/{patientId}', 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/{patientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  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/{patientId}"

	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("PUT", 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.put("https://forecaster.cairhealth.com/api/patient/{patientId}")
  .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/{patientId}")

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

request = Net::HTTP::Put.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

Path Parameters

Request Body

Example

Response

Authorizations

Path Parameters

Body

Response

​Overview

​Authentication

​Path Parameters

​Request Body

​Example

​Response

Authorizations

Path Parameters

Body

Response

Overview

Authentication

Path Parameters

Request Body

Example

Response