Skip to main content
GET
Get an EHR action
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.
Look an action up by its stable <ehr>.<action> name, for example athena.search_patients. Guide: EHR integrations. Errors: Error catalog.

Authorizations

X-API-Key
string
header
required

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

Path Parameters

actionName
string
required
Pattern: ^[a-z0-9_]{1,64}\.[a-z0-9_]{1,64}$
Example:

"athena.search_patients"

Response

The action

data
object
required