Skip to content
API Reference
/
/
Count Episodes

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

Count Episodes

Request

Retrieves a count of all episodes for a practice group.

Security
apiKeyAuth and practiceGroupId
Query
assignee_id[]Array of strings
assignee_type[]Array of strings
Items Enum"Admin""AdminTeam""Unassigned"
status[]Array of strings
Items Enum"open""closed""in_progress"
priority[]Array of strings
Items Enum"lowest""low""medium""high""highest"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/episodes/count?assignee_id%5B%5D=string&assignee_type%5B%5D=Admin&status%5B%5D=open&priority%5B%5D=lowest' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
countnumberrequired
Response
application/json
{
  "count": 0
}

List Episodes

Request

Retrieves a list of all episodes for a practice group.

Security
apiKeyAuth and practiceGroupId
Query
page_indexinteger
page_sizeinteger
assignee_id[]Array of strings
assignee_type[]Array of strings
Items Enum"Admin""AdminTeam""Unassigned"
status[]Array of strings
Items Enum"open""closed""in_progress"
priority[]Array of strings
Items Enum"lowest""low""medium""high""highest"
order_by[]Array of strings
Items Enum"created_at""priority"
order_descending[]Array of strings
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/episodes?page_index=0&page_size=0&assignee_id%5B%5D=string&assignee_type%5B%5D=Admin&status%5B%5D=open&priority%5B%5D=lowest&order_by%5B%5D=created_at&order_descending%5B%5D=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
countnumberrequired
dataArray of objectsrequired
data[].​idstring^\d+$required
data[].​statusstringrequired
Enum"open""closed""in_progress"
data[].​prioritystringrequired
Enum"lowest""low""medium""high""highest"
data[].​assigneesArray of objects
Default []
data[].​tasksArray of objects
Default []
data[].​patientobject or nullrequired
data[].​patient.​idstring or null^\d+$
data[].​patient.​uidstring or null
data[].​patient.​titlestring or null
data[].​patient.​first_namestring or null
data[].​patient.​last_namestring or null
data[].​categorystring or nullrequired
data[].​labelstring or nullrequired
data[].​descriptionstring or nullrequired
data[].​created_atstringrequired
data[].​updated_atstringrequired
Response
application/json
{
  "count": 0,
  "data": [
    { … }
  ]
}

Get Episode

Request

Retrieve episode information for the given ID.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/episodes/{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
statusstringrequired
Enum"open""closed""in_progress"
prioritystringrequired
Enum"lowest""low""medium""high""highest"
assigneesArray of objects
Default []
tasksArray of objects
Default []
patientobject or nullrequired
patient.​ehr_partner_idstring or null
patient.​emis_idstring or null
patient.​deceased_atstring or null(date-time)
patient.​dobstring or null(date-time)required
patient.​titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
patient.​first_namestring or null
patient.​last_namestring or null
patient.​sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
patient.​nhs_numberstring or null
patient.​emailstring or null
patient.​mobilestring or null
patient.​last_sync_atstring or null(date-time)
patient.​data_sourcestring or null
Enum"hero""emis""pds""gha""systm_one"
patient.​restrictedboolean
Default false
patient.​line_1string or null
patient.​line_2string or null
patient.​line_3string or null
patient.​townstring or null
patient.​countystring or null
patient.​postcodestring or null
patient.​hero_idstring or null^\d+$
patient.​hero_uidstring or null
patient.​identifiersArray of objectsrequired
patient.​identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
patient.​identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
patient.​identifiers[].​rolestringrequired
Enum"main""secondary"
patient.​identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
patient.​identifiers[].​valuestringrequired
patient.​ehr_registeredboolean or nullrequired
categorystring or nullrequired
labelstring or nullrequired
descriptionstring or nullrequired
created_atstringrequired
updated_atstringrequired
Response
application/json
{
  "id": "string",
  "status": "open",
  "priority": "lowest",
  "assignees": [],
  "tasks": [],
  "patient": {
    "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
  },
  "category": "string",
  "label": "string",
  "description": "string",
  "created_at": "string",
  "updated_at": "string"
}

Update an episode

Request

Updates an episode using the provided parameters.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
statusstring
Enum"open""closed""in_progress"
prioritystring
Enum"lowest""low""medium""high""highest"
assigneesArray of objects
curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/episodes/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "status": "open",
    "priority": "lowest",
    "assignees": [
      {
        "type": "Admin",
        "id": "string",
        "name": "string"
      }
    ]
  }'

Responses

Ok

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

Form

Operations

Form Response

Operations

Invoicing

Operations

Partner

Operations

Partners

Operations

Patients

Operations

Prescription

Operations

Subscriptions

Operations

Task

Operations

Webhooks

Operations

Prescriptions

Operations