REST API for Nexus Health

Every HTTP endpoint the application exposes, grouped by resource.

Calling the API

The API is served from the same address as the application, under /api. Requests carry the session cookie issued at sign-in, so a browser session and an API call are the same identity and obey the same permissions.

Every state changing request (POST, PUT, PATCH, DELETE) must also carry this application family's presence header, or it is refused with 403 bad request. That refusal reads like a permissions fault but is not one. Integration and APIs lists the header per family.

Endpoints

152 endpoints in 55 resource groups.

ai · allergies · analytics · appointments · audit · beds · break-glass · bu · care-bundles · caregaps · claims · connect · custom-domain · dashboard · drug-check · eligibility · entstruct · health-positions · imaging · immunizations · labs · login · logout · mar · me · medications · messages · next-number · notes · nxtz · orders · password · patients · perms · pharmacy · population · problems · providers · public · referrals · search · sender-domains · sender-emails · sender-options · sender-prefs · sentinel · sso · stayboard · stays · uam · username · users · virtual-visits · vitals · wards

ai 1

Method	Path	Access
POST	`/api/ai/ask`	signed in

allergies 1

Method	Path	Access
POST	`/api/allergies`	signed in

analytics 1

Method	Path	Access
GET	`/api/analytics`	signed in

appointments 4

Method	Path	Access
GET	`/api/appointments`	signed in
POST	`/api/appointments`	signed in
PUT	`/api/appointments/:id`	signed in
POST	`/api/appointments/:id/virtual`	administrator

audit 1

Method	Path	Access
GET	`/api/audit`	administrator

beds 1

Method	Path	Access
PUT	`/api/beds/:id`	administrator

break-glass 7

Method	Path	Access
POST	`/api/break-glass`	signed in
POST	`/api/break-glass/:id/review`	administrator
GET	`/api/break-glass/active`	signed in
POST	`/api/break-glass/end`	signed in
GET	`/api/break-glass/log`	administrator
POST	`/api/break-glass/notify-to`	administrator
GET	`/api/break-glass/reasons`	signed in

bu 9

Method	Path	Access
GET	`/api/bu`	signed in
POST	`/api/bu/assign-org`	administrator
POST	`/api/bu/entities`	administrator
GET	`/api/bu/for-entity`	signed in
POST	`/api/bu/functions`	administrator
GET	`/api/bu/resolve`	signed in
POST	`/api/bu/service-providers`	administrator
POST	`/api/bu/service-providers/:id/delete`	administrator
POST	`/api/bu/units`	administrator

care-bundles 4

Method	Path	Access
GET	`/api/care-bundles`	administrator
POST	`/api/care-bundles`	administrator
PUT	`/api/care-bundles/:id`	administrator
POST	`/api/care-bundles/:id/apply`	signed in

caregaps 1

Method	Path	Access
POST	`/api/caregaps/:id/close`	signed in

claims 9

Method	Path	Access
GET	`/api/claims`	signed in
POST	`/api/claims`	signed in
POST	`/api/claims/:id/appeal`	administrator
POST	`/api/claims/:id/deny`	administrator
POST	`/api/claims/:id/post-payment`	signed in
POST	`/api/claims/:id/resolve`	administrator
POST	`/api/claims/:id/scrub`	administrator
POST	`/api/claims/:id/submit`	signed in
GET	`/api/claims/recovery-lane`	administrator

connect 25

Method	Path	Access
GET	`/api/connect/connections`	signed in
POST	`/api/connect/connections`	signed in
DELETE	`/api/connect/connections/:id`	signed in
PUT	`/api/connect/connections/:id`	signed in
POST	`/api/connect/connections/:id/call`	signed in
POST	`/api/connect/connections/:id/test`	signed in
GET	`/api/connect/hooks`	signed in
POST	`/api/connect/hooks`	signed in
DELETE	`/api/connect/hooks/:id`	signed in
PUT	`/api/connect/hooks/:id`	signed in
GET	`/api/connect/hooks/:id/events`	signed in
GET	`/api/connect/log`	signed in
GET	`/api/connect/meta`	signed in
GET	`/api/connect/subs`	signed in
POST	`/api/connect/subs`	signed in
DELETE	`/api/connect/subs/:id`	signed in
PUT	`/api/connect/subs/:id`	signed in
POST	`/api/connect/subs/:id/test`	administrator
GET	`/api/connect/tokens`	signed in
POST	`/api/connect/tokens`	signed in
DELETE	`/api/connect/tokens/:id`	signed in
PUT	`/api/connect/tokens/:id`	signed in
POST	`/connect/hook/:slug`	signed in
GET	`/connect/mcp`	signed in
POST	`/connect/mcp`	signed in

custom-domain 3

Method	Path	Access
GET	`/api/custom-domain`	signed in
PUT	`/api/custom-domain`	signed in
POST	`/api/custom-domain/verify`	signed in

dashboard 1

Method	Path	Access
GET	`/api/dashboard`	signed in

drug-check 1

Method	Path	Access
POST	`/api/drug-check`	signed in

eligibility 1

Method	Path	Access
POST	`/api/eligibility`	signed in

entstruct 5

