Skip to main content

Overview

A care job is an action your agent proposes on the patient’s behalf that a person at Arlo carries out with another office: moving an external referral to a different clinic, booking an appointment, or cancelling and rescheduling one. The patient approves each job on a hosted sheet with their own verification, Arlo’s care team executes it, and every step lands in an audit trail the patient can see. Three tools cover it:
US patients only. A job for a patient outside a supported region is refused with REGION_NOT_SUPPORTED. Do not retry.
Over REST the same three calls are POST /api/care-jobs, GET /api/care-jobs/{id}, and GET /api/care-jobs. See the REST API.

How approval works

  • The agent only ever learns the status of a job, never an approval artifact. Approval happens on Arlo’s page with the patient’s own verification on their device, and cannot be completed by an agent. Never open the approvalUrl yourself.
  • The approval tier is assigned server-side by job type. The agent does not choose it.
  • Consent and authorizations are per patient within the account, and revocable per patient. The patient sees the same ledger, with revocation controls, on the care activity page of their Arlo portal.
  • Approval links expire 15 minutes after creation.

The flow

1

Build the job from Arlo's own data

Use the NPI from search_care_prices or check_network_status for the target provider, and names from get_health_records where they apply
2

Call create_care_job

Returns status: "pending_approval", a jobId, and an approvalUrl
3

Hand the approvalUrl to the user

Say what will happen once they approve. On widget hosts (Claude.ai, ChatGPT) an approval card renders around the same link
4

Poll get_care_job

Every 15 to 30 seconds, or when the user says they’ve decided, until status is approved, declined, or expired
5

Execution

On approved, Arlo’s care team executes under a single-use grant. status moves to executed (or failed) and the audit trail records each step

create_care_job

Propose a real-world care action for the user.

Parameters

Naming the provider’s office

Wherever an action points at a provider’s office, both the provider and the specific practice location are required. Providers work at multiple locations, and the action is directed to one:
  • Identity: npi (strongly preferred, so it resolves against Arlo’s directory) or providerName
  • Location: city and state (required), plus facilityName, address, and phone when known

Job types

move_referral

For external referrals, written by an outside provider. Arlo does not hold the referral record; the care team confirms it with the source office before anything moves.

book_appointment

cancel_or_reschedule

Records release, refills, claim disputes, and standing payment grants are not available yet. The server rejects them with JOB_TYPE_NOT_AVAILABLE and the currently available list. Do not offer them to the user.

Returns

Errors


get_care_job

Status of a care job plus the patient-visible audit trail. Widget hosts refresh the approval card through this tool too.

Parameters

Returns

Statuses


list_care_jobs

The user’s care jobs, newest first: pending approvals, approved actions in execution, and completed ones.

Parameters

None.

Returns

approvalUrl is present only while a job is pending.

Care pricing

Resolve the target provider’s NPI and network status before proposing a move or a booking

Health records

The patient’s coverage, conditions, and visits, for the context you attach to a job