Binary Resource
The FHIR Binary resource stores the raw contents of a file that cannot be represented directly as a standard FHIR resource. This may include PDF reports, images, text files, structured documents, or other file types.
The FHIR Binary resource stores the raw contents of a file that cannot be represented directly as a standard FHIR resource. This may include PDF reports, images, text files, structured documents, or other file types.
The FHIR CapabilityStatement resource describes the capabilities and supported functionality of a FHIR server. This includes the FHIR version, supported resources, interactions, search parameters, and other features available through the API.
The AdvaPACS FHIR API allows external systems to access and manage supported clinical and imaging data using the FHIR standard. Before making requests to the API, you will need:
The FHIR Device resource represents an acquisition device configured within AdvaPACS, such as a DICOM modality or other imaging equipment. Device resources can be referenced by other FHIR resources, most commonly a ServiceRequest, where they identify the modality that will perform the requested procedure.
The FHIR DiagnosticReport resource represents a completed diagnostic report in AdvaPACS. DiagnosticReport resources are typically associated with a ServiceRequest and contain the report content, reporting status, issuing time, and reporting practitioners.
FHIR Extensions allow AdvaPACS to expose additional information that is not available in the core HL7 FHIR R5 specification. They provide a standards-compliant way to include AdvaPACS-specific data while maintaining compatibility with FHIR clients and integrations.
The AdvaPACS FHIR interface provides a standards-based way for external systems to exchange data with AdvaPACS. Use the FHIR API to build integrations for workflows such as patient management, imaging orders, reporting, organisations, locations, practitioners, devices, and imaging study data.
The FHIR ImagingStudy resource represents a medical imaging study and describes the DICOM content associated with the examination. It provides study-level information such as the accession number, Study Instance UID, modality, status, series, and individual instances.
The FHIR Location resource is used to represent physical locations within a healthcare environment, such as clinics, imaging centres, or other sites. Within AdvaPACS, Location resources correspond to configured Sites. Each Location belongs to an Organization, allowing resources and activities to be associated with a specific site within an organisation.
The FHIR NamingSystem resource is used to represent a naming or identification system that provides unique identifiers for healthcare resources. Within AdvaPACS, NamingSystem resources correspond to configured Assigning Authorities. These NamingSystems provide a FHIR system URI that can be used when declaring identifiers in other FHIR resources, allowing identifiers to be associated with the appropriate Assigning Authority.
The FHIR Organization resource represents an organisation or site within AdvaPACS. Organization resources can be referenced by other FHIR resources where an organisation, provider group, site, or owning entity needs to be identified.
The Patient Portal Status extension allows external systems to manage a patient's Patient Portal preference through the FHIR API. This extension can be included when creating or updating a Patient resource to indicate whether the patient has opted in to or opted out of the AdvaPACS Patient Portal.
The FHIR Patient resource is used to represent demographic and administrative information about an individual receiving healthcare services. It provides the core patient details used to identify and associate a patient with clinical resources such as orders, imaging studies, and diagnostic reports.
The FHIR Practitioner resource is used to represent clinicians and other healthcare professionals who participate in the delivery of healthcare services. Within AdvaPACS, Practitioner resources may represent clinicians such as referring physicians, performing clinicians, or technologists associated with orders and studies.
The FHIR ServiceRequest resource is used to represent a request for a healthcare service or procedure. Within AdvaPACS, a ServiceRequest represents an imaging order. It contains the information needed to identify and schedule the requested procedure, including the patient, procedure, modality, accession number, and other order identifiers.
The Study Notes extension allows AdvaPACS to uniquely identify individual study notes exchanged through the FHIR API. While the standard FHIR Annotation datatype supports note content, author, and timestamp, it does not provide a persistent identifier for each note.
FHIR Subscriptions allow external applications to receive notifications when specific events occur in AdvaPACS. Rather than repeatedly polling the FHIR API for changes, clients can subscribe to selected resources and receive notifications whenever matching resources are created, updated, or deleted.
The Worklist Assignment extension allows external systems to assign a reporting worklist item to a user through the FHIR API. The extension is included on the ServiceRequest resource and references the Practitioner associated with the assigned AdvaPACS user.