Skip to content
API Reference
/
/
Preview Patient Merging

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

ApiKey

Operations

Booking

Operations

Utilities

Operations

Messages

Operations

Booking - HCA

Operations

Care Navigation

Operations

Consultations

Operations

Episode

Operations

Form

Operations

Form Response

Operations

Invoicing

Operations

Partner

Operations

Partners

Operations

Patients

Operations

List Candidates for the Patient on EHR

Request

Retrieve a list of candidates that can be matched against the patient on EHR

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}/ehr/candidates' \
  -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[].​ehr_partner_idstring or null
data[].​emis_idstring or null
data[].​deceased_atstring or null(date-time)
data[].​dobstring or null(date-time)required
data[].​titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
data[].​first_namestring or null
data[].​last_namestring or null
data[].​sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
data[].​nhs_numberstring or null
data[].​emailstring or null
data[].​mobilestring or null
data[].​last_sync_atstring or null(date-time)
data[].​data_sourcestring or null
Enum"hero""emis""pds""gha""systm_one"
data[].​restrictedboolean
Default false
data[].​line_1string or null
data[].​line_2string or null
data[].​line_3string or null
data[].​townstring or null
data[].​countystring or null
data[].​postcodestring or null
data[].​hero_idstring or null^\d+$
data[].​hero_uidstring or null
data[].​identifiersArray of objectsrequired
data[].​identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
data[].​identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
data[].​identifiers[].​rolestringrequired
Enum"main""secondary"
data[].​identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
data[].​identifiers[].​valuestringrequired
data[].​ehr_registeredboolean or nullrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Connect a Patient to EHR

Request

Connect a patient to an EHR patient

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
ehr_partner_idstringrequired
curl -i -X POST \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}/ehr/connect' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "ehr_partner_id": "string"
  }'

Responses

Ok

Response
No content

Preview Patient Merging

Request

Return a preview of a merge between two patients hand provide a merge token

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
patient_idstring^\d+$required
curl -i -X POST \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}/merge/preview' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "patient_id": "string"
  }'

Responses

Ok

