Capability registry

This reference is generated from packages/capabilities/manifest.json. A capability appears here only when its underlying behavior is implemented and registered.

`patients.list`

List patients

query

List patients in the current workspace.

Version: 1
Domain: patients
Effect: read
Scope: workspace
Data: health

`patients.create`

Create patient

command

Create a patient in the current workspace.

Version: 1
Domain: patients
Effect: create
Scope: workspace
Data: health

`patients.get`

Get patient

query

Get a patient in the current workspace.

Version: 1
Domain: patients
Effect: read
Scope: workspace
Data: health

`patients.self`

Get current patient

query

Get the patient record bound to the current session.

Version: 1
Domain: patients
Effect: read
Scope: patient
Data: health

`patients.update`

Update patient

command

Update a patient in the current workspace.

Version: 1
Domain: patients
Effect: update
Scope: workspace
Data: health

`patients.delete`

Delete patient

command

Delete a patient from the current workspace.

Version: 1
Domain: patients
Effect: delete
Scope: workspace
Data: health

`notes.list`

List notes

query

List notes and their resource links in the current workspace.

Version: 1
Domain: notes
Effect: read
Scope: workspace
Data: health

`notes.create`

Create note

command

Create a note linked to workspace resources.

Version: 1
Domain: notes
Effect: create
Scope: workspace
Data: health

`notes.get`

Get note

query

Get a note and its resource links in the current workspace.

Version: 1
Domain: notes
Effect: read
Scope: workspace
Data: health

`notes.update`

Update note

command

Update a note or its resource links.

Version: 1
Domain: notes
Effect: update
Scope: workspace
Data: health

`notes.delete`

Delete note

command

Delete a note from the current workspace.

Version: 1
Domain: notes
Effect: delete
Scope: workspace
Data: health

`appointments.list`

List appointments

query

List appointments in the current workspace.

Version: 1
Domain: appointments
Effect: read
Scope: workspace
Data: health

`appointments.create`

Create appointment

command

Create an appointment in the current workspace.

Version: 1
Domain: appointments
Effect: create
Scope: workspace
Data: health

`appointments.get`

Get appointment

query

Get an appointment in the current workspace.

Version: 1
Domain: appointments
Effect: read
Scope: workspace
Data: health

`appointments.transition`

Transition appointment

command

Move an appointment through its supported lifecycle.

Version: 1
Domain: appointments
Effect: update
Scope: workspace
Data: health

`events.list`

List timeline events

query

List recorded events relevant to a resource in the current workspace.

Version: 1
Domain: events
Effect: read
Scope: workspace
Data: health

`booking.slots`

List booking slots

query

Resolve available appointment slots and concrete resources for an offering.

Version: 1
Domain: booking
Effect: read
Scope: workspace
Data: operational

`booking.offerings.list`

List booking offerings

query

List active catalogue offerings that can be scheduled at a place.

Version: 1
Domain: booking
Effect: read
Scope: workspace
Data: operational

`booking.resources.list`

List booking resources

query

List schedulable people, sites, rooms, and equipment in the current workspace.

Version: 1
Domain: booking
Effect: read
Scope: workspace
Data: operational

`booking.resources.create`

Create booking resource

command

Create a schedulable person, site, room, or equipment resource in the current workspace.

Version: 1
Domain: booking
Effect: create
Scope: workspace
Data: operational

`booking.resources.update`

Update booking resource

command

Update a schedulable resource in the current workspace.

Version: 1
Domain: booking
Effect: update
Scope: workspace
Data: operational

`practitioners.list`

List practitioners

query

List practitioners in the current workspace.

Version: 1
Domain: practitioners
Effect: read
Scope: workspace
Data: operational

`catalogue.items.list`

List catalogue items

query

List products and services in the current workspace catalogue.

Version: 1
Domain: catalogue
Effect: read
Scope: workspace
Data: operational

`catalogue.items.create`

Create catalogue item

command

Create a product or service in the current workspace catalogue.

Version: 1
Domain: catalogue
Effect: create
Scope: workspace
Data: operational

`catalogue.items.get`

Get catalogue item

query

Get a product or service in the current workspace catalogue.

Version: 1
Domain: catalogue
Effect: read
Scope: workspace
Data: operational

`catalogue.items.update`

Update catalogue item

command

Update a product or service in the current workspace catalogue.

Version: 1
Domain: catalogue
Effect: update
Scope: workspace
Data: operational

`catalogue.items.delete`

Delete catalogue item

command

Delete a product or service from the current workspace catalogue.

Version: 1
Domain: catalogue
Effect: delete
Scope: workspace
Data: operational

`catalogue.prices.list`

List catalogue prices

query

List the contextual prices configured for a catalogue item.

Version: 1
Domain: catalogue
Effect: read
Scope: workspace
Data: operational

`catalogue.prices.create`

Create catalogue price

command

Create a base, override, or sale price for a catalogue item.

Version: 1
Domain: catalogue
Effect: create
Scope: workspace
Data: operational

`catalogue.prices.update`

Update catalogue price

command

Update a contextual price for a catalogue item.

Version: 1
Domain: catalogue
Effect: update
Scope: workspace
Data: operational

`catalogue.prices.delete`

Delete catalogue price

command

Delete a contextual price from a catalogue item.

Version: 1
Domain: catalogue
Effect: delete
Scope: workspace
Data: operational

`storefront.catalogue.list`

List storefront catalogue

query

List active products and services published by a workspace.

Version: 1
Domain: storefront
Effect: read
Scope: workspace
Data: public

`storefront.catalogue.get`

Get storefront item

query

Get an active product or service published by a workspace.

Version: 1
Domain: storefront
Effect: read
Scope: workspace
Data: public

`storefront.pricing.quote`

Calculate storefront quote

query

Calculate contextual prices for active storefront items.

Version: 1
Domain: storefront
Effect: read
Scope: workspace
Data: public

`search.query`

query

Search patients and appointments in the current workspace.

Version: 1
Domain: search
Effect: read
Scope: workspace
Data: health

`modules.list`

List modules

query

List module readiness and enablement for the current workspace.

Version: 1
Domain: modules
Effect: read
Scope: workspace
Data: operational

`messages.list`

List messages

query

List messages in a patient's channel.

Version: 1
Domain: messages
Effect: read
Scope: workspace
Data: health

`messages.send`

Send message

command

Send a message through a patient's channel.

Version: 1
Domain: messages
Effect: create
Scope: workspace
Data: health

`settings.list`

List settings

query

List workspace and current-member settings.

Version: 1
Domain: settings
Effect: read
Scope: workspace
Data: operational

`settings.create`

Create setting

command

Create a workspace or current-member setting.

Version: 1
Domain: settings
Effect: create
Scope: workspace
Data: operational

`settings.get`

Get setting

query

Get a workspace or current-member setting.

Version: 1
Domain: settings
Effect: read
Scope: workspace
Data: operational

`settings.update`

Update setting

command

Update a workspace or current-member setting.

Version: 1
Domain: settings
Effect: update
Scope: workspace
Data: operational

`settings.delete`

Delete setting

command

Delete a workspace or current-member setting.

Version: 1
Domain: settings
Effect: delete
Scope: workspace
Data: operational