Study Share Links
The AdvaPACS Integration API allows you to generate secure share links that provide access to imaging studies without requiring users to sign in to AdvaPACS. Share links can be created for a single study or multiple studies belonging to the same patient. These links can be embedded in external applications, such as a Radiology Information System (RIS) or Electronic Medical Record (EMR), or included in radiology reports to provide direct access to the associated imaging studies.
Authentication
Requests to the Study Share API must be authenticated using an AdvaPACS API key with the manageStudy permission.
Include the API key credentials in the Authorization header:
Authorization: Bearer ID=<accessKeyId>,Secret=<accessKeySecret>
Replace <accessKeyId> and <accessKeySecret> with your API key credentials.
Sharing a Single Study
The single-study share endpoint generates a link that provides access to an individual imaging study using its DICOM Study Instance UID. A share link can optionally be password protected, configured with an expiration date, or sent directly to an email address.
API Request
To create a share link for a single study, send an HTTP POST request to:
POST https://<region>.api.integration.advapacs.com/studies/<StudyInstanceUID>/shares
Replace <StudyInstanceUID> with the DICOM Study Instance UID of the study you want to share.
Request Parameters
The following parameters can be included in the JSON request body:
| Field | Required | Description |
|---|---|---|
viewer | Yes | Viewer used to open the shared study. Supported values are ADVAVIEW, EUNITY or MEDDREAM. |
password | No | Password required to access the shared study. |
email | No | Email address to which AdvaPACS will send the study share link. |
expiresAt | No | Expiration date and time in ISO 8601 format, including timezone information. If omitted, the link does not expire. |
The following example creates a password-protected share link that opens in AdvaView and expires on 31 December 2026.
{
"viewer": "ADVAVIEW",
"password": "ExamplePassword123",
"expiresAt": "2026-12-31T23:59:59Z"
}
API Response
When a share is successfully created, the API returns a JSON object containing the share details.If an email address was not specified, the response also includes the share token and URL.
{
"share": {
"id": "01a0362e-f2fc-7bf8-a6c1-10433efa0f0d",
"expiresAt": "2026-12-31T23:59:59Z",
"email": "",
"viewer": "ADVAVIEW",
"revokedAt": "",
"createdAt": "2026-10-14T10:02:11Z",
"hasPassword": true
},
"token": "<share-token>",
"url": "https://<tenant>.advapacs.com/Studies/Share?token=<share-token>"
}
The url field contains the share link, which can be embedded in an external application or provided directly to the recipient.
When the email parameter is specified, AdvaPACS sends the share link directly to the recipient. The share URL and token are not returned in the API response.
Sharing Multiple Studies
The multi-study share endpoint allows you to generate a single share link that provides access to multiple imaging studies belonging to the same patient. This is particularly useful when generating radiology reports that reference multiple examinations, allowing users to open all associated studies from a single link. Studies can be identified using either of the following methods:
- Patient ID and Accession Numbers – Identify a patient and specify one or more accession numbers to include in the share.
- Study Instance UIDs – Specify one or more DICOM Study Instance UIDs directly.
All studies included in a multi-study share must belong to the same patient. Requests containing studies from multiple patients will be rejected.
API Request
To create a multi-study share, send an HTTP POST request to:
POST https://<region>.api.integration.advapacs.com/studies/shares
The request body must include a viewer and one of the supported study identification methods.
Request Parameters
The following parameters can be included in the JSON request body:
| Field | Required | Description |
|---|---|---|
viewer | Yes | Viewer used to open the shared studies. Supported values are ADVAVIEW, EUNITY and MEDDREAM. |
patientId | Conditional | Patient ID associated with the studies. Must be provided with accessionNumbers. |
accessionNumbers | Conditional | Array of accession numbers to include in the share. Must be provided with patientId. |
studyInstanceUids | Conditional | Array of DICOM Study Instance UIDs. Used instead of patientId and accessionNumbers. |
dataSetId | No | UUID of the data set to restrict study lookup to. |
expiresAt | No | Expiration date and time in ISO 8601 format, including timezone information. Must be in the future. If omitted, the link does not expire. |
password | No | Optional password required to access the shared studies. |
Using Patient ID and Accession Numbers
When using this method, provide the Patient ID and an array containing one or more Accession Numbers. Patient IDs and Accession Numbers can be supplied as plain values or with issuer information using HL7 identifier formats.
| Identifier | Supported Format | Example |
|---|---|---|
| Patient ID | Plain ID or HL7 CX | 12345^^^HOSP^MR |
| Accession Number | Plain value or HL7 EI | ACC001^HOSP |
If a Patient ID issuer is not specified, the default issuer associated with the API key is used. For Accession Numbers, the issuer is taken from the first accession number that includes one. If none are specified, the API key's default issuer is used.
The following example generates a share link for two studies associated with patient 12345, opening them in AdvaView.
{
"viewer": "ADVAVIEW",
"patientId": "12345^^^HOSP^MR",
"accessionNumbers": [
"ACC001",
"ACC002"
],
"expiresAt": "2026-12-31T23:59:59+10:00"
}
Using Study Instance UIDs
Alternatively, studies can be selected directly using their DICOM Study Instance UIDs. This method does not require a Patient ID or Accession Numbers.
For example, the following request will generate a study link for studies with StudyInstanceUids 1.2.840.1.1 and 1.2.840.1.2:
{
"viewer": "ADVAVIEW",
"studyInstanceUids": [
"1.2.840.1.1",
"1.2.840.1.2"
]
}
AdvaPACS will identify the specified studies and generate a single share link, provided all matched studies belong to the same patient.
API Response
A successful request returns 200 OK with the share details, a unique token, the share URL, and the Study Instance UIDs of the matched studies.
For example:
{
"share": {
"id": "3c1f2a9e-7b4d-4c8e-9f21-0a6b5d4e3c21",
"viewer": "ADVAVIEW",
"expiresAt": "2026-12-31T23:59:59+10:00",
"createdAt": "2026-10-14T10:02:11+10:00",
"hasPassword": false
},
"token": "<share-token>",
"url": "https://<tenant>.advapacs.com/Studies/Share?token=<share-token>",
"studyInstanceUid": [
"1.2.840.1.1",
"1.2.840.1.2"
]
}
The response contains the following fields:
| Field | Description |
|---|---|
share.id | Unique identifier for the generated study share. |
share.viewer | Viewer configured for the study share. |
share.expiresAt | Expiration date and time, if configured. |
share.createdAt | Date and time the share was created. |
share.hasPassword | Indicates whether the share is password protected. |
share.issuerOfPatientId | Patient ID issuer associated with the share, where applicable. |
share.issuerOfAccessionNumber | Accession Number issuer associated with the share, where applicable. |
token | Unique token generated for the share. |
url | URL used to access the shared studies. |
studyInstanceUid | Array of Study Instance UIDs included in the share. |
Security Considerations
Study share links provide access to patient imaging information and must be treated as sensitive.
When implementing study sharing in an external application:
- Store API credentials securely and restrict access to trusted backend services.
- Use password protection when additional access security is required.
- Configure an expiration date where long-term access is unnecessary.
- Avoid including share tokens in application logs or other publicly accessible locations.
- Only distribute share links to authorised recipients.
Anyone with a valid share link may be able to access the associated imaging studies without signing in to AdvaPACS. Use password protection and expiration dates where appropriate.