Developers | Hyella

HYELLA–PACS GraphQL API

A single GraphQL endpoint powers the integration layer between Hyella, PACS imaging and speech-to-text reporting: fetch patient demographics and imaging orders, and push completed reports back into Hyella.

Endpoint

All operations are POST requests to a single GraphQL endpoint:

POST https://YOUR-HYELLA-GRAPHQL-ENDPOINT/graphql

The endpoint URL is issued to you with your integration credentials.

Authentication

Every request must include these headers:

`Nwp-Token`	Your issued integration token
`Authorization`	`Basic <base64 credentials>`
`Content-Type`	`application/json`

Requests without valid headers are rejected.

Modules

Patients (patients)

Retrieve patient demographic records. Registration originates in Hyella - this API is read-only for patients.

patientsIDFetch a patient by Hyella patient ID
patientsSNFetch a patient by serial number
patientsPaginated list with optional filters

Labs & Scans (investigation)

Query investigation/imaging orders, their status and results.

investigationPaginated list with compound AND/OR filtering
investigationIDFetch one investigation by ID
investigationSNFetch one investigation by serial number

Documents (files)

Read file records and push reports back into Hyella - the key write operation.

files / filesID / filesSNList or fetch document records
addFiles (mutation)Attach a completed report to a patient record

Example query

query GetCustomerByID($id: ID!) {
  patientsID(id: $id) {
    id
    file_number
    date_of_birth
    sex
    principal_file_number
    serial_num
    record_status
  }
}

Example mutation - push a report

mutation AddFiles($input: [filesInput!]!) {
  addFiles(input: $input) {
    id
    name
    serial_num
    record_status
  }
}

Filtering

List queries accept a FilterGroup input supporting nested AND/OR logic. Supported operators:

EQNEQLTLTEGTGTELIKEINNOT_IN

{
  "filters": {
    "filters": [
      { "field": "customer", "operator": "EQ", "value": "crs114u4170993851" }
    ],
    "AND": [
      { "filters": [
        { "field": "type", "operator": "EQ", "value": "radiological" }
      ] }
    ]
  }
}

Postman collection

The full HYELLA–PACS Postman collection (every request, headers and example variables) is available to authorised developers. Enter the developer password to download it.

Don't have the password? Request access.

Embeddable JavaScript widgets

Drop-in widgets you can embed on any website to connect your patients to Hyella - no full integration required.

Want a widget for your site?

Tell us what you need and we'll provision the right embed code and keys for you.

Request a widget

Build on Hyella