The available REST APIs are documented here in Swagger so that you can review and try out the API calls before you integrate your application with Watson Care Manager.

Alerts API

Use this API to receive alerts in Watson Care Manager when specific information that could influence care management is recorded for a client in the external system.

Try it out

Assessments API

Use this API to share completed client assessment data between an external system and Watson Care Manager.

Before you begin: To see the REST API calls for a configured assessment, you must download the API document for the assessment in the Administration application. Then, open the downloaded file in a Swagger editor (Version 2.0) to see the available calls. For more information, see Sharing the API document for an assessment.

Care Plan API

This API can be called only after receiving a webhooks notification that relates to a Share Care Plan event. Before you begin: Before you can retrieve a client's care plan via this API, you must first subscribe to notifications for the Share Care Plan data type. For more information, see Configuring subscribers and managing subscriptions.Two API calls are required.

First, the Get Care Plan Metadata API provides the metadata related to the share care plan event and a call-back URL to retrieve the PDF document for the client. Then, the Get Care Plan Report as PDF API uses the returned URL to generate and return the PDF.


             

Try it out

Care Team Actions API

Use this API to receive an action from an external system that a required care team role must do for client who is registered in Watson Care Manager. Care team actions help a client to achieve their goals and enhance their behavior, skills, or overall well-being.

Try it out

Client Deletions and Reversals API

Use this API to expose client deletions and reversals that occur in Watson Care Manager to any external system that is integrated with Watson Care Manager.

Try it out

Client Registration API

Use this API to receive a client registration in Watson Care Manager from an external system, which includes the client's demographic, contact, and identification information.

Try it out

Configurable Client Data API

Use this API to share configurable client data that is created, updated, and deleted for a client in an external system with Watson Care Manager. In addition, you can use this API to retrieve updates to configurable client data from Watson Care Manager (via webhooks).




Before you begin: To see the REST API calls for a configurable client data type, you must download its API document in the Administration application. Then, open the downloaded file in a Swagger editor (Version 2.0) to see the available calls.

For more information, see Sharing the API document for a configurable client data type.

Note: You can make a GET call only after receiving a webhooks notification that relates to a configurable client data type. For more information, see Configuring subscribers and managing subscriptions.

  

Contact: Address API

Use this API to share a client's address data that is created, updated, or deleted in an external system with Watson Care Manager.

Try it out

Contact: Telecoms API

Use this API to share a client's phone or email contact data that is created, updated, or deleted in an external system with Watson Care Manager.

Try it out

Demographics: Client Demographics API

Use this API to receive updates to a client's demographic details in Watson Care Manager from a external system, which includes a client's date of birth, date of death, marriage, gender, and status.

Try it out

Demographics: Identification API

Use this API to share a client's identification data that is created, updated, or deleted in an external system with Watson Care Manager.

Try it out

Demographics: Name API

Use this API to share a client's name that is created, updated, or deleted in an external system with Watson Care Manager.

Try it out

Demographics: Tag API

Use this API to share a client's tag data that is created, updated, or deleted in an external system with Watson Care Manager.

Try it out

Federated Users API

Use this API to create federated user accounts in Watson Care Manager that are stored in an identity provider system so that the identity provider can authenticate the user's access to Watson Care Manager.

Try it out

Notes API

Use this API to share client notes and deletions that are recorded in an external system for a client who is registered in Watson Care Manager. In addition, you can use this API to retrieve the latest notes information for clients.

Try it out

>

Program API

This API can be called only after receiving a webhooks notification that relates to a Program Status event. Before you begin: Before you can retrieve a client's program details via this API, you must first subscribe to notifications for the Program data type. For more information, see Configuring subscribers and managing subscriptions. Use this API to retrieve updates to program details that are recorded in Watson Care Manager for a registered client.

Try it out

Questionnaires API

Use this API to share completed client questionnaire data between an external system and Watson Care Manager

Before you begin: To see the REST API calls for a configured questionnaire, you must download the API document for the questionnaire in the Administration application. Then, open the downloaded file in a Swagger editor (Version 2.0) to see the available calls. For more information, see Sharing the API document for a questionnaire.

Referrals API

Use this API to receive open unassigned referrals (including suggested programs) that are captured in the external system for a client who is registered in Watson Care Manager.

Try it out