Bodyapplication/json
main_patientobjectrequired
main_patient.​idstring^\d+$required
main_patient.​uidstring or null
main_patient.​emis_idstring or null
main_patient.​ehr_partner_idstring or null
main_patient.​dobstring or null(date-time)required
main_patient.​deceased_atstring or null(date-time)
main_patient.​titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
main_patient.​first_namestring or null
main_patient.​last_namestring or null
main_patient.​sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
main_patient.​nhs_numberstring or null
main_patient.​emailstring or null
main_patient.​emailsArray of strings or null
main_patient.​mobilestring or null
main_patient.​last_sync_atstring or null(date-time)
main_patient.​address_line_1string or null
main_patient.​address_line_2string or null
main_patient.​address_line_3string or null
main_patient.​countrystring or null
main_patient.​postcodestring or null
main_patient.​townstring or null
main_patient.​countystring or null
main_patient.​notesstring or null
main_patient.​verification_credentialsArray of strings or null
main_patient.​data_sourcestringrequired
Enum"hero""emis""pds""gha""systm_one"
main_patient.​restrictedboolean
Default false
main_patient.​sex_changed_atstring or null(date-time)
main_patient.​statusstringrequired
Enum"archived""unarchived"
main_patient.​identifiersArray of objectsrequired
main_patient.​identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
main_patient.​identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
main_patient.​identifiers[].​rolestringrequired
Enum"main""secondary"
main_patient.​identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
main_patient.​identifiers[].​valuestringrequired
main_patient.​ehr_registeredboolean or nullrequired
incoming_patientobjectrequired
incoming_patient.​idstring^\d+$required
incoming_patient.​uidstring or null
incoming_patient.​emis_idstring or null
incoming_patient.​ehr_partner_idstring or null
incoming_patient.​dobstring or null(date-time)required
incoming_patient.​deceased_atstring or null(date-time)
incoming_patient.​titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
incoming_patient.​first_namestring or null
incoming_patient.​last_namestring or null
incoming_patient.​sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
incoming_patient.​nhs_numberstring or null
incoming_patient.​emailstring or null
incoming_patient.​emailsArray of strings or null
incoming_patient.​mobilestring or null
incoming_patient.​last_sync_atstring or null(date-time)
incoming_patient.​address_line_1string or null
incoming_patient.​address_line_2string or null
incoming_patient.​address_line_3string or null
incoming_patient.​countrystring or null
incoming_patient.​postcodestring or null
incoming_patient.​townstring or null
incoming_patient.​countystring or null
incoming_patient.​notesstring or null
incoming_patient.​verification_credentialsArray of strings or null
incoming_patient.​data_sourcestringrequired
Enum"hero""emis""pds""gha""systm_one"
incoming_patient.​restrictedboolean
Default false
incoming_patient.​sex_changed_atstring or null(date-time)
incoming_patient.​statusstringrequired
Enum"archived""unarchived"
incoming_patient.​identifiersArray of objectsrequired
incoming_patient.​identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
incoming_patient.​identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
incoming_patient.​identifiers[].​rolestringrequired
Enum"main""secondary"
incoming_patient.​identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
incoming_patient.​identifiers[].​valuestringrequired
incoming_patient.​ehr_registeredboolean or nullrequired
result_patientobjectrequired
result_patient.​idstring^\d+$required
result_patient.​uidstring or null
result_patient.​emis_idstring or null
result_patient.​ehr_partner_idstring or null
result_patient.​dobstring or null(date-time)required
result_patient.​deceased_atstring or null(date-time)
result_patient.​titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
result_patient.​first_namestring or null
result_patient.​last_namestring or null
result_patient.​sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
result_patient.​nhs_numberstring or null
result_patient.​emailstring or null
result_patient.​emailsArray of strings or null
result_patient.​mobilestring or null
result_patient.​last_sync_atstring or null(date-time)
result_patient.​address_line_1string or null
result_patient.​address_line_2string or null
result_patient.​address_line_3string or null
result_patient.​countrystring or null
result_patient.​postcodestring or null
result_patient.​townstring or null
result_patient.​countystring or null
result_patient.​notesstring or null
result_patient.​verification_credentialsArray of strings or null
result_patient.​data_sourcestringrequired
Enum"hero""emis""pds""gha""systm_one"
result_patient.​restrictedboolean
Default false
result_patient.​sex_changed_atstring or null(date-time)
result_patient.​statusstringrequired
Enum"archived""unarchived"
result_patient.​identifiersArray of objectsrequired
result_patient.​identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
result_patient.​identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
result_patient.​identifiers[].​rolestringrequired
Enum"main""secondary"
result_patient.​identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
result_patient.​identifiers[].​valuestringrequired
result_patient.​ehr_registeredboolean or nullrequired
merge_tokenstringrequired
Response
application/json
{
  "main_patient": {
    "id": "string",
    "uid": "string",
    "emis_id": "string",
    "ehr_partner_id": "string",
    "dob": "2019-08-24T14:15:22Z",
    "deceased_at": "2019-08-24T14:15:22Z",
    "title": "Baron",
    "first_name": "string",
    "last_name": "string",
    "sex": "Not known",
    "nhs_number": "string",
    "email": "string",
    "emails": [ … ],
    "mobile": "string",
    "last_sync_at": "2019-08-24T14:15:22Z",
    "address_line_1": "string",
    "address_line_2": "string",
    "address_line_3": "string",
    "country": "string",
    "postcode": "string",
    "town": "string",
    "county": "string",
    "notes": "string",
    "verification_credentials": [ … ],
    "data_source": "hero",
    "restricted": false,
    "sex_changed_at": "2019-08-24T14:15:22Z",
    "status": "archived",
    "identifiers": [ … ],
    "ehr_registered": true
  },
  "incoming_patient": {
    "id": "string",
    "uid": "string",
    "emis_id": "string",
    "ehr_partner_id": "string",
    "dob": "2019-08-24T14:15:22Z",
    "deceased_at": "2019-08-24T14:15:22Z",
    "title": "Baron",
    "first_name": "string",
    "last_name": "string",
    "sex": "Not known",
    "nhs_number": "string",
    "email": "string",
    "emails": [ … ],
    "mobile": "string",
    "last_sync_at": "2019-08-24T14:15:22Z",
    "address_line_1": "string",
    "address_line_2": "string",
    "address_line_3": "string",
    "country": "string",
    "postcode": "string",
    "town": "string",
    "county": "string",
    "notes": "string",
    "verification_credentials": [ … ],
    "data_source": "hero",
    "restricted": false,
    "sex_changed_at": "2019-08-24T14:15:22Z",
    "status": "archived",
    "identifiers": [ … ],
    "ehr_registered": true
  },
  "result_patient": {
    "id": "string",
    "uid": "string",
    "emis_id": "string",
    "ehr_partner_id": "string",
    "dob": "2019-08-24T14:15:22Z",
    "deceased_at": "2019-08-24T14:15:22Z",
    "title": "Baron",
    "first_name": "string",
    "last_name": "string",
    "sex": "Not known",
    "nhs_number": "string",
    "email": "string",
    "emails": [ … ],
    "mobile": "string",
    "last_sync_at": "2019-08-24T14:15:22Z",
    "address_line_1": "string",
    "address_line_2": "string",
    "address_line_3": "string",
    "country": "string",
    "postcode": "string",
    "town": "string",
    "county": "string",
    "notes": "string",
    "verification_credentials": [ … ],
    "data_source": "hero",
    "restricted": false,
    "sex_changed_at": "2019-08-24T14:15:22Z",
    "status": "archived",
    "identifiers": [ … ],
    "ehr_registered": true
  },
  "merge_token": "string"
}

