Ambra Health

Ambra Health (now part of Intelerad Medical Systems, and rebranded as InteleShare) is a cloud-based medical image management, exchange, and interoperability platform - a cloud VNA and PACS that lets healthcare providers, patients, and researchers store, view, route, and share diagnostic imaging in real time without a VPN or CD. Its imaging data is DICOM, and its v3 Services Public API (historically the DICOM Grid API) exposes programmatic control over studies, patients, users, groups, accounts, namespaces, sharing, storage/images, and webhooks. The REST API is JSON over HTTPS and is authenticated with a session id (sid) obtained from /session/login. Intelerad acquired Ambra Health in 2021 to form a $1.7B cloud PACS and enterprise-imaging leader.

10 APIs 0 Features
Medical ImagingDICOMHealthcarePACSImage ExchangeInteroperabilityVNACloud Imaging

APIs

Ambra Health Session API

Authenticate against the Ambra Health / InteleShare v3 Services API. Log in with credentials to obtain a session id (sid), inspect the current user and their account permissions...

Ambra Health Studies API

The core imaging surface. Add, list (with filtering, sorting, and pagination), get, update, and delete DICOM studies; approve or reject pending studies; push studies to external...

Ambra Health Patients API

Manage patient records that studies attach to - add, get, update, delete, and list patients, list a patient's studies, and merge duplicate patient records into a single consolid...

Ambra Health Users API

Administer platform users - add, get, update, delete, and invite users, list the namespaces a user can reach, and manage user API tokens for programmatic access.

Ambra Health Groups API

Organize users into groups - a group is a namespace that owns studies and members. Create, list, update, and delete groups and add users to them to control who can access which ...

Ambra Health Accounts API

The top-level tenant. List and get accounts, update account settings and sharing configuration, and manage the users attached to an account - add, list, and remove account members.

Ambra Health Namespaces API

Namespaces (accounts and groups) are the containers that own studies and grant access. Read namespace permissions, settings, and info, and pull the namespace-level audit log to ...

Ambra Health Sharing API

Ambra's signature image-exchange capability. Share a study with other users, groups, or accounts, list the active shares on a study, revoke a share, and share saved filters - en...

Ambra Health Storage and Images API

The pixel-and-metadata layer. Load DICOM metadata into a study, list and get DICOM data, and create and list frame-level image annotations. The companion Storage API handles the...

Ambra Health Webhooks API

Register HTTP callbacks that Ambra invokes when platform events occur (such as study activity). List, add, update, and delete webhooks and inspect webhook events. Delivery is se...

Collections

Pricing Plans

Rate Limits

Ambra Health Rate Limits

4 limits

RATE LIMITS

FinOps

Resources

🔗
DomainSecurity
DomainSecurity
🔑
Authentication
Authentication
👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Ambra Health (InteleShare) v3 Services Public API
  version: '1.0'
  description: Programmatic control of the Ambra Health / InteleShare cloud medical image platform (historically the DICOM
    Grid API). Base URL https://access.dicomgrid.com/api/v3 (access.ambrahealth.com is an alias). JSON over HTTPS; authenticate
    with POST /session/login to obtain a session id (sid) supplied via the X-AmbraHealth-SID header or the sid parameter.
    Ambra Health is part of Intelerad Medical Systems.
request:
  auth:
    type: apikey
    apikey:
      key: X-AmbraHealth-SID
      value: '{{sid}}'
      in: header
items:
- info:
    name: Session
    type: folder
  items:
  - info:
      name: Login (obtain sid)
      type: http
    http:
      method: POST
      url: https://access.dicomgrid.com/api/v3/session/login
      body:
        type: json
        data: '{"login":"user@example.com","password":""}'
    docs: Authenticate with credentials to obtain a session id (sid) used to authorize subsequent calls.
  - info:
      name: Current user
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/session/user
    docs: Retrieve the current session user.
  - info:
      name: Permissions
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/session/permissions
    docs: Get the user's permissions for an account.
  - info:
      name: Logout
      type: http
    http:
      method: POST
      url: https://access.dicomgrid.com/api/v3/session/logout
    docs: End the current session.
  - info:
      name: Bundle (batch calls)
      type: http
    http:
      method: POST
      url: https://access.dicomgrid.com/api/v3/bundle
      body:
        type: json
        data: '[{"URL":"/study/list","inherit_sid":1},{"URL":"/patient/list","inherit_sid":1}]'
    docs: Run a JSON array of calls sequentially in a single request; inherit_sid shares the session across bundled calls.
