Skip to main content

Execute a Bot by identifier

Execute a Bot selected by its FHIR identifier, instead of supplying the Bot resource ID. The input body and output are defined by the selected Bot.

MethodPath
POST/fhir/R4/Bot/$execute?identifier=

Request​

The identifier query value identifies the Bot, commonly as system|value. URL-encode the complete identifier value.

curl --request POST \
  --url 'https://api.sandbox.ovok.com/fhir/R4/Bot/$execute?identifier=https%3A%2F%2Fexample.org%2Fbot-id%7Cnightly-summary' \
  --header "Authorization: Bearer ${OVOK_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{"date":"2026-10-05"}'
Request partDescription
identifierBot identifier query parameter. Encode reserved characters such as : and `
BodyJSON input consumed by the Bot. The required shape depends on the Bot.

Response​

The response body and content type are determined by the Bot. A request using Prefer: respond-async may return 202 Accepted with a job location; follow that location to check completion.