The Follow-up outcome can be resubmitted with changes using the /api/followups/…/{id}/files ‘PUT’ endpoint until the department accepts the outcome, or if the department has withdrawn the follow-up outcome (DHHS Follow-up status = Received’, On Hold’, ’Outcome ‘Outcome ‘Outcome Withdrawn’). The supplied on a successful PUT will be the same that has been supplied on the ‘dhhsFollowUpId’ relevant recommendation. The Follow-up status, dates and withdrawal information can be retrieved using the end point. This ‘GET’ data can be useful to gauge the progress of the follow-up outcome in the department. The supplied on a successful PUT must be supplied in the GET URL. ‘dhhsFollowUpId’ NOTE: Only the outcomes for investigations and root cause analysis need to be submitted to DHHS. Case review outcomes are not submitted. Figure 7 - Example of a successful response Figure 8 - Example of an unsuccessful response API entity list (PUT Investigation outcome) – The following table lists all of the Data Fields that belong to the CIMS Follow-up Outcome API Entity when creating/updating a follow-up Investigation outcome. Refer to section 5.5 for a detailed description of the Incident follow-up data fields. Data from Service Provider/s externalId Client - sourceSystem Client - sourceSystemId Client - primaryOutcome Client - secondaryOutcome Client - primaryTheme Client - primaryThemeAction Client - primaryThemeDueDate Client - primaryThemeSecondaryAction Client - primaryThemeSecondaryDueDate Client - secondaryTheme Client - secondaryThemeAction secondaryThemeDueDate Client -
The Follow-up outcome can be resubmitted with changes using the ‘PUT’ /api/followups/…/{id}/files endpoint until the department accepts the outcome, or if the department has withdrawn the follow-up outcome (DHHS Follow-up status = ’Outcome Received’, ‘Outcome On Hold’, ‘Outcome Withdrawn’). The ‘dhhsFollowUpId’ supplied on a successful PUT will be the same that has been supplied on the relevant recommendation. The Follow-up status, dates and withdrawal information can be retrieved using the ‘GET’ end point. This data can be useful to gauge the progress of the follow-up outcome in the department. The ‘dhhsFollowUpId’ supplied on a successful PUT must be supplied in the GET URL. NOTE: Only the outcomes for investigations and root cause analysis need to be submitted to DHHS. Case review outcomes are not submitted. Figure 7 - Example of a successful response Figure 8 - Example of an unsuccessful response API entity list (PUT – Investigation outcome) The following table lists all of the Data Fields that belong to the CIMS Follow-up Outcome API Entity when creating/updating a follow-up Investigation outcome. Refer to section 5.5 for a detailed description of the Incident follow-up data fields. Data from Service Provider/s externalId Client - sourceSystem Client - sourceSystemId Client - primaryOutcome Client - secondaryOutcome Client - primaryTheme Client - primaryThemeAction Client - primaryThemeDueDate Client - primaryThemeSecondaryAction Client - primaryThemeSecondaryDueDate Client - secondaryTheme Client - secondaryThemeAction Client - secondaryThemeDueDate
Application%20programming%20interface%20specification%20%28CIMS%29.docx