- info:
    name: Studies
    type: folder
  items:
  - info:
      name: List studies
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/study/list
      params:
      - name: page.rows
        value: '25'
        type: query
        description: Rows per page.
      - name: page.number
        value: '1'
        type: query
        description: Page number.
    docs: List studies with filtering (filter.FIELD.CONDITION), sorting, and pagination.
  - info:
      name: Get study
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/study/get
      params:
      - name: uuid
        value: ''
        type: query
        description: Study uuid.
    docs: Retrieve a study by uuid.
  - info:
      name: Add study
      type: http
    http:
      method: POST
      url: https://access.dicomgrid.com/api/v3/study/add
      body:
        type: json
        data: '{"namespace_id":"","study_description":"","modality":"CT"}'
    docs: Add a study.
  - info:
      name: Share study
      type: http
    http:
      method: POST
      url: https://access.dicomgrid.com/api/v3/study/share
      body:
        type: json
        data: '{"uuid":"","account_id":"","message":"Please review"}'
    docs: Share a study with a user, group, or account (Ambra's image-exchange capability).
  - info:
      name: Study audit trail
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/study/audit
      params:
      - name: uuid
        value: ''
        type: query
        description: Study uuid.
    docs: Get a study's audit trail.
- info:
    name: Patients
    type: folder
  items:
  - info:
      name: List patients
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/patient/list
    docs: List patients.
  - info:
      name: Patient studies
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/patient/study/list
      params:
      - name: uuid
        value: ''
        type: query
        description: Patient uuid.
    docs: List a patient's studies.
  - info:
      name: Merge patients
      type: http
    http:
      method: POST
      url: https://access.dicomgrid.com/api/v3/patient/merge
      body:
        type: json
        data: '{"uuid":"","merge_uuid":""}'
    docs: Merge duplicate patient records into a single record.
- info:
    name: Users & Groups
    type: folder
  items:
  - info:
      name: Add user
      type: http
    http:
      method: POST
      url: https://access.dicomgrid.com/api/v3/user/add
      body:
        type: json
        data: '{"email":"user@example.com","first":"","last":""}'
    docs: Add a user.
  - info:
      name: List groups
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/group/list
    docs: List groups.
  - info:
      name: Add user to group
      type: http
    http:
      method: POST
      url: https://access.dicomgrid.com/api/v3/group/user/add
      body:
        type: json
        data: '{"uuid":"","user_id":""}'
    docs: Add a user to a group.
- info:
    name: Accounts & Namespaces
    type: folder
  items:
  - info:
      name: List accounts
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/account/list
    docs: List accounts.
  - info:
      name: Namespace info
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/namespace/info
      params:
      - name: uuid
        value: ''
        type: query
        description: Namespace uuid.
    docs: Get namespace info.
  - info:
      name: Namespace audit
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/namespace/audit
      params:
      - name: uuid
        value: ''
        type: query
        description: Namespace uuid.
    docs: Get the namespace audit log.
- info:
    name: Storage & Images
    type: folder
  items:
  - info:
      name: List DICOM data
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/dicomdata/list
      params:
      - name: study_id
        value: ''
        type: query
        description: Study id.
    docs: List DICOM data for a study.
  - info:
      name: List annotations
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/annotation/list
      params:
      - name: study_id
        value: ''
        type: query
        description: Study id.
    docs: List frame-level image annotations.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: List webhooks
      type: http
    http:
      method: GET
      url: https://access.dicomgrid.com/api/v3/webhook/list
    docs: List webhooks.
  - info:
      name: Add webhook
      type: http
    http:
      method: POST
      url: https://access.dicomgrid.com/api/v3/webhook/add
      body:
        type: json
        data: '{"namespace_id":"","url":"https://example.com/hook","event":"study.arrived","enabled":true}'
    docs: Create a webhook. Delivery is outbound HTTP POST to your endpoint, not a WebSocket.