logo
API docs by Redocly

LifeOmic API (1.0.0)

Download OpenAPI specification:Download

URL: https://lifeomic.com/contact/ License: MIT Terms of Service
Visit the LifeOmic Developer Center

LifeOmic API

The LifeOmic Platform is an API-first design. You can use the LifeOmic API to programmatically control all of the features of the platform. This public API powers all of the LifeOmic client applications, including the LifeOmic mobile app and the LifeOmic Platform web application.

You can build your own third-party applications around the LifeOmic health-focused APIs in the same manner that you can build a communication app around Twilio APIs. LifeOmic has helped several customers use the LifeOmic API as a Platform as a Service (PaaS). Contact LifeOmic to set up credentials for your app.

API Key

The simplest way for a developer to make API calls is to use an API key. See the Getting Started Guide for instructions on how to create an API key. After creating an API key, it can be provided via the Authorization HTTP header in the same fashion as the access tokens.

LifeOmic API Details

Visit the Developer Center for more information on the LifeOmic API:

Authentication

Supports OAuth 2.0 operations that do not require authentication

SAML metadata

Fetches the Service Provider SAML metadata for the LifeOmic platform. This operation does not require authentication.

Responses

Request samples 

curl -X GET https://api.us.lifeomic.com/v1/saml/metadata

authorize user sign-in

Displays a sign-in view for users. On successful sign-in, the authentication server redirects back to the value specified in the redirect_uri parameter and includes either the requested authorization code or access tokens. This operation does not require authentication.

query Parameters
response_type
required
string
Enum: "code" "token"

The response type. Must be code or token. Indicates whether the client wants an authorization code (authorization code grant flow) for the end user or directly issues tokens for end user (implicit flow).

client_id
required
string

The Client ID. Must be a pre-registered client for the LifeOmic Platform.

redirect_uri
required
string

The URL to which the authentication server redirects the browser after authorization has been granted by the user. Must have been pre-registered with a client.

state
string

An opaque value the clients add to the initial request. The authorization server includes this value when redirecting back to the client.

scope
string

Scopes must be separated by spaces. If the client doesn't request any scopes, the authentication server uses all scopes associated with the client. An ID token is only returned if openid scope is requested. The phone, email, and profile scopes can only be requested if openid scope is also requested. These scopes dictate the claims that go inside the ID token.

code_challenge_method
string
Value: "S256"

The method used to generate the challenge for PKCE. Currently only S256 is supported.

code_challenge
string

The code challenge for PKCE derived from the code verifier.

Responses

Request samples 

curl -X GET https://api.us.lifeomic.com/v1/oauth/authorize?response_type=code&client_id=string&redirect_uri=string

authorize access token

For the authorization code flow, this allows a client to exchange an authorization code for an access token. This operation does not require authentication.

header Parameters
Authorization
required
string

If the client was issued a secret, the client must pass its client_id and client_secret in the authorization header through Basic HTTP authorization. The secret is Basic Base64Encode(client_id:client_secret).

Request Body schema: application/x-www-form-urlencoded
grant_type
required
string
Enum: "authorization_code" "refresh_token"

The grant type.

client_id
required
string

The client ID. Must be a preregistered client.

code
string

The authorization code. Required if grant_type is authorization_code.

redirect_uri
string

Must be the same redirect_uri that was used to get authorization_code in /oauth/authorize. Required only if grant_type is authorization_code.

refresh_token
string

The refresh token. Required if grant_type is refresh_token.

code_verifier
string

The proof key. Required if grant_type is authorization_code and the authorization code was requested with PKCE.

Responses

Request samples 

# You can also use wget
curl -X POST https://api.us.lifeomic.com/v1/oauth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  -H 'Authorization: string'

Response samples

Content type
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "id_token": "string",
  • "token_type": "string",
  • "expires_in": 0
}

Cohorts

Supports operations for a subset of patients from a LifeOmic Platform project.

To learn about the service as implemented in the LifeOmic Platform web app, see the Cohorts Overview.

Get cohorts.

Returns a list of cohorts that the user has access to.

Authorizations:
Oauth2api-key
query Parameters
projectId
required
string

The ID of the project to search within for cohorts.

name
string

Only return cohorts that have a name that starts with the given value.

pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Create a cohort

Create a cohort, representing a subset of a project based on one or more queries

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
name
required
string
description
string
ownerProject
required
string
required
Array of objects (CohortQuery)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "ownerProject": "string",
  • "queries": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "ownerProject": "string",
  • "resultCount": 0,
  • "creatorUser": "string",
  • "creationTime": "string",
  • "queries": [
    ]
}

Get a cohort.

Returns a cohort.

Authorizations:
Oauth2api-key
path Parameters
cohortId
required
string

The cohort id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "ownerProject": "string",
  • "resultCount": 0,
  • "creatorUser": "string",
  • "creationTime": "string",
  • "queries": [
    ]
}

Update a cohort.

Returns the updated cohort.

Authorizations:
Oauth2api-key
path Parameters
cohortId
required
string

The cohort id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
name
required
string
description
string
ownerProject
required
string
required
Array of objects (CohortQuery)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "ownerProject": "string",
  • "queries": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "ownerProject": "string",
  • "resultCount": 0,
  • "creatorUser": "string",
  • "creationTime": "string",
  • "queries": [
    ]
}

Content Entity

Supports Content Entity operations on the LifeOmic Platform

Content Entity operations take place on https://apps.us.lifeomic.com/api/v2/content.

Get content entity

Returns the entity object.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "entityId": "string",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "account": "string",
  • "scope": "account",
  • "displayName": "string",
  • "contentType": "audio",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
  • "fetchRoute": "http://example.com"
}

Create content entity.

Creates an entity, returning the entity object.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "entityId": "string",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "account": "string",
  • "scope": "account",
  • "displayName": "string",
  • "contentType": "audio",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
  • "fetchRoute": "http://example.com"
}

Update content entity.

Updates an entity, returning the entity object.

Authorizations:
Oauth2api-key
path Parameters
entityId
required
string

The entityId.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "entityId": "string",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "account": "string",
  • "scope": "account",
  • "displayName": "string",
  • "contentType": "audio",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
  • "fetchRoute": "http://example.com"
}

Delete content entity.

Delete an entity.

Authorizations:
Oauth2api-key
path Parameters
entityId
required
string

The entityId.

query Parameters
hard
boolean
Default: false

Force hard delete

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Share content entity.

Share content entity by entityId.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "username_entityId": "string",
  • "entityId": "string",
  • "type": "owner"
}

Unshare content entity.

Unshare content entity by entityId.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
null

Get acl by type and entity id.

Get an acl.

Authorizations:
Oauth2api-key
path Parameters
type
required
string
Enum: "owner" "shared" "view"

The acl type

entityId
required
string

The entityId.

query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "username_entityId": "string",
  • "entityId": "string",
  • "type": "owner"
}

Get content entity by owner scoped to a project

Returns the entity object.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

The LifeOmic project.

query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get content entity by user

Returns the entity objects.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

The LifeOmic project.

query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Create content entity assignment.

Creates an entity assignment, returning the entity assignment object.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ownerId": "string",
  • "entityId": "string",
  • "assigneeLrn": "string",
  • "lastModified": "2019-08-24T14:15:22Z"
}

Get content entity assignment

Returns the entity assignment object.

Authorizations:
Oauth2api-key
path Parameters
assignmentId
required
string

Content entity assignment identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ownerId": "string",
  • "entityId": "string",
  • "assigneeLrn": "string",
  • "lastModified": "2019-08-24T14:15:22Z"
}

Update content entity assignment.

Updates an entity assignment, returning the entity assignment object.

Authorizations:
Oauth2api-key
path Parameters
assignmentId
required
string

Content entity assignment identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ownerId": "string",
  • "entityId": "string",
  • "assigneeLrn": "string",
  • "lastModified": "2019-08-24T14:15:22Z"
}

Delete content entity assignment.

Delete an entity assignment.

Authorizations:
Oauth2api-key
path Parameters
assignmentId
required
string

The entity assignment identifier.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "lastModified": "2019-08-24T14:15:22Z"
}

Get content entity assignments by owner scoped to a project

Returns the entity assignment object.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

The LifeOmic project.

query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get content entity assignments by user

Returns the entity assignment object.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

The LifeOmic project.

query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Initiate content conversion for video content

Starts the process of converting video file to stream format.

Authorizations:
Oauth2api-key
path Parameters
entityId
required
string

The entityId.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{ }

Retrieve the video content fetch route

After video conversion has completed then the fetch route is available

Authorizations:
Oauth2api-key
path Parameters
project
required
string <uuid>

The LifeOmic project id.

serviceId
required
string <uuid>

The service id returned from CreateEntity.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Lifeomic-User
required
string

The LifeOmic user.

Responses

Response samples

Content type
application/json
{
  • "getVideo": {}
}

Content

Supports operations for storing and retrieving course-related and program-related content. For more information, see the Content Service Guide.

List all content items

Lists the content items for your LifeOmic project.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

Only return files in the specified dataset (projectId). See Find Your Project ID.

query Parameters
name
string

Filters the result set by performing a case-insensitive begins with filter on the file name.

orderBy
string
Enum: "name" "size"

Allows one to order the results by file name or by size. Default is to sort by name in ascending order. To sort in descending order, add desc to the end of the value.

pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location 'https://api.us.lifeomic.com/v1/content/<projectId>/content' \
--header 'LifeOmic-Account: <account-id>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <api-key>'

Response samples

Content type
application/json
{
  • "items": {
    }
}

Create a content item

Create a content item. If an id is not supplied by the user, a unique id is assigned with the response. This id is the contentId you need for future operations.

Authorizations:
Oauth2api-key
query Parameters
projectId
required
string

Only return files in the specified dataset (projectId). See Find Your Project ID.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
string (id)

Content ID

project
required
string (project)

Project with which content is associated

displayName
required
string (displayName)

Human readable name for content

type
required
string (type)

Type of content

language
string (language)

Primary language for the content

object (fields)

Content fields

tags
Array of strings (tags)

Descriptive tags for the content

slug
required
string (slug) ^[a-zA-Z0-9-\/]+$

Slug to identify content

object (meta)

Additional data describing the content

public
boolean (public)

Should the content be made public

keyPath
string (keyPath) ^(?!\/)[a-z0-9-/]+$

Key path to designate path of nested content

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "project": "string",
  • "displayName": "string",
  • "type": "string",
  • "language": "string",
  • "fields": {
    },
  • "tags": [
    ],
  • "slug": "string",
  • "meta": { },
  • "public": true,
  • "keyPath": "string"
}

Response samples

Content type
application/json
{
  • "id": "8256efc4-116f-4063-bd6b-6d63b4ad8b56",
  • "project": "<projectId>",
  • "displayName": "Test Course",
  • "type": "course",
  • "slug": "1defb12c-daae-42f2-b13c-b9d010ef8c00",
  • "status": "draft",
  • "isDirty": true,
  • "lastModified": "2023-06-20T14:57:52.066Z",
  • "account": "<account-name>",
  • "fileAttachments": [ ],
  • "contentAttachments": [ ]
}

List a specific content item

Lists a specific content item.

Authorizations:
Oauth2api-key
path Parameters
contentId
required
string

Specifies the content item. Found in the list all content response as the id value.

projectId
required
string

Only return files in the specified dataset (projectId). See Find Your Project ID.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location https://api.us.lifeomic.com/v1/content/<projectId>/content/<contentId>' \
--header 'LifeOmic-Account: <account-id>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <api-key>'

Response samples

Content type
application/json
{
  • "id": "<contentId>",
  • "project": "<projectId>",
  • "displayName": "Test Course",
  • "type": "course",
  • "fields": {
    },
  • "slug": "1defb12c-daae-42f2-b13c-b9d010ef8c99",
  • "status": "published",
  • "isDirty": false,
  • "version": 1687963272285,
  • "parentVersion": "1defb12c-daae-42f2-b13c-b9d010ef8c99:1687448761669",
  • "lastModified": "2023-06-28T14:41:12.285Z",
  • "publishDate": "2023-06-28T14:41:12.285Z",
  • "account": "<accountName>",
  • "fileAttachments": [
    ],
  • "contentAttachments": [ ]
}

Delete a content item

Deletes the content item specified with the content id.

Authorizations:
Oauth2api-key
path Parameters
contentId
required
string

The content item id.

query Parameters
projectId
required
string

Only return files in the specified dataset (projectId). See Find Your Project ID.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location --request DELETE 'https://api.us.lifeomic.com/v1/content/{projectId}/content/{contentId}' \
--header 'LifeOmic-Account: {account-id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api-key}'

Response samples

Content type
application/json
null

Demote content to draft

You demote content from publish state to draft state with this POST call.

Authorizations:
Oauth2api-key
path Parameters
contentId
required
string

Specifies the content item. Found in the list all content response as the id value.

projectId
required
string

