Step by step guide

This guide covers the different options available to you for integrating messaging through the Hero API.

1. Retrieve your patient

In all cases, a patient context is required.

To generate your Hero patient ID, you will need to run our RegisterPatient call. This accepts NHS number and DOB inputs, runs a lookup against PDS then checks the underlying health record for your practice. If not found, Hero will attempt to register a temporary patient using the details retrieved from the Spine.

curl -i -X POST \
  https://api.staging.htech.app/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 '{
    "nhs_number": "123 456 7891",
    "dob": "1992-01-01"
  }'

{
  "patient_id": "string"
}

The Hero patient ID returned in the response can then be passed to the SendMessage call.

2. Send message

curl -i -X POST \
  https://api.staging.htech.app/v1/messages/send \
  -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": "1",
    "message_type": "sms",
    "message_string": "Sample text message",
    "recipient_contact_detail": "07788 123456",
    "write_to_record": true,
    "snomed_code": "123456789"
  }'

{
  "message_id": "string",
  "content": "string",
  "created_at": "string",
  "snomed_code": "string",
  "write_to_record": true,
  "auth_token": "string",
  "confirm_write_to_record_url": "string",
  "submitted_by": "string",
  "send_at": "2019-08-24T14:15:22Z"
}