API Token Generation
Get A Launch URL
AdvaPACS provides an API that can be used to return a fully formed URL to launch a particular study or studies in MedDream.
The returned URL can then be simply launched in a web browser to display the images.
Authentication
As a prerequisite, an AdvaPACS API key must be generated with the Generate MedDream Token
permission.
Provide the Access Key ID and Access Key Secret via the Authorization
header of the HTTP request in this format:
Authorization: ID=<Access Key ID>,Secret=<Access Key Secret>
For example:
Authorization: ID=991004a2dfb04faead9e30e0eb66e186,Secret=XzzxHuSfPm76PVNSd+v1Sk69yb+YGtDlc
API Request
POST https://<region>.api.integration.advapacs.com/viewer/launch
The request shall have a JSON body.
To launch via a combination of Patient ID and Accession Number(s)
{
"viewer": "meddream",
"patientId": "ABC123",
"accessionNumber": ["1", "2", "3"],
"username": "example.user"
}
To launch via Study Instance UID(s)
{
"viewer": "meddream",
"studyInstanceUid": ["1.2.3"],
"username": "example.user"
}
note
The username must be a valid AdvaPACS username with permission to access MedDream.
API Response
{
"url": "https://<region>.meddream.advapacs.com/?token=eyJhbGciOiJIU..._FKK0lmU5nQ"
}