Sparked Testing Event - June 24, 2025

Our main docs for our FHIR API for Bp Premier can be found here. This is an overview page for the June Testing Event, to give participants a simpler starting point. Please reach out to Millie or Marika if you have any questions on the day, or contact support any time to talk to the team.

Connection details

Halo Cloud does not use SMART auth (yet). Auth is via the request header Ocp-Apim-Subscription-Key. You will also need to include the correct Halo GUID in the request URI in order to hit our test instance.

Halo GUID: 63255e8a-d04a-42a6-8c75-90aa880ad94e
Integrator subscription key: e6e14396de3a4bdd8af57a53c3696773

The base URL for the test instance for this event is:

https://api.stage.haloconnect.io/integrator/sites/63255e8a-d04a-42a6-8c75-90aa880ad94e/fhir/R4/

Note: These credentials will only be active for the event. They will be deleted after.

Capabilities

A Capability Statement is available via the FHIR API. However, we are using a pre-QA test environment for this event to give participants access to live and upcoming features, and the Capability Statement may not yet include the latter. Hence the following summary.

Resources

Note: If no profile is specified, the resource is based on the international FHIR specification.

Resource	Profile	Interactions	Operations	Testing Notes
Patient	AU Base	R/S/U/C	$summary	_revinclude for Condition:patient also supported, but not listed on CapabilityStatement. Create and Update not supported for some fields for business reasons. Please check with us to clarify any unexpected behaviours. Details of $summary operation below.
Practitioner	AU Base	R/S	-
PractitionerRole	Au Base	R/S	-
Organization	AU Base	R/S	-
Location	AU Base	R/S	-
AllergyIntolerance	AU Core	R/S	-
Immunization	AU Core	R/S	-
MedicationStatement	AU Core	R/S	-	Will include 1-2 contained MedicationRequest resources.
MedicationRequest	AU Core	-	-	Supported only as resources contained within MedicationStatement.
Medication	AU Core	R/S	-
Condition	AU Core	R/S	-	Not in CapabilityStatement. Supported search parameters are: _id, _lastUpdated
Appointment		R/S/C	$waitlist	$waitlist enables Waitlist Appointments to be created. Details of $waitlist operation below. Further Appointment write functionality is in progress.
Slot		-	$find-free	$find-free operation will return a bundle containing Slots that can be used to book appointments.
Schedule		-	-	Relevant Schedules are included in bundle returned by $find-free operation.
DocumentReference		R/S	-
Communication		R/S	-
Binary		R/S	-
ValueSet		R	-	non-exhaustive
CodeSystem		R	-	non-exhaustive

Patient summary

The FHIR API supports Patient Summaries, based on the IPS for now, which can return a Patient plus their Conditions, MedicationStatements, Immunizations, and AllergyIntolerances (and other related resources).

$summary is not yet in the CapabilityStatement, and is only supported by invoking at the type not the instance by using the identifier parameter. e.g.

GET {BASE}/Patient/$summary?identifier={identifier}

The format GET {BASE}/Patient/{id}/$summary is not supported.

POST is also supported.

Adding Waitlist Appointments

Creates a new Waitlist Appointment, which adds a patient to a practice's cancellation list. Supports two use cases:

To replace an existing Scheduled Appointment with a Waitlist Appointment
To create a standalone Waitlist Appointment

Expected input parameters include combinations of:

patient (for example Patient/pt-1)
replaces (for example Appointment/appt-1)
requested-period-end (as YYYY-MM-DD)
service-type (a code from the Practice's Bp Local Service Type CodeSystem)
practitioner (for example Practitioner/pr-1)
location (for example Location/clinloc-1)
description (brief appointment details)

The two use cases require:

Replacing an appointment: patient, service-type, replaces and, optionally practitioner.
Creating a new appointment: patient, service-type, requested-period-end, and, optionally practitioner, location, and description.

POST support only.