IAR-DST API v1 (1.0.0)

Returns a data structure sufficient to render a form for obtaining the 8 domain ratings from a user.

Utilisation of this end point, while optional, avoids the need to manually copy textual elements of the IAR-DST rating form, minimising the chance of transcription errors. Ideally this should be implemented such that the rating UI is rendered dynamically each time it is used so that any text updates or corrections are incorporated automatically.

In respose to a request containing all 8 domain ratings the resulting object includes the assessment result (1, 2, 2+, 3+, 4+ or 5), a short label to describe the result and a longer description of the result as well as other useful context.

Assessment uuid

Each assessment must be accompanied by a uuid. For a single session of API calls for the same rating subject (client/patient) the uuid must remain the same.

The purpose of this unique identifier is to faciliate more accurate counting of the number of generated IAR-DST ratings while allowing for multiple calls to the API for the same subject. For example if the user adjusts the domain values during a single session.

Note that the object returned by a GET /assessment includes a uuid suitable for this purpose.