Aurabox API Documentation

List cases.

GET

https://region.aurabox.cloud

/api/v1/cases

requires authentication

Returns a paginated list of deidentified patients (cases) in the authenticated user's current team realm. Supports search by label, archived filtering, and sorting.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

7

search

string

Must not be greater than 255 characters.

Example:

rzp

sort

string

Must be one of:

label
created_at
updated_at
date_of_birth

Example:

label

direction

string

Must be one of:

asc
desc

Example:

asc

archived

boolean

Example:

false

Auth

:

Bearer

Headers

:

Body

{ "per_page": 7, "search": "rzp", "sort": "label", "direction": "asc", "archived": false }

Received response

Example request:

curl --request GET \
    --get "https://region.aurabox.cloud/api/v1/cases" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"per_page\": 7,
    \"search\": \"rzp\",
    \"sort\": \"label\",
    \"direction\": \"asc\",
    \"archived\": false
}"

Example response:

{
    "data": [
        {
            "id": "003fb6c7-a399-46de-8199-ac51e031bd10",
            "label": "CASE-00142",
            "status": "deidentified",
            "archived": false,
            "created_at": "2025-01-15T10:30:00.000000Z",
            "updated_at": "2025-01-15T10:30:00.000000Z"
        }
    ],
    "links": {
        "first": "https://region.aurabox.cloud/api/v1/cases?page=1",
        "last": "https://region.aurabox.cloud/api/v1/cases?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}

Create a Case.

POST

https://region.aurabox.cloud

/api/v1/cases

requires authentication

Creates a new deidentified patient (case) in the authenticated user's team realm. A label is required; sex and date of birth are optional.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

label

string

required

Must not be greater than 255 characters.

Example:

nvtgvzvdmelospjvztft

sex

string

Must be one of:

male
female
other
unknown

Example:

other

date_of_birth

string

Must be a valid date. Must be a date before today.

Example:

2009-11-01

Auth

:

Bearer

Headers

:

Body

{ "label": "nvtgvzvdmelospjvztft", "sex": "other", "date_of_birth": "2009-11-01" }

Received response

Example request:

curl --request POST \
    "https://region.aurabox.cloud/api/v1/cases" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"nvtgvzvdmelospjvztft\",
    \"sex\": \"other\",
    \"date_of_birth\": \"2009-11-01\"
}"

Example response:

{
    "data": {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "label": "CASE-00143",
        "status": "deidentified",
        "archived": false,
        "created_at": "2025-02-18T10:30:00.000000Z",
        "updated_at": "2025-02-18T10:30:00.000000Z"
    }
}

Show a Case.

GET

https://region.aurabox.cloud

/api/v1/cases/{patient_id}

requires authentication

Returns a deidentified patient (case) by ID. Cases are patients whose identity has been removed — only a label and non-identifying metadata are returned.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

patient_id

string

required

The ID of the patient.

Example:

eum

Auth

:

Bearer

Headers

:

URL Parameters

:

Received response

Example request:

curl --request GET \
    --get "https://region.aurabox.cloud/api/v1/cases/eum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "003fb6c7-a399-46de-8199-ac51e031bd10",
        "label": "CASE-00142",
        "status": "deidentified",
        "archived": false,
        "created_at": "2025-01-15T10:30:00.000000Z",
        "updated_at": "2025-01-15T10:30:00.000000Z"
    }
}

Update a Case.

PUT

https://region.aurabox.cloud

/api/v1/cases/{patient_id}

requires authentication

Updates an existing deidentified patient (case). Only label, sex, and date of birth may be changed.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

patient_id

string

required

The ID of the patient.

Example:

harum

Body Parameters

label

string

Must not be greater than 255 characters.

Example:

zkmrlcjeho

sex

string

Must be one of:

male
female
other
unknown

Example:

male

date_of_birth

string

Must be a valid date. Must be a date before today.

Example:

2011-05-10

Auth

:

Bearer

Headers

:

URL Parameters

:

Body