Merge Patients

Request

Merge one patient with another

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
merge_tokenstringrequired
patient_idstring^\d+$required
curl -i -X POST \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}/merge' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "merge_token": "string",
    "patient_id": "string"
  }'

Responses

Ok

Response
No content

Get a Patient

Request

Retrieve patient information.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
uidstring or null
emis_idstring or null
ehr_partner_idstring or null
dobstring or null(date-time)required
deceased_atstring or null(date-time)
titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
first_namestring or null
last_namestring or null
sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
nhs_numberstring or null
emailstring or null
emailsArray of strings or null
mobilestring or null
last_sync_atstring or null(date-time)
address_line_1string or null
address_line_2string or null
address_line_3string or null
countrystring or null
postcodestring or null
townstring or null
countystring or null
notesstring or null
verification_credentialsArray of strings or null
data_sourcestringrequired
Enum"hero""emis""pds""gha""systm_one"
restrictedboolean
Default false
sex_changed_atstring or null(date-time)
statusstringrequired
Enum"archived""unarchived"
identifiersArray of objectsrequired
identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
identifiers[].​rolestringrequired
Enum"main""secondary"
identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
identifiers[].​valuestringrequired
ehr_registeredboolean or nullrequired
Response
application/json
{
  "id": "string",
  "uid": "string",
  "emis_id": "string",
  "ehr_partner_id": "string",
  "dob": "2019-08-24T14:15:22Z",
  "deceased_at": "2019-08-24T14:15:22Z",
  "title": "Baron",
  "first_name": "string",
  "last_name": "string",
  "sex": "Not known",
  "nhs_number": "string",
  "email": "string",
  "emails": [
    "string"
  ],
  "mobile": "string",
  "last_sync_at": "2019-08-24T14:15:22Z",
  "address_line_1": "string",
  "address_line_2": "string",
  "address_line_3": "string",
  "country": "string",
  "postcode": "string",
  "town": "string",
  "county": "string",
  "notes": "string",
  "verification_credentials": [
    "string"
  ],
  "data_source": "hero",
  "restricted": false,
  "sex_changed_at": "2019-08-24T14:15:22Z",
  "status": "archived",
  "identifiers": [
    { … }
  ],
  "ehr_registered": true
}

List Patient EHR Attachments

Request

Retrieves a list of attachments for the patient.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}/attachments' \
  -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[].​ehr_partner_file_idstringrequired
data[].​file_namestringrequired
data[].​file_extensionstringrequired
data[].​created_atstring or null(date-time)required
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

