API Reference
/
Medical Record

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

Care Navigation

Operations

Medical Record

Operations

Get a Consultation

Request

Retrieve a consultation by its ID.

Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/consultations/{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
occurred_atstring or null(date-time)required
statusstringrequired
Enum"draft""final"
transcriptstring or null
elementsArray of objectsrequired
elements[].​idstring^\d+$required
elements[].​typestringrequired
Enum"problem""observation""code""note""attachment"
elements[].​namestring
elements[].​codestring
elements[].​code_systemstring
elements[].​termstring
elements[].​valuenumber
elements[].​value_textstring
elements[].​unitstring
elements[].​textstring
Response
application/json
{
  "id": "string",
  "occurred_at": "2019-08-24T14:15:22Z",
  "status": "draft",
  "transcript": "string",
  "elements": [
    { … }
  ]
}

Update a Consultation

Request

Update an existing consultation and its elements.

Path
idstringrequired
Bodyapplication/jsonrequired
occurred_atstring or null(date-time)

ISO 8601 date format

Example: "1989-04-11"
transcriptstring or null
transcript_saved_atstring or null(date-time)

ISO 8601 date format

Example: "1989-04-11"
elementsArray of any
curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/consultations/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "occurred_at": "1989-04-11",
    "transcript": "string",
    "transcript_saved_at": "1989-04-11",
    "elements": [
      {
        "id": "string",
        "type": "note",
        "name": "string",
        "code": "string",
        "code_system": "string",
        "term": "string",
        "value": 0,
        "value_text": "string",
        "unit": "string",
        "text": "string",
        "_destroy": true
      }
    ]
  }'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
occurred_atstring or null(date-time)required
statusstringrequired
Enum"draft""final"
transcriptstring or null
elementsArray of objectsrequired
elements[].​idstring^\d+$required
elements[].​typestringrequired
Enum"problem""observation""code""note""attachment"
elements[].​namestring
elements[].​codestring
elements[].​code_systemstring
elements[].​termstring
elements[].​valuenumber
elements[].​value_textstring
elements[].​unitstring
elements[].​textstring
Response
application/json
{
  "id": "string",
  "occurred_at": "2019-08-24T14:15:22Z",
  "status": "draft",
  "transcript": "string",
  "elements": [
    { … }
  ]
}

Delete a Consultation

Request

Deletes a consultation.

Path
idstringrequired
curl -i -X DELETE \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/consultations/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

No Content

Response
No content

List Consultations for a Patient

Request

Retrieves consultations for the provided patient.

Query
patient_idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/consultations?patient_id=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[].​occurred_atstring or null(date-time)required
data[].​statusstringrequired
Enum"draft""final"
data[].​transcriptstring or null
data[].​elementsArray of objectsrequired
data[].​elements[].​idstring^\d+$required
data[].​elements[].​typestringrequired
Enum"problem""observation""code""note""attachment"
data[].​elements[].​namestring
data[].​elements[].​codestring
data[].​elements[].​code_systemstring
data[].​elements[].​termstring
data[].​elements[].​valuenumber
data[].​elements[].​value_textstring
data[].​elements[].​unitstring
data[].​elements[].​textstring
Response
application/json
{
  "data": [
    { … }
  ]
}

Create a Consultation

Request

Create a new consultation for a patient, including optional elements (notes, codes, observations, attachments).

Bodyapplication/jsonrequired
patient_idstring^\d+$required
occurred_atstring or null(date-time)required

ISO 8601 date format

Example: "1989-04-11"
transcriptstring or null
transcript_saved_atstring or null(date-time)

ISO 8601 date format

Example: "1989-04-11"
admin_idstring^\d+$
elementsArray of any
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/consultations \
  -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",
    "occurred_at": "1989-04-11",
    "transcript": "string",
    "transcript_saved_at": "1989-04-11",
    "admin_id": "string",
    "elements": [
      {
        "id": "string",
        "type": "note",
        "name": "string",
        "code": "string",
        "code_system": "string",
        "term": "string",
        "value": 0,
        "value_text": "string",
        "unit": "string",
        "text": "string",
        "_destroy": true
      }
    ]
  }'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
occurred_atstring or null(date-time)required
statusstringrequired
Enum"draft""final"
transcriptstring or null
elementsArray of objectsrequired
elements[].​idstring^\d+$required
elements[].​typestringrequired
Enum"problem""observation""code""note""attachment"
elements[].​namestring
elements[].​codestring
elements[].​code_systemstring
elements[].​termstring
elements[].​valuenumber
elements[].​value_textstring
elements[].​unitstring
elements[].​textstring
Response
application/json
{
  "id": "string",
  "occurred_at": "2019-08-24T14:15:22Z",
  "status": "draft",
  "transcript": "string",
  "elements": [
    { … }
  ]
}

Finalise a Consultation

Request

Transition a consultation to final status.

Path
idstringrequired
curl -i -X POST \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/consultations/{id}/finalise' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
occurred_atstring or null(date-time)required
statusstringrequired
Enum"draft""final"
transcriptstring or null
elementsArray of objectsrequired
elements[].​idstring^\d+$required
elements[].​typestringrequired
Enum"problem""observation""code""note""attachment"
elements[].​namestring
elements[].​codestring
elements[].​code_systemstring
elements[].​termstring
elements[].​valuenumber
elements[].​value_textstring
elements[].​unitstring
elements[].​textstring
Response
application/json
{
  "id": "string",
  "occurred_at": "2019-08-24T14:15:22Z",
  "status": "draft",
  "transcript": "string",
  "elements": [
    { … }
  ]
}

Episode

Operations

Form

Operations

Form Response

Operations

Invoicing

Operations

Partners

Operations

Patients

Operations

Prescription

Operations

Subscriptions

Operations

Task

Operations

Webhooks

Operations

Prescriptions

Operations