{ "label": "zkmrlcjeho", "sex": "male", "date_of_birth": "2011-05-10" }

Received response

Example request:

curl --request PUT \
    "https://region.aurabox.cloud/api/v1/cases/harum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"zkmrlcjeho\",
    \"sex\": \"male\",
    \"date_of_birth\": \"2011-05-10\"
}"

Example response:

{
    "data": {
        "id": "003fb6c7-a399-46de-8199-ac51e031bd10",
        "label": "CASE-00142-UPDATED",
        "status": "deidentified",
        "archived": false,
        "created_at": "2025-01-15T10:30:00.000000Z",
        "updated_at": "2025-02-18T12:00:00.000000Z"
    }
}

Delete a Case.

DELETE

https://region.aurabox.cloud

/api/v1/cases/{patient_id}

requires authentication

Permanently deletes a deidentified patient (case) from the current team realm.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

patient_id

string

required

The ID of the patient.

Example:

beatae

Auth

:

Bearer

Headers

:

URL Parameters

:

Received response

Example request:

curl --request DELETE \
    "https://region.aurabox.cloud/api/v1/cases/beatae" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

List patients for the current team realm.

GET

https://region.aurabox.cloud

/api/v1/patients

requires authentication

Returns a paginated list of patients in the authenticated user's current team realm. Supports search, archived filtering, and sorting.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

9

search

string

Must not be greater than 255 characters.

Example:

cjitazziahaxrcxwogbcs

sort

string

Must be one of:

name
created_at
updated_at
date_of_birth

Example:

created_at

direction

string

Must be one of:

asc
desc

Example:

desc

archived

boolean

Example:

false

Auth

:

Bearer

Headers

:

Body

{ "per_page": 9, "search": "cjitazziahaxrcxwogbcs", "sort": "created_at", "direction": "desc", "archived": false }

Received response

Example request:

curl --request GET \
    --get "https://region.aurabox.cloud/api/v1/patients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"per_page\": 9,
    \"search\": \"cjitazziahaxrcxwogbcs\",
    \"sort\": \"created_at\",
    \"direction\": \"desc\",
    \"archived\": false
}"

Example response:

{
    "data": [
        {
            "id": "003fb6c7-a399-46de-8199-ac51e031bd10",
            "given_names": "Jessica",
            "family_name": "Jones",
            "date_of_birth": "1985-06-15",
            "sex": "female",
            "address": {
                "street": "123 Main Street",
                "city": "Sydney",
                "region": "NSW",
                "postcode": "2000",
                "country": "au"
            },
            "status": "active",
            "archived": false,
            "created_at": "2025-01-15T10:30:00.000000Z",
            "updated_at": "2025-01-15T10:30:00.000000Z"
        }
    ],
    "links": {
        "first": "https://region.aurabox.cloud/api/v1/patients?page=1",
        "last": "https://region.aurabox.cloud/api/v1/patients?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}

Create a patient record on the current team.

POST

https://region.aurabox.cloud

/api/v1/patients

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

given_names

string

required

Must not be greater than 255 characters.

Example:

aoxhnfggpebskabzzajigrfa

family_name

string

required

Must not be greater than 255 characters.

Example:

rkpurkdoj

date_of_birth

string

required

Must be a valid date. Must be a date before today.

Example:

2003-06-27

sex

string

required

Must be one of:

male
female
other
unknown

Example:

female

address

object

street

string

Must not be greater than 255 characters.

Example:

gxxseksewhhrtjgxrghfovxp

city

string

Must not be greater than 255 characters.

Example:

ndifmugoclprs

region

string

Must not be greater than 255 characters.

Example:

bzzfekbbtqpvalngaq

postcode

string

Must not be greater than 20 characters.

Example:

hkzmaverxc

country

string

Must not be greater than 2 characters.

Example:

w

Auth

:

Bearer

Headers

:

Body

{ "given_names": "aoxhnfggpebskabzzajigrfa", "family_name": "rkpurkdoj", "date_of_birth": "2003-06-27", "sex": "female", "address": { "street": "gxxseksewhhrtjgxrghfovxp", "city": "ndifmugoclprs", "region": "bzzfekbbtqpvalngaq", "postcode": "hkzmaverxc", "country": "w" } }

Received response

Example request:

curl --request POST \
    "https://region.aurabox.cloud/api/v1/patients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"given_names\": \"aoxhnfggpebskabzzajigrfa\",
    \"family_name\": \"rkpurkdoj\",
    \"date_of_birth\": \"2003-06-27\",
    \"sex\": \"female\",
    \"address\": {
        \"street\": \"gxxseksewhhrtjgxrghfovxp\",
        \"city\": \"ndifmugoclprs\",
        \"region\": \"bzzfekbbtqpvalngaq\",
        \"postcode\": \"hkzmaverxc\",
        \"country\": \"w\"
    }
}"

