Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

CapabilityStatement: ADHA Server Requirements Capability Statement (Experimental)

Official URL: http://ns.electronichealth.net.au/fhir/CapabilityStatement/dh-server-1 Version: 0.0.1
Draft as of 2024-12-19 Computable Name: ADHACapabilityStatementServer

Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The requirements for capabilities of a server implementing Australian Digital Health Agency FHIR RESTful Endpoints (au.digitalhealth.r4).

Raw OpenAPI-Swagger Definition file | Download

ADHACapabilityStatementServer

The requirements for capabilities of a server implementing Australian Digital Health Agency FHIR RESTful Endpoints (au.digitalhealth.r4).

  • Official URL: http://ns.electronichealth.net.au/fhir/CapabilityStatement/dh-server-1
  • Official name: ADHACapabilityStatementServer
  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1

FHIR RESTful Capabilities

The Server SHALL:

  1. Support the ADHA Core Patient resource profile.
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Follow the requirements documented in the Policy page.
  4. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scopes
    • (Status 404): unknown resource
  5. Support JSON source formats for all ADHA interactions.
  6. Declare a CapabilityStatement identifying the list of profiles, operations, and search parameters supported.

The Server SHOULD:

  1. Follow the guidance documented in the Guidance page
  2. Support XML source formats for all ADHA interactions.

The Server MAY:

  1. Identify the ADHA profiles supported as part of the FHIR meta.profile attribute for each instance.

Summary of System Wide Interactions

  • MAY support the transaction interaction.
  • MAY support the batch interaction.
  • MAY support the search-system interaction.
  • MAY support the history-system interaction.

RESTful Capabilities by Resource/Profile:

Summary

Resource Type Canonical Profile Supported Profiles Read V-Read Search Update Patch Create Delete Updates History
AllergyIntolerance ADHA Core AllergyIntolerance SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
BodyStructure ADHA Core BodyStructure ADHA Donatable Organ or Tissue BodyStructure SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Condition ADHA Core Condition SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Bundle ADHA Document Bundle
ADHA Payload Bundle		 SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Composition ADHA Core Composition ADHA Document Composition
ADHA Advance Care Directive Custodian Record Document Composition
ADHA Advance Care Planning Document Composition
ADHA Aged Care Transfer Summary Composition
ADHA Discharge Summary Composition
ADHA Event Summary Document Composition
ADHA Medicare Overview Composition
ADHA National Cancer Screening Program Participation View
ADHA Personal Health Notes Document Composition
ADHA Personal Health Summary Document Composition
ADHA Prescription and or Dispense History Composition
ADHA Pharmacist Shared Medicines List Composition
ADHA Personal Observations Document Composition
ADHA Shared Health Summary Document Composition
ADHA Shared Medicines List Composition		 SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Consent ADHA Record of Australian Organ Donor Register Consent SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Device ADHA Implantable Medical Device
ADHA Participant Device
ADHA System Device		 SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
DiagnosticReport ADHA Core DiagnosticReport ADHA Pathology Report SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
DocumentReference ADHA Core DocumentReference ADHA Advance Care Planning Document DocumentReference SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Encounter ADHA Core Encounter SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
ExplanationOfBenefit ADHA Record of Claim against MBS
ADHA Record of Claim against PBS or RPBS		 SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Flag ADHA Core Flag ADHA Australian Immunisation Register Notice SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
HealthcareService ADHA Core HealthcareService SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Immunization ADHA Core Immunization ADHA Record of Immunisation from Australian Immunisation Register SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
List ADHA Core List ADHA Immunisation History List
ADHA Prescription and or Dispense History List
ADHA Medication Use List
ADHA Practitioner Medicine Review List		 SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Location ADHA Core Location SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Media ADHA Core Media SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Medication ADHA Core Medication SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
MedicationAdministration ADHA Core MedicationAdministration SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
MedicationDispense ADHA Core MedicationDispense ADHA Dispense Record SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
MedicationRequest ADHA Core MedicationRequest ADHA PBS Claim Item
ADHA Prescription		 SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
MedicationStatement ADHA Core MedicationStatement SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Observation ADHA Core Observation ADHA Diagnostic Result Observation
ADHA Imaging Result Observation
ADHA Pathology Result Observation
ADHA National Cancer Screening Program Participation Observation
ADHA Simple Observation AU Assertion of No Relevant Finding
AU Biological Sex Assigned at Birth
AU Blood Pressure
AU Body Weight
AU Body Height
AU Body Mass Index
AU Oxygen Saturation
AU Head Circumference
AU Heart Rate
AU Body Temperature
AU Respiration Rate
AU Vital Signs Panel
AU Smoking Status
AU Estimated Date of Delivery
AU Gravidity
AU Parity
AU Last Menstrual Period
 SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Organization ADHA Core Organization ADHA Organization Contact SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Patient ADHA Core Patient ADHA My Health Record Patient SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Practitioner ADHA Core Practitioner SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
PractitionerRole ADHA Core PractitionerRole ADHA Authoring PractitionerRole
ADHA Authoring Care Agency Employee		 SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Procedure ADHA Core Procedure SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
RelatedPerson ADHA Core RelatedPerson ADHA Authoring RelatedPerson
ADHA MHR RelatedPerson		 SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
ServiceRequest ADHA Core ServiceRequest ADHA MBS Service Claim Item SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Specimen ADHA Core Specimen SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Substance ADHA Core Substance SHALL SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY