IAR-DST API v2 (2.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{developmentalAgeGroup} includes a uuid suitable for this purpose.

Returns a data structure sufficient to render a client referral form.

This structure is a list of nested elements that are largely modelled on HTML elements but are intened to be suitable for rendering a form in any framework.

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

Alerts

A practitioner may select an age group that does not match the client's chronological age. Similarly a practitioner may select a level of care that differs from the IAR-DST derived level of care. In these cases alerts (warnings) should be issued and appropriare reasons or notes captured if the difference is intentional.

The returned data structure includes alert elements containing text and subordinate elements, such as notes and option selections, that must be displayed when the alert's active property is true.

When an alert object has the active property set to false it, and its subordinate elements, must not be displayed or required.

When an alert object has the active property set to true it, and its subordinate elements, must be displayed and any required elements must not be omitted. Required elements have the required property set to true.

Alerts are always false when returned from this endpoint.

In respose to a request containing the subject's (client/patient) age in years and practitioner's selected level of care the result is a data structure sufficient to update a client referral form with active alerts if needed. Active alerts are indicated by a true active attribute associated with their id.

See GET /report/{developmentalAgeGroup}/{locDstDerived} for more detail.

Report uuid

Each report must be accompanied by a uuid. For a single session of API calls for the same 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 referrals 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{developmentalAgeGroup} includes a uuid suitable for this purpose.