Retrieve a patient.

GET

https://region.aurabox.cloud

/api/v1/patients/{id}

requires authentication

Returns a single patient record. De-identified patients return only a label instead of personal details.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

id

string

required

The ID of the patient.

Example:

ab

Auth

:

Bearer

Headers

:

URL Parameters

:

Received response

Example request:

curl --request GET \
    --get "https://region.aurabox.cloud/api/v1/patients/ab" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "003fb6c7-a399-46de-8199-ac51e031bd10",
        "given_names": "Jessica",
        "family_name": "Jones",
        "date_of_birth": "1985-06-15",
        "sex": "female",
        "address": {
            "street": "123 Main Street",
            "city": "Sydney",
            "region": "NSW",
            "postcode": "2000",
            "country": "au"
        },
        "status": "active",
        "archived": false,
        "created_at": "2025-01-15T10:30:00.000000Z",
        "updated_at": "2025-01-15T10:30:00.000000Z"
    }
}

Update a patient record.

PUT

https://region.aurabox.cloud

/api/v1/patients/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

id

string

required

The ID of the patient.

Example:

velit

Body Parameters

given_names

string

Must not be greater than 255 characters.

Example:

ivmvraagyukvllh

family_name

string

Must not be greater than 255 characters.

Example:

ybfycvgzpu

date_of_birth

string

Must be a valid date. Must be a date before today.

Example:

2021-12-03

sex

string

Must be one of:

male
female
other
unknown

Example:

unknown

address

object

street

string

Must not be greater than 255 characters.

Example:

i

city

string

Must not be greater than 255 characters.

Example:

yqbgdbpny

region

string

Must not be greater than 255 characters.

Example:

pyqwp

postcode

string

Must not be greater than 20 characters.

Example:

kpndmhpztbgeodpuc

country

string

Must not be greater than 2 characters.

Example:

h

Auth

:

Bearer

Headers

:

URL Parameters

:

Body

{ "given_names": "ivmvraagyukvllh", "family_name": "ybfycvgzpu", "date_of_birth": "2021-12-03", "sex": "unknown", "address": { "street": "i", "city": "yqbgdbpny", "region": "pyqwp", "postcode": "kpndmhpztbgeodpuc", "country": "h" } }

Received response

Example request:

curl --request PUT \
    "https://region.aurabox.cloud/api/v1/patients/velit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"given_names\": \"ivmvraagyukvllh\",
    \"family_name\": \"ybfycvgzpu\",
    \"date_of_birth\": \"2021-12-03\",
    \"sex\": \"unknown\",
    \"address\": {
        \"street\": \"i\",
        \"city\": \"yqbgdbpny\",
        \"region\": \"pyqwp\",
        \"postcode\": \"kpndmhpztbgeodpuc\",
        \"country\": \"h\"
    }
}"

Delete a patient record.

DELETE

https://region.aurabox.cloud

/api/v1/patients/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

id

string

required

The ID of the patient.

Example:

ad

Auth

:

Bearer

Headers

:

URL Parameters

:

Received response

Example request:

curl --request DELETE \
    "https://region.aurabox.cloud/api/v1/patients/ad" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