Only return files in the specified dataset (projectId). See Find Your Project ID.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location --request POST 'https://api.us.lifeomic.com/v1/content/<projectId>/content/<contentId>/draft' \
--header 'LifeOmic-Account: <account-id>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <api-key>'

Response samples

Content type
application/json
{
  • "id": "contentId",
  • "project": "projectId",
  • "displayName": "Test Course",
  • "type": "course",
  • "fields": {
    },
  • "slug": "1defb12c-daae-42f2-b13c-b9d010ef8c99",
  • "status": "draft",
  • "isDirty": false,
  • "version": 1687448761669,
  • "lastModified": "2023-06-20T14:29:54.662Z",
  • "publishDate": "2023-06-22T15:46:01.669Z",
  • "account": "account-name"
}

Promote content to publish

You promote content from draft state to publish state with the POST call. Content is created with a default status of draft.

Authorizations:
Oauth2api-key
path Parameters
contentId
required
string

Specifies the content item. Found in the list all content response as the id value.

projectId
required
string

Only return files in the specified dataset (projectId). See Find Your Project ID.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location --request POST 'https://api.us.lifeomic.com/v1/content/<projectId>/content/<contentId>/publish' \
--header 'LifeOmic-Account: <account-id>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <api-key>'

Response samples

Content type
application/json
{
  • "id": "contentId",
  • "project": "projectId",
  • "displayName": "Test Course",
  • "type": "course",
  • "fields": {
    },
  • "slug": "1defb12c-daae-42f2-b13c-b9d010ef8c99",
  • "status": "published",
  • "isDirty": false,
  • "version": 1687448761669,
  • "lastModified": "2023-06-20T14:29:54.662Z",
  • "publishDate": "2023-06-22T15:46:01.669Z",
  • "account": "account-name"
}

Attach a file to a course

Attaches a file to a course.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

Only return files in the specified dataset (projectId). See Find Your Project ID.

contentId
required
string

Specifies the content item. Found in the list all content response as the id value.

fileId
required
string

Specifies content file. Found in the list content files response as the id value.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location --request PUT 'https://api.us.lifeomic.com/v1/content/{projectId}/content/{contentId}/file-attachment/{fileId}' \
--header 'LifeOmic-Account: {account-id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api-key}'

Response samples

Content type
application/json
null

List content files

Lists the content files for your LifeOmic project.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

Only return files in the specified dataset (projectId). See Find Your Project ID.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location 'https://api.us.lifeomic.com/v1/content/<projectId>/file' \
--header 'LifeOmic-Account: <account-id>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--data '{"project":"<project-id>","name":"<filename>.<fileformat>"}'

Response samples

Content type
application/json
{
  • "items": {
    }
}

Create a content file

Creates a new file placeholder in the content service. The POST call requires body data in the JSON format. This POST call is the first call in a two call operation for uploading content files. For more information, see Upload a File.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

Only return files in the specified dataset (projectId). See Find Your Project ID.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
string

The file id. If provided on POST, then the id must be a V4 UUID, otherwise the server will create a new UUID for the file.

name
string

The file name.

datasetId
string

The project the file belongs to.

contentType
string

The content type of the file.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "datasetId": "string",
  • "contentType": "string"
}

Response samples

Content type
application/json
{
  • "id": "7c74a8e1-f118-4819-a2f7-04109a892c51,",
  • "name": "test.json,",
  • "datasetId": "ebe1618f-e474-4947-a6d2-18b19fac663a,",
  • "contentType": "application/json,",
  • "userId": "company:joe.smith.com,",
  • "uploadUrl": "https://<presigned-url>"
}

Delete a content file

Deletes the content file specified with the file id.

Authorizations:
Oauth2api-key
path Parameters
fileId
required
string

The content file id

projectId
required
string

Only return files in the specified dataset (projectId). See Find Your Project ID.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location --request DELETE 'https://api.us.lifeomic.com/v1/content/{projectId}/file/{fileId}' \
--header 'LifeOmic-Account: {account-id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api-key}'

Response samples

Content type
application/json
null

Accounts

Supports operations with LifeOmic Platform accounts

Retrieves a list of user accounts.

Returns a list of accounts that the user has access to.

Authorizations:
Oauth2api-key

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ]
}

Creates an account.

Creates an account, returning the account object.

Authorizations:
Oauth2api-key
Request Body schema: application/json
id
string

The account id.

name
string

The account name.

owner
string <email>

The account's owner.

type
string
Enum: "FREE" "PAID" "ENTERPRISE"

The account type.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "owner": "user@example.com",
  • "type": "FREE"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "owner": "user@example.com",
  • "type": "FREE"
}

Retrieves an account.

Retrieves details about an account. Returns the account object.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The account id.

query Parameters
include
string
Value: "groups"

Include additional information like the user's groups.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "owner": "user@example.com",
  • "type": "FREE"
}

Updates an account.

Update an account by changing the name or clearing out a pending deletion date. Returns the account object.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The account id.

Request Body schema: application/json
name
string

The account name.

deletionDate
string

The account's deletion date. Set to null on a PATCH request to cancel a pending deletion.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "deletionDate": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "owner": "user@example.com",
  • "type": "FREE"
}

Deletes an account.

Deletes an account. By default, the account will not be deleted for 14 days. During this time, the pending deletion can be cancelled by using the PATCH method. After the 14 day grace period, the account and all of its data will be removed.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The account id.

query Parameters
force
boolean

If true, the 14 day grace period will be ignored and all of the account data will be removed immediately.

Responses

Account Clients

Supports operations for clients belonging to an account

Retrieves a list of accounts.

Returns a list of clients belonging to an account.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The account id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "clients": [
    ]
}

Creates a client.

Create a new client for an account. Returns the client object.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The account id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
string

The client id.

name
string <= 64 characters

The client name.

generateSecret
boolean

If true, a secret will be created for the client.

callbackUrls
Array of strings [ 1 .. 100 ] items

The list of callback URLs allowed for this client.

logoutUrls
Array of strings [ 1 .. 100 ] items

The list of logout allowed for this client.

identityProviders
Array of strings non-empty
Items Enum: "GOOGLE" "LIFEOMIC" "FACEBOOK" "CUSTOM"

The list of identity providers allowed for this client.

allowedOAuthFlows
Array of strings non-empty
Items Enum: "code" "implicit" "client_credentials"

The list of OAuth flows allowed for this client.

object

The custom identity provider to use for this client.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "generateSecret": true,
  • "callbackUrls": [
    ],
  • "logoutUrls": [
    ],
  • "identityProviders": [
    ],
  • "allowedOAuthFlows": [
    ],
  • "customIdentityProvider": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "generateSecret": true,
  • "callbackUrls": [
    ],
  • "logoutUrls": [
    ],
  • "identityProviders": [
    ],
  • "allowedOAuthFlows": [
    ],
  • "customIdentityProvider": {
    }
}

Retrieves a client.

Retrieves an account by clientId.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The account id.

clientId
required
string

The client id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "generateSecret": true,
  • "callbackUrls": [
    ],
  • "logoutUrls": [
    ],
  • "identityProviders": [
    ],
  • "allowedOAuthFlows": [
    ],
  • "customIdentityProvider": {
    }
}

Updates a client.

Updates a client for an account.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The account id.

clientId
required
string

The client id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
string

The client id.

name
string <= 64 characters

The client name.

generateSecret
boolean

If true, a secret will be created for the client.

callbackUrls
Array of strings [ 1 .. 100 ] items

The list of callback URLs allowed for this client.

logoutUrls
Array of strings [ 1 .. 100 ] items

The list of logout allowed for this client.

identityProviders
Array of strings non-empty
Items Enum: "GOOGLE" "LIFEOMIC" "FACEBOOK" "CUSTOM"

The list of identity providers allowed for this client.

allowedOAuthFlows
Array of strings non-empty
Items Enum: "code" "implicit" "client_credentials"

The list of OAuth flows allowed for this client.

object

The custom identity provider to use for this client.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "generateSecret": true,
  • "callbackUrls": [
    ],
  • "logoutUrls": [
    ],
  • "identityProviders": [
    ],
  • "allowedOAuthFlows": [
    ],
  • "customIdentityProvider": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "generateSecret": true,
  • "callbackUrls": [
    ],
  • "logoutUrls": [
    ],
  • "identityProviders": [
    ],
  • "allowedOAuthFlows": [
    ],
  • "customIdentityProvider": {
    }
}

Delete an account client.

Deletes an account client.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The account id.

clientId
required
string

The client id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

APIKey

Supports operations for API keys

To learn about API key implementation on the LifeOmic Platform web app, see API Keys.

Retrieves a list of API Keys.

Returns a list of all API Keys for the logged in user.

Authorizations:
Oauth2api-key
query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Creates an API Key

Create an API Key can that be used in API calls,

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
name
string

the API Key name

expireInDays
number

how long before the API key expires

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expireInDays": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "key": "string",
  • "dateCreated": "string",
  • "dateExpires": "string"
}

Revoke an API Key.

Revokes an API Key immediately.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The API Key id.

Responses

Response samples

Content type
application/json
null

Files

Supports operations for storing and retrieving file data. For a guide to using the file service, see Getting Started with the File Service API.

Retrieves a list of files

Lists the files for your LifeOmic account. Refine your results to a specific project with the datasetId query parameter. For more information, see List Files.

Authorizations:
Oauth2api-key
query Parameters
name
string

Filters the result set by performing a case-insensitive begins with filter on the file name.

orderBy
string
Enum: "name" "size"

Allows one to order the results by file name or by size. Default is to sort by name in ascending order. To sort in descending order, add desc to the end of the value.

pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

datasetId
string

Only return files in the specified dataset (project id).

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location 'https://api.us.lifeomic.com/v1/files?datasetId=<project-id>' \
--header 'LifeOmic-Account: <account-id>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <api-key>'

Response samples

Content type
application/json
{
  • "items": {
    },
  • "links": {
    }
}

Creates a file

Creates and uploads a file. Uploading files is a two call operation. The first call is a POST call for a response that contains the presigned URL. The POST call contains JSON data for the file in the body. The second call is a PUT call to upload the file to the presigned URL. For more information, see Upload Files.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
string

The file id. If provided on POST, then the id must be a V4 UUID, otherwise the server will create a new UUID for the file.

name
string

The file name.

datasetId
string

The project the file belongs to.

contentType
string

The content type of the file.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "datasetId": "string",
  • "contentType": "string"
}

Response samples

Content type
application/json
{
  • "id": "7c74a8e1-f118-4819-a2f7-04109a892c51,",
  • "name": "test.json,",
  • "datasetId": "ebe1618f-e474-4947-a6d2-18b19fac663a,",
  • "contentType": "application/json,",
  • "userId": "company:joe.smith.com,",
  • "uploadUrl": "https://<presigned-url>"
}

Downloads a file

Downloads a file. Add the file id from the general GET files response and the include parameter with the downloadUrl value. The response contains the download url. For more information, see Download Files.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The file id.

query Parameters
include
string
Value: "downloadUrl"

Specifying a value of downloadUrl will return the download URL for the file.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location 'https://api.us.lifeomic.com/v1/files/<file-id>?include=downloadUrl' \
--header 'LifeOmic-Account: <account-id>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <api-key>'

Response samples

Content type
application/json
{
  • "id": "bfdf7716-1088-4021-80b5-ab4badacd081,",
  • "name": "initial_lab_report copy.pdf,",
  • "datasetId": "ebe1618f-e474-4947-a6d2-18b19fac663a,",
  • "size": "138829,",
  • "contentType": "application/pdf,",
  • "lastModified": "2020-11-17T14:35:14.823Z,",
  • "userId": "company:joe.smith@company.com,",
  • "lrn": "lrn:xyz:xyz:company:file:bfdf7716-1088-4021-80b5-ab4badacd081,",
  • "downloadUrl": "https://<presigned-url>"
}

Deletes a file

Deletes the file specified with the file id.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The file id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Request samples 

curl --location --request DELETE 'https://api.us.lifeomic.com/v1/files/<file-id>' \
--header 'LifeOmic-Account: <account-id>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <api-key>'

Response samples

Content type
application/json
null

Groups

Supports operations with groups. To learn about the implementation of groups within the LifeOmic Platform web app, see Groups.

Retrieve a list of groups.

Returns the list of groups for an account.

Authorizations:
Oauth2api-key
query Parameters
name
string

Search for groups whose name starts with the given string.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Retrieve a group by ID.

Returns the group with the given ID.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The group ID to lookup.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "description": "string",
  • "id": "string",
  • "type": "closed"
}

Updates a group.

Updates the group identified by the given ID.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The group ID to modify.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json

The new information for the group.

account
string

The account that owns the group.

description
string

A human readable description of the group.

id
string

The canonical identifier for the group.

type
string
Enum: "closed" "open"

Responses

Request samples

Content type
application/json
{
  • "account": "string",
  • "description": "string",
  • "id": "string",
  • "type": "closed"
}

