coreplus API

The coreplus API provides access to appointment booking related end points, such as clients, practitioners, availability slots and appointments. It is a RESTful API, which utilises the HTTP verbs for creating viewing objects.

If you are a developer looking to create an external consumer server to server application for your coreplus clients, then by signing up for a sandbox account you will get access to your own trial coreplus account on our sandbox server with authorisation credentials.

Create a Client (Post)

Required parameters Type Description
firstName String(50) The client’s first name
lastName String(50) The client’s surname.
dateOfBirth Date The date of birth of the client.

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Client/

BODY:

{
"firstName":"Bob",
"lastName":"Smith",
"dateOfBirth":"1996-04-29"
}
Example response
{
  "client": {
    "clientId": "3dc6e75d-20b6-42bf-bb72-193ce9da85fc"
  }
}

 

Optional parameters Type Description
title String The patient’s title – Acs Prof, Dr, Master, Miss, Mr, Mrs, Ms, Prof, Rev
preferredName String The patient’s preferred name
middleName String The patient’s middle Name
gender String The patient’s gender – Male or Female or Other or empty.
pronoun String The patient’s pronoun. Must be one of the following values – e, he, she, they, xe, ze, other

‘e’ represents — e/em/eir/eirs/emself
‘he’ represents — he/him/his/his/himself
‘she’ represents — she/her/her/hers/herself
‘they’ represents — they/them/their/theirs/theirself
‘xe’ represents — xe/xem/xyr/xyrs/xemself
‘ze’ represents   ze/hir/hir/hirs/hirself
‘other’ represents — other

medicareCardNumber String(20) The patient’s medicare card number
medicareCardIRN String(1) The patient’s medicare IRN number
medicareCardExpireDate Date The expiry date of the medicare card number (YYYY-MM-DD)
dvaCardNumber String(20) The patient’s dva card number
phoneNumberHome String(50) The patient’s home phone number
phoneNumberWork String(50) The patient’s work phone number
phoneNumberMobile String(50) The patient’s mobile phone number
Status String(50) The patient’s status – Current, Closed, Deleted, Deceased
email String(50) The patient’s email address
addressResidential The patient’s address {“streetAddress”:””,”city”:””,”postcode”:””,”state”:””}
addressPostal The Patient’s postal address {“streetAddress”:””,”city”:””,”postcode”:””,”state”:””}
postalSameAsResidential Boolean
notes1 String(300) Patient Overview Notes field 1
notes2 String(300) Patient Overview Notes field 2
practitionerId Object containing Id Patient’s assigned case manager (from Practitioner Get endpoint)
AllocatedLocationId Object containing Id Patient’s assigned location (from Location Get endpoint)
clientGroupId Object containing Id Patient’s assigned client group (from ClientGroup Get endpoint, requires advanced permissions for the calling application\user )
marketingConsent String Marketing preference of the patient. Must be one of the following 4 allowed values:

Approved, ApprovedAddressPending, NotApproved, ConsentUnknown. All other values will be ignored.

HealthFundProviderId Object containing Id Patient’s health fund provider (from Health Fund Providers Get endpoint)
HealthFundMembershipNumber String Patient’s Health Fund membership number
HealthFundCardPosition String Patient’s Health Fund card position number

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Client/

BODY:

{
   "title":"Mr",
   "firstName":"jetty",
   "lastName":"smith",
   "middleName":"kith",
   "preferredName":"jesmi",
   "Status":"Current",
   "gender":"Male",
   "pronouns":"e",
   "culture":"someculture",
   "dateOfBirth":"1957-07-03",
   "medicareCardNumber":"100456799",
   "medicareCardIRN":"1",
   "medicareCardExpireDate":"2018-09-30",
   "addressResidential":{
      "streetAddress":"120 Narreb St",
      "suburb":"Melbourne",
      "postcode":"3000",
      "state":"VIC"
   },
   "addressPostal":{
      "streetAddress":"444 Jeffrey Road",
      "suburb":"Melbourne",
      "postcode":"3000",
      "state":"VIC"
   },
   "postalSameAsResidential":"false",
   "phoneNumberMobile":"0420000008",
   "email":"asdf@coreplus.com.au",
   "phoneNumberHome":"0300000024",
   "phoneNumberFax":"0300000024",
   "notes1":"Excellent Patient",
   "notes2":"Prompt Payer",
   "practitionerId":"f006f524-d8a8-4ce4-a8d5-79f908e3a763",
   "AllocatedLocationId":"d8d4fe7c-765a-46a3-a389-54ce298a27e9",
   "clientGroupId":"cfde85be-07a7-e611-8158-0202e207ce0b",
   "marketingConsent":"Approved", 
   "HealthFundProviderId": "d7ad8954-f024-4e89-bd40-41b64aec087e",
   "HealthFundMembershipNumber": "1234567",
   "HealthFundCardPosition": "1"
}
Example response
{
  "client": {
    "clientId": "4ac7e75b-23b6-42bf-bb72-193ce9da86fa"
  }
}

Develop with us

Use the form to sign-up and start developing with coreplus today.


Please leave this field empty.