Models

Some API operations may return incomplete results that require multiple requests to retrieve the entire dataset. This process of fetching subsequent pages is known as pagination. Pagination is a crucial aspect when dealing with large datasets to ensure efficient data retrieval.

Base model

All entities that are returned by the icometrix API extend the BackendEntity entity. The BaseEntity always has the following properties:

• id: The unique identifier (uuid)

• update_timestamp: The timestamp of the last update

• creation_timestamp: The creation timestamp

• uri: The uri to point to the location of the object

Collections

When fetching a collection of models from the API; you will always get a subset of that collection in combination with some extra meta data. See: Paginators

Relations

High level overview of the relations between the available entities

erDiagram USERS }|--|{ PROJECTS : "has access to" PROJECTS ||--|{ PATIENTS : contains PATIENTS ||--|{ STUDIES : contains STUDIES ||--|{ SERIES : contains SERIES ||--|{ DICOMS : contains STUDIES ||--|{ PIPELINE-RESULTS : has PIPELINE-RESULTS ||--|{ CUSTOMER-RESULTS : has PATIENTS ||--|{ PIPELINE-LONG-RESULTS : has PIPELINE-LONG-RESULTS ||--|{ CUSTOMER-LONG-RESULTS : has STUDIES ||--|| CUSTOMER-REPORTS : has