{"version":"1.105.2","name":"HalaxyAPI","title":"Halaxy API","status":"active","experimental":false,"date":"2026-10-21T22:43:27+00:00","publisher":"Halaxy Pty Ltd","contact":[{"name":"Halaxy developers","telecom":[{"system":"email","value":"community@halaxy.com","use":"work"}]}],"description":"A FHIR API for Halaxy based on R4 of the FHIR specification\n","kind":"instance","software":{"name":"Halaxy API","version":"1.105.2"},"implementation":{"description":"A FHIR API for Halaxy based on R4 of the FHIR specification","url":"https:\/\/localhost\/main"},"fhirVersion":"4.3.0","format":["application\/fhir+json","application\/json"],"patchFormat":["application\/merge-patch+json"],"rest":[{"mode":"server","security":{"cors":true,"service":[{"coding":[{"system":"http:\/\/hl7.org\/fhir\/restful-security-service","code":"OAuth","display":"OAuth"}],"text":"OAuth"}],"description":"Currently only client credentials are supported for OAuth"},"resource":[{"type":"Appointment","documentation":"An Appointment halaxy. See https:\/\/hl7.org\/fhir\/r4\/appointment.html","interaction":[{"code":"patch","documentation":"An Appointment halaxy. See https:\/\/hl7.org\/fhir\/r4\/appointment.html"},{"code":"search-type","documentation":"An Appointment halaxy. See https:\/\/hl7.org\/fhir\/r4\/appointment.html"}],"referencePolicy":["local"],"searchInclude":["Appointment:patient","Appointment:practitioner-role","PractitionerRole:practitioner","PractitionerRole:organization"],"searchParam":[{"name":"_id","type":"token","documentation":"Logical id of this artifact."},{"name":"date","type":"date","documentation":"Appointment date\/time."},{"name":"_lastUpdated","type":"date","documentation":"When the resource last changed."},{"name":"created","type":"date","documentation":"When the resource was created."},{"name":"part-status","type":"string","documentation":"The Participation status of the patient."},{"name":"patient","type":"reference","documentation":"An individual patient within an appointment"},{"name":"practitioner","type":"reference","documentation":"An individual practitioner assigned to an appointment"},{"name":"practitioner-role","type":"reference","documentation":"An individual practitioner role assigned to an appointment"},{"name":"organization","type":"reference","documentation":"The clinic (Organization) at which the appointment takes place"}],"operation":[{"name":"find","documentation":"An Appointment halaxy. See https:\/\/hl7.org\/fhir\/r4\/appointment.html"},{"name":"book","documentation":"An Appointment halaxy. See https:\/\/hl7.org\/fhir\/r4\/appointment.html"}]},{"type":"ChargeItemDefinition","documentation":"A ChargeItemDefinition (Fee).","interaction":[{"code":"search-type","documentation":"A ChargeItemDefinition (Fee)."}],"referencePolicy":["local"],"searchParam":[{"name":"_id","type":"token","documentation":"The logical id of the resource"},{"name":"context-type","type":"string","documentation":"Type of resource (fee type: 0=Appointment, 1=Item, 2=ProRata)"},{"name":"property-group-status","type":"string","documentation":"Status of propertyGroup extension coding (fee pricing status: 1=current, 2=archived)"},{"name":"created","type":"date","documentation":"When the resource was created"},{"name":"title","type":"string","documentation":"Title of the resource (fee name)"},{"name":"publisher","type":"string","documentation":"Publisher of the resource (funder name)"},{"name":"code","type":"string","documentation":"Resource code (fee item number)"},{"name":"_lastUpdated","type":"date","documentation":"Date the resource was last updated"}]},{"type":"Coverage","documentation":"A Coverage. See https:\/\/hl7.org\/fhir\/R4\/coverage.html","interaction":[{"code":"search-type","documentation":"A Coverage. See https:\/\/hl7.org\/fhir\/R4\/coverage.html"},{"code":"create","documentation":"Create a new Coverage"},{"code":"patch","documentation":"A Coverage. See https:\/\/hl7.org\/fhir\/R4\/coverage.html"}],"referencePolicy":["local"],"searchInclude":["Coverage:beneficiary","Coverage:subscriber","Coverage:payor"]},{"type":"DocumentReference","documentation":"A reference to a document","interaction":[{"code":"create","documentation":"Create a new Note record"},{"code":"patch","documentation":"A reference to a document"}],"referencePolicy":["local"],"operation":[{"name":"access-status","documentation":"Check whether a patient has a PCEHR and what access code is required"},{"name":"remove","documentation":"A reference to a document"},{"name":"elevate-access","documentation":"A reference to a document"}]},{"type":"HealthcareService","documentation":"The detail of a healthcare service available at a location.","interaction":[{"code":"search-type","documentation":"The detail of a healthcare service available at a location."}],"referencePolicy":["local"],"searchParam":[{"name":"_id","type":"token","documentation":"The logical id of the resource"},{"name":"active","type":"token","documentation":"Whether this healthcare service record is in active use."},{"name":"name","type":"string","documentation":"Description of services as presented to a consumer while searching"}]},{"type":"InvoiceLine","documentation":"An InvoiceLine.","interaction":[{"code":"search-type","documentation":"An InvoiceLine."}],"referencePolicy":["local"],"searchInclude":["InvoiceLine:subject","InvoiceLine:performer","InvoiceLine:invoice"],"searchParam":[{"name":"_id","type":"token","documentation":"The logical id of the resource"},{"name":"created","type":"date","documentation":"When the resource was created."},{"name":"subject","type":"reference","documentation":"Patient who is the subject of the invoice line"},{"name":"performer","type":"reference","documentation":"Reference to the performer for the invoice line."},{"name":"invoice","type":"reference","documentation":"Reference to the invoice it belong."},{"name":"funder","type":"reference","documentation":"Reference to the funder it belong."},{"name":"referral","type":"reference","documentation":"Reference to the referral it belong."},{"name":"coverage","type":"reference","documentation":"Reference to the claim it belong."},{"name":"_lastUpdated","type":"date","documentation":"Date the invoice line was last updated."},{"name":"amount","type":"number","documentation":"The amount of the invoice line"}]},{"type":"Invoice","documentation":"An Invoice.","interaction":[{"code":"search-type","documentation":"An Invoice."}],"referencePolicy":["local"],"searchInclude":["Invoice:recipient","Invoice:practitioner","PractitionerRole:practitioner","PractitionerRole:organization"],"searchParam":[{"name":"_id","type":"token","documentation":"ID of the invoice"},{"name":"_lastUpdated","type":"date","documentation":"Date the invoice was last updated."},{"name":"created","type":"date","documentation":"Date the invoice was created."},{"name":"recipient","type":"reference","documentation":"The Recipient of the invoice, can be patient or organization"},{"name":"practitioner","type":"reference","documentation":"Reference to the practitioner or practitioner role for the invoice"},{"name":"practitioner-role","type":"reference","documentation":"Reference to the practitioner role for the invoice"},{"name":"organization","type":"reference","documentation":"Filter the clinic to where the invoice was created"},{"name":"status","type":"string","documentation":"Reference to the coverage for the invoice"},{"name":"totalPaid","type":"number","documentation":"The total paid amount of the invoice"},{"name":"totalBalance","type":"number","documentation":"The balance amount of the invoice"}]},{"type":"Medication","documentation":"A medication, sourced from the SNOMED CT-AU terminology server.","interaction":[{"code":"search-type","documentation":"A medication, sourced from the SNOMED CT-AU terminology server."}],"referencePolicy":["local"],"searchParam":[{"name":"code","type":"token","documentation":"SNOMED code token for the medication, optionally system|code."},{"name":"identifier","type":"token","documentation":"SNOMED identifier token for the medication, optionally system|code."},{"name":"status","type":"token","documentation":"Medication status to match: active, inactive, or entered-in-error."},{"name":"medication-class","type":"token","documentation":"Restrict results to one or more medication types (AU medication-type codes: BPGC, BPG, UPG). Comma-separate to match more than one."}]},{"type":"Organization","documentation":"An Organization within halaxy represents a Clinic. See https:\/\/hl7.org\/fhir\/r4\/organization.html","interaction":[{"code":"search-type","documentation":"An Organization within halaxy represents a Clinic. See https:\/\/hl7.org\/fhir\/r4\/organization.html"},{"code":"create","documentation":"An Organization within halaxy represents a Clinic. See https:\/\/hl7.org\/fhir\/r4\/organization.html"}],"referencePolicy":["local"]},{"type":"Patient","documentation":"Demographics and other administrative information about an individual or animal receiving care or other health-related services. See https:\/\/www.hl7.org\/fhir\/R4\/patient.html","interaction":[{"code":"search-type","documentation":"Demographics and other administrative information about an individual or animal receiving care or other health-related services. See https:\/\/www.hl7.org\/fhir\/R4\/patient.html"},{"code":"update","documentation":"Demographics and other administrative information about an individual or animal receiving care or other health-related services. See https:\/\/www.hl7.org\/fhir\/R4\/patient.html"},{"code":"create","documentation":"Demographics and other administrative information about an individual or animal receiving care or other health-related services. See https:\/\/www.hl7.org\/fhir\/R4\/patient.html"},{"code":"patch","documentation":"Demographics and other administrative information about an individual or animal receiving care or other health-related services. See https:\/\/www.hl7.org\/fhir\/R4\/patient.html"}],"referencePolicy":["local"],"searchInclude":["Patient:general-practitioner"],"operation":[{"name":"export-ids","documentation":"Demographics and other administrative information about an individual or animal receiving care or other health-related services. See https:\/\/www.hl7.org\/fhir\/R4\/patient.html"}]},{"type":"PaymentTransaction","documentation":"A PaymentTransaction.","interaction":[{"code":"search-type","documentation":"A PaymentTransaction."}],"referencePolicy":["local"],"searchParam":[{"name":"_id","type":"token","documentation":"ID of the payment transaction"},{"name":"_lastUpdated","type":"date","documentation":"Date the payment transaction was last updated."},{"name":"created","type":"date","documentation":"Date the payment transaction was created."}]},{"type":"Practitioner","documentation":"A Practitioner. See https:\/\/hl7.org\/fhir\/r4\/practitioner.html","interaction":[{"code":"search-type","documentation":"A Practitioner. See https:\/\/hl7.org\/fhir\/r4\/practitioner.html"},{"code":"create","documentation":"A Practitioner. See https:\/\/hl7.org\/fhir\/r4\/practitioner.html"}],"referencePolicy":["local"]},{"type":"PractitionerRole","documentation":"A PractitionerRole. See https:\/\/www.hl7.org\/fhir\/R4\/practitionerrole.html","interaction":[{"code":"search-type","documentation":"A PractitionerRole. See https:\/\/www.hl7.org\/fhir\/R4\/practitionerrole.html"},{"code":"create","documentation":"A PractitionerRole. See https:\/\/www.hl7.org\/fhir\/R4\/practitionerrole.html"}],"referencePolicy":["local"],"searchInclude":["PractitionerRole:practitioner","PractitionerRole:organization"]},{"type":"ReferralDefinition","documentation":"A ReferralType definition","interaction":[{"code":"search-type","documentation":"A ReferralType definition"}],"referencePolicy":["local"],"searchParam":[{"name":"_id","type":"token","documentation":"ID of the referral definition"},{"name":"fundingOrganization","type":"reference","documentation":"Funder ID"}]},{"type":"Referral","documentation":"A Referral.","interaction":[{"code":"search-type","documentation":"A Referral."},{"code":"create","documentation":"A Referral."},{"code":"patch","documentation":"A Referral."}],"referencePolicy":["local"],"searchInclude":["Referral:subject","Referral:coverage"]},{"type":"Schedule","documentation":"Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.\nThe schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available.","interaction":[{"code":"search-type","documentation":"Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.\nThe schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available."}],"referencePolicy":["local"],"searchInclude":["Schedule:actor"],"operation":[{"name":"generate","documentation":"Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.\nThe schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available."}]},{"type":"Slot","documentation":"Slot resources are used to provide time-slots that can be booked using an appointment. They do not provide any information about \n    appointments that are available, just the time, and optionally what the time can be used for. These are effectively spaces of free\/busy time.\nSlots can also be marked as busy without having appointments associated.","interaction":[{"code":"search-type","documentation":"Slot resources are used to provide time-slots that can be booked using an appointment. They do not provide any information about \n    appointments that are available, just the time, and optionally what the time can be used for. These are effectively spaces of free\/busy time.\nSlots can also be marked as busy without having appointments associated."}],"referencePolicy":["local"],"searchInclude":["Slot:practitioner","Slot:organization","Slot:practitioner-role"],"searchParam":[{"name":"_id","type":"token","documentation":"The logical id of the resource"},{"name":"duration","type":"number","documentation":"The duration of the slot"},{"name":"status","type":"string","documentation":"The free\/busy status of the appointment"},{"name":"practitioner","type":"reference","documentation":"The practitioner available for the slot"},{"name":"organization","type":"reference","documentation":"The Organization the slot if apart of the Slot"},{"name":"practitioner-role","type":"reference","documentation":"The PractitionerRole that is apart of the Slot"},{"name":"start","type":"date","documentation":"The Appointment start date\/time."},{"name":"end","type":"date","documentation":"The Appointment end date\/time."},{"name":"schedule","type":"reference","documentation":"The schedule the slot is a part of"}]}]}],"resourceType":"CapabilityStatement"}