Response samples

Content type
application/json
{
  • "account": "string",
  • "description": "string",
  • "id": "string",
  • "type": "closed"
}

Retrieve a list of group members

Returns the list of users belonging to the group.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The ID of the group

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Removes a member from a group

Removes the user from a group.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The ID of the group

username
required
string

The user to add to the group

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Invitations

Supports operations to invite users to groups

Retrieves the invitations to or from the session user.

Returns a list of invitations received or sent by the user, depending on parameters.

Authorizations:
Oauth2api-key
query Parameters
user
string

The session user, whose received invitations should be fetched.

account
string

The account in which group invitations sent by the session user should be fetched.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Invites a user to join a group

Sends an email to a user, inviting them to join a group

Authorizations:
Oauth2api-key
Request Body schema: application/json
group
string

The group to which the user should be invited.

email
string

The invitee's email address.

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "account": "string",
  • "accountName": "string",
  • "group": "string",
  • "groupName": "string",
  • "invitorUser": "string",
  • "email": "string",
  • "status": "AWAITING-USER-ACTION",
  • "inviteTimestamp": "string",
  • "expirationTimestamp": "string"
}

Join, reject, or revoke an invitation.

Performs an action on the invitation. If revoking an invitation, the accessAdmin Access Policy Privilege is required

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The invitation ID to modify.

Request Body schema: application/json
status
string
Enum: "ACCEPTED" "REJECTED" "REVOKED"

The new status of the invitation.

Responses

Request samples

Content type
application/json
{
  • "status": "ACCEPTED"
}

Response samples

Content type
application/json
null

Policy

Supports ABAC access control policy operations. For more information about the LifeOmic Platform Access Control, see the Access Control Overview.

Retrieve the current user's ABAC policies

Retrieves the ABAC policies of the user. See our open-sourced implementation of parsing ABAC policies at https://github.com/lifeomic/abac

Authorizations:
Oauth2api-key

Responses

Response samples

Content type
application/json
{
  • "rules": {
    }
}

Retrieves a list of policies.

Retrieves a list of policies for an account.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Creates a policy.

Create a new policy for an account.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account.

Responses

Response samples

Content type
application/json
null

Updates a policy.

Updates a policy for an account.

Authorizations:
Oauth2api-key
path Parameters
policyId
required
string

The policy id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account.

Request Body schema: application/json
name
string

Policy name

object (Policy)

An ABAC policy document.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "policy": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "policy": {
    }
}

Deletes a policy.

Deletes a policy for an account.

Authorizations:
Oauth2api-key
path Parameters
policyId
required
string

The policy id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account.

Responses

Response samples

Content type
application/json
null

Projects

Supports operations with the containers used to store datasets in a LifeOmic Platform account

Retrieves a list of projects.

Returns a list of all projects.

Authorizations:
Oauth2api-key
query Parameters
name
string

Filters the result set by performing a case-insensitive begins with filter on the project name.

pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Creates a project

Creates a project. Some resources refer to projects as datasets. The id of a project should be used whenever a datasetId is needed.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
string

The project id. Some resources use the term dataset to refer to a project. The project id should be used for fields such as datasetId.

name
string

The project name.

deletionDate
string

The project's deletion date. Set to null on a PATCH request to cancel a pending deletion.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "deletionDate": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "deletionDate": "string"
}

Retrieves a project.

Retrieves the details of a project. Returns an project object.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The project id.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "deletionDate": "string"
}

Updates a project.

Updates a project by changing the name or clearing out a pending deletion date.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The project id.

Request Body schema: application/json
id
string

The project id. Some resources use the term dataset to refer to a project. The project id should be used for fields such as datasetId.

name
string

The project name.

deletionDate
string

The project's deletion date. Set to null on a PATCH request to cancel a pending deletion.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "deletionDate": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "deletionDate": "string"
}

Deletes a project.

Deletes a project. By default, the project will not be deleted for 14 days. During this time, the pending deletion can be cancelled by using the PATCH method. After the 14 day grace period, the project and all of its data will be removed.

Authorizations:
Oauth2api-key
path Parameters
id
required
string

The project id.

query Parameters
force
boolean

If true, the 14 day grace period will be ignored and all of the project data will be removed immediately.

Responses

Response samples

Content type
application/json
null

Users

Supports operations for users registered with the LifeOmic Platform

Retrieves the authenticated user

Returns the full profile for the currently authenticated user

Authorizations:
Oauth2api-key

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "profile": {
    }
}

Updates the current user's profile

Updates the authenticated user's profile

Authorizations:
Oauth2api-key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "profile": {
    }
}

Retrieves a user's profile

Returns a users profile. When requesting one's own profile the full profile is returned. Otherwise a limited profile is returned.

Authorizations:
Oauth2api-key
path Parameters
username
required
string

The user to lookup

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "profile": {
    }
}

Retrieves a list of groups that the user is a member of

Returns a list of groups that the user is a member of. This currently only succeeds if a user is asking for their own groups.

Authorizations:
Oauth2api-key
path Parameters
username
required
string

The user to list groups for

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Retrieves metadata for the user's profile picture

Returns profile picture metadata.

Authorizations:
Oauth2api-key
path Parameters
username
required
string

The user to retrieve profile picture information for

Responses

Response samples

Content type
application/json
{
  • "downloadUrl": "string"
}

Updates a user's profile picture

Update a user's profile picture. This only for the currently authorized user using a LifeOmic account.

Authorizations:
Oauth2api-key
path Parameters
username
required
string

The user to update the profile picture for

header Parameters
Content-Type
required
string

The MIME type of the image being uploaded

Content-Length
required
number

The size of the image payload in bytes

Request Body schema: application/json

The binary profile picture content

string <binary>

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "downloadUrl": "string"
}

DSL Analytics

Supports operations with a domain specific language that query the analytics database. For more information, see the Insights API.

Query the analytics databases

Returns the results a query that may span patients, genetic variants, and gene expression data.

Authorizations:
Oauth2api-key
Request Body schema: application/json
Any of
dataset_id
required
string
cohort_id
string
string_query
string
required
object or object (AnalyticsDSL-Query)
evaluate_contract
boolean

Responses

Request samples

Content type
application/json
{
  • "dataset_id": "string",
  • "cohort_id": "string",
  • "string_query": "string",
  • "query": {
    },
  • "evaluate_contract": true
}

Response samples

Content type
application/json
{
  • "data": { }
}

EHRs

Supports operations, such as syncing and ingestion, with Electronic Health Records and the LifeOmic Platform

Get ehrs.

Returns a list of EHRs that the user has access to.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Create an EHR configuration

Create an EHR configuration, which can then be connected to projects and used to sync data from your EHR to the LifeOmic Platform.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
string
name
required
string
ehrType
required
string
Value: "cerbo"
apiBaseUrl
required
string <uri> ^https:\/\/[a-z]+\.md-hq\.com$
apiKey
required
string
apiSecret
required
string
apiAuthType
required
string
Value: "header"
ingestionModel
string
Enum: "ASYNCHRONOUS" "SYNCHRONOUS"
delayBetweenRecords
number <= 3000

Number of milliseconds to pause in between each record during a SYNCHRONOUS ingestion.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ehrType": "cerbo",
  • "apiBaseUrl": "http://example.com",
  • "apiKey": "string",
  • "apiSecret": "string",
  • "apiAuthType": "header",
  • "ingestionModel": "ASYNCHRONOUS",
  • "delayBetweenRecords": 3000
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ehrType": "cerbo",
  • "apiBaseUrl": "http://example.com",
  • "apiKey": "string",
  • "apiSecret": "string",
  • "apiAuthType": "header",
  • "ingestionModel": "ASYNCHRONOUS",
  • "delayBetweenRecords": 3000
}

Get an EHR.

Returns an EHR.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ehrType": "cerbo",
  • "apiBaseUrl": "http://example.com",
  • "apiKey": "string",
  • "apiSecret": "string",
  • "apiAuthType": "header",
  • "ingestionModel": "ASYNCHRONOUS",
  • "delayBetweenRecords": 3000
}

Delete an EHR.

Deletes an EHR.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Update an EHR.

Updates an EHR.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ehrType": "cerbo",
  • "apiBaseUrl": "http://example.com",
  • "apiKey": "string",
  • "apiSecret": "string",
  • "apiAuthType": "header",
  • "ingestionModel": "ASYNCHRONOUS",
  • "delayBetweenRecords": 3000
}

Get list of EHR connectors.

Returns a list of project connectors configured for this EHR.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Create an EHR project connector

Creates an EHR project connector, which represents the ability for this EHR to tie ingested records to the connected project.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
required
string
ehrId
required
string
project
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "ehrId": "string",
  • "project": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "ehrId": "string",
  • "project": "string"
}

Get specific EHR connector.

Returns an EHR project connector.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

connectorId
required
string

The EHR connector id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ehrId": "string",
  • "project": "string"
}

Delete the EHR connector.

Deletes the EHR project connector.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

connectorId
required
string

The EHR connector id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Get EHR ingestions.

Returns a list of EHR ingestions.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Create an EHR ingestion

Creates an EHR ingestion, which represents a synchronization of EHR data to the LifeOmic Platform.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
Array of objects (EHRConnector)

The subset of configured EHR project connectors that should be used for this ingestion.

Array of objects

Individual records to be ingested.

consumePendingUpdates
boolean

Whether or not this ingestion should add pending updates to its records array

Responses

Request samples

Content type
application/json
{
  • "connectors": [
    ],
  • "records": [
    ],
  • "consumePendingUpdates": true
}

Response samples

Content type
application/json
{
  • "connectors": [
    ],
  • "records": [
    ],
  • "consumePendingUpdates": true
}

Get EHR ingestion.

Returns a an EHR ingestions.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

ingestionId
required
string

The EHR ingestion id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get scheduled EHR ingestions.

Returns a list of scheduled EHR ingestions.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Schedule an EHR ingestion

Creates a recurring schedule on which an EHR ingestion should run.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
object (EHRIngestion)
cronExpression
string

Responses

Request samples

Content type
application/json
{
  • "ingestion": {
    },
  • "cronExpression": "string"
}

Response samples

Content type
application/json
{
  • "ingestion": {
    },
  • "cronExpression": "string"
}

Get scheduled EHR ingestion.

Returns a scheduled EHR ingestion.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

scheduledIngestionId
required
string

The scheduled EHR ingestion id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "ingestion": {
    },
  • "cronExpression": "string"
}

Delete the scheduled EHR ingestion.

Deletes the scheduled EHR ingestion.

Authorizations:
Oauth2api-key
path Parameters
ehrId
required
string

The EHR id.

scheduledIngestionId
required
string

The scheduled EHR ingestion id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Search a project's FHIR resources using an expressive DSL

For additional information and examples see the user guide

Authorizations:
Oauth2api-key
path Parameters
project
required
string

The target project identifier

query Parameters
scroll
string

The _scroll_id from the previous request, which should be used to retrieve the next batch of results.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema:
type
required
string
Value: "select"

A DSL Statement Type

required
string or (Array of FHIR-Column (object) or FHIR-Aggregation (object))

The Columns to Select

required
Array of objects (FHIR-Table)

The Table to Target

FHIR-Where (object)
Array of objects or objects = 2 items

The Offset and Limit

Responses

Request samples

Content type
{
  • "type": "select",
  • "columns": "*",
  • "from": [
    ],
  • "where": {
    },
  • "limit": [
    ]
}

Response samples

Content type
application/json
{ }

Search a patient's FHIR resources using an expressive DSL

For additional information and examples see the user guide

Authorizations:
Oauth2api-key
path Parameters
project
required
string

The target project identifier

patient
required
string

The target patient identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema:
type
required
string
Value: "select"

A DSL Statement Type

required
string or (Array of FHIR-Column (object) or FHIR-Aggregation (object))

The Columns to Select

required
Array of objects (FHIR-Table)

The Table to Target

FHIR-Where (object)
Array of objects or objects = 2 items

The Offset and Limit

Responses

Request samples

Content type
{
  • "type": "select",
  • "columns": "*",
  • "from": [
    ],
  • "where": {
    },
  • "limit": [
    ]
}

Response samples

Content type
application/json
{ }

Search a cohort's FHIR resources using an expressive DSL

For additional information and examples see the user guide

Authorizations:
Oauth2api-key
path Parameters
project
required
string

The target project identifier

cohort
required
string

The target cohort identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema:
type
required
string
Value: "select"

A DSL Statement Type

required
string or (Array of FHIR-Column (object) or FHIR-Aggregation (object))

The Columns to Select

required
Array of objects (FHIR-Table)

The Table to Target

FHIR-Where (object)
Array of objects or objects = 2 items

The Offset and Limit

Responses

Request samples

Content type
{
  • "type": "select",
  • "columns": "*",
  • "from": [
    ],
  • "where": {
    },
  • "limit": [
    ]
}

Response samples

Content type
application/json
{ }

Fetch a distinct set of values for a given field belonging to a project's FHIR resources.

Endpoint will programmatically optimize the search query

Authorizations:
Oauth2api-key
path Parameters
project
required
string

The target project identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema:
field
required
string

The field to select

resource
required
string

The resource type to query

FHIR-Where (object)
size
number

Maximum list size to be returned

FHIR-SearchAfter (object)

Responses

Request samples

Content type
{
  • "field": "string",
  • "resource": "string",
  • "where": {
    },
  • "size": 0,
  • "after": {
    }
}

Response samples

Content type
application/json
{ }

Medical Device Firmware

listFirmwareUploads

Authorizations:
(Oauth2api-key)
query Parameters
pageSize
string
nextPageToken
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

createFirmwareUpload

Authorizations:
(Oauth2api-key)
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
name
required
string

A user friendly name for the firmware file

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "uploadUrl": "http://example.com"
}

getFirmwareById

Authorizations:
(Oauth2api-key)
path Parameters
id
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "size": 0,
  • "checksum": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

listFirmwareDeployments

Authorizations:
(Oauth2api-key)
path Parameters
firmwareId
required
string
query Parameters
pageSize
string
nextPageToken
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

createFirmwareDeployment

Authorizations:
(Oauth2api-key)
path Parameters
firmwareId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
required
object

The target configuration for this deployment.

Responses

Request samples

Content type
application/json
{
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firmwareId": "44bbc267-0d43-4d6e-8f0e-67a633a4574d",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "target": {
    },
  • "status": "active",
  • "progress": {
    }
}

updateFirmwareDeployment

Authorizations:
(Oauth2api-key)
path Parameters
firmwareId
required
string
deploymentId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
status
required
string
Value: "cancelled"

Responses

Request samples

Content type
application/json
{
  • "status": "cancelled"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firmwareId": "44bbc267-0d43-4d6e-8f0e-67a633a4574d",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "target": {
    },
  • "status": "active",
  • "progress": {
    }
}

deleteFirmwareDeployment

Authorizations:
(Oauth2api-key)
path Parameters
firmwareId
required
string
deploymentId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{ }

Medical Device Groups

putDeviceGroup

Authorizations:
(Oauth2api-key)
path Parameters
id
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
name
required
string

The name of the group.

project
required
string

The unique identifier of the project the group belongs to.

filter
required
string

The filter that describes the group. Device filters must be a valid STU3 FHIR Device query string.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "project": "string",
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "project": "string",
  • "filter": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

getDeviceGroup

Authorizations:
(Oauth2api-key)
path Parameters
id
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "project": "string",
  • "filter": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

deleteDeviceGroup

Authorizations:
(Oauth2api-key)
path Parameters
id
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{ }

listDeviceGroups

Authorizations:
(Oauth2api-key)
query Parameters
project
required
string

The unique identifier of the project the group belongs to.

pageSize
string
nextPageToken
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

listDevicesInGroup

Authorizations:
(Oauth2api-key)
path Parameters
id
required
string
query Parameters
pageSize
string
nextPageToken
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

getDeviceGroupPreview

Authorizations:
(Oauth2api-key)
query Parameters
pageSize
string
nextPageToken
string
filter
required
string

The filter that describes the group. Device filters must be a valid STU3 FHIR Device query string.

project
required
string

The unique identifier of the project the group belongs to.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Medical Device Provisioning

getClaimById

Authorizations:
(Oauth2api-key)
path Parameters
id
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "certificateId": "string",
  • "name": "string",
  • "projectId": "string"
}

deleteClaim

Authorizations:
(Oauth2api-key)
path Parameters
id
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{ }

listClaims

Authorizations:
(Oauth2api-key)
query Parameters
projectId
string
pageSize
string
nextPageToken
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

createClaim

Authorizations:
(Oauth2api-key)
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
name
required
string
projectId
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "projectId": "string"
}

Response samples

Content type
application/json
{
  • "certificateId": "string",
  • "name": "string",
  • "certificatePem": "string",
  • "privateKey": "string",
  • "publicKey": "string"
}

Search medical services.

Returns a list of NPPES database medical services and/or custom services.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The ID of the project to search within.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
zipCode
required
number (Zip Code) [ 10001 .. 99999 ]
searchRadius
number (Search Radius) [ 0 .. 300 ]
omitNPIRecords
boolean (Omit NPI Records)

Omit NPPES NPI records from the search set and only search custom services

omitCustomServices
boolean (Omit Custom Services)

Omit custom services from the search set and only search NPPES NPI records

pageSize
number (Page Size) [ 1 .. 100 ]
nextPageToken
string (Next Page Token)
taxonomy
required
string (Taxonomy)

Responses

Request samples

Content type
application/json
{
  • "zipCode": 10001,
  • "searchRadius": 300,
  • "omitNPIRecords": true,
  • "omitCustomServices": true,
  • "pageSize": 1,
  • "nextPageToken": "string",
  • "taxonomy": "string"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get NPI service or custom service by ID

Returns a single NPI record or custom service.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The ID of the project to search within.

serviceId
required
string

The ID of the NPI record or custom service

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Update a custom service

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The ID of the project that owns the custom service.

serviceId
required
string

The ID of the custom service

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
serviceId
string (Service ID)

The ID of the custom service or NPI record. If augmenting an NPI record, this service ID should match the NPI number

taxonomy
required
string (Taxonomy)

Either a standard NPPES taxonomy or any custom taxonomy

zipCode
required
number (Zip Code) [ 10001 .. 99999 ]
rank
required
number (Rank)

Rank determines how results are sorted. The higher the rank, the lower index it will be returned in the response list. Ranks of custom services >= 0 are returned before NPPES NPI records. Ranks < 0 are returned after NPPES NPI records.

isNPIRecord
required
boolean (Is NPI Record)

Flag indicating if this service is supposed to augment an NPI record or be a separate custom service.

object (PartialNPIRecord)
additionalProperties
object (Additional Properties)

Any additional properties to associate with an NPI record or custom service

Responses

Request samples

Content type
application/json
{
  • "serviceId": "string",
  • "taxonomy": "string",
  • "zipCode": 10001,
  • "rank": 0,
  • "isNPIRecord": true,
  • "npiRecordOverride": {
    },
  • "additionalProperties": { }
}

Response samples

Content type
application/json
{
  • "serviceId": "string",
  • "taxonomy": "string",
  • "zipCode": 10001,
  • "rank": 0,
  • "isNPIRecord": true,
  • "npiRecordOverride": {
    },
  • "additionalProperties": { }
}

Delete a custom service

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The ID of the project that owns the custom service.

serviceId
required
string

The ID of the custom service

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Create a new custom service

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The ID of the project that owns the custom service.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
serviceId
string (Service ID)

The ID of the custom service or NPI record. If augmenting an NPI record, this service ID should match the NPI number

taxonomy
required
string (Taxonomy)

Either a standard NPPES taxonomy or any custom taxonomy

zipCode
required
number (Zip Code) [ 10001 .. 99999 ]
rank
required
number (Rank)

Rank determines how results are sorted. The higher the rank, the lower index it will be returned in the response list. Ranks of custom services >= 0 are returned before NPPES NPI records. Ranks < 0 are returned after NPPES NPI records.

isNPIRecord
required
boolean (Is NPI Record)

Flag indicating if this service is supposed to augment an NPI record or be a separate custom service.

object (PartialNPIRecord)
additionalProperties
object (Additional Properties)

Any additional properties to associate with an NPI record or custom service

Responses

Request samples

Content type
application/json
{
  • "serviceId": "string",
  • "taxonomy": "string",
  • "zipCode": 10001,
  • "rank": 0,
  • "isNPIRecord": true,
  • "npiRecordOverride": {
    },
  • "additionalProperties": { }
}

Response samples

Content type
application/json
{
  • "serviceId": "string",
  • "taxonomy": "string",
  • "zipCode": 10001,
  • "rank": 0,
  • "isNPIRecord": true,
  • "npiRecordOverride": {
    },
  • "additionalProperties": { }
}

List all custom services

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The ID of the project that owns the custom service.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
pageSize
number (Page Size) [ 1 .. 100 ]
nextPageToken
string (Next Page Token)

Responses

Request samples

Content type
application/json
{
  • "pageSize": 1,
  • "nextPageToken": "string"
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "nextPageToken": "string"
}

OCR

Supports operations for OCR

To learn about the service as implemented in the LifeOmic Platform web app, see OCR Overview.

Create an OCR configuration

Create OCR configuration for a project in the LifeOmic Platform

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic Platform account to access.

Request Body schema: application/json
project
required
string <uuid>

LifeOmic project ID

required
object (OcrConfig)

Responses

Request samples

Content type
application/json
{
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "account": "string",
  • "creatorUser": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "config": {
    }
}

Retrieve OCR configuration for a project

Retrieve the OCR configuration for a project in the LifeOmic Platform

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

LifeOmic project ID

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "account": "string",
  • "creatorUser": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "config": {
    }
}

Update OCR configuration for a project

Update OCR configuration for a project in LifeOmic

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

LifeOmic project ID

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
project
required
string <uuid>

LifeOmic project ID

required
object (OcrConfig)

Responses

Request samples

Content type
application/json
{
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "account": "string",
  • "creatorUser": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "config": {
    }
}

Delete OCR configuration for a project

Delete OCR configuration for a project in LifeOmic

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

LifeOmic project ID

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Create an OCR-document

Create a DocumentReference, representing a PDF file and its OCR pipeline

Authorizations:
Oauth2api-key
query Parameters
analyzeTypes
string

Type of analysis to perform, comma separated string of values 'TABLES', 'FORMS'

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
project
required
string <uuid>

LifeOmic Project identifier

subject
string

Subject identifier of the subject the file should be associated with

fileId
required
string

Identifier of the original file in file-service

externalId
string

External identifier for associating with an external system

Array of objects

Array of FHIR extensions to be attached to the DocumentReference

object or string

Type/Class of document. This value will be applied to all pages.

customPageDate
string

Date of document. This value will be applied to all pages.

Responses

Request samples

Content type
application/json
{
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "subject": "string",
  • "fileId": "string",
  • "externalId": "string",
  • "extensions": [
    ],
  • "customPageClassification": {
    },
  • "customPageDate": "string"
}

Response samples

Content type
application/json
{
  • "documentReferenceId": "string"
}

Re ingest an existing OCR-document

Re process a document, creates a new DocumentReference ID

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project Id

documentReferenceId
required
string <uuid>

DocumentReference identfier

query Parameters
cohort
string <uuid>

Cohort Identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "documentReferenceId": "string"
}

Retrieve a page of the document as an image

Retrieve a document page as an image

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project Id

documentReferenceId
required
string <uuid>

DocumentReference identfier

page
required
integer

Page number

query Parameters
Width
number

Width of cropped image

Height
number

Height of cropped image

Top
number

Top coordinate for crop

Left
number

Left coordinate for crop

Rotate
number

Rotation angle

Quality
number

Expected image quality

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Create concepts from user defined ontologies

Create a list of concepts from user defined ontology file

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project Id

fileId
required
string <uuid>

File-service identifier of file to be processed

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "documentReferenceId": "string"
}

Return defined ontologies in current project

Retrieve a list of user defined ontology concepts

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project Id

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "project": "string",
  • "account": "string",
  • "fileId": "string",
  • "user": "string",
  • "systems": [
    ],
  • "ontologyIds": [
    ],
  • "created": "string",
  • "fileName": "string",
  • "version": "string"
}

Retrieve an ontology template as an Excel spreadsheet

Retrieve a template file for OCR ontology

Authorizations:
Oauth2api-key

Responses

Response samples

Content type
application/json
null

Retrieve a list of dates suggested from a pool of source compositions

Retrieve a list of dates suggested from a pool of source compositions

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project Id

header Parameters
LifeOmic-Account
string

The LifeOmic account to access.

Request Body schema: application/json
object (CodeableConcept)
sourceDocumentReference
string <uuid>

If supplied, dates are only suggested from sources within the specified document reference

omitSourceCompositions
Array of strings

The IDs of compositions that should not be included in the source data for suggestions

object or object

Responses

Request samples

Content type
application/json
{
  • "sourceClassification": {
    },
  • "sourceDocumentReference": "758c1cdc-7a99-4847-9aa3-63408e963028",
  • "omitSourceCompositions": [
    ],
  • "dateSuggestionInput": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve metadata with url and bounding box information of the snippet

Retrieve metadata with url and bounding box information of the snippet

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project Id

documentReferenceId
required
string <uuid>

DocumentReference identifier

page
required
number

Page number

query Parameters
lineIndices
string

Array of line indices for which snippets are needed

wordIndex
string

Identifier of word for which snippet is needed

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "boundingBox": { },
  • "pdfPageS3Url": "string",
  • "aspectRatio": {
    },
  • "rotation": 0
}

Update a DocumentReference

Update a DocumentReference

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project identifier

documentReferenceId
required
string <uuid>

DocumentReference identifier

query Parameters
cohort
string <uuid>

Cohort identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{ }

Retrieve a DocumentReference

Retrieve a DocumentReference

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project identifier

documentReferenceId
required
string <uuid>

DocumentReference identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{ }

Deletes a DocumentReference and attached artifacts

Deletes a DocumentReference and attached artifacts

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project identifier

documentReferenceId
required
string <uuid>

DocumentReference identifier

query Parameters
retainFiles
boolean
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Analyze an OCR document

Analyze an OCR document

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project identifier

documentReferenceId
required
string <uuid>

DocumentReference identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Create a redacted copy (as PDF) of the document

Create a redacted PDF

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project identifier

documentReferenceId
required
string <uuid>

DocumentReference identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "redactedFileId": "11fb4854-0d7a-44cb-a08a-a7236f8b00f8",
  • "redactedFileName": "string"
}

Retrieve FHIR suggestions for the document

Retrieve FHIR Suggestions

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project identifier

documentReferenceId
required
string <uuid>

DocumentReference identifier

query Parameters
pageSize
number

Number of elements per call

nextPageToken
string

Token to retrive the next page

excludeFields
string

Fields to exclude in response (reduces payload size)

codingLimit
string

Limit the number of codings in response (reduces payload size)

confidenceLimit
string
Enum: "HIGH" "STRONG" "MODERATE" "LOW" "OFF"

Confidence limit for analysis

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve FHIR suggestions for a page

Retrieve FHIR suggestions for a page

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project identifier

documentReferenceId
required
string <uuid>

DocumentReference identifier

pages
required
string

Page indicies (comma separated string)

query Parameters
excludeFields
string

Fields to exclude in response (reduces payload size)

codingLimit
string

Limit the number of codings in response (reduces payload size)

confidenceLimit
string
Enum: "HIGH" "STRONG" "MODERATE" "LOW" "OFF"

Confidence limit for analysis

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates codings in relevant FHIR resources

Updates codings in relevant FHIR resources

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic Project identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
required
object (CodeableConcept)
required
object (CodeableConcept)

Responses

Request samples

Content type
application/json
{
  • "searchTerm": {
    },
  • "replaceTerm": {
    }
}

Response samples

Content type
application/json
null

Create an OCR report extractor

Create an OCR report extractor

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project ID

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
required
string <uuid>

Report extractor identifier

project
required
string <uuid>

LifeOmic project identifier

required
ReportExtractor (object) or ReportExtractorMeta (object)
account
required
string

LifeOmic account name

creatorUser
required
string

User who created the extractor

lastUpdated
required
string <date-time>

Timestamp of last update

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "reportExtractor": {
    },
  • "account": "string",
  • "creatorUser": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "extractor": [
    ],
  • "codes": [
    ],
  • "reportExtractor": null
}

List OCR report extractors

List OCR report extractors

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project ID

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List OCR report extractors for account

List OCR report extractors for account

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve OCR report extractor

Retrieve OCR report extractor

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project ID

reportExtractorId
required
string <uuid>

LifeOmic project ID

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "reportExtractor": {
    },
  • "account": "string",
  • "creatorUser": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z"
}

Update an OCR report extractor

Update an OCR report extractor

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project ID

reportExtractorId
required
string <uuid>

LifeOmic project ID

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
required
string <uuid>

Report extractor identifier

project
required
string <uuid>

LifeOmic project identifier

required
ReportExtractor (object) or ReportExtractorMeta (object)
account
required
string

LifeOmic account name

creatorUser
required
string

User who created the extractor

lastUpdated
required
string <date-time>

Timestamp of last update

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "reportExtractor": {
    },
  • "account": "string",
  • "creatorUser": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "extractor": [
    ],
  • "codes": [
    ],
  • "reportExtractor": null
}

Delete an OCR report extractor

Delete an OCR report extractor

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project ID

reportExtractorId
required
string <uuid>

LifeOmic project ID

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Extract report for a document reference, with given report extractor

Extract report for a document reference, with given report extractor

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project ID

documentReferenceId
required
string <uuid>

DocumentReference identifier

reportExtractorId
required
string <uuid>

ReportExtractor identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Extract report for a document reference and report extractor

Extract report for a document reference and report extractor

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project ID

documentReferenceId
required
string <uuid>

DocumentReference identifier

reportExtractorId
required
string <uuid>

ReportExtractor identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Bulk extract report for a document reference, with all available report extractors

Bulk extract report for a document reference, with all available report extractors

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project ID

documentReferenceId
required
string <uuid>

DocumentReference identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Delete report for a document reference

Delete report for a document reference

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project ID

documentReferenceId
required
string <uuid>

DocumentReference identifier

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Bulk extract report for a document reference, with all available report extractors

Bulk extract report for a document reference, with all available report extractors

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string <uuid>

LifeOmic project ID

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
documentReferenceId
required
string <uuid>
required
object (ReportExtractor)

The reportExtractor property is unnecessary and can be removed when it is no longer sent to the API

Responses

Request samples

Content type
application/json
{
  • "documentReferenceId": "34e0e764-a84b-4ab5-81c2-32cd312ddb0d",
  • "reportExtractor": {
    }
}

Response samples

Content type
application/json
{
  • "results": "error",
  • "result": {
    }
}

Ontologies

Supports operations for ontologies on the LifeOmic Platform

To learn about the service as implemented in the LifeOmic Platform web app, see the Ontologies Overview.

Creates a relationship

Creates a relationship.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json

The relationship to create

equivalence
string
Enum: "relatedto" "equivalent" "equal" "wider" "subsumes" "narrower" "specializes" "inexact" "unmatched" "disjoint"

The degree of equivalence between concepts.

object or string
object or string

Responses

Request samples

Content type
application/json
{
  • "equivalence": "relatedto",
  • "source": {
    },
  • "target": {
    }
}

Response samples

Content type
application/json
null

Creates many relationships

Creates many relationships.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json

The relationships to create

Array
equivalence
string
Enum: "relatedto" "equivalent" "equal" "wider" "subsumes" "narrower" "specializes" "inexact" "unmatched" "disjoint"

The degree of equivalence between concepts.

object or string
object or string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get a relationship

Get a relationship.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

relationship
required
string

Relationship identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a relationship

Delete a relationship.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

relationship
required
string

Relationship identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
null

Creates a coding

Creates a coding.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json

The coding to create

system
string or null

The identification of the code system that defines the meaning of the symbol in the code.

version
string or null

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

code
string or null[^\s]+([\s]?[^\s]+)*

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

display
string or null

A representation of the meaning of the code in the system, following the rules of the system.

Responses

Request samples

Content type
application/json
{
  • "system": "string",
  • "version": "string",
  • "code": "string",
  • "display": "string"
}

Response samples

Content type
application/json
null

Gets a collection of codings

Gets a collection of codings.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

query Parameters
system
required
string

The identification of the code system that defines the meaning of the symbol in the code.

version
string

The version of the code system which was used when choosing this code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

display
string

A representation of the meaning of the code in the system, following the rules of the system.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Truncates a collection of codings

Deletes all matching codings. This operation cannot be undone.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

query Parameters
system
required
string

The identification of the code system that defines the meaning of the symbol in the code.

version
string

The version of the code system which was used when choosing this code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

display
string

A representation of the meaning of the code in the system, following the rules of the system.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
null

Gets a coding

Gets a coding.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

coding
required
string

Coding identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "system": "string",
  • "version": "string",
  • "code": "string",
  • "display": "string"
}

Delete a coding

Delete a coding.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

coding
required
string

Coding identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
null

Lists available code systems

Lists available code systems from a Marketplace context.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

query Parameters
availability
any
Enum: "project" "account"

The availability(ies) to include, default is both project and account. Example ?availability=account&availability=project

pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Creates a code system

Creates a code system that is owned and maintained by the specified project.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
title
string non-empty
description
string non-empty
publisher
string non-empty
copyright
string non-empty
url
required
string non-empty
version
string non-empty
null or Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "publisher": "string",
  • "copyright": "string",
  • "url": "string",
  • "version": "string",
  • "contact": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "availability": "PROJECT",
  • "title": "string",
  • "description": "string",
  • "url": "string",
  • "version": "string",
  • "publisher": "string",
  • "copyright": "string",
  • "contact": { }
}

Lists projects code systems

Lists code systems that are owned and maintained by the specified project.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Fetches a single code system

Fetches a single code system with the provided id.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

code-system
required
string

Desired code system's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "availability": "PROJECT",
  • "title": "string",
  • "description": "string",
  • "url": "string",
  • "version": "string",
  • "publisher": "string",
  • "copyright": "string",
  • "contact": { }
}

Updates a code system

Updates a code system with the given ID

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

code-system
required
string

Desired code system's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json

The updated code system

null or string
null or string
null or string
null or string
null or any
null or Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": { },
  • "description": { },
  • "publisher": { },
  • "copyright": { },
  • "availability": { },
  • "contact": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "availability": "PROJECT",
  • "title": "string",
  • "description": "string",
  • "url": "string",
  • "version": "string",
  • "publisher": "string",
  • "copyright": "string",
  • "contact": { }
}

Deletes a code system

Deletes a code system with the given ID

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

code-system
required
string

Desired code system's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
null

Gets a collection of codings

Gets a collection of codings from the specified code system.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

code-system
required
string

Desired code system's ID

query Parameters
code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

display
string

A representation of the meaning of the code in the system, following the rules of the system.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a coding

Gets a coding from the specified code system

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

code-system
required
string

Desired code system's ID

coding
required
string

Coding identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "system": "string",
  • "version": "string",
  • "code": "string",
  • "display": "string"
}

Gets associated code systems

Gets associated code systems for the current project

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Creates an association

Creates an association between the specified project and the specified code system

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

code-system
required
string

Desired code system's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Removes an association

Removes an association between the specified project and the specified code system

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

code-system
required
string

Desired code system's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Lists available value sets

Lists available value sets from a Marketplace context.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

query Parameters
availability
any
Enum: "project" "account"

The availability(ies) to include, default is both project and account. Example '?availability=account&availability=project'

pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Lists projects value sets

Lists value sets that are owned and maintained by the specified project.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Creates a value set

Creates a value set that is owned and maintained by the specified project.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
title
string non-empty
description
string non-empty
publisher
string non-empty
copyright
string non-empty
url
required
string non-empty
version
string non-empty
null or Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "publisher": "string",
  • "copyright": "string",
  • "url": "string",
  • "version": "string",
  • "contact": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "availability": "PROJECT",
  • "title": "string",
  • "description": "string",
  • "url": "string",
  • "version": "string",
  • "publisher": "string",
  • "copyright": "string",
  • "immutable": true,
  • "contact": [
    ]
}

Fetches a single value set

Fetches a single value set with the provided id.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

value-set
required
string

Desired value set's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "availability": "PROJECT",
  • "title": "string",
  • "description": "string",
  • "url": "string",
  • "version": "string",
  • "publisher": "string",
  • "copyright": "string",
  • "immutable": true,
  • "contact": [
    ]
}

Updates a value set

Updates a value set with the given ID

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

value-set
required
string

Desired value set's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
null or string
null or string
null or string
null or string
null or any
null or Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": { },
  • "description": { },
  • "publisher": { },
  • "copyright": { },
  • "availability": { },
  • "contact": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "availability": "PROJECT",
  • "title": "string",
  • "description": "string",
  • "url": "string",
  • "version": "string",
  • "publisher": "string",
  • "copyright": "string",
  • "immutable": true,
  • "contact": [
    ]
}

Deletes a value set

Deletes a value set with the given ID

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

value-set
required
string

Desired value set's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
null

Gets a collection of codings

Gets a collection of codings from the specified value set.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

value-set
required
string

Desired value set's ID

query Parameters
code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

display
string

A representation of the meaning of the code in the system, following the rules of the system.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds codings to the specified value set

Adds codings to the specified value set, pulling from the specified code system by id.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

value-set
required
string

Desired value set's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
codeSystemId
string

The code system origin of the codings

codingIds
Array of strings [ 1 .. 1000 ] items

Responses

Request samples

Content type
application/json
{
  • "codeSystemId": "string",
  • "codingIds": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Removes codings from the specified value set

Removes codings from the specified value set by id.

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

value-set
required
string

Desired value set's ID

query Parameters
id
required
string

Coding id to remove from the value set, can be multiple. E.G. ?id={string}&id={string}

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Gets a coding

Gets a coding from the specified value set

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

value-set
required
string

Desired value set's ID

coding
required
string

Coding identifier

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "system": "string",
  • "version": "string",
  • "code": "string",
  • "display": "string"
}

Gets associated value set

Gets associated value set for the current project

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Creates an association

Creates an association between the specified project and the specified value set

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

value-set
required
string