List Patients

Request

Retrieves a list of all patients.

Security
apiKeyAuth and practiceGroupId
Query
fieldstring
Enum"emis_id""nhs_number""dob"
searchstring
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients?field=emis_id&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[].​idstring^\d+$required
data[].​uidstring or null
data[].​emis_idstring or null
data[].​ehr_partner_idstring or null
data[].​dobstring or null(date-time)required
data[].​deceased_atstring or null(date-time)
data[].​titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
data[].​first_namestring or null
data[].​last_namestring or null
data[].​sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
data[].​nhs_numberstring or null
data[].​emailstring or null
data[].​emailsArray of strings or null
data[].​mobilestring or null
data[].​last_sync_atstring or null(date-time)
data[].​address_line_1string or null
data[].​address_line_2string or null
data[].​address_line_3string or null
data[].​countrystring or null
data[].​postcodestring or null
data[].​townstring or null
data[].​countystring or null
data[].​notesstring or null
data[].​verification_credentialsArray of strings or null
data[].​data_sourcestringrequired
Enum"hero""emis""pds""gha""systm_one"
data[].​restrictedboolean
Default false
data[].​sex_changed_atstring or null(date-time)
data[].​statusstringrequired
Enum"archived""unarchived"
data[].​identifiersArray of objectsrequired
data[].​identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
data[].​identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
data[].​identifiers[].​rolestringrequired
Enum"main""secondary"
data[].​identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
data[].​identifiers[].​valuestringrequired
data[].​ehr_registeredboolean or nullrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Register a Patient using PDS

Request

Sends minimal patient information to Hero to allow us to trace a patient against the Spine and return their Hero patient_id.If not existing in Hero, the patient record will also be created for that practice group as part of this request.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
One of:
nhs_numberstringrequired

A valid NHS number

dobstring or null(date-time)required

ISO 8601 date format

Example: "1989-04-11"
ehr_partnerstringnon-empty
ehr_partner_idstringnon-empty
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/register_pds \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "dob": "1989-04-11",
    "postcode": "string",
    "forename": "string",
    "surname": "string",
    "ehr_partner": "string",
    "ehr_partner_id": "string"
  }'

Responses

Ok

Bodyapplication/json
One of:
patient_idstring^\d+$required
Response
application/json
{
  "message": "string",
  "login_url": "string"
}

Register a Patient

Request

Create or update a patient based on the data sent. If a patient with matching NHS number and DOB exists for the practice group, it will be updated. Otherwise, a new patient record is created.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
One of:
ehr_partner_idstring
nhs_numberstring
dobstringnon-emptyrequired
first_namestringnon-emptyrequired
last_namestringnon-emptyrequired
sexstring
Enum"Not known""Not specified""Male""Female""Other"
titlestring
One of:
string
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
landlinestring
address_line_1string
address_line_2string
address_line_3string
countrystring
postcodestring
townstring
countystring
data_sourcestring
Default "emis"
Enum"hero""emis""pds""gha""systm_one"
callerstringnon-empty

[Internal use only] The name of the application calling the register endpoint

mobilestringnon-emptyrequired
emailstring
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/register \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "ehr_partner_id": "string",
    "nhs_number": "string",
    "dob": "string",
    "first_name": "string",
    "last_name": "string",
    "sex": "Not known",
    "title": "Baron",
    "landline": "string",
    "address_line_1": "string",
    "address_line_2": "string",
    "address_line_3": "string",
    "country": "string",
    "postcode": "string",
    "town": "string",
    "county": "string",
    "data_source": "hero",
    "caller": "string",
    "mobile": "string",
    "email": "string"
  }'

Responses

Ok

Bodyapplication/json
patient_idstring^\d+$required
Response
application/json
{
  "patient_id": "string"
}

Get Patient Billing Info

Request

Retrieves billing information for the patient.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}/billing_info' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
external_billing_idstringrequired
insuranceobjectrequired
insurance.​insurerstring or nullrequired
insurance.​membership_numberstring or nullrequired
insurance.​auth_codestring or nullrequired
billing_notestring or nullrequired
confidentialboolean or nullrequired
Response
application/json
{
  "id": "string",
  "external_billing_id": "string",
  "insurance": {
    "insurer": "string",
    "membership_number": "string",
    "auth_code": "string"
  },
  "billing_note": "string",
  "confidential": true
}

