Norvya DevelopersSolution
Concierge doctors
Between-visit monitoring and a two-minute pre-visit brief for a small, high-touch panel.
- Credential model
- OAuth 2.0 client credentials for your organisation. Authentication
- Before production
- A business associate agreement (BAA) with the practice.
- Sandbox
- A practice sandbox.
Families you'll use
| Family | Fit | Status |
|---|---|---|
| Clinical intelligence | Core | Built — gated |
| Data in | Core | Built — gated |
| Enrolment & messaging | Core | Built — gated |
| Events (webhooks) | Core | Built — gated |
| Practice operations & reports | Core | Built — gated |
| Billing & scheduling | Useful | Built — gated |
| EHR embedding: SMART launch and CDS Hooks | Useful | Built — gated |
| Fitness intelligence | Useful | Built — gated |
| Member data in: observations and workouts | Useful | Built — gated |
| Social needs & programmes | Useful | Built — gated |
| Enrolment roster | Useful | Built — gated |
| Specialty care | Useful | Built — gated |
| Care transitions | Useful | Built — gated |
Scopes to request
Ask only for what your product uses.
| Scope | Allows |
|---|---|
members.read | List the organisation's linked members as opaque member references. |
clinical.brief.read | Read the clinician pre-visit brief for a patient (medical practices only; per-section consent). |
clinical.panel.read | Read the practice's ranked panel worklist and start worklist runs (medical practices only). |
clinical.patient.read | Read a patient's care gaps and between-visit home-data signals (medical practices only; consent and data basis respected). |
clinical.panel.write | Triage your practice's worklist findings from your system (addressed, snoozed until a date, dismissed with a reason, or reopened) with the same rules as Norvya's own worklist screen (medical practices only). |
clinical.loops.write | Close the loop on results and referrals from your system: record that a named clinician acknowledged a result, that the patient was told, the action taken, and move a tracked referral through scheduled, seen, report received and closed (medical practices only). |
instruments.request | Ask a patient to complete a validated questionnaire from Norvya's instrument library; Norvya sends its own generic notification (treating practices only). |
instruments.read | Read questionnaire scores (total, severity band, subscales) with the instrument version and completion time, never item-level answers; mental-health instruments only when the patient shares mental health with you (treating practices only). |
members.invite | Invite people to join your organisation on Norvya (Norvya emails its own invitation in the person's language; never a pre-granted consent: the person chooses what to share in the app) and create printable join codes; follow each invitation to joined. Daily cap, de-duplicated per address, and the answer never says whether an address has an account. |
messages.write | Send a member a secure in-app message from your organisation (the conversation your staff use in Norvya); Norvya notifies them with its own generic wording, never your text. Members who turned messages off are refused. |
messages.read | Read your organisation's in-app conversation with a member, including their replies (audited as a disclosure). |
observations.write | Write measurements to a member's own record: vitals, lab results and body composition (practices with a BAA on file), or body composition and the vitals a gym measures (gyms; never labs). Idempotent per item by your external_id; units converted, implausible values refused; DELETE retracts only your own item. |
panel.import.write | Stage, review, commit and discard practice panel imports (FHIR Bulk Data, or a spreadsheet with a saved mapping profile; medical practices with a BAA on file only). |
webhooks.manage | Register HTTPS webhook endpoints (payloads carry no PHI). Each event also needs its own scope: worklist / attention events clinical.panel.read, import events panel.import.write, population.export_completed population.export (medical practices only), member.at_risk fitness.roster.read, public_health.iis_ack_received public_health.immunizations.read, public_health.case_report_response public_health.case_reports.read. claims.import_completed needs claims.import.write (medical practices only). member.account_claimed needs members.claim_invite (medical practices only). hospital_at_home.escalation needs hospital_at_home.read (hospitals only). hospice.idg_review_due needs hospice.read (hospice agencies only). pharmacy.refill_due and pharmacy.discharge_episode_opened need pharmacy.patients.read; care_site.change_of_condition, care_site.incident_recorded and care_site.mar_exception need care_sites.read (pharmacies and care-facility operators, their own sites). travel.journey_updated and travel.leg_status_changed need travel.journeys.read, travel.nursing_visit_recorded travel.nursing.read, travel.invoice_issued travel.billing.read (medical-travel desks only). travel.inquiry_updated needs travel.inquiries.read, travel.journey_message_posted travel.messages.read (medical-travel desks only). instrument.batch_dispatched needs instruments.request (medical practices only). roster.enrolment_summary needs members.roster.read (medical practices only). older_adults.falls_tier_raised needs older_adults.read (medical practices only). employer.challenge_completed needs employer.challenges.read and occupational.exam_due occupational.read (employers only); medspa.adverse_event_reported needs medspa.aftercare.read (treating practices only). rehab.goal_met needs rehab.read; nutrition.caseload_flagged needs nutrition.read (medical practices only). cocm.review_due needs behavioral.read (medical practices only). derm.lesion_recheck_due and derm.patch_test_read_recorded need derm.read (medical practices only). |
transitions.notices.read | Read the hospital admissions, discharges and ED visits Norvya received for a patient of your practice, with the Transitional Care Management windows (treating practices and hospitals; each patient's sharing choices apply). |
clinical.specialty.read | Read a patient's specialty hub results (cardio, nephro, endo, neuro, pulmo, rheum, GI and questionnaires) under their sharing switches, and run the stateless spirometry, lung-cancer screening and GI alarm checks (treating practices only). |
clinical.ratings.write | Record a clinician-rated or clinician-timed measure (for example FOIS, Nine-Hole Peg Test, AIMS) that a named clinician of your practice assigned; scored by Norvya (treating practices only). |
documents.read | List and download the documents Norvya already produces about a patient (care plans, survivorship plans, reviews, summaries, estimates) as PDF, in the patient's language where the document supports it; each document kind keeps its own consent gate (treating practices, including medical-travel desks, and pharmacies). |
clinical.record.read | Read one patient's record as a FHIR R4 Bundle (the same builders and the same consent scope as the population export: the patient's sharing choices, your practice's own records, 42 CFR Part 2 records only under a covering consent); size-capped, with the population export for large records (treating practices with a BAA on file, or a sandbox). |
clinical.annual_review.read | Read a patient's member annual review content (their year in numbers, what is going well, screenings and vaccines, the open findings a physician may select); urgent and practice-internal findings are never selectable (treating practices only). |
clinical.reports.read | Read your practice's quarterly value report and programme outcomes report as JSON: aggregates only, counts below the small-cell minimum withheld, with the reports' honest framing (observational, this practice only); no dollar figure (treating practices only). |
clinical.morning_brief.read | Read one clinician's morning brief for a day: the members on their schedule, what changed since each member's last visit, open referrals and suggested labs, on what the practice may use for each member (treating practices only). |
clinical.outreach.read | Read rule-based message drafts for your patients' open worklist findings, in the patient's language; never sent by this call (send with messages.write) and never for urgent or practice-internal findings (treating practices only). |
clinical.video.write | Open a telehealth video room for an existing appointment of your practice (Daily, under Norvya's BAA; recording and transcription off); participants join in the Norvya app (treating practices only). |
clinical.credentials.read | Read your practice's clinicians with the licence and NPI fields Norvya holds for them and whether Norvya verified them (treating practices only). |
programs.benefits.read | Read your practice's benefits-coordination worklist (transport and home-modification requests on open community referrals); Norvya never determines eligibility or books a ride (treating practices only). |
members.claim_invite | Invite a patient your practice imported (no Norvya login yet) to claim their own account: Norvya emails its own invitation in the patient's language with a one-time code that also needs their date of birth; follow the invitation to claimed (treating practices with a BAA on file). |
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 roster Built — gated Gate: Treating practices or programmes with a BAA on file (or a sandbox).
- Fitness intelligence Built — gated
- Billing & scheduling Built — gated Gate: A BAA with each practice. The care-management view also needs the practice to switch on care-management documentation in Norvya (after its own compliance review).
- Social needs & programmes Built — gated
Before production
Gate: A business associate agreement (BAA) with the practice.
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] 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 — gated3
- GET
/v1/members - POST
/v1/oauth/token - GET
/v1/usage
Enrolment & messaging Built — gated12
- GET
/v1/invites - POST
/v1/invites - GET
/v1/invites/{invite_ref} - POST
/v1/invites/{invite_ref}/revoke - POST
/v1/invites/{invite_ref}/simulate-join - GET
/v1/join-codes - POST
/v1/join-codes - POST
/v1/join-codes/{code_ref}/revoke - POST
/v1/join-codes/{code_ref}/simulate-join - GET
/v1/members/{member_ref}/messages - POST
/v1/members/{member_ref}/messages - POST
/v1/members/{member_ref}/messages/simulate-reply
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}
Practice operations & reports Built — gated13
- POST
/v1/appointments/{appointment_ref}/video-link - GET
/v1/patients/{member_ref}/annual-review - GET
/v1/patients/{member_ref}/annual-review/content - GET
/v1/patients/{member_ref}/claim-invite - POST
/v1/patients/{member_ref}/claim-invite - GET
/v1/practice/benefits/worklist - GET
/v1/practice/clinicians/credentials - GET
/v1/practice/morning-brief - GET
/v1/practice/outcomes-report - GET
/v1/practice/outcomes-report/content - GET
/v1/practice/outreach-drafts - GET
/v1/practice/value-report - GET
/v1/practice/value-report/content
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