Desired value set's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Removes an association

Removes an association between the specified project and the specified value set

Authorizations:
Oauth2api-key
path Parameters
project
required
string

Target project identifier

value-set
required
string

Desired value set's ID

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Patient ML

createModel

Creates a new model via a model config object.

Authorizations:
(Oauth2api-key)
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
name
required
string
description
required
string
required
TuningJobTrainingApproach (object) (TrainingApproach)
required
EdgeDeployApproach (object) or CloudDeployApproach (object) (DeployApproach)
object (EvaluationApproach)
required
ClassificationProblemInput (object) or ClassificationProblemInput (object) (MlProblemDefinitionInput)
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "trainingApproach": {
    },
  • "deployApproach": {
    },
  • "evaluationApproach": {
    },
  • "problemDefinition": {
    }
}

Response samples

Content type
application/json
{
  • "model": {
    }
}

getModels

Gets all model configs for an account.

Authorizations:
(Oauth2api-key)
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "models": [
    ]
}

updateModel

Updates a model config.

Authorizations:
(Oauth2api-key)
path Parameters
id
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
name
required
string
description
required
string
required
TuningJobTrainingApproach (object) (TrainingApproach)
required
EdgeDeployApproach (object) or CloudDeployApproach (object) (DeployApproach)
object (EvaluationApproach)
required
ClassificationProblemInput (object) or ClassificationProblemInput (object) (MlProblemDefinitionInput)
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "trainingApproach": {
    },
  • "deployApproach": {
    },
  • "evaluationApproach": {
    },
  • "problemDefinition": {
    }
}

Response samples

Content type
application/json
{
  • "model": {
    }
}

deleteModel

Deletes a model.

Authorizations:
(Oauth2api-key)
path Parameters
id
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

getModel

Gets a model config.

Authorizations:
(Oauth2api-key)
path Parameters
id
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "model": {
    }
}

createRun

Begins a new ML run for a given model.

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "runId": "string"
}

getRuns

Gets data for all ML runs for a model.

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "runs": [
    ]
}

getRun

Gets data for a particular run.

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
runId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "run": {
    }
}

getModelArtifact

Gets a url that can be used to download the model artifact for a particular run.

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
runId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

getModelLogs

Gets the log events for a particular run.

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
runId
required
string
query Parameters
filter
string

An optional field used to filter the log events. This parameter supports AWS CloudWatch Logs' filter and pattern syntax. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html for instructions on how to write filters.

marker
string

Passed in to control which page of results is retrieved.

limit
string

The maximum number of events to return. The default is to return 10,000 -- the largest allowed.

header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "marker": "string"
}

createApprovalDecision

Adds a new approval decision to a model run.

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
runId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
choice
required
string (ApprovalChoice)
Enum: "approved" "rejected"

Responses

Request samples

Content type
application/json
{
  • "choice": "approved"
}

Response samples

Content type
application/json
{
  • "approvalDecision": {
    }
}

getExamples

Fetches a page of training data examples for data labeling.

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
query Parameters
projectId
required
string
hasLabel
string
hasUnconfirmedLabel
string

Allows for fetching examples that have unconfirmed labels.

marker
string
patientId
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "examples": [
    ],
  • "marker": "string"
}

getExample

Fetches a single training data example for data labeling.

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
exampleId
required
string
query Parameters
projectId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "example": {
    }
}

putLabel

Updates the label for a training data example

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
exampleId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
Any of
isConfirmed
boolean

A confirmed label is believed to be correct and may be used during training and evaluation.

lastConfirmedBy
string

The email address or other identifier of the user who last confirmed this label.

updatedAt
number

Timestamp for when the label was last updated or created expressed as milliseconds since the UTC epoch.

Array of objects (Tags)
labelType
required
string
Value: "imgSeg"
required
object

The fileId of an image containing per-pixel labels

property name*
additional property
any

Responses

Request samples

Content type
application/json
Example
{
  • "isConfirmed": true,
  • "lastConfirmedBy": "string",
  • "updatedAt": 0,
  • "tags": [
    ],
  • "labelType": "imgSeg",
  • "mask": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "updatedAt": 0,
  • "exampleType": "imgSeg",
  • "image": {
    },
  • "label": {
    }
}

getLabelFile

Retrieves the label file for the given example, if it exists, and converts it to the format LabelStudio expects.

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
exampleId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Responses

Response samples

Content type
application/json
{
  • "labelData": {
    }
}

putLabelFile

Preprocesses the label data and updates the label file for a training data example. This is done for ML problem types that store their labels as independent files, such as image segmentation. For those problem types, The label data is not stored on a label FHIR record, but in a separate file-service file, and pointed to by a label FHIR record.

Authorizations:
(Oauth2api-key)
path Parameters
modelId
required
string
exampleId
required
string
header Parameters
LifeOmic-Account
required
string

Assigned LifeOmic account

Request Body schema: application/json
Any of
labelType
required
string
Value: "imgSeg"
projectId
required
string

The ID of the LifeOmic project the label file is saved under.

height
required
integer

The height of the segmentation mask in pixels.

width
required
integer

The width of the segmentation mask in pixels.

required
Array of objects (ImageSegmentationArea)

Responses

Request samples

Content type
application/json
{
  • "labelType": "imgSeg",
  • "projectId": "string",
  • "height": 0,
  • "width": 0,
  • "areas": [
    ]
}

Response samples

Content type
application/json
{
  • "fileId": "string"
}

FHIR

Supports FHIR resource operations on the LifeOmic Platform

FHIR operations take place on https://fhir.us.lifeomic.com.

View FHIR resource type

Returns a searchset of a resource type that includes the unique identifiers for the individual resource. FHIR offers sophisticated parameters for search operations, see FHIR Search.

LifeOmic also offers a FHIR Search service that utilizes Elasticsearch and searches on any field, see the FHIR Search tab.

Authorizations:
Oauth2api-key
path Parameters
account
required
string

Assigned name to the customer's account, usually a short form of the company name

dstu3
required
string

Signifies the LifeOmic supported FHIR version STU3

resourceType
required
string

A value set defined by the FHIR project. Commonly used examples are observation and patient

Responses

Request samples 

curl --location --request GET\
--url 'https://fhir.lifeomic.com/{account}/dstu3/{resourceType}/' \
--header 'Authorization=Bearer <api-key>' \

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "link": [
    ],
  • "type": "searchset",
  • "entry": [
    ]
}

Create a FHIR resource

Creates a new specific instance of a resource type with the unique id assigned by the system. Any supplied id is ignored. The 201 response body contains the assigned id. To assign an id to a resource, see PUT Update a FHIR resource.

Authorizations:
Oauth2api-key
path Parameters
account
required
string

Assigned name to the customer's account, usually a short form of the company name

dstu3
required
string

Signifies the LifeOmic supported FHIR version STU3

resourceType
required
string

A value set defined by the FHIR project. Commonly used examples are observation and patient

Request Body schema: application/fhir+json; fhirVersion=3.0
arrays

Responses

Request samples

Content type
application/fhir+json; fhirVersion=3.0
{
  • "resourceType": "Patient",
  • "name": [
    ],
  • "gender": "male",
  • "birthDate": "1984-02-01",
  • "meta": {}
}

Response samples

Content type
application/json
{
  • "resourceType": "Patient",
  • "name": [
    ],
  • "gender": "male",
  • "birthDate": "1984-02-01",
  • "meta": {},
  • "extension": [],
  • "id": "8f194dc0-ef5e-4702-b729-d978529adf07"
}

View a FHIR resource

Shows the data for the specific instance of a resource type and its current state specified by id.

Authorizations:
Oauth2api-key
path Parameters
account
required
string

Assigned name to the customer's account, usually a short form of the company name

dstu3
required
string

Signifies the LifeOmic supported FHIR version STU3

resourceType
required
string

A value set defined by the FHIR project. Commonly used examples are observation and patient

id
required
number

A unique identifier for that specific resource

Responses

Request samples 

curl --location --request GET\
--url 'https://fhir.lifeomic.com/{account}/dstu3/{resourceType}/{id}' \
--header 'Authorization=Bearer <api-key>' \

Response samples

Content type
application/json
{
  • "resourceType": "Patient",
  • "name": [
    ],
  • "gender": "female",
  • "birthDate": "1964-02-01",
  • "meta": {},
  • "id": "00000623-04ad-4d69-991f-6388f4bff4a9"
}

Delete a FHIR resource

Removes a specific resource from the database

Authorizations:
Oauth2api-key
path Parameters
account
required
string

Assigned name to the customer's account, usually a short form of the company name

dstu3
required
string

Signifies the LifeOmic supported FHIR version STU3

resourceType
required
string

A value set defined by the FHIR project. Commonly used examples are observation and patient

id
required
number

A unique identifier for that specific resource

Responses

Request samples 

curl --location --request DELETE\
--url 'https://fhir.lifeomic.com/{account}/dstu3/{resourceType}/{id}' \
--header 'Authorization=Bearer <api-key>' \

Response samples

Content type
application/json
null

Update a FHIR resource

Creates a new current version for an existing resource or creates an initial version if no resource already exists for the given id.

Authorizations:
Oauth2api-key
path Parameters
account
required
string

Assigned name to the customer's account, usually a short form of the company name

dstu3
required
string

Signifies the LifeOmic supported FHIR version STU3

resourceType
required
string

A value set defined by the FHIR project. Commonly used examples are observation and patient

id
required
number

A unique identifier for that specific resource

Request Body schema: application/fhir+json; fhirVersion=3.0
arrays

Responses

Request samples

Content type
application/fhir+json; fhirVersion=3.0
{
  • "resourceType": "Patient",
  • "name": [
    ],
  • "gender": "male",
  • "birthDate": "1984-02-01",
  • "meta": {},
  • "id": "8f194dc0-ef5e-4702-b729-d978529adf07"
}

Response samples

Content type
application/json
{
  • "resourceType": "Patient",
  • "name": [
    ],
  • "gender": "male",
  • "birthDate": "1984-02-01",
  • "meta": {},
  • "id": "8f194dc0-ef5e-4702-b729-d978529adf07"
}

Search for FHIR resources

You can can use a POST request with the _search parameter to search FHIR in addition to the GET request search. The POST request includes the query parameters in the body of the request. Insert the query parameters in the body of the request in the URL-encoded format. In Postman, this is the x-www-form-urlencoded option under the body tab.

LifeOmic also offers a FHIR Search service that utilizes Elasticsearch and searches on any field, see the FHIR Search tab.

Authorizations:
Oauth2api-key
path Parameters
account
required
string

Assigned name to the customer's account, usually a short form of the company name

dstu3
required
string

Signifies the LifeOmic supported FHIR version STU3

resourceType
required
string

A value set defined by the FHIR project. Commonly used examples are observation and patient

_search?
required
string

Specifies the search interaction

query Parameters
code
string

An industry standard code value, such as a LOINC, SNOMED, or RxNorm code, or a LifeOmic custom code. For example 3040-3

date
string

Specifies the date, for example 2019-10-25T21:29:15.417Z. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] (the standard XML format).

patient
string

Specifies the patient id, for example 00000623-04ad-4d69-991f-6388f4bff4a9

_tag
string

Specifies the dataset/project. You must encode the url in the format: http%3A%2F%2Flifeomic.com%2Ffhir%2Fdataset%7C<>. For example, the tag https://lifeomic.com/fhir/dataset|0bb18fef-4e2d-4b91-a623-09527265a8b3 is encoded to become https%3A%2F%2Flifeomic.com%2Ffhir%2Fdataset%7C0bb18fef-4e2d-4b91-a623-09527265a8b3 Note: Failure to add a tag may impact query performance time.

orderBy
string

Specify sort order with one of the fields you are searching on. Example: code

pageSize
number

The number of results to return in the request.

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "link": [
    ],
  • "type": "searchset",
  • "entry": [
    ]
}

Policy Attributes

Supports updating the ABAC policy for a user.

For more information about the LifeOmic Platform Access Control, see the Access Control Overview.

Updates the policy attributes for the specified user, returning the updated attributes.

Updates the policy attributes for the specified user, returning the updated attributes.

Using this API requires access to the accessAdmin operation.

Authorizations:
Oauth2api-key
path Parameters
username
required
string
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "attributes": { }
}

Response samples

Content type
application/json
{
  • "attributes": { }
}

Fetches the policy attributes for the specified user.

Fetches the policy attributes for the specified user.

Using this API requires access to the accessAdmin operation.

Authorizations:
Oauth2api-key
path Parameters
username
required
string
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "attributes": { }
}

Rules

Supports rules operations for job resources

Get rules.

Returns a list of rules that the user has access to.

Authorizations:
Oauth2api-key
query Parameters
datasetId
required
string

The ID of the project to search within for rules.

inputType
string
Enum: "event" "questionnaireResponse"

Only return rules that have the given input type. If this is specified, then you can supply other input properties for the given inputType to filter the rules further based on their input properties.