List Patient Payment Methods

Request

Retrieves payment methods for default stripe customer of patient.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}/payment_methods' \
  -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[].​idstringrequired
data[].​typestringrequired
data[].​brandstringrequired
data[].​last4stringrequired
data[].​checksobject
data[].​walletstring or null
data[].​countrystring or nullrequired
data[].​fundingstring or nullrequired
data[].​exp_yearnumber or nullrequired
data[].​networksobject
data[].​exp_monthnumber or nullrequired
data[].​display_brandstring or null
data[].​generated_fromstring or null
data[].​fingerprintstring or nullrequired
data[].​regulated_statusstring or nullrequired
data[].​three_d_secure_usageobject
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Get a Patient

Request

Retrieve patient information.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Query
data_sourcestring
Enum"hero""ehr"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/patients/{id}?data_source=hero' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
ehr_partner_idstring or null
emis_idstring or null
deceased_atstring or null(date-time)
dobstring or null(date-time)required
titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
first_namestring or null
last_namestring or null
sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
nhs_numberstring or null
emailstring or null
mobilestring or null
last_sync_atstring or null(date-time)
data_sourcestring or null
Enum"hero""emis""pds""gha""systm_one"
restrictedboolean
Default false
line_1string or null
line_2string or null
line_3string or null
townstring or null
countystring or null
postcodestring or null
hero_idstring or null^\d+$
hero_uidstring or null
identifiersArray of objectsrequired
identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
identifiers[].​rolestringrequired
Enum"main""secondary"
identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
identifiers[].​valuestringrequired
ehr_registeredboolean or nullrequired
Response
application/json
{
  "ehr_partner_id": "string",
  "emis_id": "string",
  "deceased_at": "2019-08-24T14:15:22Z",
  "dob": "2019-08-24T14:15:22Z",
  "title": "Baron",
  "first_name": "string",
  "last_name": "string",
  "sex": "Not known",
  "nhs_number": "string",
  "email": "string",
  "mobile": "string",
  "last_sync_at": "2019-08-24T14:15:22Z",
  "data_source": "hero",
  "restricted": false,
  "line_1": "string",
  "line_2": "string",
  "line_3": "string",
  "town": "string",
  "county": "string",
  "postcode": "string",
  "hero_id": "string",
  "hero_uid": "string",
  "identifiers": [
    { … }
  ],
  "ehr_registered": true
}

List Patients (v2)

Request

Retrieves a list of all patients, from either the EHR or HERO.

Security
apiKeyAuth and practiceGroupId
Query
fieldstring
searchstring
dataSourcestring
Enum"hero""ehr"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/patients?field=string&search=string&dataSource=hero' \
  -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[].​ehr_partner_idstring or null
data[].​emis_idstring or null
data[].​deceased_atstring or null(date-time)
data[].​dobstring or null(date-time)required
data[].​titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
data[].​first_namestring or null
data[].​last_namestring or null
data[].​sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
data[].​nhs_numberstring or null
data[].​emailstring or null
data[].​mobilestring or null
data[].​last_sync_atstring or null(date-time)
data[].​data_sourcestring or null
Enum"hero""emis""pds""gha""systm_one"
data[].​restrictedboolean
Default false
data[].​line_1string or null
data[].​line_2string or null
data[].​line_3string or null
data[].​townstring or null
data[].​countystring or null
data[].​postcodestring or null
data[].​hero_idstring or null^\d+$
data[].​hero_uidstring or null
data[].​identifiersArray of objectsrequired
data[].​identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
data[].​identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
data[].​identifiers[].​rolestringrequired
Enum"main""secondary"
data[].​identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
data[].​identifiers[].​valuestringrequired
data[].​ehr_registeredboolean or nullrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Prescription

Operations

Subscriptions

Operations

Task

Operations

Webhooks

Operations

Prescriptions

Operations