Specialty care

By specialty

One read per specialty hub, through the {hub} path parameter (values from the API itself). A hub not on this list answers 404 unknown_specialty.

• GET/v1/patients/{member_ref}/specialty/all
• GET/v1/patients/{member_ref}/specialty/cardio
• GET/v1/patients/{member_ref}/specialty/nephro
• GET/v1/patients/{member_ref}/specialty/endo
• GET/v1/patients/{member_ref}/specialty/neuro
• GET/v1/patients/{member_ref}/specialty/pulmo
• GET/v1/patients/{member_ref}/specialty/rheum
• GET/v1/patients/{member_ref}/specialty/gi
• GET/v1/patients/{member_ref}/specialty/other

Direct and stateless checks

• GET/v1/patients/{member_ref}/specialty-checkseGFR, the GLP-1 thyroid check, the colonoscopy interval and the heart-failure check
• POST/v1/clinical/checks/spirometryInterpret spirometry values (GOLD criteria; stateless)
• POST/v1/clinical/checks/lung-cancer-screeningLung-cancer screening eligibility (USPSTF 2021; stateless)
• POST/v1/clinical/checks/gi-alarmGI alarm-feature triage lane (stateless)

Questionnaires (Clinical intelligence)

One instrument registry: GET /v1/instruments says which questionnaires your organisation may request.

• GET/v1/instrumentsQuestionnaires you may request
• POST/v1/members/{member_ref}/instrument-requestsAsk a patient to complete a questionnaire
• GET/v1/members/{member_ref}/instrument-responsesA patient's questionnaire scores
• POST/v1/members/{member_ref}/instrument-requests/{response_ref}/simulate-completionSandbox: make a synthetic patient complete a requested questionnaire
• POST/v1/instrument-requests/batchAsk a caseload to complete a questionnaire
• GET/v1/instrument-requests/batchYour caseload batches, newest first
• GET/v1/instrument-requests/batch/{batch_ref}A caseload batch: progress and results

Families you'll use

Scopes to request

Ask only for what your product uses.

Before production

Sandbox

Build and test against synthetic members before you touch real data. A practice sandbox. What a sandbox holds, its credentials, limits, resets and expiry are in the Sandbox guide. To request one, write to [email protected].

Every endpoint for this solution

The families this solution uses, filtered to the scopes it requests. Each link opens the endpoint on its family page.

Platform Built — gated3

• GET/v1/members
• POST/v1/oauth/token
• GET/v1/usage

Events (webhooks) Built — gated5

• GET/v1/webhooks
• POST/v1/webhooks
• DELETE/v1/webhooks/{webhook_id}
• GET/v1/webhooks/{webhook_id}/deliveries
• POST/v1/webhooks/{webhook_id}/enable

Records & documents Built — gated4

• GET/v1/documents/{document_ref}
• GET/v1/documents/{document_ref}/content
• GET/v1/patients/{member_ref}/documents
• GET/v1/patients/{member_ref}/record

Clinical intelligence Built — gated23

• GET/v1/instrument-requests/batch
• POST/v1/instrument-requests/batch
• GET/v1/instrument-requests/batch/{batch_ref}
• GET/v1/instruments
• POST/v1/members/{member_ref}/instrument-requests
• POST/v1/members/{member_ref}/instrument-requests/{response_ref}/simulate-completion
• GET/v1/members/{member_ref}/instrument-responses
• GET/v1/panel/clinicians
• GET/v1/panel/worklist
• POST/v1/panel/worklist/items/{item_ref}/triage
• POST/v1/panel/worklist/runs
• GET/v1/panel/worklist/runs/{run_id}
• GET/v1/patients/{member_ref}/between-visit
• GET/v1/patients/{member_ref}/brief
• GET/v1/patients/{member_ref}/care-gaps
• POST/v1/patients/{member_ref}/clinician-ratings
• GET/v1/patients/{member_ref}/referrals
• POST/v1/patients/{member_ref}/referrals/{referral_ref}/status
• GET/v1/patients/{member_ref}/results
• POST/v1/patients/{member_ref}/results/{result_ref}/acknowledge
• POST/v1/patients/{member_ref}/results/{result_ref}/action
• POST/v1/patients/{member_ref}/results/{result_ref}/close
• POST/v1/patients/{member_ref}/results/{result_ref}/informed

Specialty care Built — gated5

• POST/v1/clinical/checks/gi-alarm
• POST/v1/clinical/checks/lung-cancer-screening
• POST/v1/clinical/checks/spirometry
• GET/v1/patients/{member_ref}/specialty-checks
• GET/v1/patients/{member_ref}/specialty/{hub}

Data in Built — gated4

• POST/v1/panel/imports
• GET/v1/panel/imports/{import_id}
• POST/v1/panel/imports/{import_id}/commit
• POST/v1/panel/imports/{import_id}/discard

EHR embedding: cards and chart documents Built — gated3

• POST/v1/patients/match
• GET/v1/patients/{member_ref}/brief/document
• GET/v1/patients/{member_ref}/cards