eventType
string
Enum: "PatientWriteEvent" "FileChangeEvent"

Only valid when inputType is 'event'. Filters event based rules further by their event type.

resourceType
string

Only valid when eventType is specified. Filters event based rules further by their resource type.

id
string <uuid>

Only valid when inputType is 'questionnaireResponse'. Filters questionnaire response based rules further by the questionnaire ID.

status
string

Only valid when id is specified. Filters questionnaire response based rules further by the status of the response.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a rule

Create a rule that will execute based on the given input, running each step in sequence until a step returns false, or all steps have completed. The input defines what causes the rule to fire.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
string <uuid>

Unique ID for this rule.

account
required
string

The account the rule belongs to.

datasetId
required
string

The ID of the dataset this rule belongs to.

userId
string

The ID of the user that created this rule.

name
required
string <= 256 characters

The name given to the rule.

description
string <= 1024 characters

A more detailed description of the rule, so users can get more information about its purpose.

creationTime
string <date-time>

An ISO formatted timestamp of when the Rule was created.

updatedTime
string <date-time>

An ISO formatted timestamp of when the Rule was last updated.

required
object or object (Rules-Input)

Base input schema. The type of input used is dependent on the type property, and the attribute properties will be based on that type's schema.

required
Array of objects or objects or objects (Rules-Step)

The steps that should be executed when this rule is triggered. These steps will be executed in order, until one of them returns false or fails.

Responses

Request samples

Content type
application/json
{
  • "id": "785ec0fa-77a4-49ab-b9ac-a5462d365ae8",
  • "account": "myComp",
  • "datasetId": "edf88862-cb60-4f12-be89-a50e09dc8ae7",
  • "userId": "myUser",
  • "name": "Example Rule",
  • "description": "This is just an example rule",
  • "creationTime": "2020-01-01T00:00:00.000Z",
  • "updatedTime": "2020-01-01T00:00:00.000Z",
  • "input": {
    },
  • "steps": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "785ec0fa-77a4-49ab-b9ac-a5462d365ae8",
  • "account": "myComp",
  • "datasetId": "edf88862-cb60-4f12-be89-a50e09dc8ae7",
  • "userId": "myUser",
  • "name": "Example Rule",
  • "description": "This is just an example rule",
  • "creationTime": "2020-01-01T00:00:00.000Z",
  • "updatedTime": "2020-01-01T00:00:00.000Z",
  • "input": {
    },
  • "steps": [
    ]
}

Get a rule.

Returns a rule.

Authorizations:
Oauth2api-key
path Parameters
ruleId
required
string <uuid>

The rule id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "id": "785ec0fa-77a4-49ab-b9ac-a5462d365ae8",
  • "account": "myComp",
  • "datasetId": "edf88862-cb60-4f12-be89-a50e09dc8ae7",
  • "userId": "myUser",
  • "name": "Example Rule",
  • "description": "This is just an example rule",
  • "creationTime": "2020-01-01T00:00:00.000Z",
  • "updatedTime": "2020-01-01T00:00:00.000Z",
  • "input": {
    },
  • "steps": [
    ]
}

Delete a rule.

Deletes a rule.

Authorizations:
Oauth2api-key
path Parameters
ruleId
required
string <uuid>

The rule id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Get rule jobs.

Returns a list of rule jobs that the user has access to.

Authorizations:
Oauth2api-key
query Parameters
datasetId
required
string

The ID of the project to search within for rule jobs.

state
required
string
Enum: "RUNNING" "COMPLETE" "CANCELED"

Only return rule jobs that have the given state.

pageSize
number
Default: 10

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a rule job.

Create a rule job that will execute the given steps for each of the given resource IDs. Rule jobs only support patient resources for now. The job will asynchronously execute the steps for each resource in batches, allowing it to handle large numbers of resources.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
datasetId
string

The ID of the dataset this rule job belongs to.

required
Array of objects or objects or objects (Rules-Step)

The steps that should be executed when this rule job is triggered. These steps will be executed in order, until one of them returns false or fails.

resourceType
required
string
Value: "Patient"

The type of resource that are batched up and have the steps executed against.

resourceIds
required
Array of strings

The list of resource IDs that you want to execute the steps against, in batches.

Responses

Request samples

Content type
application/json
{
  • "datasetId": "edf88862-cb60-4f12-be89-a50e09dc8ae7",
  • "steps": [
    ],
  • "resourceType": "Patient",
  • "resourceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "785ec0fa-77a4-49ab-b9ac-a5462d365ae8",
  • "creationTime": "2020-01-01T00:00:00.000Z",
  • "userId": "myUser",
  • "account": "myComp",
  • "policy": {
    },
  • "accountGroups": [
    ],
  • "datasetId": "edf88862-cb60-4f12-be89-a50e09dc8ae7",
  • "state": "RUNNING",
  • "steps": [
    ],
  • "resourceType": "Patient",
  • "execution": "arn:execution",
  • "successes": 12,
  • "failures": 3,
  • "total": 20
}

Get a rule job.

Returns a rule job.

Authorizations:
Oauth2api-key
path Parameters
jobId
required
string <uuid>

The rule job id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "id": "785ec0fa-77a4-49ab-b9ac-a5462d365ae8",
  • "creationTime": "2020-01-01T00:00:00.000Z",
  • "userId": "myUser",
  • "account": "myComp",
  • "policy": {
    },
  • "accountGroups": [
    ],
  • "datasetId": "edf88862-cb60-4f12-be89-a50e09dc8ae7",
  • "state": "RUNNING",
  • "steps": [
    ],
  • "resourceType": "Patient",
  • "execution": "arn:execution",
  • "successes": 12,
  • "failures": 3,
  • "total": 20
}

Delete a rule job.

Deletes a rule job.

Authorizations:
Oauth2api-key
path Parameters
jobId
required
string <uuid>

The rule job id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Get list of items for a rule job.

Returns a a list of items for a rule job.

Authorizations:
Oauth2api-key
path Parameters
jobId
required
string <uuid>

The rule job id.

query Parameters
state
string
Enum: "PENDING" "RUNNING" "SUCCESS" "FAILURE"

Only return rule job items that have the given state.

pageSize
number
Default: 10

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SFTP

Manages an SFTP user to access standard SFTP methods and tools for files in the LifeOmic Platform

To learn about the service as implemented by the LifeOmic Platform web app, see SFTP Data Transfer.

Get events for an SFTP user

Get events for a SFTP user

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The project id.

username
required
string

The username

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Delete SFTP user for a project

Delete a SFTP user for a given project.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The project id.

username
required
string

The username

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Get a SFTP user for a project

Get a SFTP user for a given project.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The project id.

username
required
string

The username

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "username": "string",
  • "description": "string",
  • "sshKeys": [
    ],
  • "homeDirectory": "string",
  • "createdBy": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z"
}

Update a SFTP user for a project

Update a SFTP user for a given project.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The project id.

username
required
string

The username

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
sshKeys
Array of strings

List of publich SSH keys for the user.

description
string

A user description

homeDirectory
string

The location within the LifeOmic Project where the user can write files

Responses

Request samples

Content type
application/json
{
  • "sshKeys": [
    ],
  • "description": "string",
  • "homeDirectory": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "description": "string",
  • "sshKeys": [
    ],
  • "homeDirectory": "string",
  • "createdBy": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z"
}

Create a SFTP user for a project

Create a SFTP users for a given project.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The project id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
username
string

The SFTP username

description
string

A user description

sshKeys
Array of strings

List of publich SSH keys for the user.

homeDirectory
string

The location within the LifeOmic project where the user can write files

createdBy
string

The LifeOmic Platform username that created the SFTP user

dateCreated
string <date-time>

The date when the user was created

dateUpdated
string <date-time>

The date when the user was last updated

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "description": "string",
  • "sshKeys": [
    ],
  • "homeDirectory": "string",
  • "createdBy": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "description": "string",
  • "sshKeys": [
    ],
  • "homeDirectory": "string",
  • "createdBy": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z"
}

List SFTP users for a project

Lists all of the SFTP users for a given project.

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The project id.

query Parameters
username
string

Filter results by SFTP username.

pageSize
string

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Surveys

Supports operations for sending surveys with the LifeOmic Platform

For more information about surveys as implemented on the LifeOmic Platform web app, see the Surveys Overview.

Accept a survey invitation

Authorizations:
Oauth2api-key

Fetch survey responses in a project

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

Send survey to existing subject

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
Request Body schema: application/json
object
survey
required
string non-empty

The id of the survey associated with the response

current
boolean non-empty

Set to true to assign the most recent published version of the survey.

notificationType
string
Enum: "EMAIL" "PUSH"
object or object

Request samples

Content type
application/json
{
  • "invite": {
    },
  • "survey": "string",
  • "current": true,
  • "notificationType": "EMAIL",
  • "subject": {
    }
}

Delete a survey response

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
responseId
required
string

Fetch a survey response

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
responseId
required
string

Update a survey response

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
responseId
required
string
Request Body schema: application/json
required
object
required
object
resourceType
required
string
Value: "QuestionnaireResponse"
authored
string

Date the response was submitted. Formatted YYYY-MM-DDTHH:mm:ss.sssZ

object
status
string
Enum: "in-progress" "completed"
item
Array of arrays

array of survey questions

Request samples

Content type
application/json
{
  • "subject": {
    },
  • "questionnaire": {
    },
  • "resourceType": "QuestionnaireResponse",
  • "authored": "string",
  • "author": {
    },
  • "status": "in-progress",
  • "item": [ ]
}

Fetch a survey attachment

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
responseId
required
string
linkId
required
string
fileId
required
string

Fetch surveys for a project

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

Create a survey for a project

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
Request Body schema: application/json
resourceType
required
string
Value: "Questionnaire"
title
required
string^[^<>&/`@]+$

Name of the survey

status
required
string
Enum: "draft" "active" "retried"

Use draft for a new survey, active for an existing survey that is to be publicly available, and retired for archived surveys that should no longer be used.

item
required
Array of arrays non-empty

List of survey questions

Request samples

Content type
application/json
{
  • "resourceType": "Questionnaire",
  • "title": "string",
  • "status": "draft",
  • "item": [ ]
}

Fetch a prior survey version for a survey

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
primarySurveyId
required
string

Delete a survey

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string

Fetch a survey by ID

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string

Update a survey by ID

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string
Request Body schema: application/json
resourceType
required
string
Value: "Questionnaire"
title
required
string^[^<>&/`@]+$

Name of the survey

status
required
string
Enum: "draft" "active" "retried"

Use draft for a new survey, active for an existing survey that is to be publicly available, and retired for archived surveys that should no longer be used.

item
required
Array of arrays non-empty

List of survey questions

Request samples

Content type
application/json
{
  • "resourceType": "Questionnaire",
  • "title": "string",
  • "status": "draft",
  • "item": [ ]
}

Fetch survey adapters configured for a survey

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string

Create a survey adapter for a survey

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string

Fetch global survey adapter

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string

Delete survey adapter by name

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string
name
required
string

Fetch survey adapter by name

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string
name
required
string

Update survey adapter by name

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string
name
required
string

Evaluate (or test) a survey adapter by name

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string
name
required
string

Get survey configuration for the survey ID

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string

Update survey configuration for the survey ID

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string
Request Body schema: application/json
object

Request samples

Content type
application/json
{
  • "notificationPreferences": {
    }
}

Create a survey reminder

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string

Delete a survey schedule

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string

Fetch a survey schedule

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string

Update a survey schedule

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string
Request Body schema: application/json
recurrence
required
string
Enum: "continuously" "daily" "weekly" "monthly" "yearly"
stopAfter
number
remind
boolean
expire
boolean

Request samples

Content type
application/json
{
  • "recurrence": "continuously",
  • "stopAfter": 0,
  • "remind": true,
  • "expire": true
}