Method	Path	Access
GET	`/api/entstruct`	signed in
POST	`/api/entstruct/assign`	administrator
POST	`/api/entstruct/entities`	administrator
POST	`/api/entstruct/registrations`	administrator
POST	`/api/entstruct/registrations/:id/delete`	administrator

health-positions 5

Method	Path	Access
GET	`/api/health-positions`	signed in
POST	`/api/health-positions`	administrator
GET	`/api/health-positions/my-access`	signed in
GET	`/api/health-positions/preview`	administrator
POST	`/api/health-positions/security`	administrator

imaging 4

Method	Path	Access
GET	`/api/imaging`	signed in
POST	`/api/imaging`	signed in
DELETE	`/api/imaging/:id`	signed in
POST	`/api/imaging/:id/report`	signed in

immunizations 1

Method	Path	Access
POST	`/api/immunizations`	signed in

labs 1

Method	Path	Access
GET	`/api/labs`	signed in

Method	Path	Access
POST	`/api/login`	public
POST	`/api/login/2fa`	public

logout 1

Method	Path	Access
POST	`/api/logout`	signed in

mar 2

Method	Path	Access
GET	`/api/mar`	signed in
POST	`/api/mar/:id/administer`	signed in

me 4

Method	Path	Access
GET	`/api/me`	signed in
POST	`/api/me/password`	signed in
GET	`/api/me/profile`	signed in
PUT	`/api/me/profile`	signed in

medications 3

Method	Path	Access
POST	`/api/medications`	signed in
POST	`/api/medications/:id/discontinue`	signed in
POST	`/api/medications/:id/verify`	signed in

messages 2

Method	Path	Access
GET	`/api/messages`	signed in
POST	`/api/messages`	signed in

next-number 1

Method	Path	Access
GET	`/api/next-number`	signed in

notes 1

Method	Path	Access
POST	`/api/notes`	signed in

nxtz 3

Method	Path	Access
GET	`/api/nxtz`	signed in
PUT	`/api/nxtz`	signed in
POST	`/api/nxtz/device`	signed in

orders 3

Method	Path	Access
POST	`/api/orders`	signed in
PUT	`/api/orders/:id`	signed in
GET	`/api/orders/board`	signed in

password 2

Method	Path	Access
POST	`/api/password/forgot`	public
POST	`/api/password/reset`	signed in

patients 4

Method	Path	Access
GET	`/api/patients`	signed in
POST	`/api/patients`	signed in
GET	`/api/patients/:id`	signed in
GET	`/api/patients/:id/ai-summary`	signed in

perms 2

Method	Path	Access
GET	`/api/perms/catalog`	signed in
GET	`/api/perms/resolved`	administrator

pharmacy 1

Method	Path	Access
GET	`/api/pharmacy/queue`	signed in

population 1

Method	Path	Access
GET	`/api/population`	signed in

problems 1

Method	Path	Access
POST	`/api/problems`	signed in

providers 1

Method	Path	Access
GET	`/api/providers`	signed in

public 2

Method	Path	Access
GET	`/api/public/visit/:code`	signed in
POST	`/api/public/visit/:code`	signed in

referrals 2

Method	Path	Access
GET	`/api/referrals`	signed in
POST	`/api/referrals`	signed in

search 2

Method	Path	Access
GET	`/api/search`	signed in
GET	`/api/search/coverage`	signed in

sender-domains 1

Method	Path	Access
GET	`/api/sender-domains/:domain/dkim`	signed in

sender-emails 6

Method	Path	Access
POST	`/api/sender-emails`	signed in
DELETE	`/api/sender-emails/:id`	signed in
PUT	`/api/sender-emails/:id`	signed in
POST	`/api/sender-emails/:id/primary`	signed in
POST	`/api/sender-emails/:id/resend`	signed in
POST	`/api/sender-emails/:id/verify`	signed in

sender-options 1

Method	Path	Access
GET	`/api/sender-options`	signed in

sender-prefs 1

Method	Path	Access
GET	`/api/sender-prefs`	signed in

sentinel 4

Method	Path	Access
GET	`/api/sentinel/advisories`	administrator
GET	`/api/sentinel/rules`	administrator
POST	`/api/sentinel/rules`	administrator
PUT	`/api/sentinel/rules/:id`	administrator

sso 1

Method	Path	Access
POST	`/api/sso/accounts`	signed in

stayboard 1

Method	Path	Access
GET	`/api/stayboard`	administrator

stays 3

Method	Path	Access
POST	`/api/stays`	administrator
POST	`/api/stays/:id/discharge`	administrator
POST	`/api/stays/:id/move`	administrator

uam 1

Method	Path	Access
GET	`/api/uam/users`	administrator

username 1

Method	Path	Access
POST	`/api/username/forgot`	public

users 1

Method	Path	Access
GET	`/api/users`	signed in

virtual-visits 3

Method	Path	Access
GET	`/api/virtual-visits`	administrator
POST	`/api/virtual-visits/:id/end`	signed in
POST	`/api/virtual-visits/:id/start`	signed in

vitals 1

Method	Path	Access
POST	`/api/vitals`	signed in

wards 1

Method	Path	Access
POST	`/api/wards`	administrator