API package
EHR
Patient records, encounters, medication safety, orders and results. Encounters bill through Accounting.
73 APIs542 operationsBase path
/api/ehrAdministration
Calendar Invitations
Invitations sent from appointments: who was invited to what, when, and how often it was sent. Sending again after a change updates the same calendar entry; cancelling removes it from every calendar.
GET1 POST2
Clinical Departments
Every department in the organization, with its cost center and its head.
GET2 POST2 PUT1 DELETE1
Compliance Reporting
Quality measures and regulatory returns, with the numerator and denominator behind each rate.
GET2 POST2 PUT1 DELETE1
Providers
Clinicians and the departments they work in. Linked to the HRMS personnel record.
GET2 POST2 PUT1 DELETE1
Resources
Rooms, beds, theatres and equipment that can be booked.
GET2 POST2 PUT1 DELETE1
Scheduling
A booking is refused when the provider or the room is already taken, and schedules its own reminders.
GET2 POST6 PUT1 DELETE1
Behavioral Health
Claims EDI
Claim Adjustments
Every adjustment a payer made on a remittance, by group and reason code (CARC) with its remark codes (RARC).
GET2 POST2 PUT1 DELETE1
Clearinghouse Payers
The payer ids a clearinghouse routes to, and which transactions each takes.
GET2 POST2 PUT1 DELETE1
EDI Files
Every X12 interchange with the clearinghouse: 837P and 837I claims and 270 inquiries out; 999, 277CA, 835 and 271 in. Control numbers, counts and the raw file.
GET3 POST5 PUT1 DELETE1
Eligibility Checks
Each 270 inquiry and the payer's 271 answer: coverage, plan, copay, deductible and what is left of it, coinsurance and out-of-pocket.
GET2 POST2 PUT1 DELETE1
Practice Sites
Where prescribers write from and claims bill from: the group NPI, tax id, taxonomy and address that NCPDP and X12 carry.
GET2 POST2 PUT1 DELETE1
Remittances
Electronic remittance advice (835): the payment, the claims it pays, the adjustments and the patient's share, posted to the claims, and whether it all balances.
GET3 POST4 PUT1 DELETE1
Clinical
Care Planning
The plan, its goals and who is accountable. Goals carry a measure and a target.
GET3 POST3 PUT2 DELETE2
Clinical Documentation
A signed note is the legal record: it is never edited, only addended.
GET2 POST4 PUT1 DELETE1
Decision Support Alerts
Every alert that fired, and whether it was accepted or overridden. A high override rate says the alerts are being ignored.
GET2 POST2 PUT1 DELETE1
Medication Reconciliation
At admission, transfer, discharge or a visit: what the patient takes at home, what is ordered here and what other systems sent, side by side, a decision for each, signed, and the medication list changed to match.
GET5 POST6 PUT1 DELETE1
Order Entry (CPOE)
Orders run through decision support before they are written. A contraindication stops the order unless it is overridden with a reason.
POST2
Order Sets
Standing orders, so a chest-pain workup is one action rather than five.
GET3 POST3 PUT2 DELETE2
Patients
Read and maintain patients records (ehr.patients).
GET3 POST3 PUT1 PATCH1 DELETE1
Possible Duplicate Patients
Every patient whose name matches another record together with the date of birth or an email or phone. Open both to compare. Different people: choose Not a duplicate and say why (or say why when saving with Create anyway), and the pair leaves this list.
GET2 POST3 PUT1 DELETE1
E-Prescribing
E-Prescribing Messages
Every NCPDP SCRIPT message sent to or received from a pharmacy: NewRx, renewals, changes, cancellations, fill notices and the network's status answers, with the raw XML exactly as it travelled.
GET3 POST3 PUT1 DELETE1
EPCS Permissions
Who may sign electronic prescriptions for controlled substances. Each is requested, then approved by two different people other than the prescriber, at least one of them a DEA registrant (21 CFR 1311.125).
GET2 POST5 PUT1 DELETE1
EPCS Signing Log
Every attempt to sign a controlled-substance prescription, signed or refused, with the factors presented. Append-only.
GET2 POST2 PUT1 DELETE1
Pharmacy Directory
Pharmacies a prescription can be sent to, by NCPDP id: retail, 24-hour, mail order, specialty and long-term care, and whether each takes electronic prescriptions for controlled substances.
GET2 POST2 PUT1 DELETE1
Prescriber Tasks
What pharmacies have asked prescribers for: renewals, changes, and refusals to look at. Approving a renewal writes the new prescription and answers the pharmacy.
GET2 POST3 PUT1 DELETE1
Emergency
Existing Records
Allergies
Read and maintain allergies records (ehr.allergies).
GET2 POST2 PUT1 DELETE1
Clinical Orders
Read and maintain clinical orders records (ehr.clinical_orders).
GET3 POST5 PUT2 DELETE2
Encounters
Read and maintain encounters records (ehr.encounters).
GET4 POST6 PUT2 DELETE2
Medications
Every medication a patient is on or has been on: ordered here with Prescribe (safety checked), or prescribed under Prescribing. A prescription is transmitted, dispensed or stopped on Prescribing.
GET3 POST4 PUT2 PATCH1 DELETE2
Problem List
Read and maintain problems records (ehr.problems).
GET2 POST2 PUT1 DELETE1
Results / Observations
Read and maintain observations records (ehr.observations).
GET2 POST2 PUT1 DELETE1
Health Information
PHI Access Log
Every look at a chart, append-only. An access log that can be edited proves nothing.
GET2 POST2 PUT1 DELETE1
Release of Information
Records are not released without an authorization on file, and a release is logged as an access.
GET2 POST3 PUT1 DELETE1
Interoperability
FHIR Clients
Applications allowed to use the FHIR R4 API at /fhir/r4, with the scopes each may ask for and the patient or user it is bound to. The secret is shown once. SMART apps (EHR launch, standalone, back-end services) are registered here too.
GET2 POST5 PUT1 DELETE1
HL7 Interfaces
Trading partners speaking HL7 v2: ADT, results (ORU), orders (ORM/OML) and pharmacy (RDE), over HTTP, a watched folder, or MLLP (off until switched on).
GET2 POST3 PUT1 DELETE1
HL7 Messages
Every HL7 v2 message in or out, with the acknowledgement it was given: AA accepted, AE could not be applied, AR rejected.
GET3 POST3 PUT1 DELETE1
Network Connections
Surescripts, clearinghouses and HL7 partners: the transport, the identities in the envelope and the control numbers. Credentials are sealed and never shown again. With no live connection the sandbox answers.
GET2 POST3 PUT1 DELETE1
Outside Medications
Medication lists other systems sent, over FHIR or HL7, kept apart from the medication list until a clinician reconciles them.
GET2 POST3 PUT1 DELETE1
Laboratory
Laboratory Catalog
Tests with their reference and critical ranges — the ranges a result is flagged against.
GET2 POST2 PUT1 DELETE1
Laboratory Orders
Orders, specimens and results. A result flags itself against the reference and critical ranges.
GET3 POST6 PUT2 DELETE2
Laboratory Quality Control
Control runs. Beyond two standard deviations warns; beyond three fails and results are held.
GET2 POST3 PUT1 DELETE1
Operating Theatre
Patient Access
Appointment Reminders
Scheduled with the booking rather than chased afterwards.
GET2 POST2 PUT1 DELETE1
Patient Education
Material that can be assigned to a patient, matched to their conditions.
GET2 POST2 PUT1 DELETE1
Patient Portal
Portal invitations, activation and reminder preferences. Invite sends the patient a one-time link to the patient portal (statements, appointments and cases), with a second step at sign-in; Add a proxy lets a parent, guardian or carer see the record too.
GET2 POST2 PUT1 DELETE1
Recalls
Patients to see again by a date. The daily job reminds each patient whose recall falls due and who has nothing booked (if they allow reminders), and marks the ones who have booked.
GET2 POST2 PUT1 DELETE1
Telehealth
Virtual visits, their link and how the connection held up.
GET2 POST2 PUT1 DELETE1
Patient Billing
Dunning Messages
What a statement says, by how old the oldest money on it is.
GET2 POST2 PUT1 DELETE1
Patient Payments
Money from patients: copays at the desk, payments, refunds, and adjustments the practice grants.
GET2 POST2 PUT1 DELETE1
Patient Statements
Every statement sent, held or suppressed: previous balance, new charges, payments, adjustments, amount due, ageing and the dunning message. A patient with a portal account sees theirs there.
GET5 POST4 PUT1 DELETE1
Statement Runs
One billing cycle: a statement for every patient with a balance after insurance, aged and dunned, with the ones that should not go held or suppressed and the reason recorded.
GET2 POST4 PUT1 DELETE1
Pharmacy
Drug Interactions
The pairs decision support checks against when a medication is ordered.
GET2 POST2 PUT1 DELETE1
Formulary
What may be prescribed, with the controlled and high-alert flags that change how it is handled.
GET2 POST2 PUT1 DELETE1
Prescribing
Written, transmitted and dispensed. A controlled substance must be sent electronically or printed.
GET4 POST8 PUT2 DELETE2
Public Health
Disease Surveillance
Reportable conditions, outbreak references and what has yet to be reported.
GET2 POST2 PUT1 DELETE1
Immunizations
What was given, when, and what is still due against each series.
GET2 POST2 PUT1 DELETE1
Vaccine Catalog
Series length and intervals — what makes a course complete.
GET2 POST2 PUT1 DELETE1
Radiology & Imaging
Imaging Catalog
What can be ordered, by modality, with its price and preparation.
GET2 POST2 PUT1 DELETE1
Imaging Worklist
From order through acquisition to a signed report. A critical finding raises an alert.
GET4 POST6 PUT3 DELETE3
Records
Cds rules
Read and maintain cds rules records (ehr.cds_rules).
GET2 POST2 PUT1 DELETE1
Note templates
Read and maintain note templates records (ehr.note_templates).
GET2 POST2 PUT1 DELETE1
Rehabilitation
Reporting
Revenue Cycle
Charge Capture
What was done becomes what is billed. Captured from laboratory, imaging and theatre.
GET2 POST3 PUT1 DELETE1
Claims
Built, scrubbed, submitted and adjudicated. What the patient owes becomes a receivable in Accounting.
GET3 POST6 PUT2 DELETE2
Denial Work Queue
Every denied or rejected claim, opened as a piece of work by the overnight job, with what kind of denial it is and what usually fixes it. Resubmitting sends the corrected claim -- as a replacement when the payer had already adjudicated it.
GET2 POST3 PUT1 DELETE1
Insurance Verification
Coverage on file, and whether it has been verified. A claim will not pass the scrub without it.
GET2 POST4 PUT1 DELETE1
Payers
Who is billed, and how long they typically take to pay.
GET2 POST2 PUT1 DELETE1