Create a new survey version for the existing survey by ID

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string
surveyId
required
string
Request Body schema: application/json
resourceType
required
string
Value: "Questionnaire"
title
required
string^[^<>&/`@]+$

Name of the survey

status
required
string
Enum: "draft" "active" "retried"

Use draft for a new survey, active for an existing survey that is to be publicly available, and retired for archived surveys that should no longer be used.

item
required
Array of arrays non-empty

List of survey questions

Request samples

Content type
application/json
{
  • "resourceType": "Questionnaire",
  • "title": "string",
  • "status": "draft",
  • "item": [ ]
}

Tasks

Supports direct access to cloud data in a secure compute environment with your own code inside Docker containers

Get tasks.

Returns a list of tasks that the user has access to.

Authorizations:
Oauth2api-key
query Parameters
datasetId
required
string

The ID of the project to search within for tasks.

state
string

Only return tasks in the given state.

name
string

Only return tasks that have a name that starts with the given value.

orderBy
string

Specify sort order. Example: name desc

pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Create a task

Create a task that will run Docker images against data in the LifeOmic Platform. The Docker images can be accessed from DockerHub. To use a private image, run docker save to save the image to a TAR file. You can then upload the TAR file to the LifeOmic Platform and provide it as an input to the Task using the DOCKER_IMAGE input type. The image will be loaded from the TAR file during task execution making the image available to any executors defined in the task.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
name
string <= 256 characters
datasetId
required
string
description
string <= 1024 characters
scheduleExpression
string

A CRON expression for a recurring task

scheduleDate
string <date-time>

A date-time string for when the task should be scheduled to run

maxDurationSeconds
number [ 60 .. 864000 ]
object

A key-value map of arbitrary tags.

object
required
Array of objects <= 20 items

A list of executors to be run, sequentially. Execution stops on the first error.

required
object or object

Request that the task be run with these resources.

required
Array of objects or objects or objects or objects or objects <= 25 items

Input files. Inputs will be downloaded and mounted into the executor container.

required
Array of objects or objects or objects or (object or objects) or (object or objects) or objects or objects or objects or objects <= 25 items

Output files. Outputs will be uploaded from the executor container to long-term storage.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "datasetId": "string",
  • "description": "string",
  • "scheduleExpression": "string",
  • "scheduleDate": "2019-08-24T14:15:22Z",
  • "maxDurationSeconds": 60,
  • "tags": {
    },
  • "email": {
    },
  • "executors": [
    ],
  • "resources": {
    },
  • "inputs": [
    ],
  • "outputs": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "datasetId": "string",
  • "description": "string",
  • "scheduleExpression": "string",
  • "scheduleDate": "2019-08-24T14:15:22Z",
  • "maxDurationSeconds": 60,
  • "tags": {
    },
  • "email": {
    },
  • "executors": [
    ],
  • "resources": {
    },
  • "inputs": [
    ],
  • "outputs": [
    ]
}

Get a task.

Returns a task.

Authorizations:
Oauth2api-key
path Parameters
taskId
required
string

The task id.

query Parameters
view
string
Default: "FULL"
Enum: "FULL" "MINIMAL"

Affects the fields included in the returned Task.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "datasetId": "string",
  • "description": "string",
  • "scheduleExpression": "string",
  • "scheduleDate": "2019-08-24T14:15:22Z",
  • "maxDurationSeconds": 60,
  • "tags": {
    },
  • "email": {
    },
  • "executors": [
    ],
  • "resources": {
    },
  • "inputs": [
    ],
  • "outputs": [
    ]
}

Cancel a task.

Cancels a task.

Authorizations:
Oauth2api-key
path Parameters
taskId
required
string

The task id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "datasetId": "string",
  • "description": "string",
  • "scheduleExpression": "string",
  • "scheduleDate": "2019-08-24T14:15:22Z",
  • "maxDurationSeconds": 60,
  • "tags": {
    },
  • "email": {
    },
  • "executors": [
    ],
  • "resources": {
    },
  • "inputs": [
    ],
  • "outputs": [
    ]
}

Create a Foundation Medicine import task

Create a Foundation Medicine import task.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
xmlFileId
required
string
datasetId
required
string
reportFileId
string
subjectId
required
string
sequenceName
string
performerId
string
testType
string
indexedDate
string
indexType
string
useExistingSequence
boolean
sequenceId
string
reIngestFile
boolean
bodySite
string
bodySiteSystem
string
bodySiteDisplay
string
sendFailedTo
string <email>

If present, send emails for failed tasks to this email address.

Responses

Request samples

Content type
application/json
{
  • "xmlFileId": "string",
  • "datasetId": "string",
  • "reportFileId": "string",
  • "subjectId": "string",
  • "sequenceName": "string",
  • "performerId": "string",
  • "testType": "string",
  • "indexedDate": "string",
  • "indexType": "string",
  • "useExistingSequence": true,
  • "sequenceId": "string",
  • "reIngestFile": true,
  • "bodySite": "string",
  • "bodySiteSystem": "string",
  • "bodySiteDisplay": "string",
  • "sendFailedTo": "user@example.com"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "datasetId": "string",
  • "description": "string",
  • "scheduleExpression": "string",
  • "scheduleDate": "2019-08-24T14:15:22Z",
  • "maxDurationSeconds": 60,
  • "tags": {
    },
  • "email": {
    },
  • "executors": [
    ],
  • "resources": {
    },
  • "inputs": [
    ],
  • "outputs": [
    ]
}

Create a Nantomics import task

Create a Nantomics import task.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
nantomicsVcfFileId
required
string
datasetId
required
string
outputFilePrefix
required
string
subjectId
required
string
sequenceName
string
sequenceType
required
string
Enum: "somatic" "germline"
performerId
string
testType
string
indexedDate
string
uploadType
string
useExistingSequence
boolean
reIngestFile
boolean
bodySite
string
bodySiteSystem
string
bodySiteDisplay
string
sendFailedTo
string <email>

If present, send emails for failed tasks to this email address.

Responses

Request samples

Content type
application/json
{
  • "nantomicsVcfFileId": "string",
  • "datasetId": "string",
  • "outputFilePrefix": "string",
  • "subjectId": "string",
  • "sequenceName": "string",
  • "sequenceType": "somatic",
  • "performerId": "string",
  • "testType": "string",
  • "indexedDate": "string",
  • "uploadType": "string",
  • "useExistingSequence": true,
  • "reIngestFile": true,
  • "bodySite": "string",
  • "bodySiteSystem": "string",
  • "bodySiteDisplay": "string",
  • "sendFailedTo": "user@example.com"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "datasetId": "string",
  • "description": "string",
  • "scheduleExpression": "string",
  • "scheduleDate": "2019-08-24T14:15:22Z",
  • "maxDurationSeconds": 60,
  • "tags": {
    },
  • "email": {
    },
  • "executors": [
    ],
  • "resources": {
    },
  • "inputs": [
    ],
  • "outputs": [
    ]
}

Create an Ashion import task

Create an Ashion import task.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
nantomicsVcfFileId
required
string
datasetId
required
string
outputFilePrefix
required
string
subjectId
required
string
sequenceName
string
sequenceType
required
string
Enum: "somatic" "germline"
performerId
string
testType
string
indexedDate
string
uploadType
string
useExistingSequence
boolean
reIngestFile
boolean
bodySite
string
bodySiteSystem
string
bodySiteDisplay
string
sendFailedTo
string <email>

If present, send emails for failed tasks to this email address.

Responses

Request samples

Content type
application/json
{
  • "nantomicsVcfFileId": "string",
  • "datasetId": "string",
  • "outputFilePrefix": "string",
  • "subjectId": "string",
  • "sequenceName": "string",
  • "sequenceType": "somatic",
  • "performerId": "string",
  • "testType": "string",
  • "indexedDate": "string",
  • "uploadType": "string",
  • "useExistingSequence": true,
  • "reIngestFile": true,
  • "bodySite": "string",
  • "bodySiteSystem": "string",
  • "bodySiteDisplay": "string",
  • "sendFailedTo": "user@example.com"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "datasetId": "string",
  • "description": "string",
  • "scheduleExpression": "string",
  • "scheduleDate": "2019-08-24T14:15:22Z",
  • "maxDurationSeconds": 60,
  • "tags": {
    },
  • "email": {
    },
  • "executors": [
    ],
  • "resources": {
    },
  • "inputs": [
    ],
  • "outputs": [
    ]
}

Trial Matching Alert Service

Supports clinical trials alerting operations.

For information about Clinical Trials as implemented in the LifeOmic Platform web app, see the Clinical Trials Overview.

Get a user alert

Returns a user alert based on id

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The LifeOmic project to access

alertId
required
string

The alert id

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "projectId": "string",
  • "userId": "string",
  • "id": "string",
  • "trialId": "string",
  • "trialName": "string",
  • "filterName": "string",
  • "createdDate": "string",
  • "effect": "Positive",
  • "type": "TaggedTrial",
  • "cleared": true,
  • "trialsAdded": [
    ],
  • "trialsRemoved": [
    ],
  • "changes": [
    ],
  • "emailSent": true
}

Delete user alert

Delete a user alert based on id

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The LifeOmic project to access

alertId
required
string

The alert id

Responses

Response samples

Content type
application/json
null

List user alerts

List user alerts in the specified LifeOmic project with paging

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The LifeOmic project to access

query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get clinical trial filters that user is watching

Gets a list of clinical trial filters that a user is watching in the specified LifeOmic project

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The LifeOmic project to access

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "projectId": "string",
  • "userId": "string",
  • "filters": [
    ]
}

Add a clinical trial filter to watch

Adds a clinical trial filter to the list of filters that a user is watching in the specified LifeOmic project

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The LifeOmic project to access

filterName
required
string

The name of the clinical trial filter to watch

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "projectId": "string",
  • "userId": "string",
  • "filters": [
    ]
}

Remove a clinical trial filter from watch list

Removes a clinical trial filter to the list of filters that a user is watching in the specified LifeOmic project

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The LifeOmic project to access

filterName
required
string

The name of the clinical trial filter to stop watching

Responses

Response samples

Content type
application/json
null

Get a user tag based on id

Returns a user tag based on id

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The LifeOmic project to access

tagId
required
string

The clinical trial tag to return, 13644aa6-0b27-4647-9621-0ed6c269c981 for favorites

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "projectId": "string",
  • "userId": "string",
  • "id": "string",
  • "name": "string",
  • "trials": [
    ],
  • "alertEnabled": true
}

Update a user tag based on id

Update the alerting status of a user tag based on id

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The LifeOmic project to access

tagId
required
string

The clinical trial tag to update, 13644aa6-0b27-4647-9621-0ed6c269c981 for favorites

Request Body schema: application/json
alertEnabled
required
boolean

Responses

Request samples

Content type
application/json
{
  • "alertEnabled": true
}

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "projectId": "string",
  • "userId": "string",
  • "id": "string",
  • "name": "string",
  • "trials": [
    ],
  • "alertEnabled": true
}

Add a trial to a user tag

Adds the given trial to the specified user tag

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The LifeOmic project to access

tagId
required
string

The clinical trial tag to add the trial to, 13644aa6-0b27-4647-9621-0ed6c269c981 for favorites

trialId
required
string

The id of the trial to add to the tag

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Remove a trial from a user tag

Removes the given trial from the specified user tag

Authorizations:
Oauth2api-key
path Parameters
projectId
required
string

The LifeOmic project to access

tagId
required
string

The clinical trial tag to remove the trial from, 13644aa6-0b27-4647-9621-0ed6c269c981 for favorites

trialId
required
string

The id of the trial to remove from the tag

Responses

Response samples

Content type
application/json
null

Uploads

Supports the operation of multi-part file uploads where each file is over 5 MBs. Use the Files operations for smaller uploads.

Get user multi-part uploads.

Returns a list of multi-part uploads that the user has access to.

Authorizations:
Oauth2api-key
query Parameters
pageSize
number

The number of results to return in the request.

nextPageToken
string

The page token used to request a specific page.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Create a multi-part upload

Create an multi-part upload operation. Note that each part of the upload must be at least 5 MB in size to use this method. If the file is smaller than this, use the normal file upload resource at /v1/files. If an id is specified in the request body, then any existing file at that id will be overwritten.

Authorizations:
Oauth2api-key
header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Request Body schema: application/json
id
string

Id of the resultant file. If provided on POST, then the id must be a V4 UUID, otherwise the server will create a new UUID for the file.

name
string

The file name.

datasetId
string

The project the file belongs to.

contentType
string

The content type of the file.

uploadId
string

The server generated upload ID for the multi-part operation. This field is ignored on POST requests.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "datasetId": "string",
  • "contentType": "string",
  • "uploadId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "datasetId": "string",
  • "contentType": "string",
  • "uploadId": "string"
}

Get a multi-part upload.

Returns an multi-part upload.

Authorizations:
Oauth2api-key
path Parameters
uploadId
required
string

The upload id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "datasetId": "string",
  • "contentType": "string",
  • "uploadId": "string"
}

Complete or abort a multi-part upload.

Completes or aborts a multi-part upload. Upon completion, the file parts are combined in order and the file is ready to be accessed

Authorizations:
Oauth2api-key
path Parameters
uploadId
required
string

The upload id.

query Parameters
abort
boolean

Set to true to abort a multi-part upload operation.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
null

Get uploaded parts for a multi-upload operation.

Returns an upload.

Authorizations:
Oauth2api-key
path Parameters
uploadId
required
string

The upload id.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    }
}

Get upload URL for part.

Get upload URL for part of a multi-part upload operation. Note that part numbers do not have to be consecutive.

Authorizations:
Oauth2api-key
path Parameters
uploadId
required
string

The upload id.

partNumber
required
number

The part number. Must be between 1 and 10,000.

header Parameters
LifeOmic-Account
required
string

The LifeOmic account to access.

Responses

Response samples

Content type
application/json
{
  • "uploadUrl": "string",
  • "partNumber": 0
}