API Reference
Start typing to search…

Patient

The Patient resource represents individuals who receive care or services within the Halaxy system

This resource allows the retrieval of patient records, ensuring that healthcare providers can access and manage patient data efficiently. Key attributes include personal details, contact details and demographic information.

For more information on managing patients in Halaxy, see our Help Guide.


Endpoints

EndpointOperationDescription
GET /main/PatientList PatientsReturn a list or collection of patients
GET /main/Patient/{id}Get PatientReturn an individual patient record
POST /main/PatientCreate PatientCreate a patient record
PATCH /main/Patient/{id}Update PatientUpdate specific fields in a patient record
PUT /main/Patient/{id}Replace PatientReplaces all data in a patient record
GET /main/Patient/$export-idsExport Patient IDsExport a list of patient references that the user is allowed to access

Schema

Property

Description

id

string
The patient ID in the practice group

active

boolean
Indicates whether this patient profile is active - this depends on the patient status.

The following patient statuses are considered active: Current Claimant Contact

name

array of objects
The name of the patient

use
The type of name
official - legal name registered in government
usual - preferred name

given
Given name (may include middle name)

family
Surname

prefix
Title before the patient's name - e.g. Mr, Mrs, Ms, Dr

telecom

array of objects
The patient's contact number/s or email address/es

system
Type of contact detail
sms | phone | fax | email

value
The actual phone number or email address
e.g. +61412345678 [email protected]

use
Purpose of the contact detail
home | work | mobile

Note: Phone number format must follow+{country code}{phone number without spaces}

gender

string
male | female | other | custom gender

Note: Legal Sex populates this field if it is enabled.

See article: Manage gender diversity settings

birthDate

date
The date of birth of the patient
Format: YYYY-MM-DD

deceasedBoolean

boolean
Indicates if the patient is deceased - based on patient status

address

array of objects
The patient's address/es

use string
The purpose of this address
home work billing mailing

type string
Distinguishes between a physical address and mailing address
postal physical both

line array of strings
Contains the house number, apartment number, P.O. box number, street name.

city string

state string

postalCode string

country string min 2 characters
The ISO 3166 two-letter code - e.g. AU CA

contact

array of objects
A contact person for the patient (e.g. emergency contact)

name
The name of the contact person

telecom
The contact details of the contact person

relationship
The relationship property for each contact person must include these two properties with coding systems: contact relationship and contact type

"relationship": [
        {
          "coding": [
            {
              "system": "https://terminology.halaxy.com/CodeSystem/contact-relationship",
              "display": "Mother"
            }
          ]
        },
        {
          "coding": [
            {
              "system": "https://terminology.halaxy.com/CodeSystem/contact-type",
              "display": "Emergency"
            }
          ]
        }
      ],

Note: The contact relationship and contact type must already exist in your Halaxy account (including custom contact relationships). The Halaxy API does not support creating new contact relationship or contact type options.

generalPractitioner

array of objects
Practitioners and/or locations that the patient has linked records with

"generalPractitioner": [
    {
      "reference": "https://au-api.halaxy.com/main/Organization/CL-770121",
      "type": "Organization"
    },
    {
      "reference": "https://au-api.halaxy.com/main/Practitioner/PR-1014021",
      "type": "Practitioner"
    }
]

See resources: Organization, Practitioner

managingOrganization

Reference(Organization)
The practice group ID

"reference": "https://au-api.halaxy.com/main/Organization/PG-12345"
"type": "Organization"

See resource: Organization

patient-status

HALAXY API EXTENSION
The status of the patient record

"url": "https://terminology.halaxy.com/StructureDefinition/patient-status"
"valueString": "current"

See article: Set a patient status

patient-created

HALAXY API EXTENSION
The date the patient record was created

"url": "https://terminology.halaxy.com/StructureDefinition/patient-created"
"valueDateTime": "2022-03-23T10:00:00+10:00"

profile-type

HALAXY API EXTENSION
The profile type of this patient record - full dependant contact only

"url": "https://terminology.halaxy.com/StructureDefinition/profile-type"
"valueString": "full"

See article: Set patient profile types for your practice

attachments

array of objects - POST and PUT only>
File attachments to the patient profile

contentType enum required The format of the file attachment
Supported formats:
application/msword
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.wordprocessingml.document
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/pdf
image/jpeg
image/png

data required File must be encoded to base64
Maximum file size: 200MB

title string required
The file name