Skip to main content
GET
List EHR actions
Safety
  • Writes data: No
  • Safe to retry: Yes
  • Contacts an outside system: None. Reads HealOS’s catalog; your EHR is not contacted.
  • Dry run: Not needed (read-only).
This endpoint only describes EHR actions. Running them through the HealOS API is not available yet: there is no endpoint that executes an action.
The catalog is the same for every organization. Filter one EHR with ?ehr=athena. Guide: EHR integrations. Errors: Error catalog.

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Query Parameters

ehr
string

Only this EHR's actions.

Pattern: ^[a-z0-9_]{1,64}$
Example:

"athena"

Response

Actions, sorted by EHR

data
object[]
required
meta
object
required