Study Share Links

AdvaPACS provides an API endpoint for generating secure study share links. This allows external applications to provide access to a specific imaging study without requiring the recipient to sign in to AdvaPACS.

Study shares can be created for the eUnity or MedDream viewer and can optionally be protected with a password, sent directly to an email address, and configured to expire at a specified date and time.

Authentication

Requests to the Study Share API must be authenticated using an AdvaPACS API key. The API key must have permission to generate study shares. Include the API key credentials in the Authorization header using the following format:

Authorization: ID=<Access Key ID>,Secret=<Access Key Secret>

Example:

Authorization: ID=991004a2dfb04faead9e30e0eb66e186,Secret=XzzxHuSfPm76PVNSd+v1Sk69yb+YGtDlc

Keep the access key secret secure. It should only be stored in trusted backend systems and should not be exposed in client-side applications, browser code, or public repositories.

API Request

Study share links are generated for a specific study using its Study Instance UID.

Requests must be submitted as JSON using an HTTP POST request to:

https://<region>.api.integration.advapacs.com/studies/<StudyInstanceUID>/shares

For example:

POST /studies/2.25.124276541956949134084802148533099360891/shares
Host: <region>.api.integration.advapacs.com
Authorization: ID=<Access Key ID>,Secret=<Access Key Secret>
Accept: application/json
Content-Type: application/json

{
  "viewer": "EUNITY"
}

The viewer field determines which viewer is used to open the shared study. Set this to EUNITY for eUnity or MEDDREAM for MedDream. The request can also include an optional password, email address, and expiry time:

{
  "viewer": "EUNITY",
  "password": "ABCDEFG",
  "email": "recipient@example.com",
  "expiresAt": "2026-09-01T00:00:00Z"
}

The following arameters are supported:

Field	Required	Description
viewer	Yes	Viewer used to open the shared study. Supported values are EUNITY and MEDDREAM.
password	No	Password used to protect the study share. The recipient must enter this password before accessing the shared study.
email	No	Email address to send the study share to. When specified, AdvaPACS sends the study share directly to this address.
expiresAt	No	Date and time at which the share expires, provided as an ISO 8601 timestamp.

Note

If email is specified, AdvaPACS sends the study share directly to the supplied email address. In this case, the share URL is not returned in the API response.

API Response

If the request is successful, the API returns a JSON object containing information about the generated study share.

When an email address is not specified, the response also includes the token and URL that can be used to access the shared study.

{
  "share": {
    "id": "01a0362e-f2fc-7bf8-a6c1-10433efa0f0d",
    "expiresAt": "",
    "email": "",
    "viewer": "EUNITY",
    "revokedAt": "",
    "createdAt": "2026-08-24T23:50:41.662356Z",
    "hasPassword": true
  },
  "token": "<Study Share Token>",
  "url": "https://<tenant>.advapacs.com/Studies/Share?token=<Study Share Token>"
}

The response contains the following fields:

Field	Description
share.id	Unique identifier for the generated study share.
share.expiresAt	Date and time at which the share expires. This is empty if no expiry was specified.
share.email	Email address the share was sent to. This is empty if no email address was specified.
share.viewer	Viewer configured for the study share. This will be EUNITY or MEDDREAM.
share.revokedAt	Date and time at which the share was revoked. This is empty for an active share that has not been revoked.
share.createdAt	Date and time at which the study share was created.
share.hasPassword	Indicates whether the study share is protected by a password.
token	Secure token generated for the study share.
url	URL that can be provided to the recipient to access the shared study.

When a url is returned, it can be opened in a supported web browser to access the shared study using the viewer specified in the request. If the share is password protected, the recipient will be prompted to enter the configured password before the study can be accessed.

If an email address was specified when creating the share, AdvaPACS sends the share link directly to the recipient and the url is not returned in the API response.

Important

Study share URLs and tokens provide access to patient imaging and should be treated as sensitive information.