API Reference
/
Booking - HCA
/
Search HCA Consultants

Hero Health Public API (1.0.0)

Download OpenAPI description
Download API docs
Languages
Servers
Mock server
https://developer.herohealth.net/_mock/apis/public-api/openapi/
Staging
https://api.staging.htech.app/
Production
https://api.herohealth.net/

Practice Group

Operations

Admin

Operations

Booking

Operations

Links

Operations

Utilities

Operations

Messages

Operations

Booking - HCA

Operations

Search HCA Consultants

Request

Search for consultants in the HCA system by specified fields.

Query
searchstringrequired

The search query string

fieldsArray of stringsrequired

Fields to search within

Items Enum"first_name""last_name""speciality""mnemonic""gmc_number""service"
Example: fields=fields=first_name&fields=last_name
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking-hca/consultants?fields=fields%3Dfirst_name%26fields%3Dlast_name&search=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
dataArray of objectsrequired
data[].​first_namestringrequired
data[].​last_namestringrequired
data[].​specialitystringrequired
data[].​mnemonicstringrequired
data[].​gmc_numberstring^\d{7}$required
data[].​available_to_book_with_onlinebooleanrequired
data[].​servicestringrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Get HCA Consultant Details

Request

Retrieves consultant details from the HCA system.

Path
gmc_numberstring^\d{7}$required

The GMC number of the consultant

Query
booking_typestringrequired

The type of appointment to be booked

Enum"initial""follow_on"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking-hca/consultants/{gmc_number}?booking_type=initial' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
hca_consultant_idstringrequired
crm_idstring(uuid)required
provider_typestringrequired
professional_registration_numberstring^\d{7}$required
provider_main_specialtystringrequired
titlestringrequired
first_namestringrequired
last_namestringrequired
live_diary_booking_availablebooleanrequired
availabilityArray of objectsrequired
availability[].​facility_locationstringrequired
availability[].​facility_crm_idstring(uuid)required
availability[].​facility_full_namestringrequired
availability[].​facility_addressstringrequired
availability[].​latitudestringrequired
availability[].​longitudestringrequired
availability[].​first_appointment_slot_date_timestring(date-time)required
Response
application/json
{
  "hca_consultant_id": "string",
  "crm_id": "a1cca198-42e1-4e72-a0e1-017dec9db0e1",
  "provider_type": "string",
  "professional_registration_number": "string",
  "provider_main_specialty": "string",
  "title": "string",
  "first_name": "string",
  "last_name": "string",
  "live_diary_booking_available": true,
  "availability": [
    { … }
  ]
}

Get HCA Consultant Availability

Request

Retrieves consultant availability from the HCA system.

Path
crm_idstring(uuid)required

UUID of the consultant

Query
location_idstring(uuid)required

UUID of the location

date_fromstring(date)required

Start date for availability search

date_tostring(date)required

End date for availability search

booking_typestringrequired

Type of appointment to be booked

Enum"initial""follow_on"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking-hca/consultants/{crm_id}/availability?booking_type=initial&date_from=2019-08-24&date_to=2019-08-24&location_id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
date_fromstring(date-time)required
date_tostring(date-time)required
slotsArray of objectsrequired
slots[].​start_timestring(date-time)required
slots[].​end_timestring(date-time)required
slots[].​is_blockedbooleanrequired
Response
application/json
{
  "date_from": "2019-08-24T14:15:22Z",
  "date_to": "2019-08-24T14:15:22Z",
  "slots": [
    { … }
  ]
}

Create HCA Diary Booking

Request

Creates a diary booking in the HCA system.

Bodyapplication/jsonrequired
consultant_gmc_numberstring^\d{7}$required
booking_typestringrequired
Enum"initial""follow_on"
facility_idstringrequired
date_fromstring(date-time)required
visit_reason_detailsobjectrequired
visit_reason_details.​selected_specialitystringrequired
visit_reason_details.​reason_for_appointmentstring<= 512 charactersrequired
demographicsobjectrequired
demographics.​booking_bystringrequired
Enum"patient""insurer""practitioner"
demographics.​paid_bystringrequired
Enum"self-pay""insurance"
demographics.​gp_referralbooleanrequired
demographics.​insurance_providerstring
demographics.​insurance_policy_numberstring
demographics.​insurance_authorisation_codestring
demographics.​previously_been_with_hcabooleanrequired
demographics.​patient_codestring
demographics.​titlestringrequired
demographics.​first_namestringrequired
demographics.​last_namestringrequired
demographics.​address_1stringrequired
demographics.​address_2string
demographics.​postcodestringrequired
demographics.​town_citystringrequired
demographics.​countrystringrequired
demographics.​genderstringrequired
Enum"Not known""Not specified""Male""Female""Other"
demographics.​date_of_birthstringrequired
demographics.​emailstring(email)required
demographics.​phonestringrequired
demographics.​marketing_preference_emailbooleanrequired
demographics.​marketing_preference_phonebooleanrequired
demographics.​marketing_preference_smsbooleanrequired
demographics.​marketing_preference_postbooleanrequired
demographics.​representative_titlestring
demographics.​representative_first_namestring
demographics.​representative_last_namestring
demographics.​representative_emailstring(email)
demographics.​representative_phonestring
demographics.​representative_relationstring
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking-hca/appointments \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "consultant_gmc_number": "string",
    "booking_type": "initial",
    "facility_id": "string",
    "date_from": "2019-08-24T14:15:22Z",
    "visit_reason_details": {
      "selected_speciality": "string",
      "reason_for_appointment": "string"
    },
    "demographics": {
      "booking_by": "patient",
      "paid_by": "self-pay",
      "gp_referral": true,
      "insurance_provider": "string",
      "insurance_policy_number": "string",
      "insurance_authorisation_code": "string",
      "previously_been_with_hca": true,
      "patient_code": "string",
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "address_1": "string",
      "address_2": "string",
      "postcode": "string",
      "town_city": "string",
      "country": "string",
      "gender": "Not known",
      "date_of_birth": "string",
      "email": "user@example.com",
      "phone": "string",
      "marketing_preference_email": true,
      "marketing_preference_phone": true,
      "marketing_preference_sms": true,
      "marketing_preference_post": true,
      "representative_title": "string",
      "representative_first_name": "string",
      "representative_last_name": "string",
      "representative_email": "user@example.com",
      "representative_phone": "string",
      "representative_relation": "string"
    }
  }'

Responses

Ok

Bodyapplication/json
date_fromstring(date-time)required
date_tostring(date-time)required
hca_reservation_idstring(uuid)required
booking_statusstringrequired
booking_messagestringrequired
Response
application/json
{
  "date_from": "2019-08-24T14:15:22Z",
  "date_to": "2019-08-24T14:15:22Z",
  "hca_reservation_id": "111e9f51-395d-4850-9e33-16fb9a7b74f0",
  "booking_status": "string",
  "booking_message": "string"
}

Care Navigation

Operations

Form

Operations

Form Response

Operations

Invoicing

Operations

Patients

Operations

Prescription

Operations

Task

Operations

Webhooks

Operations

Prescriptions

Operations