EMR vendors

How it works

Families you'll use

Scopes to request

A practice can grant you fewer. Ask only for what your product uses.

Protocol endpoints outside /v1

Called by the EHR itself rather than with a partner token.

EHR embedding: SMART launch and CDS Hooks Built — gated

Gate: Registration with each EHR vendor's developer programme, then their review.

• GET/ehr/launchSMART on FHIR EHR launch (the EHR opens Norvya with iss and launch)
• GET/ehr/callbackSMART authorization callback
• GET/ehr/.well-known/jwks.jsonNorvya's public keys for SMART backend authentication
• GET/cds-servicesCDS Hooks discovery
• POST/cds-services/norvya-patient-viewCDS Hooks patient-view: the card for the open chart
• POST/cds-services/norvya-patient-view/feedbackCDS Hooks card feedback

Not callable yet

• Enrolment & messaging Built — gated
• Practice operations & reports Built — gated Gate: Claim invitations need a BAA on file (a sandbox simulates).

Before production

Sandbox

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

Every endpoint for this market

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

Platform Built — gated4

• GET/v1/members
• POST/v1/oauth/token
• GET/v1/practices
• 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

Member data in: observations and workouts Built — gated2

• POST/v1/members/{member_ref}/observations
• DELETE/v1/members/{member_ref}/observations/{external_id}

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