List studies for a patient.

GET

https://region.aurabox.cloud

/api/v1/patients/{patient_id}/studies

requires authentication

Returns a paginated list of DICOM studies associated with the patient's person record. Supports filtering by modality and date range.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

patient_id

string

required

The ID of the patient.

Example:

ut

Body Parameters

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

11

modality

string

Must not be greater than 255 characters.

Example:

mgtscehavixjttrdhdc

date_from

string

Must be a valid date.

Example:

2026-02-18T22:47:20

date_to

string

Must be a valid date. Must be a date after or equal to date_from.

Example:

2038-07-23

sort

string

Must be one of:

study_date
created_at
updated_at

Example:

study_date

direction

string

Must be one of:

asc
desc

Example:

desc

Auth

:

Bearer

Headers

:

URL Parameters

:

Body

{ "per_page": 11, "modality": "mgtscehavixjttrdhdc", "date_from": "2026-02-18T22:47:20", "date_to": "2038-07-23", "sort": "study_date", "direction": "desc" }

Received response

Example request:

curl --request GET \
    --get "https://region.aurabox.cloud/api/v1/patients/ut/studies" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"per_page\": 11,
    \"modality\": \"mgtscehavixjttrdhdc\",
    \"date_from\": \"2026-02-18T22:47:20\",
    \"date_to\": \"2038-07-23\",
    \"sort\": \"study_date\",
    \"direction\": \"desc\"
}"

Example response:

{
    "data": [
        {
            "id": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
            "study_instance_uid": "1.2.840.113619.2.55.3.604688119",
            "study_description": "CT CHEST W CONTRAST",
            "study_date": "2025-01-10",
            "study_time": "143022",
            "accession_no": "ACC001234",
            "modalities": [
                "CT"
            ],
            "institution_name": "Sydney Radiology",
            "referring_physician_name": "Dr Smith",
            "series_count": 3,
            "instance_count": 156,
            "availability": "dicom",
            "status": "viewable",
            "notes": null,
            "series": [
                {
                    "id": "b2c3d4e5-f6a7-b8c9-d0e1-f2a3b4c5d6e7",
                    "series_instance_uid": "1.2.840.113619.2.55.3.604688119.1",
                    "series_number": 1,
                    "series_description": "Axial 5mm",
                    "modality": "CT",
                    "body_part_examined": "CHEST",
                    "instance_count": 52
                }
            ],
            "reports": [],
            "created_at": "2025-01-10T15:30:00.000000Z",
            "updated_at": "2025-01-10T15:30:00.000000Z"
        }
    ],
    "links": {
        "first": "https://region.aurabox.cloud/api/v1/patients/003fb6c7/studies?page=1",
        "last": "https://region.aurabox.cloud/api/v1/patients/003fb6c7/studies?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}

Create a study for a patient.

POST

https://region.aurabox.cloud

/api/v1/patients/{patient_id}/studies

requires authentication

Creates a new imaging study record associated with the patient's person. Defaults to a record-type study. To create a DICOM study, set availability to "dicom" and provide a study_instance_uid.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

patient_id

string

required

The ID of the patient.

Example:

ratione

Body Parameters

study_description

string

Must not be greater than 128 characters.

Example:

cwxdpaoj

study_date

string

Must not be greater than 255 characters.

Example:

qivrudfykbwrqkkpjyf

study_time

string

Must not be greater than 255 characters.

Example:

jogsghuouke

accession_no

string

Must not be greater than 255 characters.

Example:

dydqkwnhuiqcajnicy

institution_name

string

Must not be greater than 255 characters.

Example:

czpzvpxrwzyzsbetppnlzxml

referring_physician_name

string

Must not be greater than 255 characters.

Example:

akhybaujjxnbvvamuds

notes

string

Must not be greater than 512 characters.

Example:

xjdbzgnekvpwqhzszbmpiups

availability

string

Must be one of:

dicom
digital
film
print
record

Example:

digital

study_instance_uid

string

Must not be greater than 255 characters.

Example:

nhvqctbppmg

Auth

:

Bearer

Headers

:

URL Parameters

:

Body

{ "study_description": "cwxdpaoj", "study_date": "qivrudfykbwrqkkpjyf", "study_time": "jogsghuouke", "accession_no": "dydqkwnhuiqcajnicy", "institution_name": "czpzvpxrwzyzsbetppnlzxml", "referring_physician_name": "akhybaujjxnbvvamuds", "notes": "xjdbzgnekvpwqhzszbmpiups", "availability": "digital", "study_instance_uid": "nhvqctbppmg" }

Received response

Example request:

curl --request POST \
    "https://region.aurabox.cloud/api/v1/patients/ratione/studies" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"study_description\": \"cwxdpaoj\",
    \"study_date\": \"qivrudfykbwrqkkpjyf\",
    \"study_time\": \"jogsghuouke\",
    \"accession_no\": \"dydqkwnhuiqcajnicy\",
    \"institution_name\": \"czpzvpxrwzyzsbetppnlzxml\",
    \"referring_physician_name\": \"akhybaujjxnbvvamuds\",
    \"notes\": \"xjdbzgnekvpwqhzszbmpiups\",
    \"availability\": \"digital\",
    \"study_instance_uid\": \"nhvqctbppmg\"
}"

Example response:

{
    "data": {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "study_instance_uid": null,
        "study_description": "CT CHEST W CONTRAST",
        "study_date": "20250110",
        "study_time": null,
        "accession_no": "ACC001234",
        "modalities": [],
        "institution_name": "Sydney Radiology",
        "referring_physician_name": "Dr Smith",
        "series_count": null,
        "instance_count": null,
        "availability": "record",
        "status": "viewable",
        "notes": "External study record",
        "series": [],
        "reports": [],
        "created_at": "2025-02-18T10:30:00.000000Z",
        "updated_at": "2025-02-18T10:30:00.000000Z"
    }
}

Retrieve a single study.

GET

https://region.aurabox.cloud

/api/v1/patients/{patient_id}/studies/{id}

requires authentication

Returns detailed information about a specific DICOM study, including its series and reports.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

patient_id

string

required

The ID of the patient.

Example:

veniam

id

string

required

The ID of the study.

Example:

corporis

Auth

:

Bearer

Headers

:

URL Parameters

:

Received response

Example request:

curl --request GET \
    --get "https://region.aurabox.cloud/api/v1/patients/veniam/studies/corporis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
        "study_instance_uid": "1.2.840.113619.2.55.3.604688119",
        "study_description": "CT CHEST W CONTRAST",
        "study_date": "2025-01-10",
        "study_time": "143022",
        "accession_no": "ACC001234",
        "modalities": [
            "CT"
        ],
        "institution_name": "Sydney Radiology",
        "referring_physician_name": "Dr Smith",
        "series_count": 3,
        "instance_count": 156,
        "availability": "dicom",
        "status": "viewable",
        "notes": null,
        "series": [
            {
                "id": "b2c3d4e5-f6a7-b8c9-d0e1-f2a3b4c5d6e7",
                "series_instance_uid": "1.2.840.113619.2.55.3.604688119.1",
                "series_number": 1,
                "series_description": "Axial 5mm",
                "modality": "CT",
                "body_part_examined": "CHEST",
                "instance_count": 52
            }
        ],
        "reports": [
            {
                "id": "c3d4e5f6-a7b8-c9d0-e1f2-a3b4c5d6e7f8",
                "title": "CT Chest Report",
                "type": "radiology",
                "date": "2025-01-10"
            }
        ],
        "created_at": "2025-01-10T15:30:00.000000Z",
        "updated_at": "2025-01-10T15:30:00.000000Z"
    }
}

Update a study.

PUT

https://region.aurabox.cloud

/api/v1/patients/{patient_id}/studies/{id}

requires authentication

Updates metadata on an existing imaging study. Only descriptive fields can be modified — the study's person ownership and availability type cannot be changed.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

