HTTP Requests

Use this header format when performing HTTP requests for GET operations.

curl --request GET \
     --url 'https://au-api.halaxy.com/main/Patient' \
     --header 'Accept: application/fhir+json' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: ••••••'

Use this header format when performing HTTP requests for POST operations

curl --request POST \
     --url 'https://au-api.halaxy.com/main/Patient' \
     --header 'Accept: application/fhir+json' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: ••••••'
     --data

Use this header format when performing HTTP requests for PATCH operations.

curl --request PATCH \
     --url 'https://au-api.halaxy.com/main/Patient' \
     --header 'Accept: application/fhir+json' \
     --header 'Content-Type: application/merge-patch+json' \
     --header 'Authorization: ••••••'
     --data

Base URLs

UK & EU countries must use the base URL: https://eu-api.halaxy.com/main/

All other countries must use the base URL: https://au-api.halaxy.com/main/

Security

Add the authorization header to include your API token.

Content Types

Halaxy API only supports application/fhir+json.

Symbols

Symbols used in property values may cause request errors. You may need to encode symbols in your requests.

Example: If you are querying an email address that includes a plus (+) symbol, use the character reference %2B in its place. Instead of [email protected], use patient%[email protected]