Helix AU Core
0.1.0 - ci-build

Helix AU Core - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Fhir

FHIR Introduction

This implementation guide uses terminology, notation, and design principles that are specific to FHIR. This implementation guide supports the R4 version of the FHIR standard and builds on the AU Core (FHIR R4) implementation guide. Before reading this implementation guide, familiarise yourself with the basic principles of FHIR and how to read FHIR specifications. The following resources provide useful background:

FHIR Resource Operations

In FHIR, CRUD (Create, Read, Update, Delete) operations define how systems can interact with FHIR resources , such as Patient, Observation, and Encounter.

CRUD Operation HTTP Method FHIR Endpoint Example Description
Create POST /Patient Create a new resource. Server assigns an ID.
Read GET /Patient/{id} Read a resource by its ID.
Update PUT /Patient/{id} Replace the entire resource.
Delete DELETE /Patient/{id} Delete the resource.

Notes:

  • Replace Patient with any FHIR resource type (for example, Observation, Encounter, Medication).
  • {id} is the unique ID assigned by the FHIR server.
  • vid refers to a specific version of the resource (if versioning is enabled).
  • Footnote 1: An appointment can be cancelled via an update.

Each resource supports standard RESTful operations for managing health data via HTTP.

FHIR Resource / API Associated Helix Concept / Functional Area Create Read Update Delete
AllergyIntolerance Allergies / Adverse Reactions No Yes No No
Appointment Appointments Yes Yes Yes No ​1
Claim Visits No Yes No No
Condition Conditions No Yes No No
DiagnosticReport Results No Yes No No
DocumentReference HealthLink SmartForms (Create only) Yes Yes No No
Encounter Consults No Yes No No
Endpoint HealthLink SmartForms No Yes No No
FamilyMemberHistory Family History / Family Conditions No Yes No No
HealthcareService Centre / Work Areas No Yes No No
Immunisation Immunisations No Yes No No
Location Centre / Work Areas No Yes No No
MedicationRequest Script Items / Medications No Yes No No
MedicationStatement Script Items / Medications No Yes No No
Observation SNAP, Social History, Pregnancies, Measurements No Yes No No
Organization Centre / Work Areas No Yes No No
Patient Patients (currently not live) Yes Yes Yes No
Practitioner Practitioners No Yes No No
PractitionerRole Practitioners No Yes No No
Procedure Pregnancies No Yes No No
RelatedPerson Patients / Carers No Yes No No
Schedule Appointment Books No Yes No No
SearchParameter N/A, FHIR concept only No Yes No No
Slot Appointment Books (virtualised) No Yes No No
Subscription N/A (we configure the subscriptions for a partner) No Yes No No