patients:read / patients:write | Read / write | Demographics and identifiers for in-scope patients; write also creates/updates a patient. |
appointments:read / appointments:write | Read / write | Appointments for in-scope patients; write books, reschedules or cancels. |
notes:read / notes:write | Read / write | A patient’s clinical notes; write creates a DRAFT only — never signs, locks, or finalizes one. A note created through the API cannot carry treatment, service or diagnosis blocks; they are refused with unknown_field. |
allergies:read / allergies:write | Read / write | A patient’s allergies and intolerances; write sends an allergy for clinician review. It never changes the chart on its own, unless the clinic has chosen to accept your new allergies automatically — see Allergies and Automatic acceptance. |
medications:read / medications:write | Read / write | The medicines a patient reports, and the prescriptions written for them (read-only, drug, dose, frequency and status only); write sends a reported medicine for clinician review. It never changes the chart on its own, and no key can write a prescription — see Medications. |
referrals:read / referrals:write | Read / write | The referrals a clinic has received for a patient; write sends a referral for the clinic to review, and changes or takes back one you sent only while the clinic has not acted on it. No key can accept, decline, book, complete or cancel a referral: those are the clinic’s decisions — see Referrals. |
conditions:read / conditions:write | Read / write | A patient’s problem list and diagnoses; write sends a condition for clinician review. It never changes the chart on its own — see Conditions. |
coverage:read / coverage:write | Read / write | A patient’s insurance coverage: payer, member and group identifiers, dates, network status. Write adds or updates one, but a coverage you add is inactive until staff confirm it — see Insurance. |
insurance.enrollees:read | Read-only | The enrollees of the insurer the clinic linked to your organization, to verify one before service. |
insurance.claims:read / insurance.claims:adjudicate / insurance.claims:submit | Read / vet / submit | That insurer’s claims with their lines; vet a claim (approve, adjust or decline each line, never moving money); submit a claim (developers and clinic keys only). |
insurance.pa:read / insurance.pa:decide / insurance.pa:submit | Read / decide / send | Authorization requests the clinic sent to that insurer; approve or deny one; send one (developers and clinic keys only). |
insurance.remittances:write | Write | Tell the clinic what the insurer paid, as a payment advice for staff to reconcile. It never changes the clinic’s books. |
care_providers:read / care_providers:write | Read / write | The outside doctors, referrers and specialists a patient names; write adds one, and changes or removes only the contacts your app added. The clinic’s own and other apps’ contacts are read-only to you — see Outside care providers. |
encounters:read / encounters:write | Read / write | A patient’s visits as the clinic documents them: status, dates, reason for the visit and clinician, never clinical text or billing. Write opens a draft visit for a clinician to complete, and changes the details of a draft your app opened until a person touches it. It never orders, bills, signs, locks or finalises — see Encounters. |
requests:read / requests:write | Read / write | Drug requests sent to a clinic — see Drug requests. |
dispensing:read | Read-only | The dispensing history of an enrollee you are linked to, and the refill and duplicate-dispensing flags a pharmacist has recorded for linked enrollees. Never a price, never another customer, never a staff member’s name. |
pickups:read / pickups:write | Read / write | Prescription pickup records: who collected, counselling, the clinic’s own questions and answers, and whether a signature is on file; write sends a pickup collection for clinician review. The signature image is never returned, and agent_name is never shown to an organization — see Prescription pickups. |
outreach:read / outreach:write | Read / write | Outreach (screening-day) events, their stations and who is checked in; write sends a check-in for clinician review, for an existing patient only — see Outreach events. |