Care Collaborator API

If you are a developer and want to integrate your product with Care Collaborator, we would love to hear from you.

Care Collaborator API

 

With the Care Collaborator API, you will be able to manage all key components (Home Care Providers, Case Managers and Suppliers etc.)

The current components supported are:

AUTHENTICATION

Authenticate to Care Collaborator and Select HCP

HOME CARE PROVIDER

Manage (add/update) Home Care Provider (HCP)

 

Change Home Care Provider (HCP)

CASE MANAGER

Manage (add) Case Managers.

SUPPLIER

Manage (add/update) Suppliers

Search for Suppliers

Manage (add) Supplier Services

Overview

Getting Started

Getting Started


Before you call an API in Care Collaborator, you must

  • First obtain an OAuth token by calling /oauth/token
  • Then select a HCP by calling /facility/changeSelectedFacility/{facility-id}




Authentication


POST /oauth/token
{
grant_type: "password",
client_id: "to_be_provided",
client_secret: "to_be_provided",
username: "to_be_provided",
scope: "" }





Case Manager

Add a Case Manager


POST /register { name: "Full name of the case manager", email: "Email address of the case manager", user_role: "5ba873b19a89202530417f33" }





Supplier

Add or Update a Supplier


POST /supplier/store
{
supplier_id: "supplier_id" or NULL,
abn: "ABN of the supplier",
name: "Full name of the supplier",
Address1: "First line of the address",
AddressLine2: "Second line of the address",
Suburb: "Suburb of the HCP",
State: "State of the HCP",
Postcode: "Postcode of the HCP",
privacy_officer: "Full name of the privacy officer",
complaint_officer: "Full name of the complaint officer",
ContactFirstName: "First name of the contact person",
ContactLastName: "Last name of the contact person",
Phone: "Phone of the contact person",
EmailAddress1: "Email address of the contact person", }

  • When supplier_id is NULL, a new supplier is created.
  • When supplier_id is a valid supplier id, supplier is updated.




Add or Update a Supplier Service


POST /supplier/store
{
supplier_id: "supplier_id",
service_id: "service_id" or NULL,
service_category: "Category Id",
name: "Full name of the service", regions: [ ] ,
code: "SKU of the service",
status: "live", "archived",
weekly: [ ],
from_time: "Available from what time, e.g. 0800"
to_time: "To when, e.g. 1500"
rate: "Unit cose of this service"
unit: "Unit of measure" }
Weekly is an array of what day of the week this servicve is available, e.g. ["mon", "tue"] means this service is available on Monday and Tuesday




Find a Supplier


POST /supplier/find
{
name: "Name of the supplier to find",
status: "live", "hold", or "archived", } Name can be a partial name.





Home Care Provider (HCP)

Add or Update a Care Provider


POST /facility/store
{
FacilityId: "facility-id" or NULL,
NameLong: "Full name of the provider",
Address1: "First line of the address",
AddressLine2: "Second line of the address",
Suburb: "Suburb of the HCP",
State: "State of the HCP",
Postcode: "Postcode of the HCP",
privacy_officer: "Full name of the privacy officer",
complaint_officer: "Full name of the complaint officer",
ContactFirstName: "First name of the contact person",
ContactLastName: "Last name of the contact person",
Phone: "Phone of the contact person",
EmailAddress1: "Email address of the contact person",
abn: "ABN of the HCP",
additional_requirements: "Additional requirements of the HCP",
trial_mode: "yes" or NULL,
agreement_version: "v1" or "v2" }

  • When FacilityId is NULL, a new HCP is created.
  • When FacilityId is a valid facility id, HCP is updated.
  • When trial_mode = "yes", certain function in Care Collaborator will be disabled.
  • When agreement_version = "v1", agreement version prior to Nov 2018 is used




Change Home Care Provider (HCP)


GET /facility/changeSelectedFacility/{facility-id}





© Care Collaborator 2019

GET IN TOUCH

  • LinkedIn - Care Collaborator
  • Twitter - Care Collaborator

LEARN MORE

ABOUT

SUPPORT

FEATURES

+61 (0) 438 020 728
Melbourne, Australia