Care Collaborator developer API

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}

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

GET /facility/changeSelectedFacility/{facility-id}

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

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.

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 service is available, e.g. ["mon", "tue"] means this service is available on Monday and Tuesday

POST /supplier/find { name: "Name of the supplier to find", status: "live", "hold", or "archived", }

  • Name can a partial name

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

Logout       Unlock