Awell Score API

Awell Score is a separate product with its own REST API. It calculates validated clinical and patient-reported outcome measures, and it is CE-marked.

• It is REST, not GraphQL. The Orchestration API is unrelated.
• You can use it without Awell Orchestration. A care flow can call a calculation through Add a calculation, but Score also stands alone.

Endpoints

Perform a calculation

POST /v2/calculations

Send the calculation inputs and get the results back.

There is also a /v1/calculations endpoint. Use v2 for new work. If you're maintaining an integration on v1, check the response shape before switching, as the two are not interchangeable.

List calculations

GET /v1/calculations

Returns every calculation available in Awell Score.

The full response is large, because it includes each calculation's complete schema. If you only need IDs and names, exclude the schema:

GET /v1/calculations?include_schema=false

Retrieve, search, and simulate

Further endpoints let you fetch a single calculation, search the catalog, retrieve calculation results, and simulate a calculation without storing anything.

Simulate a calculation to confirm the inputs map to the instrument as intended before relying on a score in a live care flow.

Input keys matter

Each calculation expects specific question keys. Awell publishes a proposed question and question key per calculation, for example PROMIS_10_..., and the calculation matches on them.

Use the published keys. A renamed key means the calculation can't find its input, so the result is a wrong or missing score rather than an error. See Encode questions and answer options.

Score Explorer

Score Explorer is the browsable catalog of available calculations and their documentation, including how each instrument's questions and answers should be interpreted. Start there when choosing an instrument.

Next steps

• Add a calculation to use one inside a care flow.
• Work with forms for collecting the inputs.

This page covers the shape of the Score API rather than every endpoint's fields. Nine source pages fold into it, and the per-endpoint field tables have not been ported. If you need them, see migration/recovery-log.md.