patient_id

string

required

The ID of the patient.

Example:

et

id

string

required

The ID of the study.

Example:

id

Body Parameters

study_description

string

Must not be greater than 128 characters.

Example:

ldwulmntpc

study_date

string

Must not be greater than 255 characters.

Example:

sxyqumoqmqmnc

study_time

string

Must not be greater than 255 characters.

Example:

nmndyvkhfsyyqfztnepjuq

accession_no

string

Must not be greater than 255 characters.

Example:

dauseaiphbtpvlq

institution_name

string

Must not be greater than 255 characters.

Example:

elldeigws

referring_physician_name

string

Must not be greater than 255 characters.

Example:

qxmxofvjfehniqqojhgtzpca

notes

string

Must not be greater than 512 characters.

Example:

ud

Auth

:

Bearer

Headers

:

URL Parameters

:

Body

{ "study_description": "ldwulmntpc", "study_date": "sxyqumoqmqmnc", "study_time": "nmndyvkhfsyyqfztnepjuq", "accession_no": "dauseaiphbtpvlq", "institution_name": "elldeigws", "referring_physician_name": "qxmxofvjfehniqqojhgtzpca", "notes": "ud" }

Received response

Example request:

curl --request PUT \
    "https://region.aurabox.cloud/api/v1/patients/et/studies/id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"study_description\": \"ldwulmntpc\",
    \"study_date\": \"sxyqumoqmqmnc\",
    \"study_time\": \"nmndyvkhfsyyqfztnepjuq\",
    \"accession_no\": \"dauseaiphbtpvlq\",
    \"institution_name\": \"elldeigws\",
    \"referring_physician_name\": \"qxmxofvjfehniqqojhgtzpca\",
    \"notes\": \"ud\"
}"

Example response:

{
    "data": {
        "id": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
        "study_instance_uid": "1.2.840.113619.2.55.3.604688119",
        "study_description": "CT CHEST W CONTRAST - UPDATED",
        "study_date": "2025-01-10",
        "study_time": "143022",
        "accession_no": "ACC001234",
        "modalities": [
            "CT"
        ],
        "institution_name": "Sydney Radiology",
        "referring_physician_name": "Dr Jones",
        "series_count": 3,
        "instance_count": 156,
        "availability": "dicom",
        "status": "viewable",
        "notes": "Updated notes",
        "series": [],
        "reports": [],
        "created_at": "2025-01-10T15:30:00.000000Z",
        "updated_at": "2025-02-18T12:00:00.000000Z"
    }
}

Delete a study.

DELETE

https://region.aurabox.cloud

/api/v1/patients/{patient_id}/studies/{id}

requires authentication

Permanently deletes an imaging study and all associated series. File cleanup is handled asynchronously.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

patient_id

string

required

The ID of the patient.

Example:

harum

id

string

required

The ID of the study.

Example:

est

Auth

:

Bearer

Headers

:

URL Parameters

:

Received response

Example request:

curl --request DELETE \
    "https://region.aurabox.cloud/api/v1/patients/harum/studies/est" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Introduction

Authenticating requests

Cases

List cases.

Headers

Body Parameters

Create a Case.

Headers

Body Parameters

Show a Case.

Headers

URL Parameters

Update a Case.

Headers

URL Parameters

Body Parameters

Delete a Case.

Headers

URL Parameters

Patients

List patients for the current team realm.

Headers

Body Parameters

Create a patient record on the current team.

Headers

Body Parameters

Retrieve a patient.

Headers

URL Parameters

Update a patient record.

Headers

URL Parameters

Body Parameters

Delete a patient record.

Headers

URL Parameters

Studies

List studies for a patient.

Headers

URL Parameters

Body Parameters

Create a study for a patient.

Headers

URL Parameters

Body Parameters

Retrieve a single study.

Headers

URL Parameters

Update a study.

Headers

URL Parameters

Body Parameters

Delete a study.

Headers

URL Parameters