Onconova API 1.4.0¶
Welcome to the Onconova API — a secure, standards-based interface designed to facilitate the exchange, management, and analysis of research data related to cancer genomics, clinical records, and associated metadata. This API provides an extensive set of RESTful endpoints enabling authorized users to perform full CRUD (Create, Read, Update, Delete) operations on various resources within the platform’s data ecosystem.
The primary objective of this API is to support precision oncology research by enabling interoperability between data systems, promoting data sharing among research institutions, and streamlining workflows for clinical and genomic data management in a secure, authenticated environment.
Authentication¶
To ensure the security and integrity of cancer research data, all API requests require proper authentication.
A valid session token must be obtained prior to accessing any protected endpoint. This token must be included in the request header X-Session-Token.
The authentication and authorization flows for obtaining and managing session tokens are provided through the AllAuth authentication service. This includes endpoints for user login, logout, password management, and token renewal. For complete details on implementing authentication and managing session tokens, please refer to the AllAuth API documentation.
Important: Unauthorized requests or those missing valid authentication tokens will receive an HTTP 401 Unauthorized response.
Terminologies¶
Many resources take objects of the type CodedConcept to represent concepts from coded terminologies. Each property of the type CodedConcept in a schema will have an associated x-terminology attribute. The full list of CodedConcept objects allowed for specific resource properties can be retrieved through the terminology endpoint by passing the x-terminology value as the terminologyName parameter.
Terms and Conditions¶
By accessing and using this website, you agree to comply with and be bound by the following terms and conditions. The content provided on this API is intended solely for general informational and research purposes. While we strive to ensure the information is accurate and reliable, we do not make any express or implied warranties about the accuracy, adequacy, validity, reliability, availability, or completeness of the content.
The information presented on this platform is provided in good faith. However, we do not accept any liability for any loss or damage incurred as a result of using the site or relying on the information provided. Your use of this site and any reliance on the content is solely at your own risk.
These terms and conditions may be updated from time to time, and it is your responsibility to review them regularly to ensure compliance.
License¶
The Onconova API specification is made available under the MIT License, a permissive open-source license that allows users to freely use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, subject to the inclusion of the original copyright and license.
License: MIT
Servers¶
| Description | URL |
|---|---|
| API server | https://{domain}:{port}/api |
API Health¶
GET /api/v1/healthcheck¶
Health Check
Description
Performs a health check of the server, database connection, and database migrations.
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Schema representing the health status of the server and its components.\n\nAttributes:\n server (Literal[\"ok\"]): Indicates whether the server is online.\n database (Union[Literal[\"ok\"], Literal[\"error\"]]): Indicates the status of the database connection.\n database_connection_time_ms (Optional[float]): Time taken to connect to the database in milliseconds.\n migrations (Union[Literal[\"ok\"], Literal[\"pending\"], Literal[\"error\"]]): Status of database migrations.",
"properties": {
"server": {
"const": "ok",
"description": "Whether the server is online",
"title": "Server Status",
"type": "string"
},
"database": {
"anyOf": [
{
"const": "ok",
"type": "string"
},
{
"const": "error",
"type": "string"
}
],
"description": "Whether the database is online",
"title": "Database Status"
},
"database_connection_time_ms": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Database connection time in milliseconds",
"title": "Database Connection Time"
},
"migrations": {
"anyOf": [
{
"const": "ok",
"type": "string"
},
{
"const": "pending",
"type": "string"
},
{
"const": "error",
"type": "string"
}
],
"description": "Whether there are pending migrations",
"title": "Migration Status"
}
},
"required": [
"server",
"database",
"migrations"
],
"title": "HealthCheck",
"type": "object"
}
Authentication¶
POST /api/v1/auth/session¶
Login
Description
Authenticates a user using the provided credentials.
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"description": "Schema representing user credentials required for authentication.\n\nAttributes:\n username (str): The username of the user.\n password (str): The password associated with the username.",
"properties": {
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
},
"password": {
"description": "The password associated with the username.",
"title": "Password",
"type": "string"
}
},
"required": [
"username",
"password"
],
"title": "UserCredentials",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Schema representing authentication metadata.\n\nAttributes:\n sessionToken (Optional[str]): The session token associated with the authentication, if available.\n accessToken (Optional[str]): The access token for the authenticated session, if available.\n isAuthenticated (bool): Indicates whether the user is authenticated.",
"properties": {
"sessionToken": {
"description": "The session token associated with the authentication, if available.",
"title": "Session Token",
"type": "string"
},
"accessToken": {
"description": "The access token for the authenticated session, if available.",
"title": "Access Token",
"type": "string"
},
"isAuthenticated": {
"description": "Indicates whether the user is authenticated.",
"title": "Is Authenticated",
"type": "boolean"
}
},
"required": [
"isAuthenticated"
],
"title": "AuthenticationMeta",
"type": "object"
}
POST /api/v1/auth/provider/session¶
Login With Provider Token
Description
Authenticates a user using a provider token.
Request body
{
"provider": "string",
"process": null,
"token": {
"client_id": "string",
"id_token": "string",
"access_token": "string"
}
}
Schema of the request body
{
"description": "Schema representing a user's provider token information.\n\nAttributes:\n provider (str): The name of the authentication provider (e.g., 'google', 'facebook').\n process (Literal[\"login\"] | Literal[\"connect\"]): The process type, either 'login' or 'connect'.\n token (UserProviderClientToken): The token object containing provider-specific authentication details.",
"properties": {
"provider": {
"description": "The name of the authentication provider (e.g., 'google', 'facebook').",
"title": "Provider",
"type": "string"
},
"process": {
"anyOf": [
{
"const": "login",
"type": "string"
},
{
"const": "connect",
"type": "string"
}
],
"description": "The process type, either 'login' or 'connect'.",
"title": "Process Type"
},
"token": {
"$ref": "#/components/schemas/UserProviderClientToken",
"description": "The token object containing provider-specific authentication details.",
"title": "Provider Token"
}
},
"required": [
"provider",
"process",
"token"
],
"title": "UserProviderToken",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Schema representing authentication metadata.\n\nAttributes:\n sessionToken (Optional[str]): The session token associated with the authentication, if available.\n accessToken (Optional[str]): The access token for the authenticated session, if available.\n isAuthenticated (bool): Indicates whether the user is authenticated.",
"properties": {
"sessionToken": {
"description": "The session token associated with the authentication, if available.",
"title": "Session Token",
"type": "string"
},
"accessToken": {
"description": "The access token for the authenticated session, if available.",
"title": "Access Token",
"type": "string"
},
"isAuthenticated": {
"description": "Indicates whether the user is authenticated.",
"title": "Is Authenticated",
"type": "boolean"
}
},
"required": [
"isAuthenticated"
],
"title": "AuthenticationMeta",
"type": "object"
}
Users¶
GET /api/v1/users¶
Get All Users Matching The Query
Description
Retrieves all user objects that match the specified query filters.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
accessLevel.between |
query | array | No | Access level - Filter for entries with values between two specified values (inclusive) | |
accessLevel.equal |
query | integer | No | Access level - Filter for entries with values exactly equal to the specified value | |
accessLevel.greaterThan |
query | integer | No | Access level - Filter for entries with values greater than the specified value | |
accessLevel.greaterThanOrEqual |
query | integer | No | Access level - Filter for entries with values greater than or equal to the specified value | |
accessLevel.lessThan |
query | integer | No | Access level - Filter for entries with values less than the specified value | |
accessLevel.lessThanOrEqual |
query | integer | No | Access level - Filter for entries with values less than or equal to the specified value | |
accessLevel.not.between |
query | array | No | Access level - Filter for entries with values between two specified values (inclusive) | |
accessLevel.not.equal |
query | integer | No | Access level - Filter for entries with values not equal to the specified value | |
canExportData |
query | boolean | No | Export Data - Filter for yes/no statement | |
canManageCases |
query | boolean | No | Manage Cases - Filter for yes/no statement | |
canManageProjects |
query | boolean | No | Manage Projects - Filter for yes/no statement | |
canManageUsers |
query | boolean | No | Manage Users - Filter for yes/no statement | |
canViewCases |
query | boolean | No | View Cases - Filter for yes/no statement | |
canViewCohorts |
query | boolean | No | View Cohorts - Filter for yes/no statement | |
canViewDatasets |
query | boolean | No | View Datasets - Filter for yes/no statement | |
canViewProjects |
query | boolean | No | View Projects - Filter for yes/no statement | |
canViewUsers |
query | boolean | No | View Users - Filter for yes/no statement | |
department |
query | string | No | Department - Filter for full text matches | |
department.anyOf |
query | array | No | Department - Filter for entries where at least one reference matches the query | |
department.beginsWith |
query | string | No | Department - Filter for entries starting with the text | |
department.contains |
query | string | No | Department - Filter for partial text matches | |
department.endsWith |
query | string | No | Department - Filter for entries ending with the text | |
department.exists |
query | boolean | No | Department - Filter for entries with a value | |
department.not |
query | string | No | Department - Filter for full text mismatches | |
department.not.anyOf |
query | array | No | Department - Filter for entries where at least one reference mismatches the query | |
department.not.beginsWith |
query | string | No | Department - Filter for entries not starting with the text | |
department.not.contains |
query | string | No | Department - Filter for partial text mismatches | |
department.not.endsWith |
query | string | No | Department - Filter for entries not ending with the text | |
department.not.exists |
query | boolean | No | Department - Filter for entries without a value | |
email |
query | string | No | Email Address - Filter for full text matches | |
email.anyOf |
query | array | No | Email Address - Filter for entries where at least one reference matches the query | |
email.beginsWith |
query | string | No | Email Address - Filter for entries starting with the text | |
email.contains |
query | string | No | Email Address - Filter for partial text matches | |
email.endsWith |
query | string | No | Email Address - Filter for entries ending with the text | |
email.exists |
query | boolean | No | Email Address - Filter for entries with a value | |
email.not |
query | string | No | Email Address - Filter for full text mismatches | |
email.not.anyOf |
query | array | No | Email Address - Filter for entries where at least one reference mismatches the query | |
email.not.beginsWith |
query | string | No | Email Address - Filter for entries not starting with the text | |
email.not.contains |
query | string | No | Email Address - Filter for partial text mismatches | |
email.not.endsWith |
query | string | No | Email Address - Filter for entries not ending with the text | |
email.not.exists |
query | boolean | No | Email Address - Filter for entries without a value | |
externalSource |
query | string | No | External source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External source - Filter for entries with a value | |
externalSource.not |
query | string | No | External source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External source - Filter for entries without a value | |
firstName |
query | string | No | First Name - Filter for full text matches | |
firstName.anyOf |
query | array | No | First Name - Filter for entries where at least one reference matches the query | |
firstName.beginsWith |
query | string | No | First Name - Filter for entries starting with the text | |
firstName.contains |
query | string | No | First Name - Filter for partial text matches | |
firstName.endsWith |
query | string | No | First Name - Filter for entries ending with the text | |
firstName.exists |
query | boolean | No | First Name - Filter for entries with a value | |
firstName.not |
query | string | No | First Name - Filter for full text mismatches | |
firstName.not.anyOf |
query | array | No | First Name - Filter for entries where at least one reference mismatches the query | |
firstName.not.beginsWith |
query | string | No | First Name - Filter for entries not starting with the text | |
firstName.not.contains |
query | string | No | First Name - Filter for partial text mismatches | |
firstName.not.endsWith |
query | string | No | First Name - Filter for entries not ending with the text | |
firstName.not.exists |
query | boolean | No | First Name - Filter for entries without a value | |
fullName |
query | string | No | Full Name - Filter for full text matches | |
fullName.anyOf |
query | array | No | Full Name - Filter for entries where at least one reference matches the query | |
fullName.beginsWith |
query | string | No | Full Name - Filter for entries starting with the text | |
fullName.contains |
query | string | No | Full Name - Filter for partial text matches | |
fullName.endsWith |
query | string | No | Full Name - Filter for entries ending with the text | |
fullName.not |
query | string | No | Full Name - Filter for full text mismatches | |
fullName.not.anyOf |
query | array | No | Full Name - Filter for entries where at least one reference mismatches the query | |
fullName.not.beginsWith |
query | string | No | Full Name - Filter for entries not starting with the text | |
fullName.not.contains |
query | string | No | Full Name - Filter for partial text mismatches | |
fullName.not.endsWith |
query | string | No | Full Name - Filter for entries not ending with the text | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
isActive |
query | boolean | No | Active - Filter for yes/no statement | |
isProvided |
query | boolean | No | Is Provided - Filter for yes/no statement | |
isServiceAccount |
query | boolean | No | Is service account? - Filter for yes/no statement | |
isSystemAdmin |
query | boolean | No | System Administrator - Filter for yes/no statement | |
lastLogin.after |
query | string | No | Last Login - Filter for entries with dates after the specified value | |
lastLogin.before |
query | string | No | Last Login - Filter for entries with dates before the specified value | |
lastLogin.between |
query | array | No | Last Login - Filter for entries with dates between two specified values (inclusive) | |
lastLogin.exists |
query | boolean | No | Last Login - Filter for entries with a value | |
lastLogin.not.between |
query | array | No | Last Login - Filter for entries with dates not between two specified values (inclusive) | |
lastLogin.not.exists |
query | boolean | No | Last Login - Filter for entries without a value | |
lastLogin.not.on |
query | string | No | Last Login - Filter for entries with dates not matching the specified value | |
lastLogin.on |
query | string | No | Last Login - Filter for entries with dates exactly matching the specified value | |
lastLogin.onOrAfter |
query | string | No | Last Login - Filter for entries with dates on or after the specified value | |
lastLogin.onOrBefore |
query | string | No | Last Login - Filter for entries with dates on or before the specified value | |
lastName |
query | string | No | Last Name - Filter for full text matches | |
lastName.anyOf |
query | array | No | Last Name - Filter for entries where at least one reference matches the query | |
lastName.beginsWith |
query | string | No | Last Name - Filter for entries starting with the text | |
lastName.contains |
query | string | No | Last Name - Filter for partial text matches | |
lastName.endsWith |
query | string | No | Last Name - Filter for entries ending with the text | |
lastName.exists |
query | boolean | No | Last Name - Filter for entries with a value | |
lastName.not |
query | string | No | Last Name - Filter for full text mismatches | |
lastName.not.anyOf |
query | array | No | Last Name - Filter for entries where at least one reference mismatches the query | |
lastName.not.beginsWith |
query | string | No | Last Name - Filter for entries not starting with the text | |
lastName.not.contains |
query | string | No | Last Name - Filter for partial text mismatches | |
lastName.not.endsWith |
query | string | No | Last Name - Filter for entries not ending with the text | |
lastName.not.exists |
query | boolean | No | Last Name - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
organization |
query | string | No | Organization - Filter for full text matches | |
organization.anyOf |
query | array | No | Organization - Filter for entries where at least one reference matches the query | |
organization.beginsWith |
query | string | No | Organization - Filter for entries starting with the text | |
organization.contains |
query | string | No | Organization - Filter for partial text matches | |
organization.endsWith |
query | string | No | Organization - Filter for entries ending with the text | |
organization.exists |
query | boolean | No | Organization - Filter for entries with a value | |
organization.not |
query | string | No | Organization - Filter for full text mismatches | |
organization.not.anyOf |
query | array | No | Organization - Filter for entries where at least one reference mismatches the query | |
organization.not.beginsWith |
query | string | No | Organization - Filter for entries not starting with the text | |
organization.not.contains |
query | string | No | Organization - Filter for partial text mismatches | |
organization.not.endsWith |
query | string | No | Organization - Filter for entries not ending with the text | |
organization.not.exists |
query | boolean | No | Organization - Filter for entries without a value | |
provider |
query | string | No | Provider - Filter for full text matches | |
provider.anyOf |
query | array | No | Provider - Filter for entries where at least one reference matches the query | |
provider.beginsWith |
query | string | No | Provider - Filter for entries starting with the text | |
provider.contains |
query | string | No | Provider - Filter for partial text matches | |
provider.endsWith |
query | string | No | Provider - Filter for entries ending with the text | |
provider.exists |
query | boolean | No | Provider - Filter for entries with a value | |
provider.not |
query | string | No | Provider - Filter for full text mismatches | |
provider.not.anyOf |
query | array | No | Provider - Filter for entries where at least one reference mismatches the query | |
provider.not.beginsWith |
query | string | No | Provider - Filter for entries not starting with the text | |
provider.not.contains |
query | string | No | Provider - Filter for partial text mismatches | |
provider.not.endsWith |
query | string | No | Provider - Filter for entries not ending with the text | |
provider.not.exists |
query | boolean | No | Provider - Filter for entries without a value | |
role |
query | No | Role - Filter for single value choice | ||
role.anyOf |
query | array | No | Role - ('Filter for excluding a subset of value choices',) | |
role.not |
query | No | Role - ('Filter for all but a single value choice',) | ||
shareable |
query | boolean | No | Shareable - Filter for yes/no statement | |
shareable.exists |
query | boolean | No | Shareable - Filter for entries with a value | |
shareable.not.exists |
query | boolean | No | Shareable - Filter for entries without a value | |
title |
query | string | No | Title - Filter for full text matches | |
title.anyOf |
query | array | No | Title - Filter for entries where at least one reference matches the query | |
title.beginsWith |
query | string | No | Title - Filter for entries starting with the text | |
title.contains |
query | string | No | Title - Filter for partial text matches | |
title.endsWith |
query | string | No | Title - Filter for entries ending with the text | |
title.exists |
query | boolean | No | Title - Filter for entries with a value | |
title.not |
query | string | No | Title - Filter for full text mismatches | |
title.not.anyOf |
query | array | No | Title - Filter for entries where at least one reference mismatches the query | |
title.not.beginsWith |
query | string | No | Title - Filter for entries not starting with the text | |
title.not.contains |
query | string | No | Title - Filter for partial text mismatches | |
title.not.endsWith |
query | string | No | Title - Filter for entries not ending with the text | |
title.not.exists |
query | boolean | No | Title - Filter for entries without a value | |
username |
query | string | No | Username - Filter for full text matches | |
username.anyOf |
query | array | No | Username - Filter for entries where at least one reference matches the query | |
username.beginsWith |
query | string | No | Username - Filter for entries starting with the text | |
username.contains |
query | string | No | Username - Filter for partial text matches | |
username.endsWith |
query | string | No | Username - Filter for entries ending with the text | |
username.not |
query | string | No | Username - Filter for full text mismatches | |
username.not.anyOf |
query | array | No | Username - Filter for entries where at least one reference mismatches the query | |
username.not.beginsWith |
query | string | No | Username - Filter for entries not starting with the text | |
username.not.contains |
query | string | No | Username - Filter for partial text mismatches | |
username.not.endsWith |
query | string | No | Username - Filter for entries not ending with the text |
Responses
{
"count": 0,
"items": [
{
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"externalSource": "string",
"externalSourceId": "string",
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true,
"id": "6fc64e8f-9669-4b6c-af92-670df27a9916",
"fullName": "string",
"role": "External",
"canViewCases": true,
"canViewProjects": true,
"canViewCohorts": true,
"canViewUsers": true,
"canViewDatasets": true,
"canManageCases": true,
"canExportData": true,
"canManageProjects": true,
"canManageUsers": true,
"isSystemAdmin": true,
"isProvided": true,
"provider": "string"
}
]
}
POST /api/v1/users¶
Create User
Description
Creates a new user with the provided payload.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"externalSource": "string",
"externalSourceId": "string",
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true
}
Schema of the request body
{
"properties": {
"lastLogin": {
"description": "",
"format": "date-time",
"title": "Last Login",
"type": "string"
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"title": "Username",
"type": "string"
},
"firstName": {
"description": "",
"maxLength": 150,
"title": "First Name",
"type": "string"
},
"lastName": {
"description": "",
"maxLength": 150,
"title": "Last Name",
"type": "string"
},
"email": {
"description": "",
"maxLength": 254,
"title": "Email Address",
"type": "string"
},
"isActive": {
"default": true,
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
"title": "Active",
"type": "boolean"
},
"externalSource": {
"description": "Name of the source from which the user originated, if imported",
"maxLength": 500,
"title": "External source",
"type": "string"
},
"externalSourceId": {
"description": "Unique identifier within the source from which the user originated, if imported",
"maxLength": 500,
"title": "External source ID",
"type": "string"
},
"isServiceAccount": {
"default": false,
"description": "Whether the user is a technical service account",
"title": "Is service account?",
"type": "boolean"
},
"title": {
"description": "Personal title of the user",
"maxLength": 100,
"title": "Title",
"type": "string"
},
"organization": {
"description": "Organization to which the user belongs to",
"maxLength": 100,
"title": "Organization",
"type": "string"
},
"department": {
"description": "Department within an organization to which the user belongs to",
"maxLength": 100,
"title": "Department",
"type": "string"
},
"accessLevel": {
"default": 0,
"description": "Level of access of the user in terms of permissions",
"title": "Access level",
"type": "integer"
},
"shareable": {
"description": "Whether user has consented to its data to be shared with other Onconova instances",
"title": "Shareable",
"type": "boolean"
}
},
"required": [
"username"
],
"title": "UserCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/users/{userId}¶
Get User By Id
Description
Retrieve a user instance by its unique ID.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
userId |
path | string | No |
Responses
{
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"externalSource": "string",
"externalSourceId": "string",
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true,
"id": "8b95e005-f169-4973-abc7-2508954f4f15",
"fullName": "string",
"role": "External",
"canViewCases": true,
"canViewProjects": true,
"canViewCohorts": true,
"canViewUsers": true,
"canViewDatasets": true,
"canManageCases": true,
"canExportData": true,
"canManageProjects": true,
"canManageUsers": true,
"isSystemAdmin": true,
"isProvided": true,
"provider": "string"
}
Schema of the response body
{
"properties": {
"lastLogin": {
"description": "",
"format": "date-time",
"title": "Last Login",
"type": "string"
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"title": "Username",
"type": "string"
},
"firstName": {
"description": "",
"maxLength": 150,
"title": "First Name",
"type": "string"
},
"lastName": {
"description": "",
"maxLength": 150,
"title": "Last Name",
"type": "string"
},
"email": {
"description": "",
"maxLength": 254,
"title": "Email Address",
"type": "string"
},
"isActive": {
"default": true,
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
"title": "Active",
"type": "boolean"
},
"externalSource": {
"description": "Name of the source from which the user originated, if imported",
"maxLength": 500,
"title": "External source",
"type": "string"
},
"externalSourceId": {
"description": "Unique identifier within the source from which the user originated, if imported",
"maxLength": 500,
"title": "External source ID",
"type": "string"
},
"isServiceAccount": {
"default": false,
"description": "Whether the user is a technical service account",
"title": "Is service account?",
"type": "boolean"
},
"title": {
"description": "Personal title of the user",
"maxLength": 100,
"title": "Title",
"type": "string"
},
"organization": {
"description": "Organization to which the user belongs to",
"maxLength": 100,
"title": "Organization",
"type": "string"
},
"department": {
"description": "Department within an organization to which the user belongs to",
"maxLength": 100,
"title": "Department",
"type": "string"
},
"accessLevel": {
"default": 0,
"description": "Level of access of the user in terms of permissions",
"title": "Access level",
"type": "integer"
},
"shareable": {
"description": "Whether user has consented to its data to be shared with other Onconova instances",
"title": "Shareable",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"fullName": {
"description": "The user's full name.",
"title": "Full Name",
"type": "string"
},
"role": {
"$ref": "#/components/schemas/AccessRoles",
"description": "The user's assigned access role.",
"title": "Role"
},
"canViewCases": {
"description": "Permission to view cases.",
"title": "View Cases",
"type": "boolean"
},
"canViewProjects": {
"description": "Permission to view projects.",
"title": "View Projects",
"type": "boolean"
},
"canViewCohorts": {
"description": "Permission to view cohorts.",
"title": "View Cohorts",
"type": "boolean"
},
"canViewUsers": {
"description": "Permission to view other user accounts.",
"title": "View Users",
"type": "boolean"
},
"canViewDatasets": {
"description": "Permission to view available datasets.",
"title": "View Datasets",
"type": "boolean"
},
"canManageCases": {
"description": "Permission to manage cases.",
"title": "Manage Cases",
"type": "boolean"
},
"canExportData": {
"description": "Permission to export data out of the system.",
"title": "Export Data",
"type": "boolean"
},
"canManageProjects": {
"description": "Permission to manage projects.",
"title": "Manage Projects",
"type": "boolean"
},
"canManageUsers": {
"description": "Permission to create and manage users.",
"title": "Manage Users",
"type": "boolean"
},
"isSystemAdmin": {
"description": "Whether the user is a system administrator.",
"title": "System Administrator",
"type": "boolean"
},
"isProvided": {
"description": "Indicates whether the user account is externally provided.",
"title": "Is Provided",
"type": "boolean"
},
"provider": {
"description": "The external authentication provider, if applicable.",
"title": "Provider",
"type": "string"
}
},
"required": [
"username",
"id",
"fullName",
"role",
"canViewCases",
"canViewProjects",
"canViewCohorts",
"canViewUsers",
"canViewDatasets",
"canManageCases",
"canExportData",
"canManageProjects",
"canManageUsers",
"isSystemAdmin",
"isProvided"
],
"title": "User",
"type": "object"
}
PUT /api/v1/users/{userId}¶
Update User
Description
Updates the specified user's information using the provided payload.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
userId |
path | string | No |
Request body
{
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"externalSource": "string",
"externalSourceId": "string",
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true
}
Schema of the request body
{
"properties": {
"lastLogin": {
"description": "",
"format": "date-time",
"title": "Last Login",
"type": "string"
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"title": "Username",
"type": "string"
},
"firstName": {
"description": "",
"maxLength": 150,
"title": "First Name",
"type": "string"
},
"lastName": {
"description": "",
"maxLength": 150,
"title": "Last Name",
"type": "string"
},
"email": {
"description": "",
"maxLength": 254,
"title": "Email Address",
"type": "string"
},
"isActive": {
"default": true,
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
"title": "Active",
"type": "boolean"
},
"externalSource": {
"description": "Name of the source from which the user originated, if imported",
"maxLength": 500,
"title": "External source",
"type": "string"
},
"externalSourceId": {
"description": "Unique identifier within the source from which the user originated, if imported",
"maxLength": 500,
"title": "External source ID",
"type": "string"
},
"isServiceAccount": {
"default": false,
"description": "Whether the user is a technical service account",
"title": "Is service account?",
"type": "boolean"
},
"title": {
"description": "Personal title of the user",
"maxLength": 100,
"title": "Title",
"type": "string"
},
"organization": {
"description": "Organization to which the user belongs to",
"maxLength": 100,
"title": "Organization",
"type": "string"
},
"department": {
"description": "Department within an organization to which the user belongs to",
"maxLength": 100,
"title": "Department",
"type": "string"
},
"accessLevel": {
"default": 0,
"description": "Level of access of the user in terms of permissions",
"title": "Access level",
"type": "integer"
},
"shareable": {
"description": "Whether user has consented to its data to be shared with other Onconova instances",
"title": "Shareable",
"type": "boolean"
}
},
"required": [
"username"
],
"title": "UserCreate",
"type": "object"
}
Responses
{
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"externalSource": "string",
"externalSourceId": "string",
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true,
"id": "26940bd6-8f02-4c55-8f50-48ed6f789b65",
"fullName": "string",
"role": "External",
"canViewCases": true,
"canViewProjects": true,
"canViewCohorts": true,
"canViewUsers": true,
"canViewDatasets": true,
"canManageCases": true,
"canExportData": true,
"canManageProjects": true,
"canManageUsers": true,
"isSystemAdmin": true,
"isProvided": true,
"provider": "string"
}
Schema of the response body
{
"properties": {
"lastLogin": {
"description": "",
"format": "date-time",
"title": "Last Login",
"type": "string"
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"title": "Username",
"type": "string"
},
"firstName": {
"description": "",
"maxLength": 150,
"title": "First Name",
"type": "string"
},
"lastName": {
"description": "",
"maxLength": 150,
"title": "Last Name",
"type": "string"
},
"email": {
"description": "",
"maxLength": 254,
"title": "Email Address",
"type": "string"
},
"isActive": {
"default": true,
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
"title": "Active",
"type": "boolean"
},
"externalSource": {
"description": "Name of the source from which the user originated, if imported",
"maxLength": 500,
"title": "External source",
"type": "string"
},
"externalSourceId": {
"description": "Unique identifier within the source from which the user originated, if imported",
"maxLength": 500,
"title": "External source ID",
"type": "string"
},
"isServiceAccount": {
"default": false,
"description": "Whether the user is a technical service account",
"title": "Is service account?",
"type": "boolean"
},
"title": {
"description": "Personal title of the user",
"maxLength": 100,
"title": "Title",
"type": "string"
},
"organization": {
"description": "Organization to which the user belongs to",
"maxLength": 100,
"title": "Organization",
"type": "string"
},
"department": {
"description": "Department within an organization to which the user belongs to",
"maxLength": 100,
"title": "Department",
"type": "string"
},
"accessLevel": {
"default": 0,
"description": "Level of access of the user in terms of permissions",
"title": "Access level",
"type": "integer"
},
"shareable": {
"description": "Whether user has consented to its data to be shared with other Onconova instances",
"title": "Shareable",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"fullName": {
"description": "The user's full name.",
"title": "Full Name",
"type": "string"
},
"role": {
"$ref": "#/components/schemas/AccessRoles",
"description": "The user's assigned access role.",
"title": "Role"
},
"canViewCases": {
"description": "Permission to view cases.",
"title": "View Cases",
"type": "boolean"
},
"canViewProjects": {
"description": "Permission to view projects.",
"title": "View Projects",
"type": "boolean"
},
"canViewCohorts": {
"description": "Permission to view cohorts.",
"title": "View Cohorts",
"type": "boolean"
},
"canViewUsers": {
"description": "Permission to view other user accounts.",
"title": "View Users",
"type": "boolean"
},
"canViewDatasets": {
"description": "Permission to view available datasets.",
"title": "View Datasets",
"type": "boolean"
},
"canManageCases": {
"description": "Permission to manage cases.",
"title": "Manage Cases",
"type": "boolean"
},
"canExportData": {
"description": "Permission to export data out of the system.",
"title": "Export Data",
"type": "boolean"
},
"canManageProjects": {
"description": "Permission to manage projects.",
"title": "Manage Projects",
"type": "boolean"
},
"canManageUsers": {
"description": "Permission to create and manage users.",
"title": "Manage Users",
"type": "boolean"
},
"isSystemAdmin": {
"description": "Whether the user is a system administrator.",
"title": "System Administrator",
"type": "boolean"
},
"isProvided": {
"description": "Indicates whether the user account is externally provided.",
"title": "Is Provided",
"type": "boolean"
},
"provider": {
"description": "The external authentication provider, if applicable.",
"title": "Provider",
"type": "string"
}
},
"required": [
"username",
"id",
"fullName",
"role",
"canViewCases",
"canViewProjects",
"canViewCohorts",
"canViewUsers",
"canViewDatasets",
"canManageCases",
"canExportData",
"canManageProjects",
"canManageUsers",
"isSystemAdmin",
"isProvided"
],
"title": "User",
"type": "object"
}
PUT /api/v1/users/{userId}/profile¶
Update User Profile
Description
Updates the profile information of a user with the given user ID.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
userId |
path | string | No |
Request body
{
"firstName": "string",
"lastName": "string",
"organization": "string",
"department": "string",
"title": "string",
"email": "string"
}
Schema of the request body
{
"description": "Schema representing a user's profile information.\n\nAttributes:\n firstName (Optional[str]): The user's given name. Accepts either 'firstName' or 'first_name' as input.\n lastName (Optional[str]): The user's surname. Accepts either 'lastName' or 'last_name' as input.\n organization (Optional[str]): The user's affiliated organization.\n department (Optional[str]): The user's department within the organization.\n title (Optional[str]): The user's job title or position.\n email (str): The user's primary email address.",
"properties": {
"firstName": {
"description": "The user's given name.",
"title": "First Name",
"type": "string"
},
"lastName": {
"description": "The user's surname.",
"title": "Last Name",
"type": "string"
},
"organization": {
"description": "The user's affiliated organization.",
"title": "Organization",
"type": "string"
},
"department": {
"description": "The user's department within the organization.",
"title": "Department",
"type": "string"
},
"title": {
"description": "The user's job title or position.",
"title": "Job Title",
"type": "string"
},
"email": {
"description": "The user's primary email address.",
"title": "Email Address",
"type": "string"
}
},
"required": [
"firstName",
"lastName",
"email"
],
"title": "UserProfile",
"type": "object"
}
Responses
{
"lastLogin": "2022-04-13T15:42:05.901Z",
"username": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"isActive": true,
"externalSource": "string",
"externalSourceId": "string",
"isServiceAccount": true,
"title": "string",
"organization": "string",
"department": "string",
"accessLevel": 0,
"shareable": true,
"id": "c47d59c6-5d6e-415b-b3e3-8589f42ba5ac",
"fullName": "string",
"role": "External",
"canViewCases": true,
"canViewProjects": true,
"canViewCohorts": true,
"canViewUsers": true,
"canViewDatasets": true,
"canManageCases": true,
"canExportData": true,
"canManageProjects": true,
"canManageUsers": true,
"isSystemAdmin": true,
"isProvided": true,
"provider": "string"
}
Schema of the response body
{
"properties": {
"lastLogin": {
"description": "",
"format": "date-time",
"title": "Last Login",
"type": "string"
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"title": "Username",
"type": "string"
},
"firstName": {
"description": "",
"maxLength": 150,
"title": "First Name",
"type": "string"
},
"lastName": {
"description": "",
"maxLength": 150,
"title": "Last Name",
"type": "string"
},
"email": {
"description": "",
"maxLength": 254,
"title": "Email Address",
"type": "string"
},
"isActive": {
"default": true,
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
"title": "Active",
"type": "boolean"
},
"externalSource": {
"description": "Name of the source from which the user originated, if imported",
"maxLength": 500,
"title": "External source",
"type": "string"
},
"externalSourceId": {
"description": "Unique identifier within the source from which the user originated, if imported",
"maxLength": 500,
"title": "External source ID",
"type": "string"
},
"isServiceAccount": {
"default": false,
"description": "Whether the user is a technical service account",
"title": "Is service account?",
"type": "boolean"
},
"title": {
"description": "Personal title of the user",
"maxLength": 100,
"title": "Title",
"type": "string"
},
"organization": {
"description": "Organization to which the user belongs to",
"maxLength": 100,
"title": "Organization",
"type": "string"
},
"department": {
"description": "Department within an organization to which the user belongs to",
"maxLength": 100,
"title": "Department",
"type": "string"
},
"accessLevel": {
"default": 0,
"description": "Level of access of the user in terms of permissions",
"title": "Access level",
"type": "integer"
},
"shareable": {
"description": "Whether user has consented to its data to be shared with other Onconova instances",
"title": "Shareable",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"fullName": {
"description": "The user's full name.",
"title": "Full Name",
"type": "string"
},
"role": {
"$ref": "#/components/schemas/AccessRoles",
"description": "The user's assigned access role.",
"title": "Role"
},
"canViewCases": {
"description": "Permission to view cases.",
"title": "View Cases",
"type": "boolean"
},
"canViewProjects": {
"description": "Permission to view projects.",
"title": "View Projects",
"type": "boolean"
},
"canViewCohorts": {
"description": "Permission to view cohorts.",
"title": "View Cohorts",
"type": "boolean"
},
"canViewUsers": {
"description": "Permission to view other user accounts.",
"title": "View Users",
"type": "boolean"
},
"canViewDatasets": {
"description": "Permission to view available datasets.",
"title": "View Datasets",
"type": "boolean"
},
"canManageCases": {
"description": "Permission to manage cases.",
"title": "Manage Cases",
"type": "boolean"
},
"canExportData": {
"description": "Permission to export data out of the system.",
"title": "Export Data",
"type": "boolean"
},
"canManageProjects": {
"description": "Permission to manage projects.",
"title": "Manage Projects",
"type": "boolean"
},
"canManageUsers": {
"description": "Permission to create and manage users.",
"title": "Manage Users",
"type": "boolean"
},
"isSystemAdmin": {
"description": "Whether the user is a system administrator.",
"title": "System Administrator",
"type": "boolean"
},
"isProvided": {
"description": "Indicates whether the user account is externally provided.",
"title": "Is Provided",
"type": "boolean"
},
"provider": {
"description": "The external authentication provider, if applicable.",
"title": "Provider",
"type": "string"
}
},
"required": [
"username",
"id",
"fullName",
"role",
"canViewCases",
"canViewProjects",
"canViewCohorts",
"canViewUsers",
"canViewDatasets",
"canManageCases",
"canExportData",
"canManageProjects",
"canManageUsers",
"isSystemAdmin",
"isProvided"
],
"title": "User",
"type": "object"
}
PUT /api/v1/users/{userId}/password¶
Update User Password
Description
Updates the password for a specified user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
userId |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"description": "Schema for user password reset operation.\n\nAttributes:\n oldPassword (str): The user's current password.\n newPassword (str): The user's new password to be set.",
"properties": {
"oldPassword": {
"description": "The user's current password.",
"title": "Old Password",
"type": "string"
},
"newPassword": {
"description": "The user's new password to be set.",
"title": "New Password",
"type": "string"
}
},
"required": [
"oldPassword",
"newPassword"
],
"title": "UserPasswordReset",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
POST /api/v1/users/{userId}/password/reset¶
Reset User Password
Description
Resets the password for the specified user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
password |
query | string | No | ||
userId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/users/{userId}/events¶
Get User Events
Description
Retrieves the event history for the specified user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
userId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Projects¶
GET /api/v1/projects¶
Get All Projects Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
clinicalCenters |
query | string | No | Clinical Centers - Filter for full text matches | |
clinicalCenters.anyOf |
query | array | No | Clinical Centers - Filter for entries where at least one reference matches the query | |
clinicalCenters.beginsWith |
query | string | No | Clinical Centers - Filter for entries starting with the text | |
clinicalCenters.contains |
query | string | No | Clinical Centers - Filter for partial text matches | |
clinicalCenters.endsWith |
query | string | No | Clinical Centers - Filter for entries ending with the text | |
clinicalCenters.not |
query | string | No | Clinical Centers - Filter for full text mismatches | |
clinicalCenters.not.anyOf |
query | array | No | Clinical Centers - Filter for entries where at least one reference mismatches the query | |
clinicalCenters.not.beginsWith |
query | string | No | Clinical Centers - Filter for entries not starting with the text | |
clinicalCenters.not.contains |
query | string | No | Clinical Centers - Filter for partial text mismatches | |
clinicalCenters.not.endsWith |
query | string | No | Clinical Centers - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
dataConstraints.exists |
query | boolean | No | Data constraints - Filter for entries with a value | |
dataConstraints.not.exists |
query | boolean | No | Data constraints - Filter for entries without a value | |
ethicsApprovalNumber |
query | string | No | Ethics approval number - Filter for full text matches | |
ethicsApprovalNumber.anyOf |
query | array | No | Ethics approval number - Filter for entries where at least one reference matches the query | |
ethicsApprovalNumber.beginsWith |
query | string | No | Ethics approval number - Filter for entries starting with the text | |
ethicsApprovalNumber.contains |
query | string | No | Ethics approval number - Filter for partial text matches | |
ethicsApprovalNumber.endsWith |
query | string | No | Ethics approval number - Filter for entries ending with the text | |
ethicsApprovalNumber.not |
query | string | No | Ethics approval number - Filter for full text mismatches | |
ethicsApprovalNumber.not.anyOf |
query | array | No | Ethics approval number - Filter for entries where at least one reference mismatches the query | |
ethicsApprovalNumber.not.beginsWith |
query | string | No | Ethics approval number - Filter for entries not starting with the text | |
ethicsApprovalNumber.not.contains |
query | string | No | Ethics approval number - Filter for partial text mismatches | |
ethicsApprovalNumber.not.endsWith |
query | string | No | Ethics approval number - Filter for entries not ending with the text | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
leader.username |
query | string | No | Project leader - Filter for username matches | |
leader.username.anyOf |
query | array | No | Project leader - Filter for entries where at least one reference mismatches the query | |
leader.username.not |
query | string | No | Project leader - Filter for username mismatches | |
leader.username.not.anyOf |
query | string | No | Project leader - Filter for entries where at least one reference matches the query | |
limit |
query | integer | 10 | No | |
members.exists |
query | boolean | No | Project members - Filter for entries with a value | |
members.not.exists |
query | boolean | No | Project members - Filter for entries without a value | |
members.username |
query | string | No | Project members - Filter for username matches | |
members.username.anyOf |
query | array | No | Project members - Filter for entries where at least one reference mismatches the query | |
members.username.not |
query | string | No | Project members - Filter for username mismatches | |
members.username.not.anyOf |
query | string | No | Project members - Filter for entries where at least one reference matches the query | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
status |
query | No | Project status - Filter for single value choice | ||
status.anyOf |
query | array | No | Project status - ('Filter for excluding a subset of value choices',) | |
status.exists |
query | boolean | No | Project status - Filter for entries with a value | |
status.not |
query | No | Project status - ('Filter for all but a single value choice',) | ||
status.not.exists |
query | boolean | No | Project status - Filter for entries without a value | |
summary |
query | string | No | Project description - Filter for full text matches | |
summary.anyOf |
query | array | No | Project description - Filter for entries where at least one reference matches the query | |
summary.beginsWith |
query | string | No | Project description - Filter for entries starting with the text | |
summary.contains |
query | string | No | Project description - Filter for partial text matches | |
summary.endsWith |
query | string | No | Project description - Filter for entries ending with the text | |
summary.not |
query | string | No | Project description - Filter for full text mismatches | |
summary.not.anyOf |
query | array | No | Project description - Filter for entries where at least one reference mismatches the query | |
summary.not.beginsWith |
query | string | No | Project description - Filter for entries not starting with the text | |
summary.not.contains |
query | string | No | Project description - Filter for partial text mismatches | |
summary.not.endsWith |
query | string | No | Project description - Filter for entries not ending with the text | |
title |
query | string | No | Project title - Filter for full text matches | |
title.anyOf |
query | array | No | Project title - Filter for entries where at least one reference matches the query | |
title.beginsWith |
query | string | No | Project title - Filter for entries starting with the text | |
title.contains |
query | string | No | Project title - Filter for partial text matches | |
title.endsWith |
query | string | No | Project title - Filter for entries ending with the text | |
title.not |
query | string | No | Project title - Filter for full text mismatches | |
title.not.anyOf |
query | array | No | Project title - Filter for entries where at least one reference mismatches the query | |
title.not.beginsWith |
query | string | No | Project title - Filter for entries not starting with the text | |
title.not.contains |
query | string | No | Project title - Filter for partial text mismatches | |
title.not.endsWith |
query | string | No | Project title - Filter for entries not ending with the text | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"id": "e9c67cde-dbc0-45ef-9596-abd4f20285c7",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"leader": "string",
"clinicalCenters": [
"string"
],
"title": "string",
"summary": "string",
"ethicsApprovalNumber": "string",
"status": null,
"dataConstraints": {},
"members": [
"string"
]
}
]
}
POST /api/v1/projects¶
Create Project
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"leader": "string",
"clinicalCenters": [
"string"
],
"title": "string",
"summary": "string",
"ethicsApprovalNumber": "string",
"status": null,
"dataConstraints": {},
"members": [
"string"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"leader": {
"description": "User responsible for the project and its members",
"title": "Project leader",
"type": "string"
},
"clinicalCenters": {
"description": "Clinical centers that are part of the project",
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Clinical Centers",
"type": "array"
},
"title": {
"description": "Title of the project",
"maxLength": 200,
"title": "Project title",
"type": "string"
},
"summary": {
"description": "Description of the project",
"title": "Project description",
"type": "string"
},
"ethicsApprovalNumber": {
"description": "Ethics approval number of the project",
"maxLength": 100,
"title": "Ethics approval number",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectStatusChoices"
}
],
"default": "planned",
"description": "Status of the project",
"title": "Project status"
},
"dataConstraints": {
"additionalProperties": true,
"description": "Data constraints of the project",
"title": "Data constraints",
"type": "object"
},
"members": {
"description": "Users that are part of the project",
"items": {
"type": "string"
},
"title": "Project members",
"type": "array"
}
},
"required": [
"leader",
"clinicalCenters",
"title",
"summary",
"ethicsApprovalNumber"
],
"title": "ProjectCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/projects/{projectId}¶
Get Project By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
projectId |
path | string | No |
Responses
{
"id": "ea536435-fc6c-456a-a1b0-395622521807",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"leader": "string",
"clinicalCenters": [
"string"
],
"title": "string",
"summary": "string",
"ethicsApprovalNumber": "string",
"status": null,
"dataConstraints": {},
"members": [
"string"
]
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"leader": {
"description": "User responsible for the project and its members",
"title": "Project leader",
"type": "string"
},
"clinicalCenters": {
"description": "Clinical centers that are part of the project",
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Clinical Centers",
"type": "array"
},
"title": {
"description": "Title of the project",
"maxLength": 200,
"title": "Project title",
"type": "string"
},
"summary": {
"description": "Description of the project",
"title": "Project description",
"type": "string"
},
"ethicsApprovalNumber": {
"description": "Ethics approval number of the project",
"maxLength": 100,
"title": "Ethics approval number",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectStatusChoices"
}
],
"default": "planned",
"description": "Status of the project",
"title": "Project status"
},
"dataConstraints": {
"additionalProperties": true,
"description": "Data constraints of the project",
"title": "Data constraints",
"type": "object"
},
"members": {
"description": "Users that are part of the project",
"items": {
"type": "string"
},
"title": "Project members",
"type": "array"
}
},
"required": [
"id",
"description",
"leader",
"clinicalCenters",
"title",
"summary",
"ethicsApprovalNumber"
],
"title": "Project",
"type": "object"
}
PUT /api/v1/projects/{projectId}¶
Update Project
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
projectId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"leader": "string",
"clinicalCenters": [
"string"
],
"title": "string",
"summary": "string",
"ethicsApprovalNumber": "string",
"status": null,
"dataConstraints": {},
"members": [
"string"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"leader": {
"description": "User responsible for the project and its members",
"title": "Project leader",
"type": "string"
},
"clinicalCenters": {
"description": "Clinical centers that are part of the project",
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Clinical Centers",
"type": "array"
},
"title": {
"description": "Title of the project",
"maxLength": 200,
"title": "Project title",
"type": "string"
},
"summary": {
"description": "Description of the project",
"title": "Project description",
"type": "string"
},
"ethicsApprovalNumber": {
"description": "Ethics approval number of the project",
"maxLength": 100,
"title": "Ethics approval number",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectStatusChoices"
}
],
"default": "planned",
"description": "Status of the project",
"title": "Project status"
},
"dataConstraints": {
"additionalProperties": true,
"description": "Data constraints of the project",
"title": "Data constraints",
"type": "object"
},
"members": {
"description": "Users that are part of the project",
"items": {
"type": "string"
},
"title": "Project members",
"type": "array"
}
},
"required": [
"leader",
"clinicalCenters",
"title",
"summary",
"ethicsApprovalNumber"
],
"title": "ProjectCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/projects/{projectId}¶
Delete Project
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
projectId |
path | string | No |
Responses
GET /api/v1/projects/{projectId}/history/events¶
Get All Project History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
projectId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/projects/{projectId}/history/events/{eventId}¶
Get Project History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
projectId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/projects/{projectId}/history/events/{eventId}/reversion¶
Revert Project To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
projectId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants¶
Get All Project Data Manager Grant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
memberId |
path | string | No | ||
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
projectId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": "c45c50e2-5055-487d-a93b-3909a830bfea",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"revoked": true,
"validityPeriod": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"isValid": true,
"member": "string",
"projectId": "ecc0e900-60a3-4284-8fcb-736f7f48346f"
}
]
}
Schema of the response body
POST /api/v1/projects/{projectId}/members/{memberId}/data-management/grants¶
Create Project Data Manager Grant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
memberId |
path | string | No | ||
projectId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"revoked": true,
"validityPeriod": {
"start": "2022-04-13",
"end": "2022-04-13"
}
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"revoked": {
"default": false,
"description": "A flag that indicated whether the authorization has been revoked",
"title": "Revoked",
"type": "boolean"
},
"validityPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Period of validity",
"title": "Validity period"
}
},
"required": [
"validityPeriod"
],
"title": "ProjectDataManagerGrantCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}¶
Check Project Data Manager Grant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
grantId |
path | string | No | ||
memberId |
path | string | No | ||
projectId |
path | string | No |
Responses
{
"id": "ac328ffa-892c-4394-a3fd-c3eee19240c9",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"revoked": true,
"validityPeriod": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"isValid": true,
"member": "string",
"projectId": "0d39e46a-30c8-40d0-b7fc-d0ba7f29ef1b"
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"revoked": {
"default": false,
"description": "A flag that indicated whether the authorization has been revoked",
"title": "Revoked",
"type": "boolean"
},
"validityPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Period of validity",
"title": "Validity period"
},
"isValid": {
"description": "Whether the authorization grant is valid today",
"title": "Is valid",
"type": "boolean"
},
"member": {
"description": "Manager of the project data",
"title": "Manager",
"type": "string"
},
"projectId": {
"description": "Project under which the permission is granted",
"format": "uuid",
"title": "Project",
"type": "string"
}
},
"required": [
"id",
"description",
"validityPeriod",
"isValid",
"member",
"projectId"
],
"title": "ProjectDataManagerGrant",
"type": "object"
}
DELETE /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}¶
Revoke Project Data Manager Grant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
grantId |
path | string | No | ||
memberId |
path | string | No | ||
projectId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}/history/events¶
Get All Project Data Management Grant History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
grantId |
path | string | No | ||
limit |
query | integer | 10 | No | |
memberId |
path | string | No | ||
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
projectId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}/history/events/{eventId}¶
Get Project Data Management Grant History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
grantId |
path | string | No | ||
memberId |
path | string | No | ||
projectId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}/history/events/{eventId}/reversion¶
Revert Project Data Management Grant To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
grantId |
path | string | No | ||
memberId |
path | string | No | ||
projectId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Interoperability¶
GET /api/v1/interoperability/resources/{resourceId}¶
Export Resource
Description
Exports a resource identified by its UUID, serializing its data and associated metadata.
Notes:
- Creates an export event for the resource using `pghistory.create_event`.
- Computes a checksum of the exported data for integrity verification.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
resourceId |
path | string | No |
Responses
GET /api/v1/interoperability/resources/{resourceId}/description¶
Resolve Resource Id
Description
Resolves a resource ID by searching across models for a matching UUID.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
resourceId |
path | string | No |
Responses
GET /api/v1/interoperability/bundles/{caseId}¶
Export Case Bundle
Description
Exports a patient case bundle by retrieving the PatientCase object with the given case ID, creates an export event for the case, and returns the exported case object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No |
Responses
{
"anonymized": true,
"id": "709508e5-c6c4-404e-93cb-89faee16d352",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"pseudoidentifier": "string",
"age": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"neoplasticEntities": [
{
"anonymized": true,
"id": "95c924d0-09fa-409e-91fb-751a68a3c235",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f3516498-7cf4-4b32-98a7-bc776c470b0c",
"relationship": "primary",
"relatedPrimaryId": "62528096-c3b2-4fec-8479-797e57d9e385",
"assertionDate": "2022-04-13",
"topography": null,
"morphology": null,
"differentitation": null,
"laterality": null,
"topographyGroup": null
}
],
"stagings": [
null
],
"tumorMarkers": [
{
"anonymized": true,
"id": "909ab5dd-97f4-42f4-965b-6e519332e60d",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b6d56d3c-5dfa-4133-88a2-61a9189ebc30",
"date": "2022-04-13",
"analyte": null,
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"a5a08ca9-5080-4127-9798-2810f7155101"
]
}
],
"riskAssessments": [
{
"anonymized": true,
"id": "ce7ec8d1-45f2-448f-81f8-6e489f769c13",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "91785b33-a5b5-4b3c-9432-466e1cf37f64",
"date": "2022-04-13",
"methodology": null,
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"82648bf2-ae20-40e3-aaa6-d78cb013c75d"
]
}
],
"therapyLines": [
{
"anonymized": true,
"id": "76635d37-153d-419b-8fb0-e573c716adf9",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ebdb5285-c3d8-4144-b155-d84b6b6cfe8f",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13",
"period": null,
"label": "string",
"progressionFreeSurvival": 10.12
}
],
"systemicTherapies": [
{
"anonymized": true,
"id": "6f80b115-727d-44ee-9f4b-8ea2e17af207",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0544e47e-c151-4fe2-9cbb-7e6292455a20",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"terminationReason": null,
"therapyLineId": "2a6f7a0b-368a-43ef-8ae5-41782c513039",
"targetedEntitiesIds": [
"abadb57b-57c4-452e-acda-c5703a97a942"
],
"medications": [
{
"id": "7b6c9f51-ec2b-4cec-9645-4191f8d00f9e",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"drug": null,
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
],
"isAdjunctive": true,
"duration": {
"value": 10.12,
"unit": "string"
}
}
],
"surgeries": [
{
"anonymized": true,
"id": "14c27317-500a-4fa4-8b85-bc2b57bcf47c",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "35936c5d-df0d-4bfd-9785-b59db08941a2",
"date": "2022-04-13",
"procedure": null,
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "89fa76e7-d36d-4cf7-89ae-ff8225b7b2dd",
"targetedEntitiesIds": [
"3804927d-b4a3-495e-9d15-70eea1efccd0"
]
}
],
"radiotherapies": [
{
"anonymized": true,
"id": "4be904ce-f235-448a-86b2-730e5b901272",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "54162752-cb72-4665-98fb-7a5c73c186b6",
"period": null,
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "307c5473-dec9-4ec8-8c85-358b00b01417",
"targetedEntitiesIds": [
"8cb5e9fb-7e3d-43ac-8554-ca9544409c95"
],
"duration": null,
"dosages": [
{
"id": "719a8985-8020-4ab5-8c93-92f7245d3bd2",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": null,
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
],
"settings": [
{
"id": "dd6533ab-36e6-4be8-8dfd-c69df30e3ca8",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null
}
]
}
],
"adverseEvents": [
{
"anonymized": true,
"id": "ef9795c8-ad33-4d11-8a73-f35b07cfcd11",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "df0c4215-5cc2-4bb4-9cf0-1b2e6997e0b7",
"date": "2022-04-13",
"event": null,
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13",
"suspectedCauses": [
{
"id": "174cc72d-b4e2-4361-81b1-53c7c20770dd",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "40d5e2d0-824a-4ef0-955a-dcdf0ff57cc5",
"medicationId": "3ada244e-7d7c-474e-8b04-bdbb459d801c",
"radiotherapyId": "692b2322-a668-44a9-bccf-7274ba250fe3",
"surgeryId": "1baa8f71-7b7f-4908-80ed-56bbdb09aa6d",
"causality": null
}
],
"mitigations": [
{
"id": "803ec53c-767c-498a-9a4d-59aaeda04816",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
]
}
],
"treatmentResponses": [
{
"anonymized": true,
"id": "f0ebb9b9-185e-4249-bc41-163b9ef61497",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "fbc51e9c-d10b-4f29-8596-8f384224b71e",
"date": "2022-04-13",
"recist": null,
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"612ce4a2-c3d3-40dc-8021-d5e699b3b668"
],
"assessedBodysites": null
}
],
"performanceStatus": [
{
"anonymized": true,
"id": "8ec84ce9-9fd4-4bdc-acf5-aa9b859e5901",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "7a599882-74ab-4b1d-a131-8dc7203e4872",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"ecogInterpretation": null,
"karnofskyInterpretation": null
}
],
"comorbidities": [
{
"anonymized": true,
"id": "cc325c84-b2ae-4d73-8141-f765bc14f351",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e75870a8-3b20-4011-b23c-9791fe98d83a",
"date": "2022-04-13",
"indexConditionId": "17ea76b3-437f-4817-9a20-3d0c6aa3becc",
"panel": null,
"presentConditions": null,
"absentConditions": null,
"score": null
}
],
"genomicVariants": [
{
"anonymized": true,
"id": "aca62106-cc79-4cfa-87f1-3b0e62a616eb",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "4d366d79-e22b-4236-833a-5957adce2389",
"date": "2022-04-13",
"genes": null,
"dnaHgvs": "string",
"rnaHgvs": "string",
"proteinHgvs": "string",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"source": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"hgvsVersion": "string",
"isPathogenic": true,
"isVUS": true,
"cytogeneticLocation": "string",
"chromosomes": [
"string"
],
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
]
}
],
"genomicSignatures": [
null
],
"vitals": [
{
"anonymized": true,
"id": "45ad6afb-0e3c-42dc-a1c5-41a01da877aa",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "bba5a948-9e96-4d83-8026-444213c6a570",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"bodyMassIndex": null
}
],
"lifestyles": [
{
"anonymized": true,
"id": "6240711e-e997-4ff9-91aa-33d52ad9af0c",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9a923bd5-8239-4b18-b9bf-96de2655275d",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": null,
"exposures": null
}
],
"familyHistory": [
{
"anonymized": true,
"id": "5fc49ff9-0f91-45ef-99c6-3d7fc3d75d27",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "26c45ede-c8c4-4b85-ac8d-d6b558e5bb8a",
"date": "2022-04-13",
"relationship": null,
"hadCancer": true,
"isDeceased": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null
}
],
"tumorBoards": [
null
],
"completedDataCategories": {},
"history": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
],
"contributorsDetails": [
{
"anonymized": true,
"id": "48b26f5e-5ac1-44b9-823c-614d4d57d256",
"externalSource": "string",
"externalSourceId": "string",
"username": "string",
"firstName": "string",
"lastName": "string",
"organization": "string",
"email": "string"
}
]
}
Schema of the response body
{
"description": "PatientCaseBundle aggregates all relevant patient case data for interoperability and import/export operations.\n\nThis schema extends PatientCase and organizes multiple related entities, such as neoplastic entities, stagings, tumor markers, risk assessments, therapies, surgeries, adverse events, treatment responses, performance status, comorbidities, genomic variants, genomic signatures, vitals, lifestyles, family history, tumor boards, completed data categories, and history events.\n\nThe order of properties is significant for import tools that rely on reference trees.\n\nAttributes:\n neoplasticEntities (List[NeoplasticEntity]): List of neoplastic entities associated with the patient case.\n stagings (List[Union[...]]): List of staging schemas (e.g., TNM, FIGO, Binet, etc.).\n tumorMarkers (List[TumorMarkerSchema]): List of tumor marker schemas.\n riskAssessments (List[RiskAssessment]): List of risk assessment schemas.\n therapyLines (List[TherapyLine]): List of therapy line schemas.\n systemicTherapies (List[SystemicTherapy]): List of systemic therapy schemas.\n surgeries (List[Surgery]): List of surgery schemas.\n radiotherapies (List[Radiotherapy]): List of radiotherapy schemas.\n adverseEvents (List[AdverseEvent]): List of adverse event schemas.\n treatmentResponses (List[TreatmentResponse]): List of treatment response schemas.\n performanceStatus (List[PerformanceStatus]): List of performance status schemas.\n comorbidities (List[ComorbiditiesAssessment]): List of comorbidities assessment schemas.\n genomicVariants (List[GenomicVariant]): List of genomic variant schemas.\n genomicSignatures (List[Union[...]]): List of genomic signature schemas (e.g., TMB, MSI, LOH, etc.).\n vitals (List[Vitals]): List of vitals schemas.\n lifestyles (List[Lifestyle]): List of lifestyle schemas.\n familyHistory (List[FamilyHistory]): List of family history schemas.\n tumorBoards (List[Union[UnspecifiedTumorBoard, MolecularTumorBoard]]): List of tumor board schemas.\n completedDataCategories (Dict[PatientCaseDataCategories, PatientCaseDataCompletionStatus]): Mapping of data categories to their completion status.\n history (List[HistoryEvent]): List of history events related to the patient case.\n\nMethods:\n resolve_stagings(obj): Resolves and serializes staging data for the patient case.\n resolve_genomicSignatures(obj): Resolves and serializes genomic signature data.\n resolve_tumorBoards(obj): Resolves and serializes tumor board data.\n resolve_completedDataCategories(obj): Resolves completion status for each data category.\n resolve_history(obj): Resolves and retrieves history events for the patient case.\n\nConfig:\n model_config: Serialization configuration (serialize_by_alias=False).",
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"clinicalCenter": {
"description": "Medical center where the patient data originally resides",
"maxLength": 200,
"title": "Medical center",
"type": "string"
},
"clinicalIdentifier": {
"description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
"maxLength": 100,
"title": "Clinical identifier",
"type": "string"
},
"consentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseConsentStatusChoices"
}
],
"default": "unknown",
"description": "Status of the general consent by the patient for the use of their data for research purposes",
"title": "Consent status"
},
"gender": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Gender of the patient for legal/administrative purposes",
"title": "Gender",
"x-terminology": "AdministrativeGender"
},
"race": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Race of the patient",
"title": "Race",
"x-terminology": "Race"
},
"sexAtBirth": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Sex assigned at birth",
"title": "Birth sex",
"x-terminology": "BirthSex"
},
"genderIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The patient's innate sense of their gender as reported",
"title": "Gender identity",
"x-terminology": "GenderIdentity"
},
"dateOfBirth": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"const": "*************",
"type": "string"
}
],
"description": "Date of birth of the patient",
"title": "Date of birth"
},
"vitalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseVitalStatusChoices"
}
],
"default": "unknown",
"description": "Whether the patient is known to be alive or decaeased or is unknkown.",
"title": "Vital status"
},
"dateOfDeath": {
"description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of death",
"type": "string"
},
"causeOfDeath": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the cause of death.",
"title": "Cause of death",
"x-terminology": "CauseOfDeath"
},
"endOfRecords": {
"description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
"format": "date",
"title": "End of records",
"type": "string"
},
"pseudoidentifier": {
"description": "Pseudoidentifier of the patient",
"maxLength": 40,
"title": "Pseudoidentifier",
"type": "string"
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years",
"title": "Age"
},
"overallSurvival": {
"description": "Overall survival of the patient since diagnosis",
"title": "Overall survival",
"type": "number"
},
"ageAtDiagnosis": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years at the time of the initial diagnosis",
"title": "Age at diagnosis"
},
"dataCompletionRate": {
"description": "Percentage indicating the completeness of a case in terms of its data.",
"title": "Data completion rate",
"type": "number"
},
"contributors": {
"description": "Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order.",
"items": {
"type": "string"
},
"title": "Data contributors",
"type": "array"
},
"neoplasticEntities": {
"default": [],
"items": {
"$ref": "#/components/schemas/NeoplasticEntity"
},
"title": "Neoplasticentities",
"type": "array"
},
"stagings": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TNMStaging"
},
{
"$ref": "#/components/schemas/FIGOStaging"
},
{
"$ref": "#/components/schemas/BinetStaging"
},
{
"$ref": "#/components/schemas/RaiStaging"
},
{
"$ref": "#/components/schemas/BreslowDepth"
},
{
"$ref": "#/components/schemas/ClarkStaging"
},
{
"$ref": "#/components/schemas/ISSStaging"
},
{
"$ref": "#/components/schemas/RISSStaging"
},
{
"$ref": "#/components/schemas/GleasonGrade"
},
{
"$ref": "#/components/schemas/INSSStage"
},
{
"$ref": "#/components/schemas/INRGSSStage"
},
{
"$ref": "#/components/schemas/WilmsStage"
},
{
"$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroup"
},
{
"$ref": "#/components/schemas/LymphomaStaging"
}
]
},
"title": "Stagings",
"type": "array"
},
"tumorMarkers": {
"default": [],
"items": {
"$ref": "#/components/schemas/TumorMarker"
},
"title": "Tumormarkers",
"type": "array"
},
"riskAssessments": {
"default": [],
"items": {
"$ref": "#/components/schemas/RiskAssessment"
},
"title": "Riskassessments",
"type": "array"
},
"therapyLines": {
"default": [],
"items": {
"$ref": "#/components/schemas/TherapyLine"
},
"title": "Therapylines",
"type": "array"
},
"systemicTherapies": {
"default": [],
"items": {
"$ref": "#/components/schemas/SystemicTherapy"
},
"title": "Systemictherapies",
"type": "array"
},
"surgeries": {
"default": [],
"items": {
"$ref": "#/components/schemas/Surgery"
},
"title": "Surgeries",
"type": "array"
},
"radiotherapies": {
"default": [],
"items": {
"$ref": "#/components/schemas/Radiotherapy"
},
"title": "Radiotherapies",
"type": "array"
},
"adverseEvents": {
"default": [],
"items": {
"$ref": "#/components/schemas/AdverseEvent"
},
"title": "Adverseevents",
"type": "array"
},
"treatmentResponses": {
"default": [],
"items": {
"$ref": "#/components/schemas/TreatmentResponse"
},
"title": "Treatmentresponses",
"type": "array"
},
"performanceStatus": {
"default": [],
"items": {
"$ref": "#/components/schemas/PerformanceStatus"
},
"title": "Performancestatus",
"type": "array"
},
"comorbidities": {
"default": [],
"items": {
"$ref": "#/components/schemas/ComorbiditiesAssessment"
},
"title": "Comorbidities",
"type": "array"
},
"genomicVariants": {
"default": [],
"items": {
"$ref": "#/components/schemas/GenomicVariant"
},
"title": "Genomicvariants",
"type": "array"
},
"genomicSignatures": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TumorMutationalBurden"
},
{
"$ref": "#/components/schemas/MicrosatelliteInstability"
},
{
"$ref": "#/components/schemas/LossOfHeterozygosity"
},
{
"$ref": "#/components/schemas/HomologousRecombinationDeficiency"
},
{
"$ref": "#/components/schemas/TumorNeoantigenBurden"
},
{
"$ref": "#/components/schemas/AneuploidScore"
}
]
},
"title": "Genomicsignatures",
"type": "array"
},
"vitals": {
"default": [],
"items": {
"$ref": "#/components/schemas/Vitals"
},
"title": "Vitals",
"type": "array"
},
"lifestyles": {
"default": [],
"items": {
"$ref": "#/components/schemas/Lifestyle"
},
"title": "Lifestyles",
"type": "array"
},
"familyHistory": {
"default": [],
"items": {
"$ref": "#/components/schemas/FamilyHistory"
},
"title": "Familyhistory",
"type": "array"
},
"tumorBoards": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnspecifiedTumorBoard"
},
{
"$ref": "#/components/schemas/MolecularTumorBoard"
}
]
},
"title": "Tumorboards",
"type": "array"
},
"completedDataCategories": {
"additionalProperties": {
"$ref": "#/components/schemas/PatientCaseDataCompletionStatus"
},
"propertyNames": {
"$ref": "#/components/schemas/PatientCaseDataCategoryChoices"
},
"title": "Completeddatacategories",
"type": "object"
},
"history": {
"default": [],
"items": {
"$ref": "#/components/schemas/HistoryEvent"
},
"title": "History",
"type": "array"
},
"contributorsDetails": {
"default": [],
"items": {
"$ref": "#/components/schemas/UserExport"
},
"title": "Contributorsdetails",
"type": "array"
}
},
"required": [
"id",
"description",
"clinicalCenter",
"clinicalIdentifier",
"gender",
"dateOfBirth",
"pseudoidentifier",
"age",
"dataCompletionRate",
"contributors",
"completedDataCategories"
],
"title": "PatientCaseBundle",
"type": "object"
}
POST /api/v1/interoperability/bundles¶
Import Case Bundle
Description
Imports a patient case bundle into the database, handling conflicts based on the specified resolution strategy.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
conflict |
query | No |
Request body
{
"anonymized": true,
"id": "26b25db1-34c6-4849-958c-0b2a4e4506fe",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"pseudoidentifier": "string",
"age": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"neoplasticEntities": [
{
"anonymized": true,
"id": "9ed5ec1a-b325-46a1-8e68-0f5cbb514f3d",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "45b6d131-5b90-4900-b00c-b867f1c744a5",
"relationship": "primary",
"relatedPrimaryId": "79021c2f-7bce-4062-b83c-6544042f9a61",
"assertionDate": "2022-04-13",
"topography": null,
"morphology": null,
"differentitation": null,
"laterality": null,
"topographyGroup": null
}
],
"stagings": [
null
],
"tumorMarkers": [
{
"anonymized": true,
"id": "8167a244-a63f-48d1-973b-63d710c43f0c",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f072f8af-e67e-43ae-a850-cca36f60d09d",
"date": "2022-04-13",
"analyte": null,
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"9852799b-75d5-459a-98a3-ff09c92418bb"
]
}
],
"riskAssessments": [
{
"anonymized": true,
"id": "932cb76f-1646-46b4-9bf8-931135e35f57",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b0dad7e5-1df5-4e9d-8abf-8a7260cece23",
"date": "2022-04-13",
"methodology": null,
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"10c36fb8-4e4f-4c3d-a14d-78eac1f6c8cd"
]
}
],
"therapyLines": [
{
"anonymized": true,
"id": "5674b26d-be2d-416e-a31c-365341f31820",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "21d9635c-9440-40bb-ac0e-9e95fd1b5398",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13",
"period": null,
"label": "string",
"progressionFreeSurvival": 10.12
}
],
"systemicTherapies": [
{
"anonymized": true,
"id": "655e501b-3be3-4974-9e66-80a2e8099beb",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f262f2c9-8d35-45be-a7e1-7b74316d3619",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"terminationReason": null,
"therapyLineId": "1ce695e0-7414-4caa-be66-58edcbc92225",
"targetedEntitiesIds": [
"ab31755f-027d-4983-89e4-2c29cc861aa9"
],
"medications": [
{
"id": "3a2d8f85-6b22-4456-9b51-a142073ceb8f",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"drug": null,
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
],
"isAdjunctive": true,
"duration": {
"value": 10.12,
"unit": "string"
}
}
],
"surgeries": [
{
"anonymized": true,
"id": "4ec66d3b-948a-4708-9300-a58d2da92576",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d5d4a729-9d23-4338-9467-b1a80eeb9cb3",
"date": "2022-04-13",
"procedure": null,
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "e05cd280-70a5-4236-b79d-5df06784eedf",
"targetedEntitiesIds": [
"6e770541-6051-4464-ac77-0b7636a22c21"
]
}
],
"radiotherapies": [
{
"anonymized": true,
"id": "e0f37250-b761-4394-b9e8-1af05ae9a618",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b32abfa7-bc99-44cc-b208-3dfee1351e05",
"period": null,
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "6facc093-cb34-45f5-a135-512bf0c52f48",
"targetedEntitiesIds": [
"b7e399c6-9642-4422-8033-034462a9ea28"
],
"duration": null,
"dosages": [
{
"id": "9c88a6c5-5b66-47cd-be0b-196b359d6bb3",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": null,
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
],
"settings": [
{
"id": "757e33ae-1e69-4357-9497-f862b09c843b",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null
}
]
}
],
"adverseEvents": [
{
"anonymized": true,
"id": "b0367702-2416-4e31-ae5e-cb0aa8616bae",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d720ede0-0475-424f-9c49-5cf63d115771",
"date": "2022-04-13",
"event": null,
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13",
"suspectedCauses": [
{
"id": "f7cb5bc6-3c9b-4e96-b18e-fa7a851d00ee",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "abe2d7d4-37e9-4727-bf53-ca60f3cad04e",
"medicationId": "e5b6c696-1aa3-49a7-9ae1-982f3b085501",
"radiotherapyId": "9d6ade5d-462f-4b73-b325-e3c74f06c78f",
"surgeryId": "b62e3f90-d78e-42d3-a362-6363bcf9b338",
"causality": null
}
],
"mitigations": [
{
"id": "a3ecf274-b2d3-4da8-a493-5dca17a12ae8",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
]
}
],
"treatmentResponses": [
{
"anonymized": true,
"id": "9979b872-4c57-4f60-8ba4-2d063ad083a5",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f9343d65-771e-46ba-a019-a9ebd236b8a1",
"date": "2022-04-13",
"recist": null,
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"bec83d90-5a43-47c5-aa20-18cda348d8e1"
],
"assessedBodysites": null
}
],
"performanceStatus": [
{
"anonymized": true,
"id": "0057d7ca-c592-4c12-be50-2a4ead7efffb",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "fee85ad5-25e5-4e40-8d8c-11bf79bbd1e4",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"ecogInterpretation": null,
"karnofskyInterpretation": null
}
],
"comorbidities": [
{
"anonymized": true,
"id": "a1264379-1c54-4b00-a1da-f1252bd5b581",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2279fdb8-d50e-4a2a-9b87-39bc69c07eb2",
"date": "2022-04-13",
"indexConditionId": "9cb409b3-e234-451e-96db-3ddc4613fb79",
"panel": null,
"presentConditions": null,
"absentConditions": null,
"score": null
}
],
"genomicVariants": [
{
"anonymized": true,
"id": "ad9ed6ae-70ea-4eab-861f-25536ef74a16",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5458ef04-1c27-40de-86d3-e9935de1318a",
"date": "2022-04-13",
"genes": null,
"dnaHgvs": "string",
"rnaHgvs": "string",
"proteinHgvs": "string",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"source": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"hgvsVersion": "string",
"isPathogenic": true,
"isVUS": true,
"cytogeneticLocation": "string",
"chromosomes": [
"string"
],
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
]
}
],
"genomicSignatures": [
null
],
"vitals": [
{
"anonymized": true,
"id": "849d5968-447e-459b-9c0f-e20ad751c682",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "4267fadb-44ed-44a5-899e-d704bcd1373a",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"bodyMassIndex": null
}
],
"lifestyles": [
{
"anonymized": true,
"id": "1d379d0e-34df-4828-b16a-99ea0f4409bc",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f8ad113b-f445-4d4b-9410-9ae91aa33808",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": null,
"exposures": null
}
],
"familyHistory": [
{
"anonymized": true,
"id": "9219047c-345a-4f1f-b754-a7479c29c877",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c5877eb0-9af8-4eb0-99a9-d33e68a62ea2",
"date": "2022-04-13",
"relationship": null,
"hadCancer": true,
"isDeceased": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null
}
],
"tumorBoards": [
null
],
"completedDataCategories": {},
"history": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
],
"contributorsDetails": [
{
"anonymized": true,
"id": "4c5857d6-02df-4701-bcf3-c1f9bed8a856",
"externalSource": "string",
"externalSourceId": "string",
"username": "string",
"firstName": "string",
"lastName": "string",
"organization": "string",
"email": "string"
}
]
}
Schema of the request body
{
"description": "PatientCaseBundle aggregates all relevant patient case data for interoperability and import/export operations.\n\nThis schema extends PatientCase and organizes multiple related entities, such as neoplastic entities, stagings, tumor markers, risk assessments, therapies, surgeries, adverse events, treatment responses, performance status, comorbidities, genomic variants, genomic signatures, vitals, lifestyles, family history, tumor boards, completed data categories, and history events.\n\nThe order of properties is significant for import tools that rely on reference trees.\n\nAttributes:\n neoplasticEntities (List[NeoplasticEntity]): List of neoplastic entities associated with the patient case.\n stagings (List[Union[...]]): List of staging schemas (e.g., TNM, FIGO, Binet, etc.).\n tumorMarkers (List[TumorMarkerSchema]): List of tumor marker schemas.\n riskAssessments (List[RiskAssessment]): List of risk assessment schemas.\n therapyLines (List[TherapyLine]): List of therapy line schemas.\n systemicTherapies (List[SystemicTherapy]): List of systemic therapy schemas.\n surgeries (List[Surgery]): List of surgery schemas.\n radiotherapies (List[Radiotherapy]): List of radiotherapy schemas.\n adverseEvents (List[AdverseEvent]): List of adverse event schemas.\n treatmentResponses (List[TreatmentResponse]): List of treatment response schemas.\n performanceStatus (List[PerformanceStatus]): List of performance status schemas.\n comorbidities (List[ComorbiditiesAssessment]): List of comorbidities assessment schemas.\n genomicVariants (List[GenomicVariant]): List of genomic variant schemas.\n genomicSignatures (List[Union[...]]): List of genomic signature schemas (e.g., TMB, MSI, LOH, etc.).\n vitals (List[Vitals]): List of vitals schemas.\n lifestyles (List[Lifestyle]): List of lifestyle schemas.\n familyHistory (List[FamilyHistory]): List of family history schemas.\n tumorBoards (List[Union[UnspecifiedTumorBoard, MolecularTumorBoard]]): List of tumor board schemas.\n completedDataCategories (Dict[PatientCaseDataCategories, PatientCaseDataCompletionStatus]): Mapping of data categories to their completion status.\n history (List[HistoryEvent]): List of history events related to the patient case.\n\nMethods:\n resolve_stagings(obj): Resolves and serializes staging data for the patient case.\n resolve_genomicSignatures(obj): Resolves and serializes genomic signature data.\n resolve_tumorBoards(obj): Resolves and serializes tumor board data.\n resolve_completedDataCategories(obj): Resolves completion status for each data category.\n resolve_history(obj): Resolves and retrieves history events for the patient case.\n\nConfig:\n model_config: Serialization configuration (serialize_by_alias=False).",
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"clinicalCenter": {
"description": "Medical center where the patient data originally resides",
"maxLength": 200,
"title": "Medical center",
"type": "string"
},
"clinicalIdentifier": {
"description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
"maxLength": 100,
"title": "Clinical identifier",
"type": "string"
},
"consentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseConsentStatusChoices"
}
],
"default": "unknown",
"description": "Status of the general consent by the patient for the use of their data for research purposes",
"title": "Consent status"
},
"gender": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Gender of the patient for legal/administrative purposes",
"title": "Gender",
"x-terminology": "AdministrativeGender"
},
"race": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Race of the patient",
"title": "Race",
"x-terminology": "Race"
},
"sexAtBirth": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Sex assigned at birth",
"title": "Birth sex",
"x-terminology": "BirthSex"
},
"genderIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The patient's innate sense of their gender as reported",
"title": "Gender identity",
"x-terminology": "GenderIdentity"
},
"dateOfBirth": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"const": "*************",
"type": "string"
}
],
"description": "Date of birth of the patient",
"title": "Date of birth"
},
"vitalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseVitalStatusChoices"
}
],
"default": "unknown",
"description": "Whether the patient is known to be alive or decaeased or is unknkown.",
"title": "Vital status"
},
"dateOfDeath": {
"description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of death",
"type": "string"
},
"causeOfDeath": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the cause of death.",
"title": "Cause of death",
"x-terminology": "CauseOfDeath"
},
"endOfRecords": {
"description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
"format": "date",
"title": "End of records",
"type": "string"
},
"pseudoidentifier": {
"description": "Pseudoidentifier of the patient",
"maxLength": 40,
"title": "Pseudoidentifier",
"type": "string"
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years",
"title": "Age"
},
"overallSurvival": {
"description": "Overall survival of the patient since diagnosis",
"title": "Overall survival",
"type": "number"
},
"ageAtDiagnosis": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years at the time of the initial diagnosis",
"title": "Age at diagnosis"
},
"dataCompletionRate": {
"description": "Percentage indicating the completeness of a case in terms of its data.",
"title": "Data completion rate",
"type": "number"
},
"contributors": {
"description": "Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order.",
"items": {
"type": "string"
},
"title": "Data contributors",
"type": "array"
},
"neoplasticEntities": {
"default": [],
"items": {
"$ref": "#/components/schemas/NeoplasticEntity"
},
"title": "Neoplasticentities",
"type": "array"
},
"stagings": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TNMStaging"
},
{
"$ref": "#/components/schemas/FIGOStaging"
},
{
"$ref": "#/components/schemas/BinetStaging"
},
{
"$ref": "#/components/schemas/RaiStaging"
},
{
"$ref": "#/components/schemas/BreslowDepth"
},
{
"$ref": "#/components/schemas/ClarkStaging"
},
{
"$ref": "#/components/schemas/ISSStaging"
},
{
"$ref": "#/components/schemas/RISSStaging"
},
{
"$ref": "#/components/schemas/GleasonGrade"
},
{
"$ref": "#/components/schemas/INSSStage"
},
{
"$ref": "#/components/schemas/INRGSSStage"
},
{
"$ref": "#/components/schemas/WilmsStage"
},
{
"$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroup"
},
{
"$ref": "#/components/schemas/LymphomaStaging"
}
]
},
"title": "Stagings",
"type": "array"
},
"tumorMarkers": {
"default": [],
"items": {
"$ref": "#/components/schemas/TumorMarker"
},
"title": "Tumormarkers",
"type": "array"
},
"riskAssessments": {
"default": [],
"items": {
"$ref": "#/components/schemas/RiskAssessment"
},
"title": "Riskassessments",
"type": "array"
},
"therapyLines": {
"default": [],
"items": {
"$ref": "#/components/schemas/TherapyLine"
},
"title": "Therapylines",
"type": "array"
},
"systemicTherapies": {
"default": [],
"items": {
"$ref": "#/components/schemas/SystemicTherapy"
},
"title": "Systemictherapies",
"type": "array"
},
"surgeries": {
"default": [],
"items": {
"$ref": "#/components/schemas/Surgery"
},
"title": "Surgeries",
"type": "array"
},
"radiotherapies": {
"default": [],
"items": {
"$ref": "#/components/schemas/Radiotherapy"
},
"title": "Radiotherapies",
"type": "array"
},
"adverseEvents": {
"default": [],
"items": {
"$ref": "#/components/schemas/AdverseEvent"
},
"title": "Adverseevents",
"type": "array"
},
"treatmentResponses": {
"default": [],
"items": {
"$ref": "#/components/schemas/TreatmentResponse"
},
"title": "Treatmentresponses",
"type": "array"
},
"performanceStatus": {
"default": [],
"items": {
"$ref": "#/components/schemas/PerformanceStatus"
},
"title": "Performancestatus",
"type": "array"
},
"comorbidities": {
"default": [],
"items": {
"$ref": "#/components/schemas/ComorbiditiesAssessment"
},
"title": "Comorbidities",
"type": "array"
},
"genomicVariants": {
"default": [],
"items": {
"$ref": "#/components/schemas/GenomicVariant"
},
"title": "Genomicvariants",
"type": "array"
},
"genomicSignatures": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TumorMutationalBurden"
},
{
"$ref": "#/components/schemas/MicrosatelliteInstability"
},
{
"$ref": "#/components/schemas/LossOfHeterozygosity"
},
{
"$ref": "#/components/schemas/HomologousRecombinationDeficiency"
},
{
"$ref": "#/components/schemas/TumorNeoantigenBurden"
},
{
"$ref": "#/components/schemas/AneuploidScore"
}
]
},
"title": "Genomicsignatures",
"type": "array"
},
"vitals": {
"default": [],
"items": {
"$ref": "#/components/schemas/Vitals"
},
"title": "Vitals",
"type": "array"
},
"lifestyles": {
"default": [],
"items": {
"$ref": "#/components/schemas/Lifestyle"
},
"title": "Lifestyles",
"type": "array"
},
"familyHistory": {
"default": [],
"items": {
"$ref": "#/components/schemas/FamilyHistory"
},
"title": "Familyhistory",
"type": "array"
},
"tumorBoards": {
"default": [],
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnspecifiedTumorBoard"
},
{
"$ref": "#/components/schemas/MolecularTumorBoard"
}
]
},
"title": "Tumorboards",
"type": "array"
},
"completedDataCategories": {
"additionalProperties": {
"$ref": "#/components/schemas/PatientCaseDataCompletionStatus"
},
"propertyNames": {
"$ref": "#/components/schemas/PatientCaseDataCategoryChoices"
},
"title": "Completeddatacategories",
"type": "object"
},
"history": {
"default": [],
"items": {
"$ref": "#/components/schemas/HistoryEvent"
},
"title": "History",
"type": "array"
},
"contributorsDetails": {
"default": [],
"items": {
"$ref": "#/components/schemas/UserExport"
},
"title": "Contributorsdetails",
"type": "array"
}
},
"required": [
"id",
"description",
"clinicalCenter",
"clinicalIdentifier",
"gender",
"dateOfBirth",
"pseudoidentifier",
"age",
"dataCompletionRate",
"contributors",
"completedDataCategories"
],
"title": "PatientCaseBundle",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Patient Cases¶
GET /api/v1/patient-cases¶
Get All Patient Cases Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
age.between |
query | array | No | Age - Filter for entries with values between two specified values (inclusive) | |
age.equal |
query | integer | No | Age - Filter for entries with values exactly equal to the specified value | |
age.greaterThan |
query | integer | No | Age - Filter for entries with values greater than the specified value | |
age.greaterThanOrEqual |
query | integer | No | Age - Filter for entries with values greater than or equal to the specified value | |
age.lessThan |
query | integer | No | Age - Filter for entries with values less than the specified value | |
age.lessThanOrEqual |
query | integer | No | Age - Filter for entries with values less than or equal to the specified value | |
age.not.between |
query | array | No | Age - Filter for entries with values between two specified values (inclusive) | |
age.not.equal |
query | integer | No | Age - Filter for entries with values not equal to the specified value | |
ageAtDiagnosis.between |
query | array | No | Age at diagnosis - Filter for entries with values between two specified values (inclusive) | |
ageAtDiagnosis.equal |
query | integer | No | Age at diagnosis - Filter for entries with values exactly equal to the specified value | |
ageAtDiagnosis.exists |
query | boolean | No | Age at diagnosis - Filter for entries with a value | |
ageAtDiagnosis.greaterThan |
query | integer | No | Age at diagnosis - Filter for entries with values greater than the specified value | |
ageAtDiagnosis.greaterThanOrEqual |
query | integer | No | Age at diagnosis - Filter for entries with values greater than or equal to the specified value | |
ageAtDiagnosis.lessThan |
query | integer | No | Age at diagnosis - Filter for entries with values less than the specified value | |
ageAtDiagnosis.lessThanOrEqual |
query | integer | No | Age at diagnosis - Filter for entries with values less than or equal to the specified value | |
ageAtDiagnosis.not.between |
query | array | No | Age at diagnosis - Filter for entries with values between two specified values (inclusive) | |
ageAtDiagnosis.not.equal |
query | integer | No | Age at diagnosis - Filter for entries with values not equal to the specified value | |
ageAtDiagnosis.not.exists |
query | boolean | No | Age at diagnosis - Filter for entries without a value | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
causeOfDeath |
query | string | No | Cause of death - Filter for a matching concept code | |
causeOfDeath.anyOf |
query | array | No | Cause of death - Filter for a matching set of concept codes | |
causeOfDeath.descendantsOf |
query | string | No | Cause of death - Filter for all child concepts of a given concepts code | |
causeOfDeath.exists |
query | boolean | No | Cause of death - Filter for entries with a value | |
causeOfDeath.not |
query | string | No | Cause of death - Filter for a mismatching concept code | |
causeOfDeath.not.anyOf |
query | array | No | Cause of death - Filter for a mismmatching set of concept codes | |
causeOfDeath.not.exists |
query | boolean | No | Cause of death - Filter for entries without a value | |
consentStatus |
query | No | Consent status - Filter for single value choice | ||
consentStatus.anyOf |
query | array | No | Consent status - ('Filter for excluding a subset of value choices',) | |
consentStatus.not |
query | No | Consent status - ('Filter for all but a single value choice',) | ||
contributors |
query | array | No | Data contributors - Filter for exact array matches | |
contributors.containedBy |
query | array | No | Data contributors - Filter for entries where where the data is a subset of the values passed | |
contributors.contains |
query | array | No | Data contributors - Filter for entries where where the values passed are a subset of the data | |
contributors.not |
query | array | No | Data contributors - Filter for exact array mismatches | |
contributors.not.containedBy |
query | array | No | Data contributors - Filter for entries where the data is not a subset of the values passed | |
contributors.not.contains |
query | array | No | Data contributors - Filter for entries where the values passed are not a subset of the data | |
contributors.not.overlaps |
query | array | No | Data contributors - Filter for entries where the data shares not any results with the values passed. | |
contributors.overlaps |
query | array | No | Data contributors - Filter for entries where the data shares any results with the values passed. | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
dataCompletionRate.between |
query | array | No | Data completion rate - Filter for entries with values between two specified values (inclusive) | |
dataCompletionRate.equal |
query | number | No | Data completion rate - Filter for entries with values exactly equal to the specified value | |
dataCompletionRate.greaterThan |
query | number | No | Data completion rate - Filter for entries with values greater than the specified value | |
dataCompletionRate.greaterThanOrEqual |
query | number | No | Data completion rate - Filter for entries with values greater than or equal to the specified value | |
dataCompletionRate.lessThan |
query | number | No | Data completion rate - Filter for entries with values less than the specified value | |
dataCompletionRate.lessThanOrEqual |
query | number | No | Data completion rate - Filter for entries with values less than or equal to the specified value | |
dataCompletionRate.not.between |
query | array | No | Data completion rate - Filter for entries with values between two specified values (inclusive) | |
dataCompletionRate.not.equal |
query | number | No | Data completion rate - Filter for entries with values not equal to the specified value | |
endOfRecords.after |
query | string | No | End of records - Filter for entries with dates after the specified value | |
endOfRecords.before |
query | string | No | End of records - Filter for entries with dates before the specified value | |
endOfRecords.between |
query | array | No | End of records - Filter for entries with dates between two specified values (inclusive) | |
endOfRecords.exists |
query | boolean | No | End of records - Filter for entries with a value | |
endOfRecords.not.between |
query | array | No | End of records - Filter for entries with dates not between two specified values (inclusive) | |
endOfRecords.not.exists |
query | boolean | No | End of records - Filter for entries without a value | |
endOfRecords.not.on |
query | string | No | End of records - Filter for entries with dates not matching the specified value | |
endOfRecords.on |
query | string | No | End of records - Filter for entries with dates exactly matching the specified value | |
endOfRecords.onOrAfter |
query | string | No | End of records - Filter for entries with dates on or after the specified value | |
endOfRecords.onOrBefore |
query | string | No | End of records - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
gender |
query | string | No | Gender - Filter for a matching concept code | |
gender.anyOf |
query | array | No | Gender - Filter for a matching set of concept codes | |
gender.descendantsOf |
query | string | No | Gender - Filter for all child concepts of a given concepts code | |
gender.not |
query | string | No | Gender - Filter for a mismatching concept code | |
gender.not.anyOf |
query | array | No | Gender - Filter for a mismmatching set of concept codes | |
genderIdentity |
query | string | No | Gender identity - Filter for a matching concept code | |
genderIdentity.anyOf |
query | array | No | Gender identity - Filter for a matching set of concept codes | |
genderIdentity.descendantsOf |
query | string | No | Gender identity - Filter for all child concepts of a given concepts code | |
genderIdentity.exists |
query | boolean | No | Gender identity - Filter for entries with a value | |
genderIdentity.not |
query | string | No | Gender identity - Filter for a mismatching concept code | |
genderIdentity.not.anyOf |
query | array | No | Gender identity - Filter for a mismmatching set of concept codes | |
genderIdentity.not.exists |
query | boolean | No | Gender identity - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
idSearch |
query | string | No | ||
limit |
query | integer | 10 | No | |
morphology |
query | string | No | Morphology - Filters for matching primary morphology code. | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
overallSurvival.between |
query | array | No | Overall survival - Filter for entries with values between two specified values (inclusive) | |
overallSurvival.equal |
query | number | No | Overall survival - Filter for entries with values exactly equal to the specified value | |
overallSurvival.exists |
query | boolean | No | Overall survival - Filter for entries with a value | |
overallSurvival.greaterThan |
query | number | No | Overall survival - Filter for entries with values greater than the specified value | |
overallSurvival.greaterThanOrEqual |
query | number | No | Overall survival - Filter for entries with values greater than or equal to the specified value | |
overallSurvival.lessThan |
query | number | No | Overall survival - Filter for entries with values less than the specified value | |
overallSurvival.lessThanOrEqual |
query | number | No | Overall survival - Filter for entries with values less than or equal to the specified value | |
overallSurvival.not.between |
query | array | No | Overall survival - Filter for entries with values between two specified values (inclusive) | |
overallSurvival.not.equal |
query | number | No | Overall survival - Filter for entries with values not equal to the specified value | |
overallSurvival.not.exists |
query | boolean | No | Overall survival - Filter for entries without a value | |
primarySite |
query | string | No | Primary site - Filters for matching primary topography code. | |
pseudoidentifier |
query | string | No | Pseudoidentifier - Filter for full text matches | |
pseudoidentifier.anyOf |
query | array | No | Pseudoidentifier - Filter for entries where at least one reference matches the query | |
pseudoidentifier.beginsWith |
query | string | No | Pseudoidentifier - Filter for entries starting with the text | |
pseudoidentifier.contains |
query | string | No | Pseudoidentifier - Filter for partial text matches | |
pseudoidentifier.endsWith |
query | string | No | Pseudoidentifier - Filter for entries ending with the text | |
pseudoidentifier.not |
query | string | No | Pseudoidentifier - Filter for full text mismatches | |
pseudoidentifier.not.anyOf |
query | array | No | Pseudoidentifier - Filter for entries where at least one reference mismatches the query | |
pseudoidentifier.not.beginsWith |
query | string | No | Pseudoidentifier - Filter for entries not starting with the text | |
pseudoidentifier.not.contains |
query | string | No | Pseudoidentifier - Filter for partial text mismatches | |
pseudoidentifier.not.endsWith |
query | string | No | Pseudoidentifier - Filter for entries not ending with the text | |
race |
query | string | No | Race - Filter for a matching concept code | |
race.anyOf |
query | array | No | Race - Filter for a matching set of concept codes | |
race.descendantsOf |
query | string | No | Race - Filter for all child concepts of a given concepts code | |
race.exists |
query | boolean | No | Race - Filter for entries with a value | |
race.not |
query | string | No | Race - Filter for a mismatching concept code | |
race.not.anyOf |
query | array | No | Race - Filter for a mismmatching set of concept codes | |
race.not.exists |
query | boolean | No | Race - Filter for entries without a value | |
sexAtBirth |
query | string | No | Birth sex - Filter for a matching concept code | |
sexAtBirth.anyOf |
query | array | No | Birth sex - Filter for a matching set of concept codes | |
sexAtBirth.descendantsOf |
query | string | No | Birth sex - Filter for all child concepts of a given concepts code | |
sexAtBirth.exists |
query | boolean | No | Birth sex - Filter for entries with a value | |
sexAtBirth.not |
query | string | No | Birth sex - Filter for a mismatching concept code | |
sexAtBirth.not.anyOf |
query | array | No | Birth sex - Filter for a mismmatching set of concept codes | |
sexAtBirth.not.exists |
query | boolean | No | Birth sex - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
vitalStatus |
query | No | Vital status - Filter for single value choice | ||
vitalStatus.anyOf |
query | array | No | Vital status - ('Filter for excluding a subset of value choices',) | |
vitalStatus.not |
query | No | Vital status - ('Filter for all but a single value choice',) |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "fcc6aee2-0c3a-4318-b30b-57bcfdf43a53",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"pseudoidentifier": "string",
"age": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
]
}
]
}
POST /api/v1/patient-cases¶
Create Patient Case
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": "2022-04-13",
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"clinicalCenter": {
"description": "Medical center where the patient data originally resides",
"maxLength": 200,
"title": "Medical center",
"type": "string"
},
"clinicalIdentifier": {
"description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
"maxLength": 100,
"title": "Clinical identifier",
"type": "string"
},
"consentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseConsentStatusChoices"
}
],
"default": "unknown",
"description": "Status of the general consent by the patient for the use of their data for research purposes",
"title": "Consent status"
},
"gender": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Gender of the patient for legal/administrative purposes",
"title": "Gender",
"x-terminology": "AdministrativeGender"
},
"race": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Race of the patient",
"title": "Race",
"x-terminology": "Race"
},
"sexAtBirth": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Sex assigned at birth",
"title": "Birth sex",
"x-terminology": "BirthSex"
},
"genderIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The patient's innate sense of their gender as reported",
"title": "Gender identity",
"x-terminology": "GenderIdentity"
},
"dateOfBirth": {
"description": "Anonymized date of birth (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of birth",
"type": "string"
},
"vitalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseVitalStatusChoices"
}
],
"default": "unknown",
"description": "Whether the patient is known to be alive or decaeased or is unknkown.",
"title": "Vital status"
},
"dateOfDeath": {
"description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of death",
"type": "string"
},
"causeOfDeath": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the cause of death.",
"title": "Cause of death",
"x-terminology": "CauseOfDeath"
},
"endOfRecords": {
"description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
"format": "date",
"title": "End of records",
"type": "string"
}
},
"required": [
"clinicalCenter",
"clinicalIdentifier",
"gender",
"dateOfBirth"
],
"title": "PatientCaseCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/patient-cases/{caseId}¶
Get Patient Case By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
path | string | No | ||
clinicalCenter |
query | No | |||
type |
query | id | No |
Responses
{
"anonymized": true,
"id": "3d03895e-d8f9-4067-85b3-11725e4347c4",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"pseudoidentifier": "string",
"age": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"clinicalCenter": {
"description": "Medical center where the patient data originally resides",
"maxLength": 200,
"title": "Medical center",
"type": "string"
},
"clinicalIdentifier": {
"description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
"maxLength": 100,
"title": "Clinical identifier",
"type": "string"
},
"consentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseConsentStatusChoices"
}
],
"default": "unknown",
"description": "Status of the general consent by the patient for the use of their data for research purposes",
"title": "Consent status"
},
"gender": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Gender of the patient for legal/administrative purposes",
"title": "Gender",
"x-terminology": "AdministrativeGender"
},
"race": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Race of the patient",
"title": "Race",
"x-terminology": "Race"
},
"sexAtBirth": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Sex assigned at birth",
"title": "Birth sex",
"x-terminology": "BirthSex"
},
"genderIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The patient's innate sense of their gender as reported",
"title": "Gender identity",
"x-terminology": "GenderIdentity"
},
"dateOfBirth": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"const": "*************",
"type": "string"
}
],
"description": "Date of birth of the patient",
"title": "Date of birth"
},
"vitalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseVitalStatusChoices"
}
],
"default": "unknown",
"description": "Whether the patient is known to be alive or decaeased or is unknkown.",
"title": "Vital status"
},
"dateOfDeath": {
"description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of death",
"type": "string"
},
"causeOfDeath": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the cause of death.",
"title": "Cause of death",
"x-terminology": "CauseOfDeath"
},
"endOfRecords": {
"description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
"format": "date",
"title": "End of records",
"type": "string"
},
"pseudoidentifier": {
"description": "Pseudoidentifier of the patient",
"maxLength": 40,
"title": "Pseudoidentifier",
"type": "string"
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years",
"title": "Age"
},
"overallSurvival": {
"description": "Overall survival of the patient since diagnosis",
"title": "Overall survival",
"type": "number"
},
"ageAtDiagnosis": {
"anyOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/AgeBin"
}
],
"description": "Approximate age of the patient in years at the time of the initial diagnosis",
"title": "Age at diagnosis"
},
"dataCompletionRate": {
"description": "Percentage indicating the completeness of a case in terms of its data.",
"title": "Data completion rate",
"type": "number"
},
"contributors": {
"description": "Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order.",
"items": {
"type": "string"
},
"title": "Data contributors",
"type": "array"
}
},
"required": [
"id",
"description",
"clinicalCenter",
"clinicalIdentifier",
"gender",
"dateOfBirth",
"pseudoidentifier",
"age",
"dataCompletionRate",
"contributors"
],
"title": "PatientCase",
"type": "object"
}
PUT /api/v1/patient-cases/{caseId}¶
Update Patient Case
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": "2022-04-13",
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"clinicalCenter": {
"description": "Medical center where the patient data originally resides",
"maxLength": 200,
"title": "Medical center",
"type": "string"
},
"clinicalIdentifier": {
"description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
"maxLength": 100,
"title": "Clinical identifier",
"type": "string"
},
"consentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseConsentStatusChoices"
}
],
"default": "unknown",
"description": "Status of the general consent by the patient for the use of their data for research purposes",
"title": "Consent status"
},
"gender": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Gender of the patient for legal/administrative purposes",
"title": "Gender",
"x-terminology": "AdministrativeGender"
},
"race": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Race of the patient",
"title": "Race",
"x-terminology": "Race"
},
"sexAtBirth": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Sex assigned at birth",
"title": "Birth sex",
"x-terminology": "BirthSex"
},
"genderIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The patient's innate sense of their gender as reported",
"title": "Gender identity",
"x-terminology": "GenderIdentity"
},
"dateOfBirth": {
"description": "Anonymized date of birth (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of birth",
"type": "string"
},
"vitalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PatientCaseVitalStatusChoices"
}
],
"default": "unknown",
"description": "Whether the patient is known to be alive or decaeased or is unknkown.",
"title": "Vital status"
},
"dateOfDeath": {
"description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
"format": "date",
"title": "Date of death",
"type": "string"
},
"causeOfDeath": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the cause of death.",
"title": "Cause of death",
"x-terminology": "CauseOfDeath"
},
"endOfRecords": {
"description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
"format": "date",
"title": "End of records",
"type": "string"
}
},
"required": [
"clinicalCenter",
"clinicalIdentifier",
"gender",
"dateOfBirth"
],
"title": "PatientCaseCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/patient-cases/{caseId}¶
Delete Patient Case
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No |
Responses
GET /api/v1/patient-cases/{caseId}/history/events¶
Get All Patient Case History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/patient-cases/{caseId}/history/events/{eventId}¶
Get Patient Case History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
eventId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/patient-cases/{caseId}/history/events/{eventId}/reversion¶
Revert Patient Case To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
eventId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/patient-cases/{caseId}/data-completion/{category}¶
Get Patient Case Data Completion Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
category |
path | string | No | Enumeration of data categories associated with a patient case in oncology. Attributes: COMORBIDITIES_ASSESSMENTS: Category for comorbidities assessments. FAMILY_HISTORIES: Category for family medical histories. GENOMIC_SIGNATURES: Category for genomic signatures. GENOMIC_VARIANTS: Category for genomic variants. LIFESTYLES: Category for patient lifestyles. COMORBIDITIES: Category for comorbidities. NEOPLASTIC_ENTITIES: Category for neoplastic entities. PERFORMANCE_STATUS: Category for performance status. RADIOTHERAPIES: Category for radiotherapy treatments. RISK_ASSESSMENTS: Category for risk assessments. STAGINS: Category for cancer stagings. SURGERIES: Category for surgical procedures. SYSTEMIC_THERAPIES: Category for systemic therapies. TUMOR_MARKERS: Category for tumor marker data. VITALS: Category for vital signs. TUMOR_BOARD_REVIEWS: Category for tumor board reviews. ADVERSE_EVENTS: Category for adverse events. THERAPY_RESPONSES: Category for therapy responses. |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"status": {
"description": "Boolean indicating whether the data category has been marked as completed",
"title": "Status",
"type": "boolean"
},
"username": {
"description": "Username of the person who marked the category as completed",
"title": "Username",
"type": "string"
},
"timestamp": {
"description": "Username of the person who marked the category as completed",
"format": "date-time",
"title": "Timestamp",
"type": "string"
}
},
"required": [
"status"
],
"title": "PatientCaseDataCompletionStatus",
"type": "object"
}
POST /api/v1/patient-cases/{caseId}/data-completion/{category}¶
Create Patient Case Data Completion
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
category |
path | string | No | Enumeration of data categories associated with a patient case in oncology. Attributes: COMORBIDITIES_ASSESSMENTS: Category for comorbidities assessments. FAMILY_HISTORIES: Category for family medical histories. GENOMIC_SIGNATURES: Category for genomic signatures. GENOMIC_VARIANTS: Category for genomic variants. LIFESTYLES: Category for patient lifestyles. COMORBIDITIES: Category for comorbidities. NEOPLASTIC_ENTITIES: Category for neoplastic entities. PERFORMANCE_STATUS: Category for performance status. RADIOTHERAPIES: Category for radiotherapy treatments. RISK_ASSESSMENTS: Category for risk assessments. STAGINS: Category for cancer stagings. SURGERIES: Category for surgical procedures. SYSTEMIC_THERAPIES: Category for systemic therapies. TUMOR_MARKERS: Category for tumor marker data. VITALS: Category for vital signs. TUMOR_BOARD_REVIEWS: Category for tumor board reviews. ADVERSE_EVENTS: Category for adverse events. THERAPY_RESPONSES: Category for therapy responses. |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/patient-cases/{caseId}/data-completion/{category}¶
Delete Patient Case Data Completion
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No | ||
category |
path | string | No | Enumeration of data categories associated with a patient case in oncology. Attributes: COMORBIDITIES_ASSESSMENTS: Category for comorbidities assessments. FAMILY_HISTORIES: Category for family medical histories. GENOMIC_SIGNATURES: Category for genomic signatures. GENOMIC_VARIANTS: Category for genomic variants. LIFESTYLES: Category for patient lifestyles. COMORBIDITIES: Category for comorbidities. NEOPLASTIC_ENTITIES: Category for neoplastic entities. PERFORMANCE_STATUS: Category for performance status. RADIOTHERAPIES: Category for radiotherapy treatments. RISK_ASSESSMENTS: Category for risk assessments. STAGINS: Category for cancer stagings. SURGERIES: Category for surgical procedures. SYSTEMIC_THERAPIES: Category for systemic therapies. TUMOR_MARKERS: Category for tumor marker data. VITALS: Category for vital signs. TUMOR_BOARD_REVIEWS: Category for tumor board reviews. ADVERSE_EVENTS: Category for adverse events. THERAPY_RESPONSES: Category for therapy responses. |
Responses
GET /api/v1/autocomplete/clinical-centers¶
Get Clinical Centers
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
query |
query | string | No |
Responses
Neoplastic Entities¶
GET /api/v1/neoplastic-entities¶
Get All Neoplastic Entities Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
assertionDate.after |
query | string | No | Assertion date - Filter for entries with dates after the specified value | |
assertionDate.before |
query | string | No | Assertion date - Filter for entries with dates before the specified value | |
assertionDate.between |
query | array | No | Assertion date - Filter for entries with dates between two specified values (inclusive) | |
assertionDate.not.between |
query | array | No | Assertion date - Filter for entries with dates not between two specified values (inclusive) | |
assertionDate.not.on |
query | string | No | Assertion date - Filter for entries with dates not matching the specified value | |
assertionDate.on |
query | string | No | Assertion date - Filter for entries with dates exactly matching the specified value | |
assertionDate.onOrAfter |
query | string | No | Assertion date - Filter for entries with dates on or after the specified value | |
assertionDate.onOrBefore |
query | string | No | Assertion date - Filter for entries with dates on or before the specified value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
differentitation |
query | string | No | Differentiation - Filter for a matching concept code | |
differentitation.anyOf |
query | array | No | Differentiation - Filter for a matching set of concept codes | |
differentitation.descendantsOf |
query | string | No | Differentiation - Filter for all child concepts of a given concepts code | |
differentitation.exists |
query | boolean | No | Differentiation - Filter for entries with a value | |
differentitation.not |
query | string | No | Differentiation - Filter for a mismatching concept code | |
differentitation.not.anyOf |
query | array | No | Differentiation - Filter for a mismmatching set of concept codes | |
differentitation.not.exists |
query | boolean | No | Differentiation - Filter for entries without a value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
laterality |
query | string | No | Laterality - Filter for a matching concept code | |
laterality.anyOf |
query | array | No | Laterality - Filter for a matching set of concept codes | |
laterality.descendantsOf |
query | string | No | Laterality - Filter for all child concepts of a given concepts code | |
laterality.exists |
query | boolean | No | Laterality - Filter for entries with a value | |
laterality.not |
query | string | No | Laterality - Filter for a mismatching concept code | |
laterality.not.anyOf |
query | array | No | Laterality - Filter for a mismmatching set of concept codes | |
laterality.not.exists |
query | boolean | No | Laterality - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
morphology |
query | string | No | Morphology - Filter for a matching concept code | |
morphology.anyOf |
query | array | No | Morphology - Filter for a matching set of concept codes | |
morphology.descendantsOf |
query | string | No | Morphology - Filter for all child concepts of a given concepts code | |
morphology.not |
query | string | No | Morphology - Filter for a mismatching concept code | |
morphology.not.anyOf |
query | array | No | Morphology - Filter for a mismmatching set of concept codes | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
relatedPrimaryId |
query | string | No | Related primary neoplasm - Filter for reference matches | |
relatedPrimaryId.anyOf |
query | array | No | Related primary neoplasm - Filter for entries where at least one reference matches the query | |
relatedPrimaryId.beginsWith |
query | string | No | Related primary neoplasm - Filter for entries starting with the text | |
relatedPrimaryId.contains |
query | string | No | Related primary neoplasm - Filter for partial text matches | |
relatedPrimaryId.endsWith |
query | string | No | Related primary neoplasm - Filter for entries ending with the text | |
relatedPrimaryId.exists |
query | boolean | No | Related primary neoplasm - Filter for entries with a value | |
relatedPrimaryId.not |
query | string | No | Related primary neoplasm - Filter for reference mismatches | |
relatedPrimaryId.not.anyOf |
query | array | No | Related primary neoplasm - Filter for entries where at least one reference mismatches the query | |
relatedPrimaryId.not.beginsWith |
query | string | No | Related primary neoplasm - Filter for entries not starting with the text | |
relatedPrimaryId.not.contains |
query | string | No | Related primary neoplasm - Filter for partial text mismatches | |
relatedPrimaryId.not.endsWith |
query | string | No | Related primary neoplasm - Filter for entries not ending with the text | |
relatedPrimaryId.not.exists |
query | boolean | No | Related primary neoplasm - Filter for entries without a value | |
relationship |
query | No | Neoplastic relationship - Filter for single value choice | ||
relationship.anyOf |
query | array | No | Neoplastic relationship - ('Filter for excluding a subset of value choices',) | |
relationship.not |
query | No | Neoplastic relationship - ('Filter for all but a single value choice',) | ||
topography |
query | string | No | Topography - Filter for a matching concept code | |
topography.anyOf |
query | array | No | Topography - Filter for a matching set of concept codes | |
topography.descendantsOf |
query | string | No | Topography - Filter for all child concepts of a given concepts code | |
topography.not |
query | string | No | Topography - Filter for a mismatching concept code | |
topography.not.anyOf |
query | array | No | Topography - Filter for a mismmatching set of concept codes | |
topographyGroup |
query | string | No | Topographical group - Filter for a matching concept code | |
topographyGroup.anyOf |
query | array | No | Topographical group - Filter for a matching set of concept codes | |
topographyGroup.descendantsOf |
query | string | No | Topographical group - Filter for all child concepts of a given concepts code | |
topographyGroup.exists |
query | boolean | No | Topographical group - Filter for entries with a value | |
topographyGroup.not |
query | string | No | Topographical group - Filter for a mismatching concept code | |
topographyGroup.not.anyOf |
query | array | No | Topographical group - Filter for a mismmatching set of concept codes | |
topographyGroup.not.exists |
query | boolean | No | Topographical group - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "b790ce62-2ccf-420a-964b-f229699ce5f6",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d341a8ed-8c75-48bb-95da-0ceb44fbd51d",
"relationship": "primary",
"relatedPrimaryId": "21cb56a1-463f-49b3-bccc-7baf4d1e29f2",
"assertionDate": "2022-04-13",
"topography": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"morphology": null,
"differentitation": null,
"laterality": null,
"topographyGroup": null
}
]
}
Schema of the response body
POST /api/v1/neoplastic-entities¶
Create Neoplastic Entity
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "cc7034f3-5aef-4ea2-8c7e-bfd7a2ae22f1",
"relationship": "primary",
"relatedPrimaryId": "937cce1e-f79d-4c01-ac67-bb877bd26766",
"assertionDate": "2022-04-13",
"topography": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"morphology": null,
"differentitation": null,
"laterality": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's neoplasm(s) are recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"relationship": {
"$ref": "#/components/schemas/NeoplasticEntityRelationshipChoices",
"description": "Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease.",
"title": "Neoplastic relationship"
},
"relatedPrimaryId": {
"description": "Reference to the primary neoplasm of which the neoplasm(s) originated from.",
"format": "uuid",
"title": "Related primary neoplasm",
"type": "string"
},
"assertionDate": {
"description": "The date on which the existence of the neoplasm(s) was first asserted or acknowledged",
"format": "date",
"title": "Assertion date",
"type": "string"
},
"topography": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the neoplasm(s)",
"title": "Topography",
"x-terminology": "CancerTopography"
},
"morphology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself",
"title": "Morphology",
"x-terminology": "CancerMorphology"
},
"differentitation": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphologic differentitation characteristics of the neoplasm(s)",
"title": "Differentiation",
"x-terminology": "HistologyDifferentiation"
},
"laterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality qualifier for the location of the neoplasm(s)",
"title": "Laterality",
"x-terminology": "LateralityQualifier"
}
},
"required": [
"caseId",
"relationship",
"assertionDate",
"topography",
"morphology"
],
"title": "NeoplasticEntityCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/neoplastic-entities/{entityId}¶
Get Neoplastic Entity By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
entityId |
path | string | No |
Responses
{
"anonymized": true,
"id": "c217e41b-2e08-4197-b88d-a9acc805eeed",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "1510548c-abae-4d93-904a-1629603ff734",
"relationship": "primary",
"relatedPrimaryId": "0169838d-f2f7-44f0-af96-056cde098a1e",
"assertionDate": "2022-04-13",
"topography": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"morphology": null,
"differentitation": null,
"laterality": null,
"topographyGroup": null
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's neoplasm(s) are recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"relationship": {
"$ref": "#/components/schemas/NeoplasticEntityRelationshipChoices",
"description": "Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease.",
"title": "Neoplastic relationship"
},
"relatedPrimaryId": {
"description": "Reference to the primary neoplasm of which the neoplasm(s) originated from.",
"format": "uuid",
"title": "Related primary neoplasm",
"type": "string"
},
"assertionDate": {
"description": "The date on which the existence of the neoplasm(s) was first asserted or acknowledged",
"format": "date",
"title": "Assertion date",
"type": "string"
},
"topography": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the neoplasm(s)",
"title": "Topography",
"x-terminology": "CancerTopography"
},
"morphology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself",
"title": "Morphology",
"x-terminology": "CancerMorphology"
},
"differentitation": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphologic differentitation characteristics of the neoplasm(s)",
"title": "Differentiation",
"x-terminology": "HistologyDifferentiation"
},
"laterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality qualifier for the location of the neoplasm(s)",
"title": "Laterality",
"x-terminology": "LateralityQualifier"
},
"topographyGroup": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Broad anatomical location of the neoplastic entity",
"title": "Topographical group",
"x-terminology": "CancerTopographyGroup"
}
},
"required": [
"id",
"description",
"caseId",
"relationship",
"assertionDate",
"topography",
"morphology"
],
"title": "NeoplasticEntity",
"type": "object"
}
PUT /api/v1/neoplastic-entities/{entityId}¶
Update Neoplastic Entity
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
entityId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "71b56431-9d99-4a1a-9595-b79b8c0d8b78",
"relationship": "primary",
"relatedPrimaryId": "f56ea22d-a85a-4816-9680-b6f76bc0e720",
"assertionDate": "2022-04-13",
"topography": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"morphology": null,
"differentitation": null,
"laterality": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's neoplasm(s) are recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"relationship": {
"$ref": "#/components/schemas/NeoplasticEntityRelationshipChoices",
"description": "Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease.",
"title": "Neoplastic relationship"
},
"relatedPrimaryId": {
"description": "Reference to the primary neoplasm of which the neoplasm(s) originated from.",
"format": "uuid",
"title": "Related primary neoplasm",
"type": "string"
},
"assertionDate": {
"description": "The date on which the existence of the neoplasm(s) was first asserted or acknowledged",
"format": "date",
"title": "Assertion date",
"type": "string"
},
"topography": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the neoplasm(s)",
"title": "Topography",
"x-terminology": "CancerTopography"
},
"morphology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself",
"title": "Morphology",
"x-terminology": "CancerMorphology"
},
"differentitation": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphologic differentitation characteristics of the neoplasm(s)",
"title": "Differentiation",
"x-terminology": "HistologyDifferentiation"
},
"laterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality qualifier for the location of the neoplasm(s)",
"title": "Laterality",
"x-terminology": "LateralityQualifier"
}
},
"required": [
"caseId",
"relationship",
"assertionDate",
"topography",
"morphology"
],
"title": "NeoplasticEntityCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/neoplastic-entities/{entityId}¶
Delete Neoplastic Entity
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
entityId |
path | string | No |
Responses
GET /api/v1/neoplastic-entities/{entityId}/history/events¶
Get All Neoplastic Entity History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
entityId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/neoplastic-entities/{entityId}/history/events/{eventId}¶
Get Neoplastic Entity History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
entityId |
path | string | No | ||
eventId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/neoplastic-entities/{entityId}/history/events/{eventId}/reversion¶
Revert Neoplastic Entity To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
entityId |
path | string | No | ||
eventId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Stagings¶
GET /api/v1/stagings¶
Get All Stagings Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Staging date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Staging date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Staging date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Staging date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Staging date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Staging date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Staging date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Staging date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
stage |
query | string | No | Stage - Filter for a matching concept code | |
stage.anyOf |
query | array | No | Stage - Filter for a matching set of concept codes | |
stage.descendantsOf |
query | string | No | Stage - Filter for all child concepts of a given concepts code | |
stage.not |
query | string | No | Stage - Filter for a mismatching concept code | |
stage.not.anyOf |
query | array | No | Stage - Filter for a mismmatching set of concept codes | |
stagedEntitiesIds |
query | string | No | Staged neoplastic entities - Filter for full text matches | |
stagedEntitiesIds.anyOf |
query | array | No | Staged neoplastic entities - Filter for entries where at least one reference matches the query | |
stagedEntitiesIds.beginsWith |
query | string | No | Staged neoplastic entities - Filter for entries starting with the text | |
stagedEntitiesIds.contains |
query | string | No | Staged neoplastic entities - Filter for partial text matches | |
stagedEntitiesIds.endsWith |
query | string | No | Staged neoplastic entities - Filter for entries ending with the text | |
stagedEntitiesIds.exists |
query | boolean | No | Staged neoplastic entities - Filter for entries with a value | |
stagedEntitiesIds.not |
query | string | No | Staged neoplastic entities - Filter for full text mismatches | |
stagedEntitiesIds.not.anyOf |
query | array | No | Staged neoplastic entities - Filter for entries where at least one reference mismatches the query | |
stagedEntitiesIds.not.beginsWith |
query | string | No | Staged neoplastic entities - Filter for entries not starting with the text | |
stagedEntitiesIds.not.contains |
query | string | No | Staged neoplastic entities - Filter for partial text mismatches | |
stagedEntitiesIds.not.endsWith |
query | string | No | Staged neoplastic entities - Filter for entries not ending with the text | |
stagedEntitiesIds.not.exists |
query | boolean | No | Staged neoplastic entities - Filter for entries without a value | |
stagingDomain |
query | No | Staging domain - Filter for single value choice | ||
stagingDomain.anyOf |
query | array | No | Staging domain - ('Filter for excluding a subset of value choices',) | |
stagingDomain.not |
query | No | Staging domain - ('Filter for all but a single value choice',) | ||
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/stagings¶
Create Staging
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/TNMStagingCreate"
},
{
"$ref": "#/components/schemas/FIGOStagingCreate"
},
{
"$ref": "#/components/schemas/BinetStagingCreate"
},
{
"$ref": "#/components/schemas/RaiStagingCreate"
},
{
"$ref": "#/components/schemas/BreslowDepthCreate"
},
{
"$ref": "#/components/schemas/ClarkStagingCreate"
},
{
"$ref": "#/components/schemas/ISSStagingCreate"
},
{
"$ref": "#/components/schemas/RISSStagingCreate"
},
{
"$ref": "#/components/schemas/GleasonGradeCreate"
},
{
"$ref": "#/components/schemas/INSSStageCreate"
},
{
"$ref": "#/components/schemas/INRGSSStageCreate"
},
{
"$ref": "#/components/schemas/WilmsStageCreate"
},
{
"$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroupCreate"
},
{
"$ref": "#/components/schemas/LymphomaStagingCreate"
}
],
"title": "Payload"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/stagings/{stagingId}¶
Get Staging By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
stagingId |
path | string | No |
Responses
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/TNMStaging"
},
{
"$ref": "#/components/schemas/FIGOStaging"
},
{
"$ref": "#/components/schemas/BinetStaging"
},
{
"$ref": "#/components/schemas/RaiStaging"
},
{
"$ref": "#/components/schemas/BreslowDepth"
},
{
"$ref": "#/components/schemas/ClarkStaging"
},
{
"$ref": "#/components/schemas/ISSStaging"
},
{
"$ref": "#/components/schemas/RISSStaging"
},
{
"$ref": "#/components/schemas/GleasonGrade"
},
{
"$ref": "#/components/schemas/INSSStage"
},
{
"$ref": "#/components/schemas/INRGSSStage"
},
{
"$ref": "#/components/schemas/WilmsStage"
},
{
"$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroup"
},
{
"$ref": "#/components/schemas/LymphomaStaging"
}
]
}
PUT /api/v1/stagings/{stagingId}¶
Update Staging
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
stagingId |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/TNMStagingCreate"
},
{
"$ref": "#/components/schemas/FIGOStagingCreate"
},
{
"$ref": "#/components/schemas/BinetStagingCreate"
},
{
"$ref": "#/components/schemas/RaiStagingCreate"
},
{
"$ref": "#/components/schemas/BreslowDepthCreate"
},
{
"$ref": "#/components/schemas/ClarkStagingCreate"
},
{
"$ref": "#/components/schemas/ISSStagingCreate"
},
{
"$ref": "#/components/schemas/RISSStagingCreate"
},
{
"$ref": "#/components/schemas/GleasonGradeCreate"
},
{
"$ref": "#/components/schemas/INSSStageCreate"
},
{
"$ref": "#/components/schemas/INRGSSStageCreate"
},
{
"$ref": "#/components/schemas/WilmsStageCreate"
},
{
"$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroupCreate"
},
{
"$ref": "#/components/schemas/LymphomaStagingCreate"
}
],
"title": "Payload"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/stagings/{stagingId}¶
Delete Staging
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
stagingId |
path | string | No |
Responses
GET /api/v1/stagings/{stagingId}/history/events¶
Get All Staging History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
stagingId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
GET /api/v1/stagings/{stagingId}/history/events/{eventId}¶
Get Staging History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
stagingId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "Schema representing a history event within the system.\n\nAttributes:\n id (Any): The unique identifier of the history event.\n resourceId (Any): The unique identifier of the tracked resource.\n category (HistoryEventCategory): The type of history event.\n timestamp (datetime): Timestamp of the history event.\n user (Nullable[str]): Username of the user that triggered the event, if applicable.\n url (Nullable[str]): Endpoint URL through which the event was triggered, if applicable.\n resource (Nullable[str]): Resource involved in the event, if applicable.\n snapshot (Dict): Data snapshot at the time of the event.\n differential (Nullable[Dict]): Data changes introduced by the event, if applicable.\n context (Nullable[Dict]): Context surrounding the event.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEvent",
"type": "object"
}
PUT /api/v1/stagings/{stagingId}/history/events/{eventId}/reversion¶
Revert Staging To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
stagingId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Risk Assessments¶
GET /api/v1/risk-assessments¶
Get All Risk Assessments Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
assessedEntitiesIds |
query | string | No | Assessed neoplastic entities - Filter for full text matches | |
assessedEntitiesIds.anyOf |
query | array | No | Assessed neoplastic entities - Filter for entries where at least one reference matches the query | |
assessedEntitiesIds.beginsWith |
query | string | No | Assessed neoplastic entities - Filter for entries starting with the text | |
assessedEntitiesIds.contains |
query | string | No | Assessed neoplastic entities - Filter for partial text matches | |
assessedEntitiesIds.endsWith |
query | string | No | Assessed neoplastic entities - Filter for entries ending with the text | |
assessedEntitiesIds.exists |
query | boolean | No | Assessed neoplastic entities - Filter for entries with a value | |
assessedEntitiesIds.not |
query | string | No | Assessed neoplastic entities - Filter for full text mismatches | |
assessedEntitiesIds.not.anyOf |
query | array | No | Assessed neoplastic entities - Filter for entries where at least one reference mismatches the query | |
assessedEntitiesIds.not.beginsWith |
query | string | No | Assessed neoplastic entities - Filter for entries not starting with the text | |
assessedEntitiesIds.not.contains |
query | string | No | Assessed neoplastic entities - Filter for partial text mismatches | |
assessedEntitiesIds.not.endsWith |
query | string | No | Assessed neoplastic entities - Filter for entries not ending with the text | |
assessedEntitiesIds.not.exists |
query | boolean | No | Assessed neoplastic entities - Filter for entries without a value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
methodology |
query | string | No | Assessment methodology - Filter for a matching concept code | |
methodology.anyOf |
query | array | No | Assessment methodology - Filter for a matching set of concept codes | |
methodology.descendantsOf |
query | string | No | Assessment methodology - Filter for all child concepts of a given concepts code | |
methodology.not |
query | string | No | Assessment methodology - Filter for a mismatching concept code | |
methodology.not.anyOf |
query | array | No | Assessment methodology - Filter for a mismmatching set of concept codes | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
risk |
query | string | No | Risk - Filter for a matching concept code | |
risk.anyOf |
query | array | No | Risk - Filter for a matching set of concept codes | |
risk.descendantsOf |
query | string | No | Risk - Filter for all child concepts of a given concepts code | |
risk.not |
query | string | No | Risk - Filter for a mismatching concept code | |
risk.not.anyOf |
query | array | No | Risk - Filter for a mismmatching set of concept codes | |
score.between |
query | array | No | Score - Filter for entries with values between two specified values (inclusive) | |
score.equal |
query | number | No | Score - Filter for entries with values exactly equal to the specified value | |
score.exists |
query | boolean | No | Score - Filter for entries with a value | |
score.greaterThan |
query | number | No | Score - Filter for entries with values greater than the specified value | |
score.greaterThanOrEqual |
query | number | No | Score - Filter for entries with values greater than or equal to the specified value | |
score.lessThan |
query | number | No | Score - Filter for entries with values less than the specified value | |
score.lessThanOrEqual |
query | number | No | Score - Filter for entries with values less than or equal to the specified value | |
score.not.between |
query | array | No | Score - Filter for entries with values between two specified values (inclusive) | |
score.not.equal |
query | number | No | Score - Filter for entries with values not equal to the specified value | |
score.not.exists |
query | boolean | No | Score - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "6c3f7acb-480e-4b57-bc81-55e3cd407b60",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e0e8d7ac-2116-426d-a48f-e82bfc849f26",
"date": "2022-04-13",
"methodology": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"38a3186a-faea-4f79-bff1-71ece0a6141b"
]
}
]
}
POST /api/v1/risk-assessments¶
Create Risk Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "70ea37aa-f030-4a0a-b137-fc31fc8468d1",
"date": "2022-04-13",
"methodology": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"3b2eb1b9-da69-4700-b546-d91151df89cb"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's cancer risk is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the risk assessment was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Indicates the method or type of risk assessment",
"title": "Assessment methodology",
"x-terminology": "CancerRiskAssessmentMethod"
},
"risk": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Assessed risk",
"title": "Risk",
"x-terminology": "CancerRiskAssessmentClassification"
},
"score": {
"description": "Quantitative score used to classify the risk",
"title": "Score",
"type": "number"
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assessed to estimate the risk.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array"
}
},
"required": [
"caseId",
"date",
"methodology",
"risk"
],
"title": "RiskAssessmentCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/risk-assessments/{riskAssessmentId}¶
Get Risk Assessment By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
riskAssessmentId |
path | string | No |
Responses
{
"anonymized": true,
"id": "47b7e1b2-cc9b-4e09-9f19-64cbda64935e",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "a7f3d2c9-bf05-4fb3-87d6-aa2063f3c91b",
"date": "2022-04-13",
"methodology": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"d9fe9698-6dce-4d2b-94dc-91830acdb654"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's cancer risk is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the risk assessment was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Indicates the method or type of risk assessment",
"title": "Assessment methodology",
"x-terminology": "CancerRiskAssessmentMethod"
},
"risk": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Assessed risk",
"title": "Risk",
"x-terminology": "CancerRiskAssessmentClassification"
},
"score": {
"description": "Quantitative score used to classify the risk",
"title": "Score",
"type": "number"
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assessed to estimate the risk.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array"
}
},
"required": [
"id",
"description",
"caseId",
"date",
"methodology",
"risk"
],
"title": "RiskAssessment",
"type": "object"
}
PUT /api/v1/risk-assessments/{riskAssessmentId}¶
Update Risk Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
riskAssessmentId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "47f8f319-d552-431e-ac7b-64283805d021",
"date": "2022-04-13",
"methodology": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"f2e4c194-ccfd-4b49-b386-bfacbbefbb94"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's cancer risk is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the risk assessment was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Indicates the method or type of risk assessment",
"title": "Assessment methodology",
"x-terminology": "CancerRiskAssessmentMethod"
},
"risk": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Assessed risk",
"title": "Risk",
"x-terminology": "CancerRiskAssessmentClassification"
},
"score": {
"description": "Quantitative score used to classify the risk",
"title": "Score",
"type": "number"
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assessed to estimate the risk.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array"
}
},
"required": [
"caseId",
"date",
"methodology",
"risk"
],
"title": "RiskAssessmentCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/risk-assessments/{riskAssessmentId}¶
Delete Risk Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
riskAssessmentId |
path | string | No |
Responses
GET /api/v1/risk-assessments/{riskAssessmentId}/history/events¶
Get All Risk Assessment History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
riskAssessmentId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/risk-assessments/{riskAssessmentId}/history/events/{eventId}¶
Get Risk Assessment History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
riskAssessmentId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/risk-assessments/{riskAssessmentId}/history/events/{eventId}/reversion¶
Revert Risk Assessment To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
riskAssessmentId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Tumor Markers¶
GET /api/v1/tumor-markers¶
Get All Tumor Markers Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
analyte |
query | string | No | Analyte - Filter for a matching concept code | |
analyte.anyOf |
query | array | No | Analyte - Filter for a matching set of concept codes | |
analyte.descendantsOf |
query | string | No | Analyte - Filter for all child concepts of a given concepts code | |
analyte.not |
query | string | No | Analyte - Filter for a mismatching concept code | |
analyte.not.anyOf |
query | array | No | Analyte - Filter for a mismmatching set of concept codes | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
arbitraryConcentration.between |
query | array | No | Arbitrary concentration - Filter for entries with values between two specified values (inclusive) | |
arbitraryConcentration.equal |
query | number | No | Arbitrary concentration - Filter for entries with values exactly equal to the specified value | |
arbitraryConcentration.exists |
query | boolean | No | Arbitrary concentration - Filter for entries with a value | |
arbitraryConcentration.greaterThan |
query | number | No | Arbitrary concentration - Filter for entries with values greater than the specified value | |
arbitraryConcentration.greaterThanOrEqual |
query | number | No | Arbitrary concentration - Filter for entries with values greater than or equal to the specified value | |
arbitraryConcentration.lessThan |
query | number | No | Arbitrary concentration - Filter for entries with values less than the specified value | |
arbitraryConcentration.lessThanOrEqual |
query | number | No | Arbitrary concentration - Filter for entries with values less than or equal to the specified value | |
arbitraryConcentration.not.between |
query | array | No | Arbitrary concentration - Filter for entries with values between two specified values (inclusive) | |
arbitraryConcentration.not.equal |
query | number | No | Arbitrary concentration - Filter for entries with values not equal to the specified value | |
arbitraryConcentration.not.exists |
query | boolean | No | Arbitrary concentration - Filter for entries without a value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
combinedPositiveScore.between |
query | array | No | Combined Positive Score (CPS) - Filter for entries with values between two specified values (inclusive) | |
combinedPositiveScore.equal |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values exactly equal to the specified value | |
combinedPositiveScore.exists |
query | boolean | No | Combined Positive Score (CPS) - Filter for entries with a value | |
combinedPositiveScore.greaterThan |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values greater than the specified value | |
combinedPositiveScore.greaterThanOrEqual |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values greater than or equal to the specified value | |
combinedPositiveScore.lessThan |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values less than the specified value | |
combinedPositiveScore.lessThanOrEqual |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values less than or equal to the specified value | |
combinedPositiveScore.not.between |
query | array | No | Combined Positive Score (CPS) - Filter for entries with values between two specified values (inclusive) | |
combinedPositiveScore.not.equal |
query | number | No | Combined Positive Score (CPS) - Filter for entries with values not equal to the specified value | |
combinedPositiveScore.not.exists |
query | boolean | No | Combined Positive Score (CPS) - Filter for entries without a value | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
fraction.between |
query | array | No | Fraction - Filter for entries with values between two specified values (inclusive) | |
fraction.equal |
query | number | No | Fraction - Filter for entries with values exactly equal to the specified value | |
fraction.exists |
query | boolean | No | Fraction - Filter for entries with a value | |
fraction.greaterThan |
query | number | No | Fraction - Filter for entries with values greater than the specified value | |
fraction.greaterThanOrEqual |
query | number | No | Fraction - Filter for entries with values greater than or equal to the specified value | |
fraction.lessThan |
query | number | No | Fraction - Filter for entries with values less than the specified value | |
fraction.lessThanOrEqual |
query | number | No | Fraction - Filter for entries with values less than or equal to the specified value | |
fraction.not.between |
query | array | No | Fraction - Filter for entries with values between two specified values (inclusive) | |
fraction.not.equal |
query | number | No | Fraction - Filter for entries with values not equal to the specified value | |
fraction.not.exists |
query | boolean | No | Fraction - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
immuneCellScore |
query | No | Immune Cells Score (ICS) - Filter for single value choice | ||
immuneCellScore.anyOf |
query | array | No | Immune Cells Score (ICS) - ('Filter for excluding a subset of value choices',) | |
immuneCellScore.exists |
query | boolean | No | Immune Cells Score (ICS) - Filter for entries with a value | |
immuneCellScore.not |
query | No | Immune Cells Score (ICS) - ('Filter for all but a single value choice',) | ||
immuneCellScore.not.exists |
query | boolean | No | Immune Cells Score (ICS) - Filter for entries without a value | |
immunohistochemicalScore |
query | No | Immunohistochemical Score - Filter for single value choice | ||
immunohistochemicalScore.anyOf |
query | array | No | Immunohistochemical Score - ('Filter for excluding a subset of value choices',) | |
immunohistochemicalScore.exists |
query | boolean | No | Immunohistochemical Score - Filter for entries with a value | |
immunohistochemicalScore.not |
query | No | Immunohistochemical Score - ('Filter for all but a single value choice',) | ||
immunohistochemicalScore.not.exists |
query | boolean | No | Immunohistochemical Score - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
massConcentration.between |
query | array | No | Mass concentration - Filter for entries with values between two specified values (inclusive) | |
massConcentration.equal |
query | number | No | Mass concentration - Filter for entries with values exactly equal to the specified value | |
massConcentration.exists |
query | boolean | No | Mass concentration - Filter for entries with a value | |
massConcentration.greaterThan |
query | number | No | Mass concentration - Filter for entries with values greater than the specified value | |
massConcentration.greaterThanOrEqual |
query | number | No | Mass concentration - Filter for entries with values greater than or equal to the specified value | |
massConcentration.lessThan |
query | number | No | Mass concentration - Filter for entries with values less than the specified value | |
massConcentration.lessThanOrEqual |
query | number | No | Mass concentration - Filter for entries with values less than or equal to the specified value | |
massConcentration.not.between |
query | array | No | Mass concentration - Filter for entries with values between two specified values (inclusive) | |
massConcentration.not.equal |
query | number | No | Mass concentration - Filter for entries with values not equal to the specified value | |
massConcentration.not.exists |
query | boolean | No | Mass concentration - Filter for entries without a value | |
multipleOfMedian.between |
query | array | No | Multiples of the median - Filter for entries with values between two specified values (inclusive) | |
multipleOfMedian.equal |
query | number | No | Multiples of the median - Filter for entries with values exactly equal to the specified value | |
multipleOfMedian.exists |
query | boolean | No | Multiples of the median - Filter for entries with a value | |
multipleOfMedian.greaterThan |
query | number | No | Multiples of the median - Filter for entries with values greater than the specified value | |
multipleOfMedian.greaterThanOrEqual |
query | number | No | Multiples of the median - Filter for entries with values greater than or equal to the specified value | |
multipleOfMedian.lessThan |
query | number | No | Multiples of the median - Filter for entries with values less than the specified value | |
multipleOfMedian.lessThanOrEqual |
query | number | No | Multiples of the median - Filter for entries with values less than or equal to the specified value | |
multipleOfMedian.not.between |
query | array | No | Multiples of the median - Filter for entries with values between two specified values (inclusive) | |
multipleOfMedian.not.equal |
query | number | No | Multiples of the median - Filter for entries with values not equal to the specified value | |
multipleOfMedian.not.exists |
query | boolean | No | Multiples of the median - Filter for entries without a value | |
nuclearExpressionStatus |
query | No | Nuclear expression status - Filter for single value choice | ||
nuclearExpressionStatus.anyOf |
query | array | No | Nuclear expression status - ('Filter for excluding a subset of value choices',) | |
nuclearExpressionStatus.exists |
query | boolean | No | Nuclear expression status - Filter for entries with a value | |
nuclearExpressionStatus.not |
query | No | Nuclear expression status - ('Filter for all but a single value choice',) | ||
nuclearExpressionStatus.not.exists |
query | boolean | No | Nuclear expression status - Filter for entries without a value | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
presence |
query | No | Presence - Filter for single value choice | ||
presence.anyOf |
query | array | No | Presence - ('Filter for excluding a subset of value choices',) | |
presence.exists |
query | boolean | No | Presence - Filter for entries with a value | |
presence.not |
query | No | Presence - ('Filter for all but a single value choice',) | ||
presence.not.exists |
query | boolean | No | Presence - Filter for entries without a value | |
relatedEntitiesIds |
query | string | No | Related neoplastic entities - Filter for full text matches | |
relatedEntitiesIds.anyOf |
query | array | No | Related neoplastic entities - Filter for entries where at least one reference matches the query | |
relatedEntitiesIds.beginsWith |
query | string | No | Related neoplastic entities - Filter for entries starting with the text | |
relatedEntitiesIds.contains |
query | string | No | Related neoplastic entities - Filter for partial text matches | |
relatedEntitiesIds.endsWith |
query | string | No | Related neoplastic entities - Filter for entries ending with the text | |
relatedEntitiesIds.exists |
query | boolean | No | Related neoplastic entities - Filter for entries with a value | |
relatedEntitiesIds.not |
query | string | No | Related neoplastic entities - Filter for full text mismatches | |
relatedEntitiesIds.not.anyOf |
query | array | No | Related neoplastic entities - Filter for entries where at least one reference mismatches the query | |
relatedEntitiesIds.not.beginsWith |
query | string | No | Related neoplastic entities - Filter for entries not starting with the text | |
relatedEntitiesIds.not.contains |
query | string | No | Related neoplastic entities - Filter for partial text mismatches | |
relatedEntitiesIds.not.endsWith |
query | string | No | Related neoplastic entities - Filter for entries not ending with the text | |
relatedEntitiesIds.not.exists |
query | boolean | No | Related neoplastic entities - Filter for entries without a value | |
substanceConcentration.between |
query | array | No | Substance concentration - Filter for entries with values between two specified values (inclusive) | |
substanceConcentration.equal |
query | number | No | Substance concentration - Filter for entries with values exactly equal to the specified value | |
substanceConcentration.exists |
query | boolean | No | Substance concentration - Filter for entries with a value | |
substanceConcentration.greaterThan |
query | number | No | Substance concentration - Filter for entries with values greater than the specified value | |
substanceConcentration.greaterThanOrEqual |
query | number | No | Substance concentration - Filter for entries with values greater than or equal to the specified value | |
substanceConcentration.lessThan |
query | number | No | Substance concentration - Filter for entries with values less than the specified value | |
substanceConcentration.lessThanOrEqual |
query | number | No | Substance concentration - Filter for entries with values less than or equal to the specified value | |
substanceConcentration.not.between |
query | array | No | Substance concentration - Filter for entries with values between two specified values (inclusive) | |
substanceConcentration.not.equal |
query | number | No | Substance concentration - Filter for entries with values not equal to the specified value | |
substanceConcentration.not.exists |
query | boolean | No | Substance concentration - Filter for entries without a value | |
tumorProportionScore |
query | No | Immune Cells Score (ICS) - Filter for single value choice | ||
tumorProportionScore.anyOf |
query | array | No | Immune Cells Score (ICS) - ('Filter for excluding a subset of value choices',) | |
tumorProportionScore.exists |
query | boolean | No | Immune Cells Score (ICS) - Filter for entries with a value | |
tumorProportionScore.not |
query | No | Immune Cells Score (ICS) - ('Filter for all but a single value choice',) | ||
tumorProportionScore.not.exists |
query | boolean | No | Immune Cells Score (ICS) - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "fd5ef126-154a-4d7e-a471-59a62578db7a",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "12e7002b-610d-458d-b87d-0877542345df",
"date": "2022-04-13",
"analyte": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"e0c1be71-42b2-4481-9f01-311217f3f825"
]
}
]
}
POST /api/v1/tumor-markers¶
Create Tumor Marker
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "dd32a037-ffce-4eae-8396-040ebe90f06b",
"date": "2022-04-13",
"analyte": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"11a97b96-2f37-4d49-bd96-7b1dd28c0896"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient related to the tumor marker result",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the tumor marker was analyzed.",
"format": "date",
"title": "Date",
"type": "string"
},
"analyte": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The chemical or biological substance/agent that is analyzed.",
"title": "Analyte",
"x-terminology": "TumorMarkerAnalyte"
},
"massConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Mass concentration of the analyte (if revelant/measured)",
"title": "Mass concentration",
"x-default-unit": "g/l",
"x-measure": "MassConcentration"
},
"arbitraryConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Arbitrary concentration of the analyte (if revelant/measured)",
"title": "Arbitrary concentration",
"x-default-unit": "kIU/l",
"x-measure": "ArbitraryConcentration"
},
"substanceConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Substance concentration of the analyte (if revelant/measured)",
"title": "Substance concentration",
"x-default-unit": "mol/l",
"x-measure": "SubstanceConcentration"
},
"fraction": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Analyte fraction (if revelant/measured)",
"title": "Fraction",
"x-default-unit": "%",
"x-measure": "Fraction"
},
"multipleOfMedian": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Multiples of the median analyte (if revelant/measured)",
"title": "Multiples of the median",
"x-default-unit": "multiple_of_median",
"x-measure": "MultipleOfMedian"
},
"tumorProportionScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerTumorProportionScoreChoices"
}
],
"description": "Categorization of the percentage of cells in a tumor that express PD-L1",
"title": "Immune Cells Score (ICS)"
},
"immuneCellScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmuneCellScoreChoices"
}
],
"description": "Categorization of the percentage of PD-L1 positive immune cells",
"title": "Immune Cells Score (ICS)"
},
"combinedPositiveScore": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100",
"title": "Combined Positive Score (CPS)",
"x-default-unit": "%",
"x-measure": "Fraction"
},
"immunohistochemicalScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmunohistochemicalScoreChoices"
}
],
"description": "Categorization of the number of analyte-positive cells in a sample",
"title": "Immunohistochemical Score"
},
"presence": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerPresenceChoices"
}
],
"description": "Whether an analyte has tested positive or negative.",
"title": "Presence"
},
"nuclearExpressionStatus": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerNuclearExpressionStatusChoices"
}
],
"description": "Categorization of the status of expression of the analyte",
"title": "Nuclear expression status"
},
"relatedEntitiesIds": {
"description": "References to the neoplastic entities that are related or the focus of the tumor marker analysis.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Related neoplastic entities",
"type": "array"
}
},
"required": [
"caseId",
"date",
"analyte"
],
"title": "TumorMarkerCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/tumor-markers/{tumorMarkerId}¶
Get Tumor Marker By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
tumorMarkerId |
path | string | No |
Responses
{
"anonymized": true,
"id": "c8000310-6cb4-4506-a0c6-bd781cb41a7c",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9232f0ab-5b4a-4648-97bd-e366a8514869",
"date": "2022-04-13",
"analyte": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"b57e8ebc-8892-49da-9c23-b5fd76b0f3e3"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient related to the tumor marker result",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the tumor marker was analyzed.",
"format": "date",
"title": "Date",
"type": "string"
},
"analyte": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The chemical or biological substance/agent that is analyzed.",
"title": "Analyte",
"x-terminology": "TumorMarkerAnalyte"
},
"massConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Mass concentration of the analyte (if revelant/measured)",
"title": "Mass concentration",
"x-default-unit": "g/l",
"x-measure": "MassConcentration"
},
"arbitraryConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Arbitrary concentration of the analyte (if revelant/measured)",
"title": "Arbitrary concentration",
"x-default-unit": "kIU/l",
"x-measure": "ArbitraryConcentration"
},
"substanceConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Substance concentration of the analyte (if revelant/measured)",
"title": "Substance concentration",
"x-default-unit": "mol/l",
"x-measure": "SubstanceConcentration"
},
"fraction": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Analyte fraction (if revelant/measured)",
"title": "Fraction",
"x-default-unit": "%",
"x-measure": "Fraction"
},
"multipleOfMedian": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Multiples of the median analyte (if revelant/measured)",
"title": "Multiples of the median",
"x-default-unit": "multiple_of_median",
"x-measure": "MultipleOfMedian"
},
"tumorProportionScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerTumorProportionScoreChoices"
}
],
"description": "Categorization of the percentage of cells in a tumor that express PD-L1",
"title": "Immune Cells Score (ICS)"
},
"immuneCellScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmuneCellScoreChoices"
}
],
"description": "Categorization of the percentage of PD-L1 positive immune cells",
"title": "Immune Cells Score (ICS)"
},
"combinedPositiveScore": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100",
"title": "Combined Positive Score (CPS)",
"x-default-unit": "%",
"x-measure": "Fraction"
},
"immunohistochemicalScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmunohistochemicalScoreChoices"
}
],
"description": "Categorization of the number of analyte-positive cells in a sample",
"title": "Immunohistochemical Score"
},
"presence": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerPresenceChoices"
}
],
"description": "Whether an analyte has tested positive or negative.",
"title": "Presence"
},
"nuclearExpressionStatus": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerNuclearExpressionStatusChoices"
}
],
"description": "Categorization of the status of expression of the analyte",
"title": "Nuclear expression status"
},
"relatedEntitiesIds": {
"description": "References to the neoplastic entities that are related or the focus of the tumor marker analysis.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Related neoplastic entities",
"type": "array"
}
},
"required": [
"id",
"description",
"caseId",
"date",
"analyte"
],
"title": "TumorMarker",
"type": "object"
}
PUT /api/v1/tumor-markers/{tumorMarkerId}¶
Update Neoplastic Entity
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorMarkerId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c18e672e-de27-47dd-9ae9-9617056ee171",
"date": "2022-04-13",
"analyte": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"bae326ef-684d-4b56-864d-97bff655e736"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient related to the tumor marker result",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the tumor marker was analyzed.",
"format": "date",
"title": "Date",
"type": "string"
},
"analyte": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The chemical or biological substance/agent that is analyzed.",
"title": "Analyte",
"x-terminology": "TumorMarkerAnalyte"
},
"massConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Mass concentration of the analyte (if revelant/measured)",
"title": "Mass concentration",
"x-default-unit": "g/l",
"x-measure": "MassConcentration"
},
"arbitraryConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Arbitrary concentration of the analyte (if revelant/measured)",
"title": "Arbitrary concentration",
"x-default-unit": "kIU/l",
"x-measure": "ArbitraryConcentration"
},
"substanceConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Substance concentration of the analyte (if revelant/measured)",
"title": "Substance concentration",
"x-default-unit": "mol/l",
"x-measure": "SubstanceConcentration"
},
"fraction": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Analyte fraction (if revelant/measured)",
"title": "Fraction",
"x-default-unit": "%",
"x-measure": "Fraction"
},
"multipleOfMedian": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Multiples of the median analyte (if revelant/measured)",
"title": "Multiples of the median",
"x-default-unit": "multiple_of_median",
"x-measure": "MultipleOfMedian"
},
"tumorProportionScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerTumorProportionScoreChoices"
}
],
"description": "Categorization of the percentage of cells in a tumor that express PD-L1",
"title": "Immune Cells Score (ICS)"
},
"immuneCellScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmuneCellScoreChoices"
}
],
"description": "Categorization of the percentage of PD-L1 positive immune cells",
"title": "Immune Cells Score (ICS)"
},
"combinedPositiveScore": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100",
"title": "Combined Positive Score (CPS)",
"x-default-unit": "%",
"x-measure": "Fraction"
},
"immunohistochemicalScore": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerImmunohistochemicalScoreChoices"
}
],
"description": "Categorization of the number of analyte-positive cells in a sample",
"title": "Immunohistochemical Score"
},
"presence": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerPresenceChoices"
}
],
"description": "Whether an analyte has tested positive or negative.",
"title": "Presence"
},
"nuclearExpressionStatus": {
"allOf": [
{
"$ref": "#/components/schemas/TumorMarkerNuclearExpressionStatusChoices"
}
],
"description": "Categorization of the status of expression of the analyte",
"title": "Nuclear expression status"
},
"relatedEntitiesIds": {
"description": "References to the neoplastic entities that are related or the focus of the tumor marker analysis.",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Related neoplastic entities",
"type": "array"
}
},
"required": [
"caseId",
"date",
"analyte"
],
"title": "TumorMarkerCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/tumor-markers/{tumorMarkerId}¶
Delete Tumor Marker
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorMarkerId |
path | string | No |
Responses
GET /api/v1/tumor-markers/{tumorMarkerId}/history/events¶
Get All Tumor Marker History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
tumorMarkerId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/tumor-markers/{tumorMarkerId}/history/events/{eventId}¶
Get Tumor Marker History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
tumorMarkerId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/tumor-markers/{tumorMarkerId}/history/events/{eventId}/reversion¶
Revert Tumor Marker To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
tumorMarkerId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/tumor-markers/analytes/{analyteCode}/details¶
Get Tumor Marker Analyte Details By Code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
analyteCode |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents details about a tumor marker analyte.\n\nAttributes:\n acronym (str): The acronym or short name for the analyte.\n display (str): The display name or description of the analyte.\n valueTypes (List[AnalyteResultType]): List of possible result types for the analyte.",
"properties": {
"acronym": {
"title": "Acronym",
"type": "string"
},
"display": {
"title": "Display",
"type": "string"
},
"valueTypes": {
"items": {
"$ref": "#/components/schemas/AnalyteResultType"
},
"title": "Valuetypes",
"type": "array"
}
},
"required": [
"acronym",
"display",
"valueTypes"
],
"title": "AnalyteDetails",
"type": "object"
}
Systemic Therapies¶
GET /api/v1/systemic-therapies¶
Get All Systemic Therapies Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adjunctiveRole |
query | string | No | Treatment Role - Filter for a matching concept code | |
adjunctiveRole.anyOf |
query | array | No | Treatment Role - Filter for a matching set of concept codes | |
adjunctiveRole.descendantsOf |
query | string | No | Treatment Role - Filter for all child concepts of a given concepts code | |
adjunctiveRole.exists |
query | boolean | No | Treatment Role - Filter for entries with a value | |
adjunctiveRole.not |
query | string | No | Treatment Role - Filter for a mismatching concept code | |
adjunctiveRole.not.anyOf |
query | array | No | Treatment Role - Filter for a mismmatching set of concept codes | |
adjunctiveRole.not.exists |
query | boolean | No | Treatment Role - Filter for entries without a value | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
cycles.between |
query | array | No | Cycles - Filter for entries with values between two specified values (inclusive) | |
cycles.equal |
query | integer | No | Cycles - Filter for entries with values exactly equal to the specified value | |
cycles.exists |
query | boolean | No | Cycles - Filter for entries with a value | |
cycles.greaterThan |
query | integer | No | Cycles - Filter for entries with values greater than the specified value | |
cycles.greaterThanOrEqual |
query | integer | No | Cycles - Filter for entries with values greater than or equal to the specified value | |
cycles.lessThan |
query | integer | No | Cycles - Filter for entries with values less than the specified value | |
cycles.lessThanOrEqual |
query | integer | No | Cycles - Filter for entries with values less than or equal to the specified value | |
cycles.not.between |
query | array | No | Cycles - Filter for entries with values between two specified values (inclusive) | |
cycles.not.equal |
query | integer | No | Cycles - Filter for entries with values not equal to the specified value | |
cycles.not.exists |
query | boolean | No | Cycles - Filter for entries without a value | |
duration.between |
query | array | No | Duration - Filter for entries with values between two specified values (inclusive) | |
duration.equal |
query | number | No | Duration - Filter for entries with values exactly equal to the specified value | |
duration.greaterThan |
query | number | No | Duration - Filter for entries with values greater than the specified value | |
duration.greaterThanOrEqual |
query | number | No | Duration - Filter for entries with values greater than or equal to the specified value | |
duration.lessThan |
query | number | No | Duration - Filter for entries with values less than the specified value | |
duration.lessThanOrEqual |
query | number | No | Duration - Filter for entries with values less than or equal to the specified value | |
duration.not.between |
query | array | No | Duration - Filter for entries with values between two specified values (inclusive) | |
duration.not.equal |
query | number | No | Duration - Filter for entries with values not equal to the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
intent |
query | No | Intent - Filter for single value choice | ||
intent.anyOf |
query | array | No | Intent - ('Filter for excluding a subset of value choices',) | |
intent.not |
query | No | Intent - ('Filter for all but a single value choice',) | ||
isAdjunctive |
query | boolean | No | Treatment Role - Filter for yes/no statement | |
limit |
query | integer | 10 | No | |
medications.createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
medications.createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
medications.createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
medications.createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
medications.createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
medications.createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
medications.createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
medications.createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
medications.createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
medications.createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
medications.dosageMass.between |
query | array | No | Dosage - Fixed Mass - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMass.equal |
query | number | No | Dosage - Fixed Mass - Filter for entries with values exactly equal to the specified value | |
medications.dosageMass.exists |
query | boolean | No | Dosage - Fixed Mass - Filter for entries with a value | |
medications.dosageMass.greaterThan |
query | number | No | Dosage - Fixed Mass - Filter for entries with values greater than the specified value | |
medications.dosageMass.greaterThanOrEqual |
query | number | No | Dosage - Fixed Mass - Filter for entries with values greater than or equal to the specified value | |
medications.dosageMass.lessThan |
query | number | No | Dosage - Fixed Mass - Filter for entries with values less than the specified value | |
medications.dosageMass.lessThanOrEqual |
query | number | No | Dosage - Fixed Mass - Filter for entries with values less than or equal to the specified value | |
medications.dosageMass.not.between |
query | array | No | Dosage - Fixed Mass - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMass.not.equal |
query | number | No | Dosage - Fixed Mass - Filter for entries with values not equal to the specified value | |
medications.dosageMass.not.exists |
query | boolean | No | Dosage - Fixed Mass - Filter for entries without a value | |
medications.dosageMassConcentration.between |
query | array | No | Dosage - Mass concentration - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMassConcentration.equal |
query | number | No | Dosage - Mass concentration - Filter for entries with values exactly equal to the specified value | |
medications.dosageMassConcentration.exists |
query | boolean | No | Dosage - Mass concentration - Filter for entries with a value | |
medications.dosageMassConcentration.greaterThan |
query | number | No | Dosage - Mass concentration - Filter for entries with values greater than the specified value | |
medications.dosageMassConcentration.greaterThanOrEqual |
query | number | No | Dosage - Mass concentration - Filter for entries with values greater than or equal to the specified value | |
medications.dosageMassConcentration.lessThan |
query | number | No | Dosage - Mass concentration - Filter for entries with values less than the specified value | |
medications.dosageMassConcentration.lessThanOrEqual |
query | number | No | Dosage - Mass concentration - Filter for entries with values less than or equal to the specified value | |
medications.dosageMassConcentration.not.between |
query | array | No | Dosage - Mass concentration - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMassConcentration.not.equal |
query | number | No | Dosage - Mass concentration - Filter for entries with values not equal to the specified value | |
medications.dosageMassConcentration.not.exists |
query | boolean | No | Dosage - Mass concentration - Filter for entries without a value | |
medications.dosageMassSurface.between |
query | array | No | Dosage - Mass per body surface - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMassSurface.equal |
query | number | No | Dosage - Mass per body surface - Filter for entries with values exactly equal to the specified value | |
medications.dosageMassSurface.exists |
query | boolean | No | Dosage - Mass per body surface - Filter for entries with a value | |
medications.dosageMassSurface.greaterThan |
query | number | No | Dosage - Mass per body surface - Filter for entries with values greater than the specified value | |
medications.dosageMassSurface.greaterThanOrEqual |
query | number | No | Dosage - Mass per body surface - Filter for entries with values greater than or equal to the specified value | |
medications.dosageMassSurface.lessThan |
query | number | No | Dosage - Mass per body surface - Filter for entries with values less than the specified value | |
medications.dosageMassSurface.lessThanOrEqual |
query | number | No | Dosage - Mass per body surface - Filter for entries with values less than or equal to the specified value | |
medications.dosageMassSurface.not.between |
query | array | No | Dosage - Mass per body surface - Filter for entries with values between two specified values (inclusive) | |
medications.dosageMassSurface.not.equal |
query | number | No | Dosage - Mass per body surface - Filter for entries with values not equal to the specified value | |
medications.dosageMassSurface.not.exists |
query | boolean | No | Dosage - Mass per body surface - Filter for entries without a value | |
medications.dosageRateMass.between |
query | array | No | Dosage rate - Fixed Mass - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMass.equal |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values exactly equal to the specified value | |
medications.dosageRateMass.exists |
query | boolean | No | Dosage rate - Fixed Mass - Filter for entries with a value | |
medications.dosageRateMass.greaterThan |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values greater than the specified value | |
medications.dosageRateMass.greaterThanOrEqual |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values greater than or equal to the specified value | |
medications.dosageRateMass.lessThan |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values less than the specified value | |
medications.dosageRateMass.lessThanOrEqual |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values less than or equal to the specified value | |
medications.dosageRateMass.not.between |
query | array | No | Dosage rate - Fixed Mass - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMass.not.equal |
query | number | No | Dosage rate - Fixed Mass - Filter for entries with values not equal to the specified value | |
medications.dosageRateMass.not.exists |
query | boolean | No | Dosage rate - Fixed Mass - Filter for entries without a value | |
medications.dosageRateMassConcentration.between |
query | array | No | Dosage rate - Mass concentration - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMassConcentration.equal |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values exactly equal to the specified value | |
medications.dosageRateMassConcentration.exists |
query | boolean | No | Dosage rate - Mass concentration - Filter for entries with a value | |
medications.dosageRateMassConcentration.greaterThan |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values greater than the specified value | |
medications.dosageRateMassConcentration.greaterThanOrEqual |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values greater than or equal to the specified value | |
medications.dosageRateMassConcentration.lessThan |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values less than the specified value | |
medications.dosageRateMassConcentration.lessThanOrEqual |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values less than or equal to the specified value | |
medications.dosageRateMassConcentration.not.between |
query | array | No | Dosage rate - Mass concentration - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMassConcentration.not.equal |
query | number | No | Dosage rate - Mass concentration - Filter for entries with values not equal to the specified value | |
medications.dosageRateMassConcentration.not.exists |
query | boolean | No | Dosage rate - Mass concentration - Filter for entries without a value | |
medications.dosageRateMassSurface.between |
query | array | No | Dosage rate - Mass per body surface - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMassSurface.equal |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values exactly equal to the specified value | |
medications.dosageRateMassSurface.exists |
query | boolean | No | Dosage rate - Mass per body surface - Filter for entries with a value | |
medications.dosageRateMassSurface.greaterThan |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values greater than the specified value | |
medications.dosageRateMassSurface.greaterThanOrEqual |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values greater than or equal to the specified value | |
medications.dosageRateMassSurface.lessThan |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values less than the specified value | |
medications.dosageRateMassSurface.lessThanOrEqual |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values less than or equal to the specified value | |
medications.dosageRateMassSurface.not.between |
query | array | No | Dosage rate - Mass per body surface - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateMassSurface.not.equal |
query | number | No | Dosage rate - Mass per body surface - Filter for entries with values not equal to the specified value | |
medications.dosageRateMassSurface.not.exists |
query | boolean | No | Dosage rate - Mass per body surface - Filter for entries without a value | |
medications.dosageRateVolume.between |
query | array | No | Dosage rate - Volume - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateVolume.equal |
query | number | No | Dosage rate - Volume - Filter for entries with values exactly equal to the specified value | |
medications.dosageRateVolume.exists |
query | boolean | No | Dosage rate - Volume - Filter for entries with a value | |
medications.dosageRateVolume.greaterThan |
query | number | No | Dosage rate - Volume - Filter for entries with values greater than the specified value | |
medications.dosageRateVolume.greaterThanOrEqual |
query | number | No | Dosage rate - Volume - Filter for entries with values greater than or equal to the specified value | |
medications.dosageRateVolume.lessThan |
query | number | No | Dosage rate - Volume - Filter for entries with values less than the specified value | |
medications.dosageRateVolume.lessThanOrEqual |
query | number | No | Dosage rate - Volume - Filter for entries with values less than or equal to the specified value | |
medications.dosageRateVolume.not.between |
query | array | No | Dosage rate - Volume - Filter for entries with values between two specified values (inclusive) | |
medications.dosageRateVolume.not.equal |
query | number | No | Dosage rate - Volume - Filter for entries with values not equal to the specified value | |
medications.dosageRateVolume.not.exists |
query | boolean | No | Dosage rate - Volume - Filter for entries without a value | |
medications.dosageVolume.between |
query | array | No | Dosage - Volume - Filter for entries with values between two specified values (inclusive) | |
medications.dosageVolume.equal |
query | number | No | Dosage - Volume - Filter for entries with values exactly equal to the specified value | |
medications.dosageVolume.exists |
query | boolean | No | Dosage - Volume - Filter for entries with a value | |
medications.dosageVolume.greaterThan |
query | number | No | Dosage - Volume - Filter for entries with values greater than the specified value | |
medications.dosageVolume.greaterThanOrEqual |
query | number | No | Dosage - Volume - Filter for entries with values greater than or equal to the specified value | |
medications.dosageVolume.lessThan |
query | number | No | Dosage - Volume - Filter for entries with values less than the specified value | |
medications.dosageVolume.lessThanOrEqual |
query | number | No | Dosage - Volume - Filter for entries with values less than or equal to the specified value | |
medications.dosageVolume.not.between |
query | array | No | Dosage - Volume - Filter for entries with values between two specified values (inclusive) | |
medications.dosageVolume.not.equal |
query | number | No | Dosage - Volume - Filter for entries with values not equal to the specified value | |
medications.dosageVolume.not.exists |
query | boolean | No | Dosage - Volume - Filter for entries without a value | |
medications.drug |
query | string | No | Antineoplastic Drug - Filter for a matching concept code | |
medications.drug.anyOf |
query | array | No | Antineoplastic Drug - Filter for a matching set of concept codes | |
medications.drug.descendantsOf |
query | string | No | Antineoplastic Drug - Filter for all child concepts of a given concepts code | |
medications.drug.not |
query | string | No | Antineoplastic Drug - Filter for a mismatching concept code | |
medications.drug.not.anyOf |
query | array | No | Antineoplastic Drug - Filter for a mismmatching set of concept codes | |
medications.externalSource |
query | string | No | External data source - Filter for full text matches | |
medications.externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
medications.externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
medications.externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
medications.externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
medications.externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
medications.externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
medications.externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
medications.externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
medications.externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
medications.externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
medications.externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
medications.id |
query | string | No | Id - Filter for full text matches | |
medications.id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
medications.id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
medications.id.contains |
query | string | No | Id - Filter for partial text matches | |
medications.id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
medications.id.not |
query | string | No | Id - Filter for full text mismatches | |
medications.id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
medications.id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
medications.id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
medications.id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
medications.route |
query | string | No | Route - Filter for a matching concept code | |
medications.route.anyOf |
query | array | No | Route - Filter for a matching set of concept codes | |
medications.route.descendantsOf |
query | string | No | Route - Filter for all child concepts of a given concepts code | |
medications.route.exists |
query | boolean | No | Route - Filter for entries with a value | |
medications.route.not |
query | string | No | Route - Filter for a mismatching concept code | |
medications.route.not.anyOf |
query | array | No | Route - Filter for a mismmatching set of concept codes | |
medications.route.not.exists |
query | boolean | No | Route - Filter for entries without a value | |
medications.updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
medications.updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
medications.updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
medications.updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
medications.updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
medications.updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
medications.updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
medications.updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
medications.updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
medications.updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
medications.usedOfflabel |
query | boolean | No | Off-label use - Filter for yes/no statement | |
medications.usedOfflabel.exists |
query | boolean | No | Off-label use - Filter for entries with a value | |
medications.usedOfflabel.not.exists |
query | boolean | No | Off-label use - Filter for entries without a value | |
medications.withinSoc |
query | boolean | No | Within SOC - Filter for yes/no statement | |
medications.withinSoc.exists |
query | boolean | No | Within SOC - Filter for entries with a value | |
medications.withinSoc.not.exists |
query | boolean | No | Within SOC - Filter for entries without a value | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
period.containedBy |
query | array | No | Treatment period - Filter for entries whose period are contined by the time period | |
period.contains |
query | array | No | Treatment period - Filter for entries containing the time period | |
period.not.containedBy |
query | array | No | Treatment period - Filter for entries whose period are not contined by the time period | |
period.not.contains |
query | array | No | Treatment period - Filter for entries not containing the time period | |
period.not.overlaps |
query | array | No | Treatment period - Filter for entries not overlapping with the time period | |
period.overlaps |
query | array | No | Treatment period - Filter for entries overlapping with the time period | |
targetedEntitiesIds |
query | string | No | Targeted neoplastic entities - Filter for full text matches | |
targetedEntitiesIds.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference matches the query | |
targetedEntitiesIds.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries starting with the text | |
targetedEntitiesIds.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text matches | |
targetedEntitiesIds.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries ending with the text | |
targetedEntitiesIds.exists |
query | boolean | No | Targeted neoplastic entities - Filter for entries with a value | |
targetedEntitiesIds.not |
query | string | No | Targeted neoplastic entities - Filter for full text mismatches | |
targetedEntitiesIds.not.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query | |
targetedEntitiesIds.not.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not starting with the text | |
targetedEntitiesIds.not.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text mismatches | |
targetedEntitiesIds.not.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not ending with the text | |
targetedEntitiesIds.not.exists |
query | boolean | No | Targeted neoplastic entities - Filter for entries without a value | |
terminationReason |
query | string | No | Termination reason - Filter for a matching concept code | |
terminationReason.anyOf |
query | array | No | Termination reason - Filter for a matching set of concept codes | |
terminationReason.descendantsOf |
query | string | No | Termination reason - Filter for all child concepts of a given concepts code | |
terminationReason.exists |
query | boolean | No | Termination reason - Filter for entries with a value | |
terminationReason.not |
query | string | No | Termination reason - Filter for a mismatching concept code | |
terminationReason.not.anyOf |
query | array | No | Termination reason - Filter for a mismmatching set of concept codes | |
terminationReason.not.exists |
query | boolean | No | Termination reason - Filter for entries without a value | |
therapyLineId |
query | string | No | Therapy line - Filter for reference matches | |
therapyLineId.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference matches the query | |
therapyLineId.beginsWith |
query | string | No | Therapy line - Filter for entries starting with the text | |
therapyLineId.contains |
query | string | No | Therapy line - Filter for partial text matches | |
therapyLineId.endsWith |
query | string | No | Therapy line - Filter for entries ending with the text | |
therapyLineId.exists |
query | boolean | No | Therapy line - Filter for entries with a value | |
therapyLineId.not |
query | string | No | Therapy line - Filter for reference mismatches | |
therapyLineId.not.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference mismatches the query | |
therapyLineId.not.beginsWith |
query | string | No | Therapy line - Filter for entries not starting with the text | |
therapyLineId.not.contains |
query | string | No | Therapy line - Filter for partial text mismatches | |
therapyLineId.not.endsWith |
query | string | No | Therapy line - Filter for entries not ending with the text | |
therapyLineId.not.exists |
query | boolean | No | Therapy line - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "25b12607-30fe-43ea-b689-ae1180ff6daf",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9c03c22c-d827-4f29-9168-6f831301b9df",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"terminationReason": null,
"therapyLineId": "0bafe61d-0b77-4381-8c1c-ac862c60cb6f",
"targetedEntitiesIds": [
"78fc4a89-97e9-4324-b562-e0cd4d7cbc8e"
],
"medications": [
{
"id": "5b13cb85-ea1b-4683-9f27-c9d10e5c8a7a",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
],
"isAdjunctive": true,
"duration": {
"value": 10.12,
"unit": "string"
}
}
]
}
POST /api/v1/systemic-therapies¶
Create Systemic Therapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "20254172-7220-4e83-ad52-930250366b19",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"terminationReason": null,
"therapyLineId": "9fc84a50-973b-4931-a192-62868548c53b",
"targetedEntitiesIds": [
"c06dd9d1-4ef5-41f3-a601-a21a5e24af08"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who received the systemic therapy",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the therapy was administered to the patient.",
"title": "Treatment period"
},
"cycles": {
"description": "The total number of treatment cycles during the treatment period.",
"title": "Cycles",
"type": "integer"
},
"intent": {
"$ref": "#/components/schemas/SystemicTherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"title": "Intent"
},
"adjunctiveRole": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Indicates the role of the adjunctive therapy (if applicable).",
"title": "Treatment Role",
"x-terminology": "AdjunctiveTherapyRole"
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the systemic therapy",
"title": "Termination reason",
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the systemic therapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string"
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the systemic therapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array"
}
},
"required": [
"caseId",
"period",
"intent"
],
"title": "SystemicTherapyCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/systemic-therapies/{systemicTherapyId}¶
Get Systemic Therapy By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
systemicTherapyId |
path | string | No |
Responses
{
"anonymized": true,
"id": "c7a405ab-be56-49b8-8e27-d1ac4dbca73d",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "50a2b04f-0637-42a9-921b-cbc0aa767c78",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"terminationReason": null,
"therapyLineId": "d555893e-1720-4e7b-8ff3-bd001a8033a6",
"targetedEntitiesIds": [
"47c45c4e-b933-43ad-91e6-db92cc12ff4c"
],
"medications": [
{
"id": "a6249e74-c384-41cd-87a8-7b222834acd0",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
],
"isAdjunctive": true,
"duration": {
"value": 10.12,
"unit": "string"
}
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who received the systemic therapy",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the therapy was administered to the patient.",
"title": "Treatment period"
},
"cycles": {
"description": "The total number of treatment cycles during the treatment period.",
"title": "Cycles",
"type": "integer"
},
"intent": {
"$ref": "#/components/schemas/SystemicTherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"title": "Intent"
},
"adjunctiveRole": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Indicates the role of the adjunctive therapy (if applicable).",
"title": "Treatment Role",
"x-terminology": "AdjunctiveTherapyRole"
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the systemic therapy",
"title": "Termination reason",
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the systemic therapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string"
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the systemic therapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array"
},
"medications": {
"description": "Medications administered during the systemic therapy",
"items": {
"$ref": "#/components/schemas/SystemicTherapyMedication"
},
"title": "Medications",
"type": "array"
},
"isAdjunctive": {
"description": "Indicates whether it is adjunctive therapy instead of a primary therapy",
"title": "Treatment Role",
"type": "boolean"
},
"duration": {
"$ref": "#/components/schemas/Measure",
"description": "Duration of treatment",
"title": "Duration",
"x-default-unit": "day",
"x-measure": "Time"
}
},
"required": [
"id",
"description",
"caseId",
"period",
"intent",
"medications",
"isAdjunctive",
"duration"
],
"title": "SystemicTherapy",
"type": "object"
}
DELETE /api/v1/systemic-therapies/{systemicTherapyId}¶
Delete Systemic Therapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
systemicTherapyId |
path | string | No |
Responses
PUT /api/v1/systemic-therapies/{systemicTherapyId}¶
Update Systemic Therapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
systemicTherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "39838e2f-9348-4c69-b61b-bddfdec3da52",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"cycles": 0,
"intent": "curative",
"adjunctiveRole": null,
"terminationReason": null,
"therapyLineId": "2f9aafa5-7d59-4bad-a689-44b7449bfffa",
"targetedEntitiesIds": [
"f1b5029e-a727-4ada-b09c-93122a6cc212"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who received the systemic therapy",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the therapy was administered to the patient.",
"title": "Treatment period"
},
"cycles": {
"description": "The total number of treatment cycles during the treatment period.",
"title": "Cycles",
"type": "integer"
},
"intent": {
"$ref": "#/components/schemas/SystemicTherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"title": "Intent"
},
"adjunctiveRole": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Indicates the role of the adjunctive therapy (if applicable).",
"title": "Treatment Role",
"x-terminology": "AdjunctiveTherapyRole"
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the systemic therapy",
"title": "Termination reason",
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the systemic therapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string"
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the systemic therapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array"
}
},
"required": [
"caseId",
"period",
"intent"
],
"title": "SystemicTherapyCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/systemic-therapies/{systemicTherapyId}/history/events¶
Get All Systemic Therapy History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
systemicTherapyId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/systemic-therapies/{systemicTherapyId}/history/events/{eventId}¶
Get Systemic Therapy History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/systemic-therapies/{systemicTherapyId}/history/events/{eventId}/reversion¶
Revert Systemic Therapy To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/systemic-therapies/{systemicTherapyId}/medications¶
Get Systemic Therapy Medications Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
systemicTherapyId |
path | string | No |
Responses
[
{
"id": "aee3b26b-3d67-4d0c-937e-90e595b0c54e",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
]
POST /api/v1/systemic-therapies/{systemicTherapyId}/medications¶
Create Systemic Therapy Medication
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
systemicTherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"drug": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Antineoplastic drug/medication administered to the patient",
"title": "Antineoplastic Drug",
"x-terminology": "AntineoplasticAgent"
},
"route": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Drug administration route",
"title": "Route",
"x-terminology": "DosageRoute"
},
"usedOfflabel": {
"description": "Indicates whether a medication was used off-label at the time of administration",
"title": "Off-label use",
"type": "boolean"
},
"withinSoc": {
"description": "Indicates whether a medication was within standard of care (SOC) at the time of administration.",
"title": "Within SOC",
"type": "boolean"
},
"dosageMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage - Mass concentration",
"x-default-unit": "g/l",
"x-measure": "MassConcentration"
},
"dosageMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage - Fixed Mass",
"x-default-unit": "g",
"x-measure": "Mass"
},
"dosageVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage - Volume",
"x-default-unit": "l",
"x-measure": "Volume"
},
"dosageMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage - Mass per body surface",
"x-default-unit": "g/square_meter",
"x-measure": "MassPerArea"
},
"dosageRateMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage rate - Mass concentration",
"x-default-unit": "g/l/s",
"x-measure": "MassConcentrationPerTime"
},
"dosageRateMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage rate - Fixed Mass",
"x-default-unit": "g/s",
"x-measure": "MassPerTime"
},
"dosageRateVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage rate - Volume",
"x-default-unit": "l/s",
"x-measure": "VolumePerTime"
},
"dosageRateMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage rate - Mass per body surface",
"x-default-unit": "g/square_meter/s",
"x-measure": "MassPerAreaPerTime"
}
},
"required": [
"drug"
],
"title": "SystemicTherapyMedicationCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}¶
Get Systemic Therapy Medication By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
medicationId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Responses
{
"id": "e29e2534-74ea-4cd7-b1b7-d1454fc1d334",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"drug": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Antineoplastic drug/medication administered to the patient",
"title": "Antineoplastic Drug",
"x-terminology": "AntineoplasticAgent"
},
"route": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Drug administration route",
"title": "Route",
"x-terminology": "DosageRoute"
},
"usedOfflabel": {
"description": "Indicates whether a medication was used off-label at the time of administration",
"title": "Off-label use",
"type": "boolean"
},
"withinSoc": {
"description": "Indicates whether a medication was within standard of care (SOC) at the time of administration.",
"title": "Within SOC",
"type": "boolean"
},
"dosageMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage - Mass concentration",
"x-default-unit": "g/l",
"x-measure": "MassConcentration"
},
"dosageMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage - Fixed Mass",
"x-default-unit": "g",
"x-measure": "Mass"
},
"dosageVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage - Volume",
"x-default-unit": "l",
"x-measure": "Volume"
},
"dosageMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage - Mass per body surface",
"x-default-unit": "g/square_meter",
"x-measure": "MassPerArea"
},
"dosageRateMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage rate - Mass concentration",
"x-default-unit": "g/l/s",
"x-measure": "MassConcentrationPerTime"
},
"dosageRateMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage rate - Fixed Mass",
"x-default-unit": "g/s",
"x-measure": "MassPerTime"
},
"dosageRateVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage rate - Volume",
"x-default-unit": "l/s",
"x-measure": "VolumePerTime"
},
"dosageRateMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage rate - Mass per body surface",
"x-default-unit": "g/square_meter/s",
"x-measure": "MassPerAreaPerTime"
}
},
"required": [
"id",
"description",
"drug"
],
"title": "SystemicTherapyMedication",
"type": "object"
}
PUT /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}¶
Update Systemic Therapy Medication
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
medicationId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"drug": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"drug": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Antineoplastic drug/medication administered to the patient",
"title": "Antineoplastic Drug",
"x-terminology": "AntineoplasticAgent"
},
"route": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Drug administration route",
"title": "Route",
"x-terminology": "DosageRoute"
},
"usedOfflabel": {
"description": "Indicates whether a medication was used off-label at the time of administration",
"title": "Off-label use",
"type": "boolean"
},
"withinSoc": {
"description": "Indicates whether a medication was within standard of care (SOC) at the time of administration.",
"title": "Within SOC",
"type": "boolean"
},
"dosageMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage - Mass concentration",
"x-default-unit": "g/l",
"x-measure": "MassConcentration"
},
"dosageMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage - Fixed Mass",
"x-default-unit": "g",
"x-measure": "Mass"
},
"dosageVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage - Volume",
"x-default-unit": "l",
"x-measure": "Volume"
},
"dosageMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage - Mass per body surface",
"x-default-unit": "g/square_meter",
"x-measure": "MassPerArea"
},
"dosageRateMassConcentration": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in mass concentration (if revelant/appliccable)",
"title": "Dosage rate - Mass concentration",
"x-default-unit": "g/l/s",
"x-measure": "MassConcentrationPerTime"
},
"dosageRateMass": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable)",
"title": "Dosage rate - Fixed Mass",
"x-default-unit": "g/s",
"x-measure": "MassPerTime"
},
"dosageRateVolume": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a volume (if revelant/appliccable)",
"title": "Dosage rate - Volume",
"x-default-unit": "l/s",
"x-measure": "VolumePerTime"
},
"dosageRateMassSurface": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable)",
"title": "Dosage rate - Mass per body surface",
"x-default-unit": "g/square_meter/s",
"x-measure": "MassPerAreaPerTime"
}
},
"required": [
"drug"
],
"title": "SystemicTherapyMedicationCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}¶
Delete Systemic Therapy Medication
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
medicationId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Responses
GET /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}/history/events¶
Get All Systemic Therapy Medication History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
medicationId |
path | string | No | ||
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
systemicTherapyId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}/history/events/{eventId}¶
Get Systemic Therapy Medication History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
medicationId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}/history/events/{eventId}/reversion¶
Revert Systemic Therapy Medication To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
medicationId |
path | string | No | ||
systemicTherapyId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Surgeries¶
GET /api/v1/surgeries¶
Get All Surgeries Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
bodysite |
query | string | No | Anatomical location - Filter for a matching concept code | |
bodysite.anyOf |
query | array | No | Anatomical location - Filter for a matching set of concept codes | |
bodysite.descendantsOf |
query | string | No | Anatomical location - Filter for all child concepts of a given concepts code | |
bodysite.exists |
query | boolean | No | Anatomical location - Filter for entries with a value | |
bodysite.not |
query | string | No | Anatomical location - Filter for a mismatching concept code | |
bodysite.not.anyOf |
query | array | No | Anatomical location - Filter for a mismmatching set of concept codes | |
bodysite.not.exists |
query | boolean | No | Anatomical location - Filter for entries without a value | |
bodysiteLaterality |
query | string | No | Anatomical location laterality - Filter for a matching concept code | |
bodysiteLaterality.anyOf |
query | array | No | Anatomical location laterality - Filter for a matching set of concept codes | |
bodysiteLaterality.descendantsOf |
query | string | No | Anatomical location laterality - Filter for all child concepts of a given concepts code | |
bodysiteLaterality.exists |
query | boolean | No | Anatomical location laterality - Filter for entries with a value | |
bodysiteLaterality.not |
query | string | No | Anatomical location laterality - Filter for a mismatching concept code | |
bodysiteLaterality.not.anyOf |
query | array | No | Anatomical location laterality - Filter for a mismmatching set of concept codes | |
bodysiteLaterality.not.exists |
query | boolean | No | Anatomical location laterality - Filter for entries without a value | |
bodysiteQualifier |
query | string | No | Anatomical location qualifier - Filter for a matching concept code | |
bodysiteQualifier.anyOf |
query | array | No | Anatomical location qualifier - Filter for a matching set of concept codes | |
bodysiteQualifier.descendantsOf |
query | string | No | Anatomical location qualifier - Filter for all child concepts of a given concepts code | |
bodysiteQualifier.exists |
query | boolean | No | Anatomical location qualifier - Filter for entries with a value | |
bodysiteQualifier.not |
query | string | No | Anatomical location qualifier - Filter for a mismatching concept code | |
bodysiteQualifier.not.anyOf |
query | array | No | Anatomical location qualifier - Filter for a mismmatching set of concept codes | |
bodysiteQualifier.not.exists |
query | boolean | No | Anatomical location qualifier - Filter for entries without a value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
intent |
query | No | Intent - Filter for single value choice | ||
intent.anyOf |
query | array | No | Intent - ('Filter for excluding a subset of value choices',) | |
intent.not |
query | No | Intent - ('Filter for all but a single value choice',) | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
outcome |
query | string | No | Outcome - Filter for a matching concept code | |
outcome.anyOf |
query | array | No | Outcome - Filter for a matching set of concept codes | |
outcome.descendantsOf |
query | string | No | Outcome - Filter for all child concepts of a given concepts code | |
outcome.exists |
query | boolean | No | Outcome - Filter for entries with a value | |
outcome.not |
query | string | No | Outcome - Filter for a mismatching concept code | |
outcome.not.anyOf |
query | array | No | Outcome - Filter for a mismmatching set of concept codes | |
outcome.not.exists |
query | boolean | No | Outcome - Filter for entries without a value | |
procedure |
query | string | No | Surgical procedure - Filter for a matching concept code | |
procedure.anyOf |
query | array | No | Surgical procedure - Filter for a matching set of concept codes | |
procedure.descendantsOf |
query | string | No | Surgical procedure - Filter for all child concepts of a given concepts code | |
procedure.not |
query | string | No | Surgical procedure - Filter for a mismatching concept code | |
procedure.not.anyOf |
query | array | No | Surgical procedure - Filter for a mismmatching set of concept codes | |
targetedEntitiesIds |
query | string | No | Targeted neoplastic entities - Filter for full text matches | |
targetedEntitiesIds.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference matches the query | |
targetedEntitiesIds.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries starting with the text | |
targetedEntitiesIds.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text matches | |
targetedEntitiesIds.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries ending with the text | |
targetedEntitiesIds.exists |
query | boolean | No | Targeted neoplastic entities - Filter for entries with a value | |
targetedEntitiesIds.not |
query | string | No | Targeted neoplastic entities - Filter for full text mismatches | |
targetedEntitiesIds.not.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query | |
targetedEntitiesIds.not.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not starting with the text | |
targetedEntitiesIds.not.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text mismatches | |
targetedEntitiesIds.not.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not ending with the text | |
targetedEntitiesIds.not.exists |
query | boolean | No | Targeted neoplastic entities - Filter for entries without a value | |
therapyLineId |
query | string | No | Therapy line - Filter for reference matches | |
therapyLineId.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference matches the query | |
therapyLineId.beginsWith |
query | string | No | Therapy line - Filter for entries starting with the text | |
therapyLineId.contains |
query | string | No | Therapy line - Filter for partial text matches | |
therapyLineId.endsWith |
query | string | No | Therapy line - Filter for entries ending with the text | |
therapyLineId.exists |
query | boolean | No | Therapy line - Filter for entries with a value | |
therapyLineId.not |
query | string | No | Therapy line - Filter for reference mismatches | |
therapyLineId.not.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference mismatches the query | |
therapyLineId.not.beginsWith |
query | string | No | Therapy line - Filter for entries not starting with the text | |
therapyLineId.not.contains |
query | string | No | Therapy line - Filter for partial text mismatches | |
therapyLineId.not.endsWith |
query | string | No | Therapy line - Filter for entries not ending with the text | |
therapyLineId.not.exists |
query | boolean | No | Therapy line - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "7bd9d0d7-1ffb-48a2-a6d5-9acb47990938",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "56af2b5b-2441-45f3-89ac-2a4ea88a05c7",
"date": "2022-04-13",
"procedure": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "04c311b0-4def-4b86-9582-cb6ea392f87c",
"targetedEntitiesIds": [
"feeadc71-f272-4eb5-bd9c-8b53db6e9b05"
]
}
]
}
POST /api/v1/surgeries¶
Create Surgery
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c2c4e5df-e952-40bb-88ee-29cadbb4aecd",
"date": "2022-04-13",
"procedure": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "3dc48caf-4da7-4348-9e0a-826c6243768c",
"targetedEntitiesIds": [
"2fa36373-6487-4832-a1f2-f54e3051cba7"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who received the surgical procedure",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date of the surgical procedure.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"procedure": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The specific surgical procedure that was performed",
"title": "Surgical procedure",
"x-terminology": "SurgicalProcedure"
},
"intent": {
"$ref": "#/components/schemas/SurgeryIntentChoices",
"description": "Therapeutic intent of the surgery",
"title": "Intent"
},
"bodysite": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Anatomical location of the surgery",
"title": "Anatomical location",
"x-terminology": "CancerTopography"
},
"bodysiteQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the surgery",
"title": "Anatomical location qualifier",
"x-terminology": "BodyLocationQualifier"
},
"bodysiteLaterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality for the anatomical location of the surgery",
"title": "Anatomical location laterality",
"x-terminology": "LateralityQualifier"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The outcome of the surgery",
"title": "Outcome",
"x-terminology": "ProcedureOutcome"
},
"therapyLineId": {
"description": "Therapy line to which the surgery is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string"
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the surgery",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array"
}
},
"required": [
"caseId",
"date",
"procedure",
"intent"
],
"title": "SurgeryCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/surgeries/{surgeryId}¶
Get Surgery By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
surgeryId |
path | string | No |
Responses
{
"anonymized": true,
"id": "60b9d66b-0297-4706-b31e-25bd8e299f2f",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ca763ac6-8444-45d8-9355-71b800b77c48",
"date": "2022-04-13",
"procedure": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "1f0b1ade-cc7c-482e-b2b5-b74dc96c2ed2",
"targetedEntitiesIds": [
"c9e06075-d3d2-499a-9c8b-384e1fb04d57"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who received the surgical procedure",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date of the surgical procedure.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"procedure": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The specific surgical procedure that was performed",
"title": "Surgical procedure",
"x-terminology": "SurgicalProcedure"
},
"intent": {
"$ref": "#/components/schemas/SurgeryIntentChoices",
"description": "Therapeutic intent of the surgery",
"title": "Intent"
},
"bodysite": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Anatomical location of the surgery",
"title": "Anatomical location",
"x-terminology": "CancerTopography"
},
"bodysiteQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the surgery",
"title": "Anatomical location qualifier",
"x-terminology": "BodyLocationQualifier"
},
"bodysiteLaterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality for the anatomical location of the surgery",
"title": "Anatomical location laterality",
"x-terminology": "LateralityQualifier"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The outcome of the surgery",
"title": "Outcome",
"x-terminology": "ProcedureOutcome"
},
"therapyLineId": {
"description": "Therapy line to which the surgery is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string"
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the surgery",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array"
}
},
"required": [
"id",
"description",
"caseId",
"date",
"procedure",
"intent"
],
"title": "Surgery",
"type": "object"
}
PUT /api/v1/surgeries/{surgeryId}¶
Update Surgery
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
surgeryId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e23f28d0-17f5-4b58-b607-6326a1e1956e",
"date": "2022-04-13",
"procedure": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"intent": "curative",
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "5ad19261-e20e-45ed-8d8f-5b4a52cb318f",
"targetedEntitiesIds": [
"90e67fb2-ba8e-4074-821d-c1e5ddc2c16d"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who received the surgical procedure",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date of the surgical procedure.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"procedure": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The specific surgical procedure that was performed",
"title": "Surgical procedure",
"x-terminology": "SurgicalProcedure"
},
"intent": {
"$ref": "#/components/schemas/SurgeryIntentChoices",
"description": "Therapeutic intent of the surgery",
"title": "Intent"
},
"bodysite": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Anatomical location of the surgery",
"title": "Anatomical location",
"x-terminology": "CancerTopography"
},
"bodysiteQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the surgery",
"title": "Anatomical location qualifier",
"x-terminology": "BodyLocationQualifier"
},
"bodysiteLaterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Laterality for the anatomical location of the surgery",
"title": "Anatomical location laterality",
"x-terminology": "LateralityQualifier"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The outcome of the surgery",
"title": "Outcome",
"x-terminology": "ProcedureOutcome"
},
"therapyLineId": {
"description": "Therapy line to which the surgery is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string"
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the surgery",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array"
}
},
"required": [
"caseId",
"date",
"procedure",
"intent"
],
"title": "SurgeryCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/surgeries/{surgeryId}¶
Delete Surgery
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
surgeryId |
path | string | No |
Responses
GET /api/v1/surgeries/{surgeryId}/history/events¶
Get All Surgery History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
surgeryId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/surgeries/{surgeryId}/history/events/{eventId}¶
Get Surgery History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
surgeryId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/surgeries/{surgeryId}/history/events/{eventId}/reversion¶
Revert Surgery To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
surgeryId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Radiotherapies¶
GET /api/v1/radiotherapies¶
Get All Radiotherapies Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
dosages.createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
dosages.createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
dosages.createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
dosages.createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
dosages.createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
dosages.createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
dosages.createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
dosages.createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
dosages.createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
dosages.createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
dosages.dose.between |
query | array | No | Total radiation dose - Filter for entries with values between two specified values (inclusive) | |
dosages.dose.equal |
query | number | No | Total radiation dose - Filter for entries with values exactly equal to the specified value | |
dosages.dose.exists |
query | boolean | No | Total radiation dose - Filter for entries with a value | |
dosages.dose.greaterThan |
query | number | No | Total radiation dose - Filter for entries with values greater than the specified value | |
dosages.dose.greaterThanOrEqual |
query | number | No | Total radiation dose - Filter for entries with values greater than or equal to the specified value | |
dosages.dose.lessThan |
query | number | No | Total radiation dose - Filter for entries with values less than the specified value | |
dosages.dose.lessThanOrEqual |
query | number | No | Total radiation dose - Filter for entries with values less than or equal to the specified value | |
dosages.dose.not.between |
query | array | No | Total radiation dose - Filter for entries with values between two specified values (inclusive) | |
dosages.dose.not.equal |
query | number | No | Total radiation dose - Filter for entries with values not equal to the specified value | |
dosages.dose.not.exists |
query | boolean | No | Total radiation dose - Filter for entries without a value | |
dosages.externalSource |
query | string | No | External data source - Filter for full text matches | |
dosages.externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
dosages.externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
dosages.externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
dosages.externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
dosages.externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
dosages.externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
dosages.externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
dosages.externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
dosages.externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
dosages.externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
dosages.externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
dosages.fractions.between |
query | array | No | Total fractions - Filter for entries with values between two specified values (inclusive) | |
dosages.fractions.equal |
query | integer | No | Total fractions - Filter for entries with values exactly equal to the specified value | |
dosages.fractions.exists |
query | boolean | No | Total fractions - Filter for entries with a value | |
dosages.fractions.greaterThan |
query | integer | No | Total fractions - Filter for entries with values greater than the specified value | |
dosages.fractions.greaterThanOrEqual |
query | integer | No | Total fractions - Filter for entries with values greater than or equal to the specified value | |
dosages.fractions.lessThan |
query | integer | No | Total fractions - Filter for entries with values less than the specified value | |
dosages.fractions.lessThanOrEqual |
query | integer | No | Total fractions - Filter for entries with values less than or equal to the specified value | |
dosages.fractions.not.between |
query | array | No | Total fractions - Filter for entries with values between two specified values (inclusive) | |
dosages.fractions.not.equal |
query | integer | No | Total fractions - Filter for entries with values not equal to the specified value | |
dosages.fractions.not.exists |
query | boolean | No | Total fractions - Filter for entries without a value | |
dosages.id |
query | string | No | Id - Filter for full text matches | |
dosages.id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
dosages.id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
dosages.id.contains |
query | string | No | Id - Filter for partial text matches | |
dosages.id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
dosages.id.not |
query | string | No | Id - Filter for full text mismatches | |
dosages.id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
dosages.id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
dosages.id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
dosages.id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
dosages.irradiatedVolume |
query | string | No | Irradiated volume - Filter for a matching concept code | |
dosages.irradiatedVolume.anyOf |
query | array | No | Irradiated volume - Filter for a matching set of concept codes | |
dosages.irradiatedVolume.descendantsOf |
query | string | No | Irradiated volume - Filter for all child concepts of a given concepts code | |
dosages.irradiatedVolume.not |
query | string | No | Irradiated volume - Filter for a mismatching concept code | |
dosages.irradiatedVolume.not.anyOf |
query | array | No | Irradiated volume - Filter for a mismmatching set of concept codes | |
dosages.irradiatedVolumeMorphology |
query | string | No | Irradiated volume morphology - Filter for a matching concept code | |
dosages.irradiatedVolumeMorphology.anyOf |
query | array | No | Irradiated volume morphology - Filter for a matching set of concept codes | |
dosages.irradiatedVolumeMorphology.descendantsOf |
query | string | No | Irradiated volume morphology - Filter for all child concepts of a given concepts code | |
dosages.irradiatedVolumeMorphology.exists |
query | boolean | No | Irradiated volume morphology - Filter for entries with a value | |
dosages.irradiatedVolumeMorphology.not |
query | string | No | Irradiated volume morphology - Filter for a mismatching concept code | |
dosages.irradiatedVolumeMorphology.not.anyOf |
query | array | No | Irradiated volume morphology - Filter for a mismmatching set of concept codes | |
dosages.irradiatedVolumeMorphology.not.exists |
query | boolean | No | Irradiated volume morphology - Filter for entries without a value | |
dosages.irradiatedVolumeQualifier |
query | string | No | Irradiated volume qualifier - Filter for a matching concept code | |
dosages.irradiatedVolumeQualifier.anyOf |
query | array | No | Irradiated volume qualifier - Filter for a matching set of concept codes | |
dosages.irradiatedVolumeQualifier.descendantsOf |
query | string | No | Irradiated volume qualifier - Filter for all child concepts of a given concepts code | |
dosages.irradiatedVolumeQualifier.exists |
query | boolean | No | Irradiated volume qualifier - Filter for entries with a value | |
dosages.irradiatedVolumeQualifier.not |
query | string | No | Irradiated volume qualifier - Filter for a mismatching concept code | |
dosages.irradiatedVolumeQualifier.not.anyOf |
query | array | No | Irradiated volume qualifier - Filter for a mismmatching set of concept codes | |
dosages.irradiatedVolumeQualifier.not.exists |
query | boolean | No | Irradiated volume qualifier - Filter for entries without a value | |
dosages.updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
dosages.updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
dosages.updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
dosages.updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
dosages.updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
dosages.updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
dosages.updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
dosages.updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
dosages.updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
dosages.updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
duration.between |
query | array | No | Duration - Filter for entries with values between two specified values (inclusive) | |
duration.equal |
query | number | No | Duration - Filter for entries with values exactly equal to the specified value | |
duration.greaterThan |
query | number | No | Duration - Filter for entries with values greater than the specified value | |
duration.greaterThanOrEqual |
query | number | No | Duration - Filter for entries with values greater than or equal to the specified value | |
duration.lessThan |
query | number | No | Duration - Filter for entries with values less than the specified value | |
duration.lessThanOrEqual |
query | number | No | Duration - Filter for entries with values less than or equal to the specified value | |
duration.not.between |
query | array | No | Duration - Filter for entries with values between two specified values (inclusive) | |
duration.not.equal |
query | number | No | Duration - Filter for entries with values not equal to the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
intent |
query | No | Intent - Filter for single value choice | ||
intent.anyOf |
query | array | No | Intent - ('Filter for excluding a subset of value choices',) | |
intent.not |
query | No | Intent - ('Filter for all but a single value choice',) | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
period.containedBy |
query | array | No | Treatment period - Filter for entries whose period are contined by the time period | |
period.contains |
query | array | No | Treatment period - Filter for entries containing the time period | |
period.not.containedBy |
query | array | No | Treatment period - Filter for entries whose period are not contined by the time period | |
period.not.contains |
query | array | No | Treatment period - Filter for entries not containing the time period | |
period.not.overlaps |
query | array | No | Treatment period - Filter for entries not overlapping with the time period | |
period.overlaps |
query | array | No | Treatment period - Filter for entries overlapping with the time period | |
sessions.between |
query | array | No | Total sessions - Filter for entries with values between two specified values (inclusive) | |
sessions.equal |
query | integer | No | Total sessions - Filter for entries with values exactly equal to the specified value | |
sessions.greaterThan |
query | integer | No | Total sessions - Filter for entries with values greater than the specified value | |
sessions.greaterThanOrEqual |
query | integer | No | Total sessions - Filter for entries with values greater than or equal to the specified value | |
sessions.lessThan |
query | integer | No | Total sessions - Filter for entries with values less than the specified value | |
sessions.lessThanOrEqual |
query | integer | No | Total sessions - Filter for entries with values less than or equal to the specified value | |
sessions.not.between |
query | array | No | Total sessions - Filter for entries with values between two specified values (inclusive) | |
sessions.not.equal |
query | integer | No | Total sessions - Filter for entries with values not equal to the specified value | |
settings.createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
settings.createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
settings.createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
settings.createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
settings.createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
settings.createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
settings.createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
settings.createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
settings.createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
settings.createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
settings.externalSource |
query | string | No | External data source - Filter for full text matches | |
settings.externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
settings.externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
settings.externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
settings.externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
settings.externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
settings.externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
settings.externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
settings.externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
settings.externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
settings.externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
settings.externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
settings.id |
query | string | No | Id - Filter for full text matches | |
settings.id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
settings.id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
settings.id.contains |
query | string | No | Id - Filter for partial text matches | |
settings.id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
settings.id.not |
query | string | No | Id - Filter for full text mismatches | |
settings.id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
settings.id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
settings.id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
settings.id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
settings.modality |
query | string | No | Modality - Filter for a matching concept code | |
settings.modality.anyOf |
query | array | No | Modality - Filter for a matching set of concept codes | |
settings.modality.descendantsOf |
query | string | No | Modality - Filter for all child concepts of a given concepts code | |
settings.modality.not |
query | string | No | Modality - Filter for a mismatching concept code | |
settings.modality.not.anyOf |
query | array | No | Modality - Filter for a mismmatching set of concept codes | |
settings.technique |
query | string | No | Technique - Filter for a matching concept code | |
settings.technique.anyOf |
query | array | No | Technique - Filter for a matching set of concept codes | |
settings.technique.descendantsOf |
query | string | No | Technique - Filter for all child concepts of a given concepts code | |
settings.technique.not |
query | string | No | Technique - Filter for a mismatching concept code | |
settings.technique.not.anyOf |
query | array | No | Technique - Filter for a mismmatching set of concept codes | |
settings.updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
settings.updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
settings.updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
settings.updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
settings.updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
settings.updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
settings.updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
settings.updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
settings.updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
settings.updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
targetedEntitiesIds |
query | string | No | Targeted neoplastic entities - Filter for full text matches | |
targetedEntitiesIds.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference matches the query | |
targetedEntitiesIds.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries starting with the text | |
targetedEntitiesIds.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text matches | |
targetedEntitiesIds.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries ending with the text | |
targetedEntitiesIds.exists |
query | boolean | No | Targeted neoplastic entities - Filter for entries with a value | |
targetedEntitiesIds.not |
query | string | No | Targeted neoplastic entities - Filter for full text mismatches | |
targetedEntitiesIds.not.anyOf |
query | array | No | Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query | |
targetedEntitiesIds.not.beginsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not starting with the text | |
targetedEntitiesIds.not.contains |
query | string | No | Targeted neoplastic entities - Filter for partial text mismatches | |
targetedEntitiesIds.not.endsWith |
query | string | No | Targeted neoplastic entities - Filter for entries not ending with the text | |
targetedEntitiesIds.not.exists |
query | boolean | No | Targeted neoplastic entities - Filter for entries without a value | |
terminationReason |
query | string | No | Termination reason - Filter for a matching concept code | |
terminationReason.anyOf |
query | array | No | Termination reason - Filter for a matching set of concept codes | |
terminationReason.descendantsOf |
query | string | No | Termination reason - Filter for all child concepts of a given concepts code | |
terminationReason.exists |
query | boolean | No | Termination reason - Filter for entries with a value | |
terminationReason.not |
query | string | No | Termination reason - Filter for a mismatching concept code | |
terminationReason.not.anyOf |
query | array | No | Termination reason - Filter for a mismmatching set of concept codes | |
terminationReason.not.exists |
query | boolean | No | Termination reason - Filter for entries without a value | |
therapyLineId |
query | string | No | Therapy line - Filter for reference matches | |
therapyLineId.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference matches the query | |
therapyLineId.beginsWith |
query | string | No | Therapy line - Filter for entries starting with the text | |
therapyLineId.contains |
query | string | No | Therapy line - Filter for partial text matches | |
therapyLineId.endsWith |
query | string | No | Therapy line - Filter for entries ending with the text | |
therapyLineId.exists |
query | boolean | No | Therapy line - Filter for entries with a value | |
therapyLineId.not |
query | string | No | Therapy line - Filter for reference mismatches | |
therapyLineId.not.anyOf |
query | array | No | Therapy line - Filter for entries where at least one reference mismatches the query | |
therapyLineId.not.beginsWith |
query | string | No | Therapy line - Filter for entries not starting with the text | |
therapyLineId.not.contains |
query | string | No | Therapy line - Filter for partial text mismatches | |
therapyLineId.not.endsWith |
query | string | No | Therapy line - Filter for entries not ending with the text | |
therapyLineId.not.exists |
query | boolean | No | Therapy line - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "18fb13d4-b4d9-41a4-826f-79601f2cee1f",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "3e1b50c9-f572-425e-9d28-fbf567e55a3d",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "4b26c49d-1c8b-4109-b179-f0d497afd9ff",
"targetedEntitiesIds": [
"6479694a-76bb-4dc9-bd63-5566b12529f2"
],
"duration": {
"value": 10.12,
"unit": "string"
},
"dosages": [
{
"id": "56a582cd-a36f-42b8-bea2-463c78aabdec",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
],
"settings": [
{
"id": "1610b49b-cafb-48f2-8447-8e2c662caaf6",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null
}
]
}
]
}
POST /api/v1/radiotherapies¶
Create Radiotherapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "a944cac9-57bf-4d02-99ff-393dc186037a",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "47da19d1-a8b3-44e1-8c4b-483fd697cbb4",
"targetedEntitiesIds": [
"8ca6149a-5027-47a8-8960-e873b9320ce5"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who received the radiotherapy",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the radiotherapy was administered to the patient.",
"title": "Treatment period"
},
"sessions": {
"description": "The total number of radiotherapy sessions over the treatment period.",
"title": "Total sessions",
"type": "integer"
},
"intent": {
"$ref": "#/components/schemas/RadiotherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"title": "Intent"
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the radiotherapy",
"title": "Termination reason",
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the radiotherapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string"
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the radiotherapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array"
}
},
"required": [
"caseId",
"period",
"sessions",
"intent"
],
"title": "RadiotherapyCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/radiotherapies/{radiotherapyId}¶
Get Radiotherapy By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
radiotherapyId |
path | string | No |
Responses
{
"anonymized": true,
"id": "5868d666-594a-4607-ada9-770acd197c48",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f501a5b6-423e-441d-a795-05268daa9ba4",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "bc9cfbd5-1003-41bd-ad72-4d370531becf",
"targetedEntitiesIds": [
"5a9ac80d-5f8e-4e6e-9ffd-8107d91aee93"
],
"duration": {
"value": 10.12,
"unit": "string"
},
"dosages": [
{
"id": "eaf70650-cc2b-4e04-b47f-2870cd7be820",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
],
"settings": [
{
"id": "db2d7dc6-3b68-4fd3-924e-a00ab8061051",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null
}
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who received the radiotherapy",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the radiotherapy was administered to the patient.",
"title": "Treatment period"
},
"sessions": {
"description": "The total number of radiotherapy sessions over the treatment period.",
"title": "Total sessions",
"type": "integer"
},
"intent": {
"$ref": "#/components/schemas/RadiotherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"title": "Intent"
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the radiotherapy",
"title": "Termination reason",
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the radiotherapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string"
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the radiotherapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array"
},
"duration": {
"$ref": "#/components/schemas/Measure",
"description": "Duration of treatment",
"title": "Duration",
"x-measure": "Time"
},
"dosages": {
"description": "Radiation doses administered during the radiotherapy",
"items": {
"$ref": "#/components/schemas/RadiotherapyDosage"
},
"title": "Dosages",
"type": "array"
},
"settings": {
"description": "Settings of the radiotherapy irradiation procedure",
"items": {
"$ref": "#/components/schemas/RadiotherapySetting"
},
"title": "Settings",
"type": "array"
}
},
"required": [
"id",
"description",
"caseId",
"period",
"sessions",
"intent",
"duration",
"dosages",
"settings"
],
"title": "Radiotherapy",
"type": "object"
}
DELETE /api/v1/radiotherapies/{radiotherapyId}¶
Delete Radiotherapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Responses
PUT /api/v1/radiotherapies/{radiotherapyId}¶
Update Radiotherapy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2291e58b-1f61-41a1-932b-d0080ab4b41b",
"period": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sessions": 0,
"intent": "curative",
"terminationReason": null,
"therapyLineId": "edfb28d9-430e-44ae-8040-22a488c953c8",
"targetedEntitiesIds": [
"31050bce-41f5-4ccd-abf9-271c4f56edf4"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who received the radiotherapy",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Clinically-relevant period during which the radiotherapy was administered to the patient.",
"title": "Treatment period"
},
"sessions": {
"description": "The total number of radiotherapy sessions over the treatment period.",
"title": "Total sessions",
"type": "integer"
},
"intent": {
"$ref": "#/components/schemas/RadiotherapyIntentChoices",
"description": "Treatment intent of the system therapy",
"title": "Intent"
},
"terminationReason": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Explanation for the premature or planned termination of the radiotherapy",
"title": "Termination reason",
"x-terminology": "TreatmentTerminationReason"
},
"therapyLineId": {
"description": "Therapy line to which the radiotherapy is assigned to",
"format": "uuid",
"title": "Therapy line",
"type": "string"
},
"targetedEntitiesIds": {
"description": "References to the neoplastic entities that were targeted by the radiotherapy",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Targeted neoplastic entities",
"type": "array"
}
},
"required": [
"caseId",
"period",
"sessions",
"intent"
],
"title": "RadiotherapyCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/radiotherapies/{radiotherapyId}/history/events¶
Get All Radiotherapy History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
radiotherapyId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/radiotherapies/{radiotherapyId}/history/events/{eventId}¶
Get Radiotherapy History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
radiotherapyId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/radiotherapies/{radiotherapyId}/history/events/{eventId}/reversion¶
Revert Radiotherapy To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
radiotherapyId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/radiotherapies/{radiotherapyId}/dosages¶
Get Radiotherapy Dosages Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Responses
[
{
"id": "00a698ca-2408-45b9-8e52-0b9dbc95f64f",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
]
POST /api/v1/radiotherapies/{radiotherapyId}/dosages¶
Create Radiotherapy Dosage
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"fractions": {
"description": "The total number of radiotherapy fractions delivered over the treatment period.",
"title": "Total fractions",
"type": "integer"
},
"dose": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Total radiation dose delivered over the full radiotherapy course",
"title": "Total radiation dose",
"x-default-unit": "Gy",
"x-measure": "RadiationDose"
},
"irradiatedVolume": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the irradiated volume",
"title": "Irradiated volume",
"x-terminology": "RadiotherapyTreatmentLocation"
},
"irradiatedVolumeMorphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the anatomical location of the irradiated volume",
"title": "Irradiated volume morphology",
"x-terminology": "RadiotherapyVolumeType"
},
"irradiatedVolumeQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the irradiated volume",
"title": "Irradiated volume qualifier",
"x-terminology": "RadiotherapyTreatmentLocationQualifier"
}
},
"required": [
"irradiatedVolume"
],
"title": "RadiotherapyDosageCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}¶
Get Radiotherapy Dosage By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
radiotherapyId |
path | string | No |
Responses
{
"id": "b340c457-1cd7-4e98-9dbf-12cd631eae9a",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"fractions": {
"description": "The total number of radiotherapy fractions delivered over the treatment period.",
"title": "Total fractions",
"type": "integer"
},
"dose": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Total radiation dose delivered over the full radiotherapy course",
"title": "Total radiation dose",
"x-default-unit": "Gy",
"x-measure": "RadiationDose"
},
"irradiatedVolume": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the irradiated volume",
"title": "Irradiated volume",
"x-terminology": "RadiotherapyTreatmentLocation"
},
"irradiatedVolumeMorphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the anatomical location of the irradiated volume",
"title": "Irradiated volume morphology",
"x-terminology": "RadiotherapyVolumeType"
},
"irradiatedVolumeQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the irradiated volume",
"title": "Irradiated volume qualifier",
"x-terminology": "RadiotherapyTreatmentLocationQualifier"
}
},
"required": [
"id",
"description",
"irradiatedVolume"
],
"title": "RadiotherapyDosage",
"type": "object"
}
PUT /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}¶
Update Radiotherapy Dosage
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
radiotherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"fractions": {
"description": "The total number of radiotherapy fractions delivered over the treatment period.",
"title": "Total fractions",
"type": "integer"
},
"dose": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Total radiation dose delivered over the full radiotherapy course",
"title": "Total radiation dose",
"x-default-unit": "Gy",
"x-measure": "RadiationDose"
},
"irradiatedVolume": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Anatomical location of the irradiated volume",
"title": "Irradiated volume",
"x-terminology": "RadiotherapyTreatmentLocation"
},
"irradiatedVolumeMorphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the anatomical location of the irradiated volume",
"title": "Irradiated volume morphology",
"x-terminology": "RadiotherapyVolumeType"
},
"irradiatedVolumeQualifier": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "General qualifier for the anatomical location of the irradiated volume",
"title": "Irradiated volume qualifier",
"x-terminology": "RadiotherapyTreatmentLocationQualifier"
}
},
"required": [
"irradiatedVolume"
],
"title": "RadiotherapyDosageCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}¶
Delete Radiotherapy Dosage
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
radiotherapyId |
path | string | No |
Responses
GET /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}/history/events¶
Get All Radiotherapy Dosage History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
radiotherapyId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}/history/events/{eventId}¶
Get Radiotherapy Dosage History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
eventId |
path | string | No | ||
radiotherapyId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}/history/events/{eventId}/reversion¶
Revert Radiotherapy Dosage To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
dosageId |
path | string | No | ||
eventId |
path | string | No | ||
radiotherapyId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/radiotherapies/{radiotherapyId}/settings¶
Get Radiotherapy Settings Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Responses
[
{
"id": "08f4f5fc-faad-4b2b-bf9b-6ae58b5eda86",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"modality": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"technique": null
}
]
POST /api/v1/radiotherapies/{radiotherapyId}/settings¶
Create Radiotherapy Setting
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"modality": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"technique": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"modality": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Modality of external beam or brachytherapy radiation procedures",
"title": "Modality",
"x-terminology": "RadiotherapyModality"
},
"technique": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Technique of external beam or brachytherapy radiation procedures",
"title": "Technique",
"x-terminology": "RadiotherapyTechnique"
}
},
"required": [
"modality",
"technique"
],
"title": "RadiotherapySettingCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}¶
Get Radiotherapy Setting By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Responses
{
"id": "03dd68da-ecae-49f1-a7bf-3cf75bd310af",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"modality": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"technique": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"modality": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Modality of external beam or brachytherapy radiation procedures",
"title": "Modality",
"x-terminology": "RadiotherapyModality"
},
"technique": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Technique of external beam or brachytherapy radiation procedures",
"title": "Technique",
"x-terminology": "RadiotherapyTechnique"
}
},
"required": [
"id",
"description",
"modality",
"technique"
],
"title": "RadiotherapySetting",
"type": "object"
}
PUT /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}¶
Update Radiotherapy Setting
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"modality": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"technique": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"modality": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Modality of external beam or brachytherapy radiation procedures",
"title": "Modality",
"x-terminology": "RadiotherapyModality"
},
"technique": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Technique of external beam or brachytherapy radiation procedures",
"title": "Technique",
"x-terminology": "RadiotherapyTechnique"
}
},
"required": [
"modality",
"technique"
],
"title": "RadiotherapySettingCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}¶
Delete Radiotherapy Setting
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Responses
GET /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}/history/events¶
Get All Radiotherapy Setting History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}/history/events/{eventId}¶
Get Radiotherapy Setting History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}/history/events/{eventId}/reversion¶
Revert Radiotherapy Setting To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
radiotherapyId |
path | string | No | ||
settingId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Therapy Lines¶
GET /api/v1/therapy-lines¶
Get All Therapy Lines Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
intent |
query | No | Intent - Filter for single value choice | ||
intent.anyOf |
query | array | No | Intent - ('Filter for excluding a subset of value choices',) | |
intent.not |
query | No | Intent - ('Filter for all but a single value choice',) | ||
label |
query | string | No | Label - Filter for full text matches | |
label.anyOf |
query | array | No | Label - Filter for entries where at least one reference matches the query | |
label.beginsWith |
query | string | No | Label - Filter for entries starting with the text | |
label.contains |
query | string | No | Label - Filter for partial text matches | |
label.endsWith |
query | string | No | Label - Filter for entries ending with the text | |
label.not |
query | string | No | Label - Filter for full text mismatches | |
label.not.anyOf |
query | array | No | Label - Filter for entries where at least one reference mismatches the query | |
label.not.beginsWith |
query | string | No | Label - Filter for entries not starting with the text | |
label.not.contains |
query | string | No | Label - Filter for partial text mismatches | |
label.not.endsWith |
query | string | No | Label - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
ordinal.between |
query | array | No | Line ordinal number - Filter for entries with values between two specified values (inclusive) | |
ordinal.equal |
query | integer | No | Line ordinal number - Filter for entries with values exactly equal to the specified value | |
ordinal.greaterThan |
query | integer | No | Line ordinal number - Filter for entries with values greater than the specified value | |
ordinal.greaterThanOrEqual |
query | integer | No | Line ordinal number - Filter for entries with values greater than or equal to the specified value | |
ordinal.lessThan |
query | integer | No | Line ordinal number - Filter for entries with values less than the specified value | |
ordinal.lessThanOrEqual |
query | integer | No | Line ordinal number - Filter for entries with values less than or equal to the specified value | |
ordinal.not.between |
query | array | No | Line ordinal number - Filter for entries with values between two specified values (inclusive) | |
ordinal.not.equal |
query | integer | No | Line ordinal number - Filter for entries with values not equal to the specified value | |
period.containedBy |
query | array | No | Period - Filter for entries whose period are contined by the time period | |
period.contains |
query | array | No | Period - Filter for entries containing the time period | |
period.exists |
query | boolean | No | Period - Filter for entries with a value | |
period.not.containedBy |
query | array | No | Period - Filter for entries whose period are not contined by the time period | |
period.not.contains |
query | array | No | Period - Filter for entries not containing the time period | |
period.not.exists |
query | boolean | No | Period - Filter for entries without a value | |
period.not.overlaps |
query | array | No | Period - Filter for entries not overlapping with the time period | |
period.overlaps |
query | array | No | Period - Filter for entries overlapping with the time period | |
progressionDate.after |
query | string | No | Begin of progression - Filter for entries with dates after the specified value | |
progressionDate.before |
query | string | No | Begin of progression - Filter for entries with dates before the specified value | |
progressionDate.between |
query | array | No | Begin of progression - Filter for entries with dates between two specified values (inclusive) | |
progressionDate.exists |
query | boolean | No | Begin of progression - Filter for entries with a value | |
progressionDate.not.between |
query | array | No | Begin of progression - Filter for entries with dates not between two specified values (inclusive) | |
progressionDate.not.exists |
query | boolean | No | Begin of progression - Filter for entries without a value | |
progressionDate.not.on |
query | string | No | Begin of progression - Filter for entries with dates not matching the specified value | |
progressionDate.on |
query | string | No | Begin of progression - Filter for entries with dates exactly matching the specified value | |
progressionDate.onOrAfter |
query | string | No | Begin of progression - Filter for entries with dates on or after the specified value | |
progressionDate.onOrBefore |
query | string | No | Begin of progression - Filter for entries with dates on or before the specified value | |
progressionFreeSurvival.between |
query | array | No | Progression-free survival in months - Filter for entries with values between two specified values (inclusive) | |
progressionFreeSurvival.equal |
query | number | No | Progression-free survival in months - Filter for entries with values exactly equal to the specified value | |
progressionFreeSurvival.exists |
query | boolean | No | Progression-free survival in months - Filter for entries with a value | |
progressionFreeSurvival.greaterThan |
query | number | No | Progression-free survival in months - Filter for entries with values greater than the specified value | |
progressionFreeSurvival.greaterThanOrEqual |
query | number | No | Progression-free survival in months - Filter for entries with values greater than or equal to the specified value | |
progressionFreeSurvival.lessThan |
query | number | No | Progression-free survival in months - Filter for entries with values less than the specified value | |
progressionFreeSurvival.lessThanOrEqual |
query | number | No | Progression-free survival in months - Filter for entries with values less than or equal to the specified value | |
progressionFreeSurvival.not.between |
query | array | No | Progression-free survival in months - Filter for entries with values between two specified values (inclusive) | |
progressionFreeSurvival.not.equal |
query | number | No | Progression-free survival in months - Filter for entries with values not equal to the specified value | |
progressionFreeSurvival.not.exists |
query | boolean | No | Progression-free survival in months - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "c598f43b-b630-47e9-816f-eada7fe92516",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2f2933b7-f33e-46df-8915-4980100804b7",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13",
"period": null,
"label": "string",
"progressionFreeSurvival": 10.12
}
]
}
POST /api/v1/therapy-lines¶
Create Therapy Line
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "82a86480-8b17-444c-8d3e-25f048b2e04d",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient to whom this therapy line is associated",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"ordinal": {
"description": "Number indicating the sequence in which this block of treatments were administered to the patient",
"title": "Line ordinal number",
"type": "integer"
},
"intent": {
"$ref": "#/components/schemas/TherapyLineIntentChoices",
"description": "Treatment intent of the system therapy",
"title": "Intent"
},
"progressionDate": {
"description": "Date at which progression was first detected, if applicable",
"format": "date",
"title": "Begin of progression",
"type": "string"
}
},
"required": [
"caseId",
"ordinal",
"intent"
],
"title": "TherapyLineCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/therapy-lines/{therapyLineId}¶
Get Therapy Line By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
therapyLineId |
path | string | No |
Responses
{
"anonymized": true,
"id": "e6447e6e-7e73-4263-9817-fd036692145a",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2afcebf7-9efd-4050-9fba-74dd45a95a96",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13",
"period": null,
"label": "string",
"progressionFreeSurvival": 10.12
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient to whom this therapy line is associated",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"ordinal": {
"description": "Number indicating the sequence in which this block of treatments were administered to the patient",
"title": "Line ordinal number",
"type": "integer"
},
"intent": {
"$ref": "#/components/schemas/TherapyLineIntentChoices",
"description": "Treatment intent of the system therapy",
"title": "Intent"
},
"progressionDate": {
"description": "Date at which progression was first detected, if applicable",
"format": "date",
"title": "Begin of progression",
"type": "string"
},
"period": {
"allOf": [
{
"$ref": "#/components/schemas/Period"
}
],
"description": "Time period of the therapy line",
"title": "Period"
},
"label": {
"description": "Label categorizing the therapy line",
"title": "Label",
"type": "string"
},
"progressionFreeSurvival": {
"description": "Progression-free survival (PFS) of the patient for the therapy line",
"title": "Progression-free survival in months",
"type": "number"
}
},
"required": [
"id",
"description",
"caseId",
"ordinal",
"intent",
"label"
],
"title": "TherapyLine",
"type": "object"
}
PUT /api/v1/therapy-lines/{therapyLineId}¶
Update Therapy Line
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
therapyLineId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0e8aacb2-8a98-44c3-9a29-012e465b26c8",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient to whom this therapy line is associated",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"ordinal": {
"description": "Number indicating the sequence in which this block of treatments were administered to the patient",
"title": "Line ordinal number",
"type": "integer"
},
"intent": {
"$ref": "#/components/schemas/TherapyLineIntentChoices",
"description": "Treatment intent of the system therapy",
"title": "Intent"
},
"progressionDate": {
"description": "Date at which progression was first detected, if applicable",
"format": "date",
"title": "Begin of progression",
"type": "string"
}
},
"required": [
"caseId",
"ordinal",
"intent"
],
"title": "TherapyLineCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/therapy-lines/{therapyLineId}¶
Delete Therapy Line
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
therapyLineId |
path | string | No |
Responses
GET /api/v1/therapy-lines/{therapyLineId}/history/events¶
Get All Therapy Line History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
therapyLineId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/therapy-lines/{therapyLineId}/history/events/{eventId}¶
Get Therapy Line History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
therapyLineId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/therapy-lines/{therapyLineId}/history/events/{eventId}/reversion¶
Revert Therapy Line To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
therapyLineId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/therapy-lines/{caseId}/re-assignments¶
Get Reassigned Patient Case Therapy Lines
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
caseId |
path | string | No |
Responses
[
{
"anonymized": true,
"id": "9f1665f2-6025-459c-b115-99dfc9ed1434",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "70d39c05-8926-402a-aad0-b1ea72c2084a",
"ordinal": 0,
"intent": "curative",
"progressionDate": "2022-04-13",
"period": null,
"label": "string",
"progressionFreeSurvival": 10.12
}
]
Adverse Events¶
GET /api/v1/adverse-events¶
Get All Adverse Events Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Event date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Event date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Event date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Event date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Event date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Event date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Event date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Event date - Filter for entries with dates on or before the specified value | |
dateResolved.after |
query | string | No | Date resolved - Filter for entries with dates after the specified value | |
dateResolved.before |
query | string | No | Date resolved - Filter for entries with dates before the specified value | |
dateResolved.between |
query | array | No | Date resolved - Filter for entries with dates between two specified values (inclusive) | |
dateResolved.exists |
query | boolean | No | Date resolved - Filter for entries with a value | |
dateResolved.not.between |
query | array | No | Date resolved - Filter for entries with dates not between two specified values (inclusive) | |
dateResolved.not.exists |
query | boolean | No | Date resolved - Filter for entries without a value | |
dateResolved.not.on |
query | string | No | Date resolved - Filter for entries with dates not matching the specified value | |
dateResolved.on |
query | string | No | Date resolved - Filter for entries with dates exactly matching the specified value | |
dateResolved.onOrAfter |
query | string | No | Date resolved - Filter for entries with dates on or after the specified value | |
dateResolved.onOrBefore |
query | string | No | Date resolved - Filter for entries with dates on or before the specified value | |
event |
query | string | No | Adverse event - Filter for a matching concept code | |
event.anyOf |
query | array | No | Adverse event - Filter for a matching set of concept codes | |
event.descendantsOf |
query | string | No | Adverse event - Filter for all child concepts of a given concepts code | |
event.not |
query | string | No | Adverse event - Filter for a mismatching concept code | |
event.not.anyOf |
query | array | No | Adverse event - Filter for a mismmatching set of concept codes | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
grade.between |
query | array | No | Grade - Filter for entries with values between two specified values (inclusive) | |
grade.equal |
query | integer | No | Grade - Filter for entries with values exactly equal to the specified value | |
grade.greaterThan |
query | integer | No | Grade - Filter for entries with values greater than the specified value | |
grade.greaterThanOrEqual |
query | integer | No | Grade - Filter for entries with values greater than or equal to the specified value | |
grade.lessThan |
query | integer | No | Grade - Filter for entries with values less than the specified value | |
grade.lessThanOrEqual |
query | integer | No | Grade - Filter for entries with values less than or equal to the specified value | |
grade.not.between |
query | array | No | Grade - Filter for entries with values between two specified values (inclusive) | |
grade.not.equal |
query | integer | No | Grade - Filter for entries with values not equal to the specified value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
mitigations.adjustment |
query | string | No | Treatment Adjustment - Filter for a matching concept code | |
mitigations.adjustment.anyOf |
query | array | No | Treatment Adjustment - Filter for a matching set of concept codes | |
mitigations.adjustment.descendantsOf |
query | string | No | Treatment Adjustment - Filter for all child concepts of a given concepts code | |
mitigations.adjustment.exists |
query | boolean | No | Treatment Adjustment - Filter for entries with a value | |
mitigations.adjustment.not |
query | string | No | Treatment Adjustment - Filter for a mismatching concept code | |
mitigations.adjustment.not.anyOf |
query | array | No | Treatment Adjustment - Filter for a mismmatching set of concept codes | |
mitigations.adjustment.not.exists |
query | boolean | No | Treatment Adjustment - Filter for entries without a value | |
mitigations.category |
query | No | Mitigation category - Filter for single value choice | ||
mitigations.category.anyOf |
query | array | No | Mitigation category - ('Filter for excluding a subset of value choices',) | |
mitigations.category.not |
query | No | Mitigation category - ('Filter for all but a single value choice',) | ||
mitigations.createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
mitigations.createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
mitigations.createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
mitigations.createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
mitigations.createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
mitigations.createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
mitigations.createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
mitigations.createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
mitigations.createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
mitigations.createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
mitigations.drug |
query | string | No | Pharmacological drug - Filter for a matching concept code | |
mitigations.drug.anyOf |
query | array | No | Pharmacological drug - Filter for a matching set of concept codes | |
mitigations.drug.descendantsOf |
query | string | No | Pharmacological drug - Filter for all child concepts of a given concepts code | |
mitigations.drug.exists |
query | boolean | No | Pharmacological drug - Filter for entries with a value | |
mitigations.drug.not |
query | string | No | Pharmacological drug - Filter for a mismatching concept code | |
mitigations.drug.not.anyOf |
query | array | No | Pharmacological drug - Filter for a mismmatching set of concept codes | |
mitigations.drug.not.exists |
query | boolean | No | Pharmacological drug - Filter for entries without a value | |
mitigations.externalSource |
query | string | No | External data source - Filter for full text matches | |
mitigations.externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
mitigations.externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
mitigations.externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
mitigations.externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
mitigations.externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
mitigations.externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
mitigations.externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
mitigations.externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
mitigations.externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
mitigations.externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
mitigations.externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
mitigations.id |
query | string | No | Id - Filter for full text matches | |
mitigations.id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
mitigations.id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
mitigations.id.contains |
query | string | No | Id - Filter for partial text matches | |
mitigations.id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
mitigations.id.not |
query | string | No | Id - Filter for full text mismatches | |
mitigations.id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
mitigations.id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
mitigations.id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
mitigations.id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
mitigations.management |
query | string | No | Management - Filter for a matching concept code | |
mitigations.management.anyOf |
query | array | No | Management - Filter for a matching set of concept codes | |
mitigations.management.descendantsOf |
query | string | No | Management - Filter for all child concepts of a given concepts code | |
mitigations.management.exists |
query | boolean | No | Management - Filter for entries with a value | |
mitigations.management.not |
query | string | No | Management - Filter for a mismatching concept code | |
mitigations.management.not.anyOf |
query | array | No | Management - Filter for a mismmatching set of concept codes | |
mitigations.management.not.exists |
query | boolean | No | Management - Filter for entries without a value | |
mitigations.procedure |
query | string | No | Procedure - Filter for a matching concept code | |
mitigations.procedure.anyOf |
query | array | No | Procedure - Filter for a matching set of concept codes | |
mitigations.procedure.descendantsOf |
query | string | No | Procedure - Filter for all child concepts of a given concepts code | |
mitigations.procedure.exists |
query | boolean | No | Procedure - Filter for entries with a value | |
mitigations.procedure.not |
query | string | No | Procedure - Filter for a mismatching concept code | |
mitigations.procedure.not.anyOf |
query | array | No | Procedure - Filter for a mismmatching set of concept codes | |
mitigations.procedure.not.exists |
query | boolean | No | Procedure - Filter for entries without a value | |
mitigations.updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
mitigations.updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
mitigations.updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
mitigations.updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
mitigations.updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
mitigations.updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
mitigations.updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
mitigations.updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
mitigations.updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
mitigations.updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
outcome |
query | No | Date resolved - Filter for single value choice | ||
outcome.anyOf |
query | array | No | Date resolved - ('Filter for excluding a subset of value choices',) | |
outcome.not |
query | No | Date resolved - ('Filter for all but a single value choice',) | ||
suspectedCauses.causality |
query | No | Causality - Filter for single value choice | ||
suspectedCauses.causality.anyOf |
query | array | No | Causality - ('Filter for excluding a subset of value choices',) | |
suspectedCauses.causality.exists |
query | boolean | No | Causality - Filter for entries with a value | |
suspectedCauses.causality.not |
query | No | Causality - ('Filter for all but a single value choice',) | ||
suspectedCauses.causality.not.exists |
query | boolean | No | Causality - Filter for entries without a value | |
suspectedCauses.createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
suspectedCauses.createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
suspectedCauses.createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
suspectedCauses.createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
suspectedCauses.createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
suspectedCauses.createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
suspectedCauses.createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
suspectedCauses.createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
suspectedCauses.createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
suspectedCauses.createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
suspectedCauses.externalSource |
query | string | No | External data source - Filter for full text matches | |
suspectedCauses.externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
suspectedCauses.externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
suspectedCauses.externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
suspectedCauses.externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
suspectedCauses.externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
suspectedCauses.externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
suspectedCauses.externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
suspectedCauses.externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
suspectedCauses.externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
suspectedCauses.externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
suspectedCauses.id |
query | string | No | Id - Filter for full text matches | |
suspectedCauses.id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
suspectedCauses.id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
suspectedCauses.id.contains |
query | string | No | Id - Filter for partial text matches | |
suspectedCauses.id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
suspectedCauses.id.not |
query | string | No | Id - Filter for full text mismatches | |
suspectedCauses.id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
suspectedCauses.id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
suspectedCauses.id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
suspectedCauses.medicationId |
query | string | No | Suspected systemic therapy medication - Filter for reference matches | |
suspectedCauses.medicationId.anyOf |
query | array | No | Suspected systemic therapy medication - Filter for entries where at least one reference matches the query | |
suspectedCauses.medicationId.beginsWith |
query | string | No | Suspected systemic therapy medication - Filter for entries starting with the text | |
suspectedCauses.medicationId.contains |
query | string | No | Suspected systemic therapy medication - Filter for partial text matches | |
suspectedCauses.medicationId.endsWith |
query | string | No | Suspected systemic therapy medication - Filter for entries ending with the text | |
suspectedCauses.medicationId.exists |
query | boolean | No | Suspected systemic therapy medication - Filter for entries with a value | |
suspectedCauses.medicationId.not |
query | string | No | Suspected systemic therapy medication - Filter for reference mismatches | |
suspectedCauses.medicationId.not.anyOf |
query | array | No | Suspected systemic therapy medication - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.medicationId.not.beginsWith |
query | string | No | Suspected systemic therapy medication - Filter for entries not starting with the text | |
suspectedCauses.medicationId.not.contains |
query | string | No | Suspected systemic therapy medication - Filter for partial text mismatches | |
suspectedCauses.medicationId.not.endsWith |
query | string | No | Suspected systemic therapy medication - Filter for entries not ending with the text | |
suspectedCauses.medicationId.not.exists |
query | boolean | No | Suspected systemic therapy medication - Filter for entries without a value | |
suspectedCauses.radiotherapyId |
query | string | No | Suspected radiotherapy - Filter for reference matches | |
suspectedCauses.radiotherapyId.anyOf |
query | array | No | Suspected radiotherapy - Filter for entries where at least one reference matches the query | |
suspectedCauses.radiotherapyId.beginsWith |
query | string | No | Suspected radiotherapy - Filter for entries starting with the text | |
suspectedCauses.radiotherapyId.contains |
query | string | No | Suspected radiotherapy - Filter for partial text matches | |
suspectedCauses.radiotherapyId.endsWith |
query | string | No | Suspected radiotherapy - Filter for entries ending with the text | |
suspectedCauses.radiotherapyId.exists |
query | boolean | No | Suspected radiotherapy - Filter for entries with a value | |
suspectedCauses.radiotherapyId.not |
query | string | No | Suspected radiotherapy - Filter for reference mismatches | |
suspectedCauses.radiotherapyId.not.anyOf |
query | array | No | Suspected radiotherapy - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.radiotherapyId.not.beginsWith |
query | string | No | Suspected radiotherapy - Filter for entries not starting with the text | |
suspectedCauses.radiotherapyId.not.contains |
query | string | No | Suspected radiotherapy - Filter for partial text mismatches | |
suspectedCauses.radiotherapyId.not.endsWith |
query | string | No | Suspected radiotherapy - Filter for entries not ending with the text | |
suspectedCauses.radiotherapyId.not.exists |
query | boolean | No | Suspected radiotherapy - Filter for entries without a value | |
suspectedCauses.surgeryId |
query | string | No | Suspected surgery - Filter for reference matches | |
suspectedCauses.surgeryId.anyOf |
query | array | No | Suspected surgery - Filter for entries where at least one reference matches the query | |
suspectedCauses.surgeryId.beginsWith |
query | string | No | Suspected surgery - Filter for entries starting with the text | |
suspectedCauses.surgeryId.contains |
query | string | No | Suspected surgery - Filter for partial text matches | |
suspectedCauses.surgeryId.endsWith |
query | string | No | Suspected surgery - Filter for entries ending with the text | |
suspectedCauses.surgeryId.exists |
query | boolean | No | Suspected surgery - Filter for entries with a value | |
suspectedCauses.surgeryId.not |
query | string | No | Suspected surgery - Filter for reference mismatches | |
suspectedCauses.surgeryId.not.anyOf |
query | array | No | Suspected surgery - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.surgeryId.not.beginsWith |
query | string | No | Suspected surgery - Filter for entries not starting with the text | |
suspectedCauses.surgeryId.not.contains |
query | string | No | Suspected surgery - Filter for partial text mismatches | |
suspectedCauses.surgeryId.not.endsWith |
query | string | No | Suspected surgery - Filter for entries not ending with the text | |
suspectedCauses.surgeryId.not.exists |
query | boolean | No | Suspected surgery - Filter for entries without a value | |
suspectedCauses.systemicTherapyId |
query | string | No | Suspected systemic therapy - Filter for reference matches | |
suspectedCauses.systemicTherapyId.anyOf |
query | array | No | Suspected systemic therapy - Filter for entries where at least one reference matches the query | |
suspectedCauses.systemicTherapyId.beginsWith |
query | string | No | Suspected systemic therapy - Filter for entries starting with the text | |
suspectedCauses.systemicTherapyId.contains |
query | string | No | Suspected systemic therapy - Filter for partial text matches | |
suspectedCauses.systemicTherapyId.endsWith |
query | string | No | Suspected systemic therapy - Filter for entries ending with the text | |
suspectedCauses.systemicTherapyId.exists |
query | boolean | No | Suspected systemic therapy - Filter for entries with a value | |
suspectedCauses.systemicTherapyId.not |
query | string | No | Suspected systemic therapy - Filter for reference mismatches | |
suspectedCauses.systemicTherapyId.not.anyOf |
query | array | No | Suspected systemic therapy - Filter for entries where at least one reference mismatches the query | |
suspectedCauses.systemicTherapyId.not.beginsWith |
query | string | No | Suspected systemic therapy - Filter for entries not starting with the text | |
suspectedCauses.systemicTherapyId.not.contains |
query | string | No | Suspected systemic therapy - Filter for partial text mismatches | |
suspectedCauses.systemicTherapyId.not.endsWith |
query | string | No | Suspected systemic therapy - Filter for entries not ending with the text | |
suspectedCauses.systemicTherapyId.not.exists |
query | boolean | No | Suspected systemic therapy - Filter for entries without a value | |
suspectedCauses.updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
suspectedCauses.updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
suspectedCauses.updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
suspectedCauses.updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
suspectedCauses.updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
suspectedCauses.updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
suspectedCauses.updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
suspectedCauses.updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
suspectedCauses.updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
suspectedCauses.updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "da9a15c7-3fb3-4416-8f1f-0a89f173b672",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d6f0a4e4-075a-4538-804b-34ccc665185c",
"date": "2022-04-13",
"event": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13",
"suspectedCauses": [
{
"id": "b1d27309-f274-4721-ba3a-67e9dcbace44",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "01c3f3cd-c39e-47e2-8d4a-48f8ad916cfb",
"medicationId": "9bb39238-5d4e-45bd-8a2c-e0a037657010",
"radiotherapyId": "df90ea33-2ef6-4a81-bfe7-9706dc4380e1",
"surgeryId": "60c3cbc5-e106-4716-9ae6-43a1743e6580",
"causality": null
}
],
"mitigations": [
{
"id": "018b7dbc-d438-4377-9887-d411e496bc02",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
]
}
]
}
POST /api/v1/adverse-events¶
Create Adverse Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "fe4318a8-6389-4f04-9db2-7de0836fe3ab",
"date": "2022-04-13",
"event": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who had the adverse event being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the adverse event ocurred.",
"format": "date",
"title": "Event date",
"type": "string"
},
"event": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Classification of the adverse event using CTCAE criteria",
"title": "Adverse event",
"x-terminology": "AdverseEventTerm"
},
"grade": {
"description": "The grade associated with the severity of an adverse event, using CTCAE criteria.",
"title": "Grade",
"type": "integer"
},
"outcome": {
"$ref": "#/components/schemas/AdverseEventOutcomeChoices",
"description": "The date when the adverse event ended or returned to baseline.",
"title": "Date resolved"
},
"dateResolved": {
"description": "The date when the adverse event ended or returned to baseline.",
"format": "date",
"title": "Date resolved",
"type": "string"
}
},
"required": [
"caseId",
"date",
"event",
"grade",
"outcome"
],
"title": "AdverseEventCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/adverse-events/{adverseEventId}¶
Get Adverse Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
Responses
{
"anonymized": true,
"id": "e469dc7d-c228-417f-912f-874fd14d7b10",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b5413c81-c1ae-4b01-a7f9-6d3f941c8eaf",
"date": "2022-04-13",
"event": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13",
"suspectedCauses": [
{
"id": "8c0cb153-f563-4abd-a958-1023c9360830",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "edebed96-fbb4-489f-a063-ab1ded43e208",
"medicationId": "3bf254e4-4c6e-419e-a2f0-b4a060f6144e",
"radiotherapyId": "f20ce19e-dea5-4b6d-9300-cdccac39f6b8",
"surgeryId": "2492846a-af25-4493-9da5-8f85c098ed12",
"causality": null
}
],
"mitigations": [
{
"id": "ffa166fa-636a-4608-a0cb-ac27069bf5b1",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who had the adverse event being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the adverse event ocurred.",
"format": "date",
"title": "Event date",
"type": "string"
},
"event": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Classification of the adverse event using CTCAE criteria",
"title": "Adverse event",
"x-terminology": "AdverseEventTerm"
},
"grade": {
"description": "The grade associated with the severity of an adverse event, using CTCAE criteria.",
"title": "Grade",
"type": "integer"
},
"outcome": {
"$ref": "#/components/schemas/AdverseEventOutcomeChoices",
"description": "The date when the adverse event ended or returned to baseline.",
"title": "Date resolved"
},
"dateResolved": {
"description": "The date when the adverse event ended or returned to baseline.",
"format": "date",
"title": "Date resolved",
"type": "string"
},
"suspectedCauses": {
"description": "Suspected causes of the adverse event",
"items": {
"$ref": "#/components/schemas/AdverseEventSuspectedCause"
},
"title": "Suspected causes",
"type": "array"
},
"mitigations": {
"description": "Mitigations of the adverse event",
"items": {
"$ref": "#/components/schemas/AdverseEventMitigation"
},
"title": "Mitigations",
"type": "array"
}
},
"required": [
"id",
"description",
"caseId",
"date",
"event",
"grade",
"outcome",
"suspectedCauses",
"mitigations"
],
"title": "AdverseEvent",
"type": "object"
}
DELETE /api/v1/adverse-events/{adverseEventId}¶
Delete Adverse Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Responses
PUT /api/v1/adverse-events/{adverseEventId}¶
Update Adverse Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "3529d372-2098-4ddb-95f2-3c8254078c67",
"date": "2022-04-13",
"event": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"grade": 0,
"outcome": "resolved",
"dateResolved": "2022-04-13"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who had the adverse event being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the adverse event ocurred.",
"format": "date",
"title": "Event date",
"type": "string"
},
"event": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Classification of the adverse event using CTCAE criteria",
"title": "Adverse event",
"x-terminology": "AdverseEventTerm"
},
"grade": {
"description": "The grade associated with the severity of an adverse event, using CTCAE criteria.",
"title": "Grade",
"type": "integer"
},
"outcome": {
"$ref": "#/components/schemas/AdverseEventOutcomeChoices",
"description": "The date when the adverse event ended or returned to baseline.",
"title": "Date resolved"
},
"dateResolved": {
"description": "The date when the adverse event ended or returned to baseline.",
"format": "date",
"title": "Date resolved",
"type": "string"
}
},
"required": [
"caseId",
"date",
"event",
"grade",
"outcome"
],
"title": "AdverseEventCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/adverse-events/{adverseEventId}/history/events¶
Get All Adverse Event History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/adverse-events/{adverseEventId}/history/events/{eventId}¶
Get Adverse Event History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
eventId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/adverse-events/{adverseEventId}/history/events/{eventId}/reversion¶
Revert Adverse Event To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
eventId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/adverse-events/{adverseEventId}/suspected-causes¶
Get Adverse Event Suspected Causes Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Responses
[
{
"id": "ff7f81c7-af08-486b-ad81-4746d158de0c",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "d6edce33-f17b-46a7-afb8-f7cbd61edfa5",
"medicationId": "5540ea55-d33f-4dbf-94b4-7eb0a6fb2155",
"radiotherapyId": "a9970817-7345-447b-ba16-296ac5cbc321",
"surgeryId": "c691e96d-565c-4e1a-9387-5bd7147d1ae6",
"causality": null
}
]
POST /api/v1/adverse-events/{adverseEventId}/suspected-causes¶
Create Adverse Event Suspected Cause
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "00d9c55f-cb32-41d4-bb0a-aa3cfa28a2be",
"medicationId": "c9da3606-488c-4581-9d75-44aeb405fc8f",
"radiotherapyId": "ebd3498e-666f-4ad6-9e99-61aadcf17f60",
"surgeryId": "eaed8b59-b57f-41f8-85d5-ff88e8f24a62",
"causality": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"systemicTherapyId": {
"description": "Systemic therapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy",
"type": "string"
},
"medicationId": {
"description": "Systemic therapy medication suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy medication",
"type": "string"
},
"radiotherapyId": {
"description": "Radiotherapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected radiotherapy",
"type": "string"
},
"surgeryId": {
"description": "Surgery suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected surgery",
"type": "string"
},
"causality": {
"allOf": [
{
"$ref": "#/components/schemas/AdverseEventSuspectedCauseCausalityChoices"
}
],
"description": "Assessment of the potential causality",
"title": "Causality"
}
},
"title": "AdverseEventSuspectedCauseCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}¶
Get Adverse Event Suspected Cause By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No |
Responses
{
"id": "7b3027e7-abdc-4361-8609-251f08fe02ae",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "25d413b2-c274-4947-af77-252c7e001920",
"medicationId": "9f897c25-81e9-44da-afac-76b58b0cb062",
"radiotherapyId": "2698a06b-26aa-4325-b17d-fba01e68a784",
"surgeryId": "a2068304-bc7d-4ef8-a874-78e6baf270cc",
"causality": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"systemicTherapyId": {
"description": "Systemic therapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy",
"type": "string"
},
"medicationId": {
"description": "Systemic therapy medication suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy medication",
"type": "string"
},
"radiotherapyId": {
"description": "Radiotherapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected radiotherapy",
"type": "string"
},
"surgeryId": {
"description": "Surgery suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected surgery",
"type": "string"
},
"causality": {
"allOf": [
{
"$ref": "#/components/schemas/AdverseEventSuspectedCauseCausalityChoices"
}
],
"description": "Assessment of the potential causality",
"title": "Causality"
}
},
"required": [
"id",
"description"
],
"title": "AdverseEventSuspectedCause",
"type": "object"
}
PUT /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}¶
Update Adverse Event Suspected Cause
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "9f52df7a-2517-4ede-8731-ed32237967ef",
"medicationId": "0541a666-b591-4b69-b166-ae16c56c8b48",
"radiotherapyId": "68b2e52f-335f-49e9-b2ea-f88eb0e9adcb",
"surgeryId": "6aac3f6e-448a-4b6f-b263-96ef88527109",
"causality": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"systemicTherapyId": {
"description": "Systemic therapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy",
"type": "string"
},
"medicationId": {
"description": "Systemic therapy medication suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected systemic therapy medication",
"type": "string"
},
"radiotherapyId": {
"description": "Radiotherapy suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected radiotherapy",
"type": "string"
},
"surgeryId": {
"description": "Surgery suspected to be the cause of the adverse event",
"format": "uuid",
"title": "Suspected surgery",
"type": "string"
},
"causality": {
"allOf": [
{
"$ref": "#/components/schemas/AdverseEventSuspectedCauseCausalityChoices"
}
],
"description": "Assessment of the potential causality",
"title": "Causality"
}
},
"title": "AdverseEventSuspectedCauseCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}¶
Delete Adverse Event Suspected Cause
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No |
Responses
GET /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}/history/events¶
Get All Adverse Event Suspected Cause History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}/history/events/{eventId}¶
Get Adverse Event Suspected Cause History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No | ||
eventId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}/history/events/{eventId}/reversion¶
Revert Adverse Event Suspected Cause To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
causeId |
path | string | No | ||
eventId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/adverse-events/{adverseEventId}/mitigations¶
Get Adverse Event Mitigations Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Responses
[
{
"id": "445a6124-e0cd-4981-9544-b906242185f4",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
]
POST /api/v1/adverse-events/{adverseEventId}/mitigations¶
Create Adverse Event Mitigation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"category": {
"$ref": "#/components/schemas/AdverseEventMitigationCategoryChoices",
"description": "Type of mitigation employed",
"title": "Mitigation category"
},
"adjustment": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable)",
"title": "Treatment Adjustment",
"x-terminology": "AdverseEventMitigationTreatmentAdjustment"
},
"drug": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the pharmacological treatment used to mitigate the adverse event (if applicable)",
"title": "Pharmacological drug",
"x-terminology": "AdverseEventMitigationDrug"
},
"procedure": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable)",
"title": "Procedure",
"x-terminology": "AdverseEventMitigationProcedure"
},
"management": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Management type of the adverse event mitigation",
"title": "Management",
"x-terminology": "AdverseEventMitigationManagement"
}
},
"required": [
"category"
],
"title": "AdverseEventMitigationCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}¶
Get Adverse Event Mitigation By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
mitigationId |
path | string | No |
Responses
{
"id": "d56b5d56-19d8-42df-a630-92ef2d459fb2",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"category": {
"$ref": "#/components/schemas/AdverseEventMitigationCategoryChoices",
"description": "Type of mitigation employed",
"title": "Mitigation category"
},
"adjustment": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable)",
"title": "Treatment Adjustment",
"x-terminology": "AdverseEventMitigationTreatmentAdjustment"
},
"drug": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the pharmacological treatment used to mitigate the adverse event (if applicable)",
"title": "Pharmacological drug",
"x-terminology": "AdverseEventMitigationDrug"
},
"procedure": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable)",
"title": "Procedure",
"x-terminology": "AdverseEventMitigationProcedure"
},
"management": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Management type of the adverse event mitigation",
"title": "Management",
"x-terminology": "AdverseEventMitigationManagement"
}
},
"required": [
"id",
"description",
"category"
],
"title": "AdverseEventMitigation",
"type": "object"
}
PUT /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}¶
Update Adverse Event Mitigation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
mitigationId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"category": "adjustment",
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"category": {
"$ref": "#/components/schemas/AdverseEventMitigationCategoryChoices",
"description": "Type of mitigation employed",
"title": "Mitigation category"
},
"adjustment": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable)",
"title": "Treatment Adjustment",
"x-terminology": "AdverseEventMitigationTreatmentAdjustment"
},
"drug": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the pharmacological treatment used to mitigate the adverse event (if applicable)",
"title": "Pharmacological drug",
"x-terminology": "AdverseEventMitigationDrug"
},
"procedure": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable)",
"title": "Procedure",
"x-terminology": "AdverseEventMitigationProcedure"
},
"management": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Management type of the adverse event mitigation",
"title": "Management",
"x-terminology": "AdverseEventMitigationManagement"
}
},
"required": [
"category"
],
"title": "AdverseEventMitigationCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}¶
Delete Adverse Event Mitigation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
mitigationId |
path | string | No |
Responses
GET /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}/history/events¶
Get All Adverse Event Mitigation History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
limit |
query | integer | 10 | No | |
mitigationId |
path | string | No | ||
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}/history/events/{eventId}¶
Get Adverse Event Mitigation History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
eventId |
path | string | No | ||
mitigationId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}/history/events/{eventId}/reversion¶
Revert Adverse Event Mitigation To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
adverseEventId |
path | string | No | ||
eventId |
path | string | No | ||
mitigationId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Treatment Responses¶
GET /api/v1/treatment-responses¶
Get All Treatment Responses Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
assessedBodysites |
query | string | No | Assessed anatomical location - Filter for a matching concept code | |
assessedBodysites.allOf |
query | array | No | Assessed anatomical location - Filter for entries matching all of the concepts | |
assessedBodysites.anyOf |
query | array | No | Assessed anatomical location - Filter for a matching set of concept codes | |
assessedBodysites.descendantsOf |
query | string | No | Assessed anatomical location - Filter for all child concepts of a given concepts code | |
assessedBodysites.exists |
query | boolean | No | Assessed anatomical location - Filter for entries with a value | |
assessedBodysites.not |
query | string | No | Assessed anatomical location - Filter for a mismatching concept code | |
assessedBodysites.not.allOf |
query | array | No | Assessed anatomical location - Filter for entries mismatching all of the concepts | |
assessedBodysites.not.anyOf |
query | array | No | Assessed anatomical location - Filter for a mismmatching set of concept codes | |
assessedBodysites.not.exists |
query | boolean | No | Assessed anatomical location - Filter for entries without a value | |
assessedEntitiesIds |
query | string | No | Assessed neoplastic entities - Filter for full text matches | |
assessedEntitiesIds.anyOf |
query | array | No | Assessed neoplastic entities - Filter for entries where at least one reference matches the query | |
assessedEntitiesIds.beginsWith |
query | string | No | Assessed neoplastic entities - Filter for entries starting with the text | |
assessedEntitiesIds.contains |
query | string | No | Assessed neoplastic entities - Filter for partial text matches | |
assessedEntitiesIds.endsWith |
query | string | No | Assessed neoplastic entities - Filter for entries ending with the text | |
assessedEntitiesIds.exists |
query | boolean | No | Assessed neoplastic entities - Filter for entries with a value | |
assessedEntitiesIds.not |
query | string | No | Assessed neoplastic entities - Filter for full text mismatches | |
assessedEntitiesIds.not.anyOf |
query | array | No | Assessed neoplastic entities - Filter for entries where at least one reference mismatches the query | |
assessedEntitiesIds.not.beginsWith |
query | string | No | Assessed neoplastic entities - Filter for entries not starting with the text | |
assessedEntitiesIds.not.contains |
query | string | No | Assessed neoplastic entities - Filter for partial text mismatches | |
assessedEntitiesIds.not.endsWith |
query | string | No | Assessed neoplastic entities - Filter for entries not ending with the text | |
assessedEntitiesIds.not.exists |
query | boolean | No | Assessed neoplastic entities - Filter for entries without a value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
methodology |
query | string | No | Assessment method - Filter for a matching concept code | |
methodology.anyOf |
query | array | No | Assessment method - Filter for a matching set of concept codes | |
methodology.descendantsOf |
query | string | No | Assessment method - Filter for all child concepts of a given concepts code | |
methodology.not |
query | string | No | Assessment method - Filter for a mismatching concept code | |
methodology.not.anyOf |
query | array | No | Assessment method - Filter for a mismmatching set of concept codes | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
recist |
query | string | No | RECIST - Filter for a matching concept code | |
recist.anyOf |
query | array | No | RECIST - Filter for a matching set of concept codes | |
recist.descendantsOf |
query | string | No | RECIST - Filter for all child concepts of a given concepts code | |
recist.not |
query | string | No | RECIST - Filter for a mismatching concept code | |
recist.not.anyOf |
query | array | No | RECIST - Filter for a mismmatching set of concept codes | |
recistInterpreted |
query | boolean | No | RECIST Interpreted? - Filter for yes/no statement | |
recistInterpreted.exists |
query | boolean | No | RECIST Interpreted? - Filter for entries with a value | |
recistInterpreted.not.exists |
query | boolean | No | RECIST Interpreted? - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "ca9760da-e730-4b3e-89ba-71d7811e3571",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "6a0b37cd-0619-4913-bc11-34bc6bb33a9a",
"date": "2022-04-13",
"recist": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"f9ad6555-71ac-43fa-bb63-a8174c71473b"
],
"assessedBodysites": null
}
]
}
Schema of the response body
POST /api/v1/treatment-responses¶
Create Treatment Response
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b222376a-f353-475e-89ec-1ca2e4bcf164",
"date": "2022-04-13",
"recist": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"5e4dc4f7-2d1b-468b-a80f-28b4654b5fe7"
],
"assessedBodysites": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's treatment response is asseessed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date of the treatment response assessment",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"recist": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The classification of the treatment response according to RECIST",
"title": "RECIST",
"x-terminology": "CancerTreatmentResponse"
},
"recistInterpreted": {
"description": "Indicates whether the RECIST value was interpreted or taken from the radiology report",
"title": "RECIST Interpreted?",
"type": "boolean"
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Method used to assess and classify the treatment response",
"title": "Assessment method",
"x-terminology": "CancerTreatmentResponseObservationMethod"
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assesed for treatment response",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array"
},
"assessedBodysites": {
"description": "Anatomical location assessed to determine the treatment response",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Assessed anatomical location",
"type": "array",
"x-terminology": "ObservationBodySite"
}
},
"required": [
"caseId",
"date",
"recist",
"methodology"
],
"title": "TreatmentResponseCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/treatment-responses/{treatmentRresponseId}¶
Get Treatment Response By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
treatmentRresponseId |
path | string | No |
Responses
{
"anonymized": true,
"id": "33934a11-ff52-4745-91e6-cde26c29be4d",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "eb909812-68a8-44f2-bdb3-27f347612ab8",
"date": "2022-04-13",
"recist": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"088d296a-2427-40ec-b351-094f62451b49"
],
"assessedBodysites": null
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's treatment response is asseessed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date of the treatment response assessment",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"recist": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The classification of the treatment response according to RECIST",
"title": "RECIST",
"x-terminology": "CancerTreatmentResponse"
},
"recistInterpreted": {
"description": "Indicates whether the RECIST value was interpreted or taken from the radiology report",
"title": "RECIST Interpreted?",
"type": "boolean"
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Method used to assess and classify the treatment response",
"title": "Assessment method",
"x-terminology": "CancerTreatmentResponseObservationMethod"
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assesed for treatment response",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array"
},
"assessedBodysites": {
"description": "Anatomical location assessed to determine the treatment response",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Assessed anatomical location",
"type": "array",
"x-terminology": "ObservationBodySite"
}
},
"required": [
"id",
"description",
"caseId",
"date",
"recist",
"methodology"
],
"title": "TreatmentResponse",
"type": "object"
}
PUT /api/v1/treatment-responses/{treatmentRresponseId}¶
Update Treatment Response
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
treatmentRresponseId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "3076a945-21d9-4088-8bd0-8501f182eceb",
"date": "2022-04-13",
"recist": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"a1ba1da1-8619-458a-9878-6539a1d9d779"
],
"assessedBodysites": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's treatment response is asseessed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date of the treatment response assessment",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"recist": {
"$ref": "#/components/schemas/CodedConcept",
"description": "The classification of the treatment response according to RECIST",
"title": "RECIST",
"x-terminology": "CancerTreatmentResponse"
},
"recistInterpreted": {
"description": "Indicates whether the RECIST value was interpreted or taken from the radiology report",
"title": "RECIST Interpreted?",
"type": "boolean"
},
"methodology": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Method used to assess and classify the treatment response",
"title": "Assessment method",
"x-terminology": "CancerTreatmentResponseObservationMethod"
},
"assessedEntitiesIds": {
"description": "References to the neoplastic entities that were assesed for treatment response",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Assessed neoplastic entities",
"type": "array"
},
"assessedBodysites": {
"description": "Anatomical location assessed to determine the treatment response",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Assessed anatomical location",
"type": "array",
"x-terminology": "ObservationBodySite"
}
},
"required": [
"caseId",
"date",
"recist",
"methodology"
],
"title": "TreatmentResponseCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/treatment-responses/{treatmentRresponseId}¶
Delete Treatment Response
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
treatmentRresponseId |
path | string | No |
Responses
GET /api/v1/treatment-responses/{treatmentRresponseId}/history/events¶
Get All Treatment Response History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
treatmentRresponseId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/treatment-responses/{treatmentRresponseId}/history/events/{eventId}¶
Get Treatment Response History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
treatmentRresponseId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/treatment-responses/{treatmentRresponseId}/history/events/{eventId}/reversion¶
Revert Treatment Response To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
treatmentRresponseId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Tumor Boards¶
GET /api/v1/tumor-boards¶
Get All Tumor Boards Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
recommendations |
query | string | No | Recommendations - Filter for a matching concept code | |
recommendations.allOf |
query | array | No | Recommendations - Filter for entries matching all of the concepts | |
recommendations.anyOf |
query | array | No | Recommendations - Filter for a matching set of concept codes | |
recommendations.descendantsOf |
query | string | No | Recommendations - Filter for all child concepts of a given concepts code | |
recommendations.exists |
query | boolean | No | Recommendations - Filter for entries with a value | |
recommendations.not |
query | string | No | Recommendations - Filter for a mismatching concept code | |
recommendations.not.allOf |
query | array | No | Recommendations - Filter for entries mismatching all of the concepts | |
recommendations.not.anyOf |
query | array | No | Recommendations - Filter for a mismmatching set of concept codes | |
recommendations.not.exists |
query | boolean | No | Recommendations - Filter for entries without a value | |
relatedEntitiesIds |
query | string | No | Related neoplastic entities - Filter for full text matches | |
relatedEntitiesIds.anyOf |
query | array | No | Related neoplastic entities - Filter for entries where at least one reference matches the query | |
relatedEntitiesIds.beginsWith |
query | string | No | Related neoplastic entities - Filter for entries starting with the text | |
relatedEntitiesIds.contains |
query | string | No | Related neoplastic entities - Filter for partial text matches | |
relatedEntitiesIds.endsWith |
query | string | No | Related neoplastic entities - Filter for entries ending with the text | |
relatedEntitiesIds.exists |
query | boolean | No | Related neoplastic entities - Filter for entries with a value | |
relatedEntitiesIds.not |
query | string | No | Related neoplastic entities - Filter for full text mismatches | |
relatedEntitiesIds.not.anyOf |
query | array | No | Related neoplastic entities - Filter for entries where at least one reference mismatches the query | |
relatedEntitiesIds.not.beginsWith |
query | string | No | Related neoplastic entities - Filter for entries not starting with the text | |
relatedEntitiesIds.not.contains |
query | string | No | Related neoplastic entities - Filter for partial text mismatches | |
relatedEntitiesIds.not.endsWith |
query | string | No | Related neoplastic entities - Filter for entries not ending with the text | |
relatedEntitiesIds.not.exists |
query | boolean | No | Related neoplastic entities - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/tumor-boards¶
Create Tumor Board
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/tumor-boards/{tumorBoardId}¶
Get Tumor Board By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
tumorBoardId |
path | string | No |
Responses
PUT /api/v1/tumor-boards/{tumorBoardId}¶
Update Tumor Board
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorBoardId |
path | string | No |
Request body
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/tumor-boards/{tumorBoardId}¶
Delete Tumor Board
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorBoardId |
path | string | No |
Responses
GET /api/v1/tumor-boards/{tumorBoardId}/history/events¶
Get All Tumor Board History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
tumorBoardId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
GET /api/v1/tumor-boards/{tumorBoardId}/history/events/{eventId}¶
Get Tumor Board History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
tumorBoardId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "Schema representing a history event within the system.\n\nAttributes:\n id (Any): The unique identifier of the history event.\n resourceId (Any): The unique identifier of the tracked resource.\n category (HistoryEventCategory): The type of history event.\n timestamp (datetime): Timestamp of the history event.\n user (Nullable[str]): Username of the user that triggered the event, if applicable.\n url (Nullable[str]): Endpoint URL through which the event was triggered, if applicable.\n resource (Nullable[str]): Resource involved in the event, if applicable.\n snapshot (Dict): Data snapshot at the time of the event.\n differential (Nullable[Dict]): Data changes introduced by the event, if applicable.\n context (Nullable[Dict]): Context surrounding the event.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEvent",
"type": "object"
}
PUT /api/v1/tumor-boards/{tumorBoardId}/history/events/{eventId}/reversion¶
Revert Tumor Board To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
tumorBoardId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations¶
Get Molecular Tumor Board Therapeutic Recommendations Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorBoardId |
path | string | No |
Responses
[
{
"id": "ac1811b5-e1f6-4cc5-92f4-dac9cc8dcb21",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"expectedEffect": null,
"clinicalTrial": "string",
"offLabelUse": true,
"withinSoc": true,
"drugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"supportingGenomicVariantsIds": [
"13a2bd43-4dfb-4465-9428-56185ddde8c4"
],
"supportingGenomicSignaturesIds": [
"bb8fb712-8e21-4cb1-8fba-56acede723d2"
],
"supportingTumorMarkersIds": [
"52c577dc-1d70-4187-b4af-34ae7fe2e94a"
]
}
]
POST /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations¶
Create Molecular Tumor Board Therapeutic Recommendation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
tumorBoardId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"expectedEffect": null,
"clinicalTrial": "string",
"offLabelUse": true,
"withinSoc": true,
"drugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"supportingGenomicVariantsIds": [
"fd65d0cd-b38d-4e32-ad7d-642c6442d282"
],
"supportingGenomicSignaturesIds": [
"96bb1aee-fcfa-47ca-97b3-9968dcf7cf16"
],
"supportingTumorMarkersIds": [
"0b284732-ec39-49e8-96f5-2dc4900eb92b"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"expectedEffect": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the expected effect of the drug",
"title": "Expected medication action",
"x-terminology": "ExpectedDrugAction"
},
"clinicalTrial": {
"description": "Clinical trial (NCT-Iddentifier) recommended by the board for enrollment",
"maxLength": 15,
"title": "Recommended clinical trial",
"type": "string"
},
"offLabelUse": {
"description": "Whether the medication(s) recommended were off-label",
"title": "Off-label use",
"type": "boolean"
},
"withinSoc": {
"description": "Whether the medication(s) recommended were within standard of care",
"title": "Within SOC",
"type": "boolean"
},
"drugs": {
"description": "Drugs(s) being recommended",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Drug(s)",
"type": "array",
"x-terminology": "AntineoplasticAgent"
},
"supportingGenomicVariantsIds": {
"description": "Genomic variants that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic variants",
"type": "array"
},
"supportingGenomicSignaturesIds": {
"description": "Genomic signatures that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic signatures",
"type": "array"
},
"supportingTumorMarkersIds": {
"description": "Tumor markers that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting tumor markers",
"type": "array"
}
},
"title": "MolecularTherapeuticRecommendationCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}¶
Get Molecular Tumor Board Therapeutic Recommendation By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Responses
{
"id": "fd9d28cb-4e98-4f8e-a096-c67510fed461",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"expectedEffect": null,
"clinicalTrial": "string",
"offLabelUse": true,
"withinSoc": true,
"drugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"supportingGenomicVariantsIds": [
"ab1f0d3a-9053-475f-9488-b1a4deb9cf7e"
],
"supportingGenomicSignaturesIds": [
"6f5b09cd-4da1-44e6-ab1a-a135df27fce3"
],
"supportingTumorMarkersIds": [
"eec9b3e8-9262-488f-a78c-806d7cc0edaa"
]
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"expectedEffect": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the expected effect of the drug",
"title": "Expected medication action",
"x-terminology": "ExpectedDrugAction"
},
"clinicalTrial": {
"description": "Clinical trial (NCT-Iddentifier) recommended by the board for enrollment",
"maxLength": 15,
"title": "Recommended clinical trial",
"type": "string"
},
"offLabelUse": {
"description": "Whether the medication(s) recommended were off-label",
"title": "Off-label use",
"type": "boolean"
},
"withinSoc": {
"description": "Whether the medication(s) recommended were within standard of care",
"title": "Within SOC",
"type": "boolean"
},
"drugs": {
"description": "Drugs(s) being recommended",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Drug(s)",
"type": "array",
"x-terminology": "AntineoplasticAgent"
},
"supportingGenomicVariantsIds": {
"description": "Genomic variants that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic variants",
"type": "array"
},
"supportingGenomicSignaturesIds": {
"description": "Genomic signatures that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic signatures",
"type": "array"
},
"supportingTumorMarkersIds": {
"description": "Tumor markers that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting tumor markers",
"type": "array"
}
},
"required": [
"id",
"description"
],
"title": "MolecularTherapeuticRecommendation",
"type": "object"
}
PUT /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}¶
Update Molecular Tumor Board Therapeutic Recommendation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"expectedEffect": null,
"clinicalTrial": "string",
"offLabelUse": true,
"withinSoc": true,
"drugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"supportingGenomicVariantsIds": [
"aabd59f7-2c06-4c7d-95ee-d64734859f92"
],
"supportingGenomicSignaturesIds": [
"0e245db9-4e12-4e82-967e-11f67bfbf4cc"
],
"supportingTumorMarkersIds": [
"b21ed1e8-b3d3-4249-828c-ff9507c79ada"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"expectedEffect": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Classification of the expected effect of the drug",
"title": "Expected medication action",
"x-terminology": "ExpectedDrugAction"
},
"clinicalTrial": {
"description": "Clinical trial (NCT-Iddentifier) recommended by the board for enrollment",
"maxLength": 15,
"title": "Recommended clinical trial",
"type": "string"
},
"offLabelUse": {
"description": "Whether the medication(s) recommended were off-label",
"title": "Off-label use",
"type": "boolean"
},
"withinSoc": {
"description": "Whether the medication(s) recommended were within standard of care",
"title": "Within SOC",
"type": "boolean"
},
"drugs": {
"description": "Drugs(s) being recommended",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Drug(s)",
"type": "array",
"x-terminology": "AntineoplasticAgent"
},
"supportingGenomicVariantsIds": {
"description": "Genomic variants that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic variants",
"type": "array"
},
"supportingGenomicSignaturesIds": {
"description": "Genomic signatures that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting genomic signatures",
"type": "array"
},
"supportingTumorMarkersIds": {
"description": "Tumor markers that support the recommendation",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Supporting tumor markers",
"type": "array"
}
},
"title": "MolecularTherapeuticRecommendationCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}¶
Delete Molecular Tumor Board Therapeutic Recommendation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Responses
GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events¶
Get All Molecular Tumor Board Therapeutic History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events/{eventId}¶
Get Molecular Tumor Board Therapeutic History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "Schema representing a history event within the system.\n\nAttributes:\n id (Any): The unique identifier of the history event.\n resourceId (Any): The unique identifier of the tracked resource.\n category (HistoryEventCategory): The type of history event.\n timestamp (datetime): Timestamp of the history event.\n user (Nullable[str]): Username of the user that triggered the event, if applicable.\n url (Nullable[str]): Endpoint URL through which the event was triggered, if applicable.\n resource (Nullable[str]): Resource involved in the event, if applicable.\n snapshot (Dict): Data snapshot at the time of the event.\n differential (Nullable[Dict]): Data changes introduced by the event, if applicable.\n context (Nullable[Dict]): Context surrounding the event.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEvent",
"type": "object"
}
PUT /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events/{eventId}/reversion¶
Revert Molecular Tumor Board Therapeutic To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
recommendationId |
path | string | No | ||
tumorBoardId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Performance Status¶
GET /api/v1/performance-status¶
Get All Performance Status Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
ecogInterpretation |
query | string | No | ECOG Interpreation - Filter for a matching concept code | |
ecogInterpretation.anyOf |
query | array | No | ECOG Interpreation - Filter for a matching set of concept codes | |
ecogInterpretation.descendantsOf |
query | string | No | ECOG Interpreation - Filter for all child concepts of a given concepts code | |
ecogInterpretation.exists |
query | boolean | No | ECOG Interpreation - Filter for entries with a value | |
ecogInterpretation.not |
query | string | No | ECOG Interpreation - Filter for a mismatching concept code | |
ecogInterpretation.not.anyOf |
query | array | No | ECOG Interpreation - Filter for a mismmatching set of concept codes | |
ecogInterpretation.not.exists |
query | boolean | No | ECOG Interpreation - Filter for entries without a value | |
ecogScore.between |
query | array | No | ECOG Score - Filter for entries with values between two specified values (inclusive) | |
ecogScore.equal |
query | integer | No | ECOG Score - Filter for entries with values exactly equal to the specified value | |
ecogScore.exists |
query | boolean | No | ECOG Score - Filter for entries with a value | |
ecogScore.greaterThan |
query | integer | No | ECOG Score - Filter for entries with values greater than the specified value | |
ecogScore.greaterThanOrEqual |
query | integer | No | ECOG Score - Filter for entries with values greater than or equal to the specified value | |
ecogScore.lessThan |
query | integer | No | ECOG Score - Filter for entries with values less than the specified value | |
ecogScore.lessThanOrEqual |
query | integer | No | ECOG Score - Filter for entries with values less than or equal to the specified value | |
ecogScore.not.between |
query | array | No | ECOG Score - Filter for entries with values between two specified values (inclusive) | |
ecogScore.not.equal |
query | integer | No | ECOG Score - Filter for entries with values not equal to the specified value | |
ecogScore.not.exists |
query | boolean | No | ECOG Score - Filter for entries without a value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
karnofskyInterpretation |
query | string | No | Karnofsky Interpreation - Filter for a matching concept code | |
karnofskyInterpretation.anyOf |
query | array | No | Karnofsky Interpreation - Filter for a matching set of concept codes | |
karnofskyInterpretation.descendantsOf |
query | string | No | Karnofsky Interpreation - Filter for all child concepts of a given concepts code | |
karnofskyInterpretation.exists |
query | boolean | No | Karnofsky Interpreation - Filter for entries with a value | |
karnofskyInterpretation.not |
query | string | No | Karnofsky Interpreation - Filter for a mismatching concept code | |
karnofskyInterpretation.not.anyOf |
query | array | No | Karnofsky Interpreation - Filter for a mismmatching set of concept codes | |
karnofskyInterpretation.not.exists |
query | boolean | No | Karnofsky Interpreation - Filter for entries without a value | |
karnofskyScore.between |
query | array | No | Karnofsky Score - Filter for entries with values between two specified values (inclusive) | |
karnofskyScore.equal |
query | integer | No | Karnofsky Score - Filter for entries with values exactly equal to the specified value | |
karnofskyScore.exists |
query | boolean | No | Karnofsky Score - Filter for entries with a value | |
karnofskyScore.greaterThan |
query | integer | No | Karnofsky Score - Filter for entries with values greater than the specified value | |
karnofskyScore.greaterThanOrEqual |
query | integer | No | Karnofsky Score - Filter for entries with values greater than or equal to the specified value | |
karnofskyScore.lessThan |
query | integer | No | Karnofsky Score - Filter for entries with values less than the specified value | |
karnofskyScore.lessThanOrEqual |
query | integer | No | Karnofsky Score - Filter for entries with values less than or equal to the specified value | |
karnofskyScore.not.between |
query | array | No | Karnofsky Score - Filter for entries with values between two specified values (inclusive) | |
karnofskyScore.not.equal |
query | integer | No | Karnofsky Score - Filter for entries with values not equal to the specified value | |
karnofskyScore.not.exists |
query | boolean | No | Karnofsky Score - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "11f302fd-d760-40d2-8126-22a3f3e37a7f",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "773a7dd1-7374-4338-8040-1e40e00d206e",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"ecogInterpretation": null,
"karnofskyInterpretation": null
}
]
}
Schema of the response body
POST /api/v1/performance-status¶
Create Performance Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5b3ce4f2-67fe-478e-b41a-821a4d1eb357",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's performance status is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the performance score was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"ecogScore": {
"description": "ECOG Performance Status Score",
"title": "ECOG Score",
"type": "integer"
},
"karnofskyScore": {
"description": "Karnofsky Performance Status Score",
"title": "Karnofsky Score",
"type": "integer"
}
},
"required": [
"caseId",
"date"
],
"title": "PerformanceStatusCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/performance-status/{performanceStatusId}¶
Get Performance Status By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
performanceStatusId |
path | string | No |
Responses
{
"anonymized": true,
"id": "c9fd978c-a2c1-4b21-8b93-011579dbe1e1",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9286cfff-1271-498d-aec3-9abbd98c05b8",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"ecogInterpretation": null,
"karnofskyInterpretation": null
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's performance status is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the performance score was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"ecogScore": {
"description": "ECOG Performance Status Score",
"title": "ECOG Score",
"type": "integer"
},
"karnofskyScore": {
"description": "Karnofsky Performance Status Score",
"title": "Karnofsky Score",
"type": "integer"
},
"ecogInterpretation": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Official interpretation of the ECOG score",
"title": "ECOG Interpreation",
"x-terminology": "ECOGPerformanceStatusInterpretation"
},
"karnofskyInterpretation": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Official interpretation of the Karnofsky score",
"title": "Karnofsky Interpreation",
"x-terminology": "KarnofskyPerformanceStatusInterpretation"
}
},
"required": [
"id",
"description",
"caseId",
"date"
],
"title": "PerformanceStatus",
"type": "object"
}
PUT /api/v1/performance-status/{performanceStatusId}¶
Update Performance Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
performanceStatusId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "8dce3f24-5bbe-44e4-9e70-ae92e53c55b8",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's performance status is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the performance score was performed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"ecogScore": {
"description": "ECOG Performance Status Score",
"title": "ECOG Score",
"type": "integer"
},
"karnofskyScore": {
"description": "Karnofsky Performance Status Score",
"title": "Karnofsky Score",
"type": "integer"
}
},
"required": [
"caseId",
"date"
],
"title": "PerformanceStatusCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/performance-status/{performanceStatusId}¶
Delete Performance Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
performanceStatusId |
path | string | No |
Responses
GET /api/v1/performance-status/{performanceStatusId}/history/events¶
Get All Performance Status History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
performanceStatusId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/performance-status/{performanceStatusId}/history/events/{eventId}¶
Get Performance Status History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
performanceStatusId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/performance-status/{performanceStatusId}/history/events/{eventId}/reversion¶
Revert Performance Status To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
performanceStatusId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Genomic Variants¶
GET /api/v1/genomic-variants¶
Get All Genomic Variants Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
alleleDepth.between |
query | array | No | Allele depth (reads) - Filter for entries with values between two specified values (inclusive) | |
alleleDepth.equal |
query | integer | No | Allele depth (reads) - Filter for entries with values exactly equal to the specified value | |
alleleDepth.exists |
query | boolean | No | Allele depth (reads) - Filter for entries with a value | |
alleleDepth.greaterThan |
query | integer | No | Allele depth (reads) - Filter for entries with values greater than the specified value | |
alleleDepth.greaterThanOrEqual |
query | integer | No | Allele depth (reads) - Filter for entries with values greater than or equal to the specified value | |
alleleDepth.lessThan |
query | integer | No | Allele depth (reads) - Filter for entries with values less than the specified value | |
alleleDepth.lessThanOrEqual |
query | integer | No | Allele depth (reads) - Filter for entries with values less than or equal to the specified value | |
alleleDepth.not.between |
query | array | No | Allele depth (reads) - Filter for entries with values between two specified values (inclusive) | |
alleleDepth.not.equal |
query | integer | No | Allele depth (reads) - Filter for entries with values not equal to the specified value | |
alleleDepth.not.exists |
query | boolean | No | Allele depth (reads) - Filter for entries without a value | |
alleleFrequency.between |
query | array | No | Allele frequency - Filter for entries with values between two specified values (inclusive) | |
alleleFrequency.equal |
query | number | No | Allele frequency - Filter for entries with values exactly equal to the specified value | |
alleleFrequency.exists |
query | boolean | No | Allele frequency - Filter for entries with a value | |
alleleFrequency.greaterThan |
query | number | No | Allele frequency - Filter for entries with values greater than the specified value | |
alleleFrequency.greaterThanOrEqual |
query | number | No | Allele frequency - Filter for entries with values greater than or equal to the specified value | |
alleleFrequency.lessThan |
query | number | No | Allele frequency - Filter for entries with values less than the specified value | |
alleleFrequency.lessThanOrEqual |
query | number | No | Allele frequency - Filter for entries with values less than or equal to the specified value | |
alleleFrequency.not.between |
query | array | No | Allele frequency - Filter for entries with values between two specified values (inclusive) | |
alleleFrequency.not.equal |
query | number | No | Allele frequency - Filter for entries with values not equal to the specified value | |
alleleFrequency.not.exists |
query | boolean | No | Allele frequency - Filter for entries without a value | |
analysisMethod |
query | string | No | Analysis method - Filter for a matching concept code | |
analysisMethod.anyOf |
query | array | No | Analysis method - Filter for a matching set of concept codes | |
analysisMethod.descendantsOf |
query | string | No | Analysis method - Filter for all child concepts of a given concepts code | |
analysisMethod.exists |
query | boolean | No | Analysis method - Filter for entries with a value | |
analysisMethod.not |
query | string | No | Analysis method - Filter for a mismatching concept code | |
analysisMethod.not.anyOf |
query | array | No | Analysis method - Filter for a mismmatching set of concept codes | |
analysisMethod.not.exists |
query | boolean | No | Analysis method - Filter for entries without a value | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
assessment |
query | No | Assessment - Filter for single value choice | ||
assessment.anyOf |
query | array | No | Assessment - ('Filter for excluding a subset of value choices',) | |
assessment.exists |
query | boolean | No | Assessment - Filter for entries with a value | |
assessment.not |
query | No | Assessment - ('Filter for all but a single value choice',) | ||
assessment.not.exists |
query | boolean | No | Assessment - Filter for entries without a value | |
assessmentDate.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
assessmentDate.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
assessmentDate.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
assessmentDate.exists |
query | boolean | No | Assessment date - Filter for entries with a value | |
assessmentDate.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
assessmentDate.not.exists |
query | boolean | No | Assessment date - Filter for entries without a value | |
assessmentDate.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
assessmentDate.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
assessmentDate.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
assessmentDate.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
chromosomes |
query | string | No | Chromosomes - Filter for full text matches | |
chromosomes.anyOf |
query | array | No | Chromosomes - Filter for entries where at least one reference matches the query | |
chromosomes.beginsWith |
query | string | No | Chromosomes - Filter for entries starting with the text | |
chromosomes.contains |
query | string | No | Chromosomes - Filter for partial text matches | |
chromosomes.endsWith |
query | string | No | Chromosomes - Filter for entries ending with the text | |
chromosomes.exists |
query | boolean | No | Chromosomes - Filter for entries with a value | |
chromosomes.not |
query | string | No | Chromosomes - Filter for full text mismatches | |
chromosomes.not.anyOf |
query | array | No | Chromosomes - Filter for entries where at least one reference mismatches the query | |
chromosomes.not.beginsWith |
query | string | No | Chromosomes - Filter for entries not starting with the text | |
chromosomes.not.contains |
query | string | No | Chromosomes - Filter for partial text mismatches | |
chromosomes.not.endsWith |
query | string | No | Chromosomes - Filter for entries not ending with the text | |
chromosomes.not.exists |
query | boolean | No | Chromosomes - Filter for entries without a value | |
clinicalRelevance |
query | No | Clinical relevance - Filter for single value choice | ||
clinicalRelevance.anyOf |
query | array | No | Clinical relevance - ('Filter for excluding a subset of value choices',) | |
clinicalRelevance.exists |
query | boolean | No | Clinical relevance - Filter for entries with a value | |
clinicalRelevance.not |
query | No | Clinical relevance - ('Filter for all but a single value choice',) | ||
clinicalRelevance.not.exists |
query | boolean | No | Clinical relevance - Filter for entries without a value | |
clinvar |
query | string | No | ClinVar accession number - Filter for full text matches | |
clinvar.anyOf |
query | array | No | ClinVar accession number - Filter for entries where at least one reference matches the query | |
clinvar.beginsWith |
query | string | No | ClinVar accession number - Filter for entries starting with the text | |
clinvar.contains |
query | string | No | ClinVar accession number - Filter for partial text matches | |
clinvar.endsWith |
query | string | No | ClinVar accession number - Filter for entries ending with the text | |
clinvar.exists |
query | boolean | No | ClinVar accession number - Filter for entries with a value | |
clinvar.not |
query | string | No | ClinVar accession number - Filter for full text mismatches | |
clinvar.not.anyOf |
query | array | No | ClinVar accession number - Filter for entries where at least one reference mismatches the query | |
clinvar.not.beginsWith |
query | string | No | ClinVar accession number - Filter for entries not starting with the text | |
clinvar.not.contains |
query | string | No | ClinVar accession number - Filter for partial text mismatches | |
clinvar.not.endsWith |
query | string | No | ClinVar accession number - Filter for entries not ending with the text | |
clinvar.not.exists |
query | boolean | No | ClinVar accession number - Filter for entries without a value | |
confidence |
query | No | Confidence - Filter for single value choice | ||
confidence.anyOf |
query | array | No | Confidence - ('Filter for excluding a subset of value choices',) | |
confidence.exists |
query | boolean | No | Confidence - Filter for entries with a value | |
confidence.not |
query | No | Confidence - ('Filter for all but a single value choice',) | ||
confidence.not.exists |
query | boolean | No | Confidence - Filter for entries without a value | |
coordinateSystem |
query | string | No | Coordinate system - Filter for a matching concept code | |
coordinateSystem.anyOf |
query | array | No | Coordinate system - Filter for a matching set of concept codes | |
coordinateSystem.descendantsOf |
query | string | No | Coordinate system - Filter for all child concepts of a given concepts code | |
coordinateSystem.exists |
query | boolean | No | Coordinate system - Filter for entries with a value | |
coordinateSystem.not |
query | string | No | Coordinate system - Filter for a mismatching concept code | |
coordinateSystem.not.anyOf |
query | array | No | Coordinate system - Filter for a mismmatching set of concept codes | |
coordinateSystem.not.exists |
query | boolean | No | Coordinate system - Filter for entries without a value | |
copyNumber.between |
query | array | No | Copy number - Filter for entries with values between two specified values (inclusive) | |
copyNumber.equal |
query | integer | No | Copy number - Filter for entries with values exactly equal to the specified value | |
copyNumber.exists |
query | boolean | No | Copy number - Filter for entries with a value | |
copyNumber.greaterThan |
query | integer | No | Copy number - Filter for entries with values greater than the specified value | |
copyNumber.greaterThanOrEqual |
query | integer | No | Copy number - Filter for entries with values greater than or equal to the specified value | |
copyNumber.lessThan |
query | integer | No | Copy number - Filter for entries with values less than the specified value | |
copyNumber.lessThanOrEqual |
query | integer | No | Copy number - Filter for entries with values less than or equal to the specified value | |
copyNumber.not.between |
query | array | No | Copy number - Filter for entries with values between two specified values (inclusive) | |
copyNumber.not.equal |
query | integer | No | Copy number - Filter for entries with values not equal to the specified value | |
copyNumber.not.exists |
query | boolean | No | Copy number - Filter for entries without a value | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
cytogeneticLocation |
query | string | No | Cytogenetic Location - Filter for full text matches | |
cytogeneticLocation.anyOf |
query | array | No | Cytogenetic Location - Filter for entries where at least one reference matches the query | |
cytogeneticLocation.beginsWith |
query | string | No | Cytogenetic Location - Filter for entries starting with the text | |
cytogeneticLocation.contains |
query | string | No | Cytogenetic Location - Filter for partial text matches | |
cytogeneticLocation.endsWith |
query | string | No | Cytogenetic Location - Filter for entries ending with the text | |
cytogeneticLocation.exists |
query | boolean | No | Cytogenetic Location - Filter for entries with a value | |
cytogeneticLocation.not |
query | string | No | Cytogenetic Location - Filter for full text mismatches | |
cytogeneticLocation.not.anyOf |
query | array | No | Cytogenetic Location - Filter for entries where at least one reference mismatches the query | |
cytogeneticLocation.not.beginsWith |
query | string | No | Cytogenetic Location - Filter for entries not starting with the text | |
cytogeneticLocation.not.contains |
query | string | No | Cytogenetic Location - Filter for partial text mismatches | |
cytogeneticLocation.not.endsWith |
query | string | No | Cytogenetic Location - Filter for entries not ending with the text | |
cytogeneticLocation.not.exists |
query | boolean | No | Cytogenetic Location - Filter for entries without a value | |
date.after |
query | string | No | Date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Date - Filter for entries with dates on or before the specified value | |
dnaChangePosition.between |
query | array | No | DNA change position - Filter for entries with values between two specified values (inclusive) | |
dnaChangePosition.equal |
query | integer | No | DNA change position - Filter for entries with values exactly equal to the specified value | |
dnaChangePosition.exists |
query | boolean | No | DNA change position - Filter for entries with a value | |
dnaChangePosition.greaterThan |
query | integer | No | DNA change position - Filter for entries with values greater than the specified value | |
dnaChangePosition.greaterThanOrEqual |
query | integer | No | DNA change position - Filter for entries with values greater than or equal to the specified value | |
dnaChangePosition.lessThan |
query | integer | No | DNA change position - Filter for entries with values less than the specified value | |
dnaChangePosition.lessThanOrEqual |
query | integer | No | DNA change position - Filter for entries with values less than or equal to the specified value | |
dnaChangePosition.not.between |
query | array | No | DNA change position - Filter for entries with values between two specified values (inclusive) | |
dnaChangePosition.not.equal |
query | integer | No | DNA change position - Filter for entries with values not equal to the specified value | |
dnaChangePosition.not.exists |
query | boolean | No | DNA change position - Filter for entries without a value | |
dnaChangePositionRange.containedBy |
query | array | No | DNA change range - Filter for entries whose Range are contined by the range | |
dnaChangePositionRange.contains |
query | array | No | DNA change range - Filter for entries containing the range | |
dnaChangePositionRange.exists |
query | boolean | No | DNA change range - Filter for entries with a value | |
dnaChangePositionRange.not.containedBy |
query | array | No | DNA change range - Filter for entries whose Range are not contined by the range | |
dnaChangePositionRange.not.contains |
query | array | No | DNA change range - Filter for entries not containing the range | |
dnaChangePositionRange.not.exists |
query | boolean | No | DNA change range - Filter for entries without a value | |
dnaChangePositionRange.not.overlaps |
query | array | No | DNA change range - Filter for entries not overlapping with the range | |
dnaChangePositionRange.overlaps |
query | array | No | DNA change range - Filter for entries overlapping with the range | |
dnaChangeType |
query | No | DNA change type - Filter for single value choice | ||
dnaChangeType.anyOf |
query | array | No | DNA change type - ('Filter for excluding a subset of value choices',) | |
dnaChangeType.exists |
query | boolean | No | DNA change type - Filter for entries with a value | |
dnaChangeType.not |
query | No | DNA change type - ('Filter for all but a single value choice',) | ||
dnaChangeType.not.exists |
query | boolean | No | DNA change type - Filter for entries without a value | |
dnaHgvs |
query | string | No | DNA HGVS - Filter for full text matches | |
dnaHgvs.anyOf |
query | array | No | DNA HGVS - Filter for entries where at least one reference matches the query | |
dnaHgvs.beginsWith |
query | string | No | DNA HGVS - Filter for entries starting with the text | |
dnaHgvs.contains |
query | string | No | DNA HGVS - Filter for partial text matches | |
dnaHgvs.endsWith |
query | string | No | DNA HGVS - Filter for entries ending with the text | |
dnaHgvs.exists |
query | boolean | No | DNA HGVS - Filter for entries with a value | |
dnaHgvs.not |
query | string | No | DNA HGVS - Filter for full text mismatches | |
dnaHgvs.not.anyOf |
query | array | No | DNA HGVS - Filter for entries where at least one reference mismatches the query | |
dnaHgvs.not.beginsWith |
query | string | No | DNA HGVS - Filter for entries not starting with the text | |
dnaHgvs.not.contains |
query | string | No | DNA HGVS - Filter for partial text mismatches | |
dnaHgvs.not.endsWith |
query | string | No | DNA HGVS - Filter for entries not ending with the text | |
dnaHgvs.not.exists |
query | boolean | No | DNA HGVS - Filter for entries without a value | |
dnaReferenceSequence |
query | string | No | DNA HGVS RefSeq - Filter for full text matches | |
dnaReferenceSequence.anyOf |
query | array | No | DNA HGVS RefSeq - Filter for entries where at least one reference matches the query | |
dnaReferenceSequence.beginsWith |
query | string | No | DNA HGVS RefSeq - Filter for entries starting with the text | |
dnaReferenceSequence.contains |
query | string | No | DNA HGVS RefSeq - Filter for partial text matches | |
dnaReferenceSequence.endsWith |
query | string | No | DNA HGVS RefSeq - Filter for entries ending with the text | |
dnaReferenceSequence.exists |
query | boolean | No | DNA HGVS RefSeq - Filter for entries with a value | |
dnaReferenceSequence.not |
query | string | No | DNA HGVS RefSeq - Filter for full text mismatches | |
dnaReferenceSequence.not.anyOf |
query | array | No | DNA HGVS RefSeq - Filter for entries where at least one reference mismatches the query | |
dnaReferenceSequence.not.beginsWith |
query | string | No | DNA HGVS RefSeq - Filter for entries not starting with the text | |
dnaReferenceSequence.not.contains |
query | string | No | DNA HGVS RefSeq - Filter for partial text mismatches | |
dnaReferenceSequence.not.endsWith |
query | string | No | DNA HGVS RefSeq - Filter for entries not ending with the text | |
dnaReferenceSequence.not.exists |
query | boolean | No | DNA HGVS RefSeq - Filter for entries without a value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
genePanel |
query | string | No | Gene panel - Filter for full text matches | |
genePanel.anyOf |
query | array | No | Gene panel - Filter for entries where at least one reference matches the query | |
genePanel.beginsWith |
query | string | No | Gene panel - Filter for entries starting with the text | |
genePanel.contains |
query | string | No | Gene panel - Filter for partial text matches | |
genePanel.endsWith |
query | string | No | Gene panel - Filter for entries ending with the text | |
genePanel.exists |
query | boolean | No | Gene panel - Filter for entries with a value | |
genePanel.not |
query | string | No | Gene panel - Filter for full text mismatches | |
genePanel.not.anyOf |
query | array | No | Gene panel - Filter for entries where at least one reference mismatches the query | |
genePanel.not.beginsWith |
query | string | No | Gene panel - Filter for entries not starting with the text | |
genePanel.not.contains |
query | string | No | Gene panel - Filter for partial text mismatches | |
genePanel.not.endsWith |
query | string | No | Gene panel - Filter for entries not ending with the text | |
genePanel.not.exists |
query | boolean | No | Gene panel - Filter for entries without a value | |
genes |
query | string | No | Gene(s) - Filter for a matching concept code | |
genes.allOf |
query | array | No | Gene(s) - Filter for entries matching all of the concepts | |
genes.anyOf |
query | array | No | Gene(s) - Filter for a matching set of concept codes | |
genes.descendantsOf |
query | string | No | Gene(s) - Filter for all child concepts of a given concepts code | |
genes.not |
query | string | No | Gene(s) - Filter for a mismatching concept code | |
genes.not.allOf |
query | array | No | Gene(s) - Filter for entries mismatching all of the concepts | |
genes.not.anyOf |
query | array | No | Gene(s) - Filter for a mismmatching set of concept codes | |
genomeAssemblyVersion |
query | string | No | Genome assembly version - Filter for a matching concept code | |
genomeAssemblyVersion.anyOf |
query | array | No | Genome assembly version - Filter for a matching set of concept codes | |
genomeAssemblyVersion.descendantsOf |
query | string | No | Genome assembly version - Filter for all child concepts of a given concepts code | |
genomeAssemblyVersion.exists |
query | boolean | No | Genome assembly version - Filter for entries with a value | |
genomeAssemblyVersion.not |
query | string | No | Genome assembly version - Filter for a mismatching concept code | |
genomeAssemblyVersion.not.anyOf |
query | array | No | Genome assembly version - Filter for a mismmatching set of concept codes | |
genomeAssemblyVersion.not.exists |
query | boolean | No | Genome assembly version - Filter for entries without a value | |
hgvsVersion |
query | string | No | HGVS Version - Filter for full text matches | |
hgvsVersion.anyOf |
query | array | No | HGVS Version - Filter for entries where at least one reference matches the query | |
hgvsVersion.beginsWith |
query | string | No | HGVS Version - Filter for entries starting with the text | |
hgvsVersion.contains |
query | string | No | HGVS Version - Filter for partial text matches | |
hgvsVersion.endsWith |
query | string | No | HGVS Version - Filter for entries ending with the text | |
hgvsVersion.not |
query | string | No | HGVS Version - Filter for full text mismatches | |
hgvsVersion.not.anyOf |
query | array | No | HGVS Version - Filter for entries where at least one reference mismatches the query | |
hgvsVersion.not.beginsWith |
query | string | No | HGVS Version - Filter for entries not starting with the text | |
hgvsVersion.not.contains |
query | string | No | HGVS Version - Filter for partial text mismatches | |
hgvsVersion.not.endsWith |
query | string | No | HGVS Version - Filter for entries not ending with the text | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
inheritance |
query | string | No | Inheritance - Filter for a matching concept code | |
inheritance.anyOf |
query | array | No | Inheritance - Filter for a matching set of concept codes | |
inheritance.descendantsOf |
query | string | No | Inheritance - Filter for all child concepts of a given concepts code | |
inheritance.exists |
query | boolean | No | Inheritance - Filter for entries with a value | |
inheritance.not |
query | string | No | Inheritance - Filter for a mismatching concept code | |
inheritance.not.anyOf |
query | array | No | Inheritance - Filter for a mismmatching set of concept codes | |
inheritance.not.exists |
query | boolean | No | Inheritance - Filter for entries without a value | |
isPathogenic |
query | boolean | No | Is Pathogenic - Filter for yes/no statement | |
isPathogenic.exists |
query | boolean | No | Is Pathogenic - Filter for entries with a value | |
isPathogenic.not.exists |
query | boolean | No | Is Pathogenic - Filter for entries without a value | |
isVUS |
query | boolean | No | Is VUS - Filter for yes/no statement | |
isVUS.exists |
query | boolean | No | Is VUS - Filter for entries with a value | |
isVUS.not.exists |
query | boolean | No | Is VUS - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
molecularConsequence |
query | string | No | Molecular consequence - Filter for a matching concept code | |
molecularConsequence.anyOf |
query | array | No | Molecular consequence - Filter for a matching set of concept codes | |
molecularConsequence.descendantsOf |
query | string | No | Molecular consequence - Filter for all child concepts of a given concepts code | |
molecularConsequence.exists |
query | boolean | No | Molecular consequence - Filter for entries with a value | |
molecularConsequence.not |
query | string | No | Molecular consequence - Filter for a mismatching concept code | |
molecularConsequence.not.anyOf |
query | array | No | Molecular consequence - Filter for a mismmatching set of concept codes | |
molecularConsequence.not.exists |
query | boolean | No | Molecular consequence - Filter for entries without a value | |
nucleotidesLength.between |
query | array | No | Variant length - Filter for entries with values between two specified values (inclusive) | |
nucleotidesLength.equal |
query | integer | No | Variant length - Filter for entries with values exactly equal to the specified value | |
nucleotidesLength.exists |
query | boolean | No | Variant length - Filter for entries with a value | |
nucleotidesLength.greaterThan |
query | integer | No | Variant length - Filter for entries with values greater than the specified value | |
nucleotidesLength.greaterThanOrEqual |
query | integer | No | Variant length - Filter for entries with values greater than or equal to the specified value | |
nucleotidesLength.lessThan |
query | integer | No | Variant length - Filter for entries with values less than the specified value | |
nucleotidesLength.lessThanOrEqual |
query | integer | No | Variant length - Filter for entries with values less than or equal to the specified value | |
nucleotidesLength.not.between |
query | array | No | Variant length - Filter for entries with values between two specified values (inclusive) | |
nucleotidesLength.not.equal |
query | integer | No | Variant length - Filter for entries with values not equal to the specified value | |
nucleotidesLength.not.exists |
query | boolean | No | Variant length - Filter for entries without a value | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
proteinChangeType |
query | No | Protein change type - Filter for single value choice | ||
proteinChangeType.anyOf |
query | array | No | Protein change type - ('Filter for excluding a subset of value choices',) | |
proteinChangeType.exists |
query | boolean | No | Protein change type - Filter for entries with a value | |
proteinChangeType.not |
query | No | Protein change type - ('Filter for all but a single value choice',) | ||
proteinChangeType.not.exists |
query | boolean | No | Protein change type - Filter for entries without a value | |
proteinHgvs |
query | string | No | Protein HGVS - Filter for full text matches | |
proteinHgvs.anyOf |
query | array | No | Protein HGVS - Filter for entries where at least one reference matches the query | |
proteinHgvs.beginsWith |
query | string | No | Protein HGVS - Filter for entries starting with the text | |
proteinHgvs.contains |
query | string | No | Protein HGVS - Filter for partial text matches | |
proteinHgvs.endsWith |
query | string | No | Protein HGVS - Filter for entries ending with the text | |
proteinHgvs.exists |
query | boolean | No | Protein HGVS - Filter for entries with a value | |
proteinHgvs.not |
query | string | No | Protein HGVS - Filter for full text mismatches | |
proteinHgvs.not.anyOf |
query | array | No | Protein HGVS - Filter for entries where at least one reference mismatches the query | |
proteinHgvs.not.beginsWith |
query | string | No | Protein HGVS - Filter for entries not starting with the text | |
proteinHgvs.not.contains |
query | string | No | Protein HGVS - Filter for partial text mismatches | |
proteinHgvs.not.endsWith |
query | string | No | Protein HGVS - Filter for entries not ending with the text | |
proteinHgvs.not.exists |
query | boolean | No | Protein HGVS - Filter for entries without a value | |
proteinReferenceSequence |
query | string | No | Protein HGVS RefSeq - Filter for full text matches | |
proteinReferenceSequence.anyOf |
query | array | No | Protein HGVS RefSeq - Filter for entries where at least one reference matches the query | |
proteinReferenceSequence.beginsWith |
query | string | No | Protein HGVS RefSeq - Filter for entries starting with the text | |
proteinReferenceSequence.contains |
query | string | No | Protein HGVS RefSeq - Filter for partial text matches | |
proteinReferenceSequence.endsWith |
query | string | No | Protein HGVS RefSeq - Filter for entries ending with the text | |
proteinReferenceSequence.exists |
query | boolean | No | Protein HGVS RefSeq - Filter for entries with a value | |
proteinReferenceSequence.not |
query | string | No | Protein HGVS RefSeq - Filter for full text mismatches | |
proteinReferenceSequence.not.anyOf |
query | array | No | Protein HGVS RefSeq - Filter for entries where at least one reference mismatches the query | |
proteinReferenceSequence.not.beginsWith |
query | string | No | Protein HGVS RefSeq - Filter for entries not starting with the text | |
proteinReferenceSequence.not.contains |
query | string | No | Protein HGVS RefSeq - Filter for partial text mismatches | |
proteinReferenceSequence.not.endsWith |
query | string | No | Protein HGVS RefSeq - Filter for entries not ending with the text | |
proteinReferenceSequence.not.exists |
query | boolean | No | Protein HGVS RefSeq - Filter for entries without a value | |
regions |
query | string | No | Gene regions - Filter for full text matches | |
regions.anyOf |
query | array | No | Gene regions - Filter for entries where at least one reference matches the query | |
regions.beginsWith |
query | string | No | Gene regions - Filter for entries starting with the text | |
regions.contains |
query | string | No | Gene regions - Filter for partial text matches | |
regions.endsWith |
query | string | No | Gene regions - Filter for entries ending with the text | |
regions.exists |
query | boolean | No | Gene regions - Filter for entries with a value | |
regions.not |
query | string | No | Gene regions - Filter for full text mismatches | |
regions.not.anyOf |
query | array | No | Gene regions - Filter for entries where at least one reference mismatches the query | |
regions.not.beginsWith |
query | string | No | Gene regions - Filter for entries not starting with the text | |
regions.not.contains |
query | string | No | Gene regions - Filter for partial text mismatches | |
regions.not.endsWith |
query | string | No | Gene regions - Filter for entries not ending with the text | |
regions.not.exists |
query | boolean | No | Gene regions - Filter for entries without a value | |
rnaChangePosition |
query | string | No | RNA change position - Filter for full text matches | |
rnaChangePosition.anyOf |
query | array | No | RNA change position - Filter for entries where at least one reference matches the query | |
rnaChangePosition.beginsWith |
query | string | No | RNA change position - Filter for entries starting with the text | |
rnaChangePosition.contains |
query | string | No | RNA change position - Filter for partial text matches | |
rnaChangePosition.endsWith |
query | string | No | RNA change position - Filter for entries ending with the text | |
rnaChangePosition.exists |
query | boolean | No | RNA change position - Filter for entries with a value | |
rnaChangePosition.not |
query | string | No | RNA change position - Filter for full text mismatches | |
rnaChangePosition.not.anyOf |
query | array | No | RNA change position - Filter for entries where at least one reference mismatches the query | |
rnaChangePosition.not.beginsWith |
query | string | No | RNA change position - Filter for entries not starting with the text | |
rnaChangePosition.not.contains |
query | string | No | RNA change position - Filter for partial text mismatches | |
rnaChangePosition.not.endsWith |
query | string | No | RNA change position - Filter for entries not ending with the text | |
rnaChangePosition.not.exists |
query | boolean | No | RNA change position - Filter for entries without a value | |
rnaChangeType |
query | No | RNA change type - Filter for single value choice | ||
rnaChangeType.anyOf |
query | array | No | RNA change type - ('Filter for excluding a subset of value choices',) | |
rnaChangeType.exists |
query | boolean | No | RNA change type - Filter for entries with a value | |
rnaChangeType.not |
query | No | RNA change type - ('Filter for all but a single value choice',) | ||
rnaChangeType.not.exists |
query | boolean | No | RNA change type - Filter for entries without a value | |
rnaHgvs |
query | string | No | RNA HGVS - Filter for full text matches | |
rnaHgvs.anyOf |
query | array | No | RNA HGVS - Filter for entries where at least one reference matches the query | |
rnaHgvs.beginsWith |
query | string | No | RNA HGVS - Filter for entries starting with the text | |
rnaHgvs.contains |
query | string | No | RNA HGVS - Filter for partial text matches | |
rnaHgvs.endsWith |
query | string | No | RNA HGVS - Filter for entries ending with the text | |
rnaHgvs.exists |
query | boolean | No | RNA HGVS - Filter for entries with a value | |
rnaHgvs.not |
query | string | No | RNA HGVS - Filter for full text mismatches | |
rnaHgvs.not.anyOf |
query | array | No | RNA HGVS - Filter for entries where at least one reference mismatches the query | |
rnaHgvs.not.beginsWith |
query | string | No | RNA HGVS - Filter for entries not starting with the text | |
rnaHgvs.not.contains |
query | string | No | RNA HGVS - Filter for partial text mismatches | |
rnaHgvs.not.endsWith |
query | string | No | RNA HGVS - Filter for entries not ending with the text | |
rnaHgvs.not.exists |
query | boolean | No | RNA HGVS - Filter for entries without a value | |
rnaReferenceSequence |
query | string | No | RNA HGVS RefSeq - Filter for full text matches | |
rnaReferenceSequence.anyOf |
query | array | No | RNA HGVS RefSeq - Filter for entries where at least one reference matches the query | |
rnaReferenceSequence.beginsWith |
query | string | No | RNA HGVS RefSeq - Filter for entries starting with the text | |
rnaReferenceSequence.contains |
query | string | No | RNA HGVS RefSeq - Filter for partial text matches | |
rnaReferenceSequence.endsWith |
query | string | No | RNA HGVS RefSeq - Filter for entries ending with the text | |
rnaReferenceSequence.exists |
query | boolean | No | RNA HGVS RefSeq - Filter for entries with a value | |
rnaReferenceSequence.not |
query | string | No | RNA HGVS RefSeq - Filter for full text mismatches | |
rnaReferenceSequence.not.anyOf |
query | array | No | RNA HGVS RefSeq - Filter for entries where at least one reference mismatches the query | |
rnaReferenceSequence.not.beginsWith |
query | string | No | RNA HGVS RefSeq - Filter for entries not starting with the text | |
rnaReferenceSequence.not.contains |
query | string | No | RNA HGVS RefSeq - Filter for partial text mismatches | |
rnaReferenceSequence.not.endsWith |
query | string | No | RNA HGVS RefSeq - Filter for entries not ending with the text | |
rnaReferenceSequence.not.exists |
query | boolean | No | RNA HGVS RefSeq - Filter for entries without a value | |
source |
query | string | No | Source - Filter for a matching concept code | |
source.anyOf |
query | array | No | Source - Filter for a matching set of concept codes | |
source.descendantsOf |
query | string | No | Source - Filter for all child concepts of a given concepts code | |
source.exists |
query | boolean | No | Source - Filter for entries with a value | |
source.not |
query | string | No | Source - Filter for a mismatching concept code | |
source.not.anyOf |
query | array | No | Source - Filter for a mismmatching set of concept codes | |
source.not.exists |
query | boolean | No | Source - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
zygosity |
query | string | No | Zygosity - Filter for a matching concept code | |
zygosity.anyOf |
query | array | No | Zygosity - Filter for a matching set of concept codes | |
zygosity.descendantsOf |
query | string | No | Zygosity - Filter for all child concepts of a given concepts code | |
zygosity.exists |
query | boolean | No | Zygosity - Filter for entries with a value | |
zygosity.not |
query | string | No | Zygosity - Filter for a mismatching concept code | |
zygosity.not.anyOf |
query | array | No | Zygosity - Filter for a mismmatching set of concept codes | |
zygosity.not.exists |
query | boolean | No | Zygosity - Filter for entries without a value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "28122aaa-740f-4b38-a783-fb069b8baf48",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5b099059-63c9-42ba-9216-c4990eaba125",
"date": "2022-04-13",
"genes": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"dnaHgvs": "string",
"rnaHgvs": "string",
"proteinHgvs": "string",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"source": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"hgvsVersion": "string",
"isPathogenic": true,
"isVUS": true,
"cytogeneticLocation": "string",
"chromosomes": [
"string"
],
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
]
}
]
}
POST /api/v1/genomic-variants¶
Create Genomic Variant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "36578877-8ea7-4105-983a-2f3972b5bfef",
"date": "2022-04-13",
"genes": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"dnaHgvs": "string",
"rnaHgvs": "string",
"proteinHgvs": "string",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"source": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who' genomic variant is described",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date of the genomic variant (e.g. the specimen collection date).",
"format": "date",
"title": "Date",
"type": "string"
},
"genes": {
"description": "Gene(s) affected by this variant",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Gene(s)",
"type": "array",
"x-terminology": "Gene"
},
"dnaHgvs": {
"description": "DNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g)|(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+))?\\(?((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3}))\\)?:)?c))\\.((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+>(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]\\sand\\s(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|gom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|lom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|met=)",
"title": "DNA HGVS",
"type": "string"
},
"rnaHgvs": {
"description": "RNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})):)?r\\.\\(?((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+>(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\])\\)?",
"title": "RNA HGVS",
"type": "string"
},
"proteinHgvs": {
"description": "Protein HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})):)?p\\.\\(?(0\\??|\\?|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))delins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))del|(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))ins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))dup|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:Ter|\\*)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)?fs(?:Ter)?(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+)))*|(?:(?:Met1ext-\\d+)|(?:Ter\\d+(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)extTer\\d+))|\\(?(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))\\)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))=)\\)?",
"title": "Protein HGVS",
"type": "string"
},
"assessmentDate": {
"description": "Date at which the genomic variant was assessed and/or reported.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"genePanel": {
"description": "Commercial or official name of the gene panel tested to identify the variant",
"maxLength": 200,
"title": "Gene panel",
"type": "string"
},
"assessment": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantAssessmentChoices"
}
],
"description": "Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants.",
"title": "Assessment"
},
"confidence": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantConfidenceChoices"
}
],
"description": "Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores.",
"title": "Confidence"
},
"analysisMethod": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Analysis method used to detect the variant",
"title": "Analysis method",
"x-terminology": "StructuralVariantAnalysisMethod"
},
"clinicalRelevance": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantClinicalRelevanceChoices"
}
],
"description": "Classification of the clinical relevance or pathogenicity of the variant.",
"title": "Clinical relevance"
},
"genomeAssemblyVersion": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The reference genome assembly versionused in this analysis.",
"title": "Genome assembly version",
"x-terminology": "ReferenceGenomeBuild"
},
"molecularConsequence": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence.",
"title": "Molecular consequence",
"x-terminology": "MolecularConsequence"
},
"copyNumber": {
"description": "Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion.",
"title": "Copy number",
"type": "integer"
},
"alleleFrequency": {
"description": "The relative frequency (value in range [0,1]) of the allele at a given locus in the sample.",
"title": "Allele frequency",
"type": "number"
},
"alleleDepth": {
"description": "Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides.",
"title": "Allele depth (reads)",
"type": "integer"
},
"zygosity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The observed level of occurrence of the variant in the set of chromosomes.",
"title": "Zygosity",
"x-terminology": "Zygosity"
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Variant genomic source (if known).",
"title": "Source",
"x-terminology": "GeneticVariantSource"
},
"inheritance": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Variant inheritance origin (if known).",
"title": "Inheritance",
"x-terminology": "VariantInheritance"
},
"coordinateSystem": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Genomic coordinate system used for identifying nucleotides or amino acids within a sequence.",
"title": "Coordinate system",
"x-terminology": "GenomicCoordinateSystem"
},
"clinvar": {
"description": "Accession number in the ClinVar variant database, given for cross-reference.",
"title": "ClinVar accession number",
"type": "string"
}
},
"required": [
"caseId",
"date",
"genes"
],
"title": "GenomicVariantCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/genomic-variants/{genomicVariantId}¶
Get Genomic Variant By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
genomicVariantId |
path | string | No |
Responses
{
"anonymized": true,
"id": "7dcc8bb8-1b0d-4ef0-a473-b6614006d1a0",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "93647ca0-7745-487b-8600-9d062358d7dc",
"date": "2022-04-13",
"genes": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"dnaHgvs": "string",
"rnaHgvs": "string",
"proteinHgvs": "string",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"source": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"hgvsVersion": "string",
"isPathogenic": true,
"isVUS": true,
"cytogeneticLocation": "string",
"chromosomes": [
"string"
],
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
]
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who' genomic variant is described",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date of the genomic variant (e.g. the specimen collection date).",
"format": "date",
"title": "Date",
"type": "string"
},
"genes": {
"description": "Gene(s) affected by this variant",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Gene(s)",
"type": "array",
"x-terminology": "Gene"
},
"dnaHgvs": {
"description": "DNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g)|(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+))?\\(?((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3}))\\)?:)?c))\\.((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+>(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]\\sand\\s(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|gom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|lom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|met=)",
"title": "DNA HGVS",
"type": "string"
},
"rnaHgvs": {
"description": "RNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})):)?r\\.\\(?((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+>(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\])\\)?",
"title": "RNA HGVS",
"type": "string"
},
"proteinHgvs": {
"description": "Protein HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})):)?p\\.\\(?(0\\??|\\?|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))delins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))del|(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))ins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))dup|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:Ter|\\*)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)?fs(?:Ter)?(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+)))*|(?:(?:Met1ext-\\d+)|(?:Ter\\d+(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)extTer\\d+))|\\(?(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))\\)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))=)\\)?",
"title": "Protein HGVS",
"type": "string"
},
"assessmentDate": {
"description": "Date at which the genomic variant was assessed and/or reported.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"genePanel": {
"description": "Commercial or official name of the gene panel tested to identify the variant",
"maxLength": 200,
"title": "Gene panel",
"type": "string"
},
"assessment": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantAssessmentChoices"
}
],
"description": "Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants.",
"title": "Assessment"
},
"confidence": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantConfidenceChoices"
}
],
"description": "Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores.",
"title": "Confidence"
},
"analysisMethod": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Analysis method used to detect the variant",
"title": "Analysis method",
"x-terminology": "StructuralVariantAnalysisMethod"
},
"clinicalRelevance": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantClinicalRelevanceChoices"
}
],
"description": "Classification of the clinical relevance or pathogenicity of the variant.",
"title": "Clinical relevance"
},
"genomeAssemblyVersion": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The reference genome assembly versionused in this analysis.",
"title": "Genome assembly version",
"x-terminology": "ReferenceGenomeBuild"
},
"molecularConsequence": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence.",
"title": "Molecular consequence",
"x-terminology": "MolecularConsequence"
},
"copyNumber": {
"description": "Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion.",
"title": "Copy number",
"type": "integer"
},
"alleleFrequency": {
"description": "The relative frequency (value in range [0,1]) of the allele at a given locus in the sample.",
"title": "Allele frequency",
"type": "number"
},
"alleleDepth": {
"description": "Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides.",
"title": "Allele depth (reads)",
"type": "integer"
},
"zygosity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The observed level of occurrence of the variant in the set of chromosomes.",
"title": "Zygosity",
"x-terminology": "Zygosity"
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Variant genomic source (if known).",
"title": "Source",
"x-terminology": "GeneticVariantSource"
},
"inheritance": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Variant inheritance origin (if known).",
"title": "Inheritance",
"x-terminology": "VariantInheritance"
},
"coordinateSystem": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Genomic coordinate system used for identifying nucleotides or amino acids within a sequence.",
"title": "Coordinate system",
"x-terminology": "GenomicCoordinateSystem"
},
"clinvar": {
"description": "Accession number in the ClinVar variant database, given for cross-reference.",
"title": "ClinVar accession number",
"type": "string"
},
"hgvsVersion": {
"default": "21.1.2",
"description": "Version of the HGVS nomenclature used for the HGVS expressions",
"title": "HGVS Version",
"type": "string"
},
"isPathogenic": {
"description": "Whether the genomic variant is considered pathogenic in a clinical setting",
"title": "Is Pathogenic",
"type": "boolean"
},
"isVUS": {
"description": "Whether the genomic variant is considered a variant of unknown signifiance (VUS)",
"title": "Is VUS",
"type": "boolean"
},
"cytogeneticLocation": {
"description": "Cytogenetic location of the variant (e.g. 17q21.31)",
"title": "Cytogenetic Location",
"type": "string"
},
"chromosomes": {
"description": "Chromosomes involved in the variant (e.g. 17, X)",
"items": {
"type": "string"
},
"title": "Chromosomes",
"type": "array"
},
"dnaReferenceSequence": {
"description": "DNA reference sequence identifier used as dna HGVS reference.",
"pattern": "(?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})|(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)",
"title": "DNA HGVS RefSeq",
"type": "string"
},
"dnaChangePosition": {
"description": "DNA-level single-nucleotide position where the variant was found.",
"title": "DNA change position",
"type": "integer"
},
"dnaChangePositionRange": {
"allOf": [
{
"$ref": "#/components/schemas/Range"
}
],
"description": "DNA-level single-nucleotide position where the variant was found.",
"title": "DNA change range"
},
"dnaChangeType": {
"allOf": [
{
"$ref": "#/components/schemas/DNAChangeType"
}
],
"description": "DNA variant type of variant.",
"title": "DNA change type"
},
"rnaReferenceSequence": {
"description": "RNA reference sequence identifier used as rna HGVS reference.",
"pattern": "(?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})",
"title": "RNA HGVS RefSeq",
"type": "string"
},
"rnaChangePosition": {
"description": "RNA-level nucleotide position/range where the variant was found.",
"pattern": "(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))",
"title": "RNA change position",
"type": "string"
},
"rnaChangeType": {
"allOf": [
{
"$ref": "#/components/schemas/RNAChangeType"
}
],
"description": "RNA variant type of variant.",
"title": "RNA change type"
},
"proteinReferenceSequence": {
"description": "Protein reference sequence identifier used as protein HGVS reference.",
"pattern": "(?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})",
"title": "Protein HGVS RefSeq",
"type": "string"
},
"proteinChangeType": {
"allOf": [
{
"$ref": "#/components/schemas/ProteinChangeType"
}
],
"description": "Protein variant type of variant.",
"title": "Protein change type"
},
"nucleotidesLength": {
"description": "Length of the variant in nucleotides",
"title": "Variant length",
"type": "integer"
},
"regions": {
"description": "Gene regions (exons, introns, UTRs) affected by the variant. Estimated from MANE reference sequences.",
"items": {
"type": "string"
},
"title": "Gene regions",
"type": "array"
}
},
"required": [
"id",
"description",
"caseId",
"date",
"genes"
],
"title": "GenomicVariant",
"type": "object"
}
PUT /api/v1/genomic-variants/{genomicVariantId}¶
Update Genomic Variant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicVariantId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "214fe150-05e2-4501-9b52-d8ad5cd9b55b",
"date": "2022-04-13",
"genes": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"dnaHgvs": "string",
"rnaHgvs": "string",
"proteinHgvs": "string",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"source": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string"
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who' genomic variant is described",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date of the genomic variant (e.g. the specimen collection date).",
"format": "date",
"title": "Date",
"type": "string"
},
"genes": {
"description": "Gene(s) affected by this variant",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Gene(s)",
"type": "array",
"x-terminology": "Gene"
},
"dnaHgvs": {
"description": "DNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g)|(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+))?\\(?((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3}))\\)?:)?c))\\.((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+>(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]\\sand\\s(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|gom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|lom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|met=)",
"title": "DNA HGVS",
"type": "string"
},
"rnaHgvs": {
"description": "RNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})):)?r\\.\\(?((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+>(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\])\\)?",
"title": "RNA HGVS",
"type": "string"
},
"proteinHgvs": {
"description": "Protein HGVS expression (g-coordinate expression, HGVS version >=21.1)",
"pattern": "(?:((?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})):)?p\\.\\(?(0\\??|\\?|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))delins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))del|(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))ins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))dup|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:Ter|\\*)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)?fs(?:Ter)?(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+)))*|(?:(?:Met1ext-\\d+)|(?:Ter\\d+(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)extTer\\d+))|\\(?(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))\\)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))=)\\)?",
"title": "Protein HGVS",
"type": "string"
},
"assessmentDate": {
"description": "Date at which the genomic variant was assessed and/or reported.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"genePanel": {
"description": "Commercial or official name of the gene panel tested to identify the variant",
"maxLength": 200,
"title": "Gene panel",
"type": "string"
},
"assessment": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantAssessmentChoices"
}
],
"description": "Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants.",
"title": "Assessment"
},
"confidence": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantConfidenceChoices"
}
],
"description": "Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores.",
"title": "Confidence"
},
"analysisMethod": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Analysis method used to detect the variant",
"title": "Analysis method",
"x-terminology": "StructuralVariantAnalysisMethod"
},
"clinicalRelevance": {
"allOf": [
{
"$ref": "#/components/schemas/GenomicVariantClinicalRelevanceChoices"
}
],
"description": "Classification of the clinical relevance or pathogenicity of the variant.",
"title": "Clinical relevance"
},
"genomeAssemblyVersion": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The reference genome assembly versionused in this analysis.",
"title": "Genome assembly version",
"x-terminology": "ReferenceGenomeBuild"
},
"molecularConsequence": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence.",
"title": "Molecular consequence",
"x-terminology": "MolecularConsequence"
},
"copyNumber": {
"description": "Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion.",
"title": "Copy number",
"type": "integer"
},
"alleleFrequency": {
"description": "The relative frequency (value in range [0,1]) of the allele at a given locus in the sample.",
"title": "Allele frequency",
"type": "number"
},
"alleleDepth": {
"description": "Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides.",
"title": "Allele depth (reads)",
"type": "integer"
},
"zygosity": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "The observed level of occurrence of the variant in the set of chromosomes.",
"title": "Zygosity",
"x-terminology": "Zygosity"
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Variant genomic source (if known).",
"title": "Source",
"x-terminology": "GeneticVariantSource"
},
"inheritance": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Variant inheritance origin (if known).",
"title": "Inheritance",
"x-terminology": "VariantInheritance"
},
"coordinateSystem": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Genomic coordinate system used for identifying nucleotides or amino acids within a sequence.",
"title": "Coordinate system",
"x-terminology": "GenomicCoordinateSystem"
},
"clinvar": {
"description": "Accession number in the ClinVar variant database, given for cross-reference.",
"title": "ClinVar accession number",
"type": "string"
}
},
"required": [
"caseId",
"date",
"genes"
],
"title": "GenomicVariantCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/genomic-variants/{genomicVariantId}¶
Delete Genomic Variant
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicVariantId |
path | string | No |
Responses
GET /api/v1/genomic-variants/{genomicVariantId}/history/events¶
Get All Genomic Variant History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicVariantId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/genomic-variants/{genomicVariantId}/history/events/{eventId}¶
Get Genomic Variant History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
genomicVariantId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/genomic-variants/{genomicVariantId}/history/events/{eventId}/reversion¶
Revert Genomic Variant To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
genomicVariantId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/autocomplete/gene-panels¶
Gell All Genomic Panels
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
query |
query | string | No |
Responses
Genomic Signatures¶
GET /api/v1/genomic-signatures¶
Get All Genomic Signatures Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
category |
query | No | Category - Filter for single value choice | ||
category.anyOf |
query | array | No | Category - ('Filter for excluding a subset of value choices',) | |
category.not |
query | No | Category - ('Filter for all but a single value choice',) | ||
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
POST /api/v1/genomic-signatures¶
Create Genomic Signature
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/TumorMutationalBurdenCreate"
},
{
"$ref": "#/components/schemas/MicrosatelliteInstabilityCreate"
},
{
"$ref": "#/components/schemas/LossOfHeterozygosityCreate"
},
{
"$ref": "#/components/schemas/HomologousRecombinationDeficiencyCreate"
},
{
"$ref": "#/components/schemas/TumorNeoantigenBurdenCreate"
},
{
"$ref": "#/components/schemas/AneuploidScoreCreate"
}
],
"title": "Payload"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/genomic-signatures/{genomicSignatureId}¶
Get Genomic Signature By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
genomicSignatureId |
path | string | No |
Responses
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/MicrosatelliteInstability"
},
{
"$ref": "#/components/schemas/TumorMutationalBurden"
},
{
"$ref": "#/components/schemas/LossOfHeterozygosity"
},
{
"$ref": "#/components/schemas/HomologousRecombinationDeficiency"
},
{
"$ref": "#/components/schemas/TumorNeoantigenBurden"
},
{
"$ref": "#/components/schemas/AneuploidScore"
}
]
}
PUT /api/v1/genomic-signatures/{genomicSignatureId}¶
Update Genomic Signature
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicSignatureId |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/TumorMutationalBurdenCreate"
},
{
"$ref": "#/components/schemas/MicrosatelliteInstabilityCreate"
},
{
"$ref": "#/components/schemas/LossOfHeterozygosityCreate"
},
{
"$ref": "#/components/schemas/HomologousRecombinationDeficiencyCreate"
},
{
"$ref": "#/components/schemas/TumorNeoantigenBurdenCreate"
},
{
"$ref": "#/components/schemas/AneuploidScoreCreate"
}
],
"title": "Payload"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/genomic-signatures/{genomicSignatureId}¶
Delete Genomic Signature
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicSignatureId |
path | string | No |
Responses
GET /api/v1/genomic-signatures/{genomicSignatureId}/history/events¶
Get All Genomic Signature History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
genomicSignatureId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
GET /api/v1/genomic-signatures/{genomicSignatureId}/history/events/{eventId}¶
Get Genomic Signature History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
genomicSignatureId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "Schema representing a history event within the system.\n\nAttributes:\n id (Any): The unique identifier of the history event.\n resourceId (Any): The unique identifier of the tracked resource.\n category (HistoryEventCategory): The type of history event.\n timestamp (datetime): Timestamp of the history event.\n user (Nullable[str]): Username of the user that triggered the event, if applicable.\n url (Nullable[str]): Endpoint URL through which the event was triggered, if applicable.\n resource (Nullable[str]): Resource involved in the event, if applicable.\n snapshot (Dict): Data snapshot at the time of the event.\n differential (Nullable[Dict]): Data changes introduced by the event, if applicable.\n context (Nullable[Dict]): Context surrounding the event.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEvent",
"type": "object"
}
PUT /api/v1/genomic-signatures/{genomicSignatureId}/history/events/{eventId}/reversion¶
Revert Genomic Signature To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
genomicSignatureId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Lifestyles¶
GET /api/v1/lifestyles¶
Get All Lifestyles Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
alcoholConsumption |
query | string | No | Alcohol consumption - Filter for a matching concept code | |
alcoholConsumption.anyOf |
query | array | No | Alcohol consumption - Filter for a matching set of concept codes | |
alcoholConsumption.descendantsOf |
query | string | No | Alcohol consumption - Filter for all child concepts of a given concepts code | |
alcoholConsumption.exists |
query | boolean | No | Alcohol consumption - Filter for entries with a value | |
alcoholConsumption.not |
query | string | No | Alcohol consumption - Filter for a mismatching concept code | |
alcoholConsumption.not.anyOf |
query | array | No | Alcohol consumption - Filter for a mismmatching set of concept codes | |
alcoholConsumption.not.exists |
query | boolean | No | Alcohol consumption - Filter for entries without a value | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
exposures |
query | string | No | Exposures - Filter for a matching concept code | |
exposures.allOf |
query | array | No | Exposures - Filter for entries matching all of the concepts | |
exposures.anyOf |
query | array | No | Exposures - Filter for a matching set of concept codes | |
exposures.descendantsOf |
query | string | No | Exposures - Filter for all child concepts of a given concepts code | |
exposures.exists |
query | boolean | No | Exposures - Filter for entries with a value | |
exposures.not |
query | string | No | Exposures - Filter for a mismatching concept code | |
exposures.not.allOf |
query | array | No | Exposures - Filter for entries mismatching all of the concepts | |
exposures.not.anyOf |
query | array | No | Exposures - Filter for a mismmatching set of concept codes | |
exposures.not.exists |
query | boolean | No | Exposures - Filter for entries without a value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
nightSleep.between |
query | array | No | Night sleep - Filter for entries with values between two specified values (inclusive) | |
nightSleep.equal |
query | number | No | Night sleep - Filter for entries with values exactly equal to the specified value | |
nightSleep.exists |
query | boolean | No | Night sleep - Filter for entries with a value | |
nightSleep.greaterThan |
query | number | No | Night sleep - Filter for entries with values greater than the specified value | |
nightSleep.greaterThanOrEqual |
query | number | No | Night sleep - Filter for entries with values greater than or equal to the specified value | |
nightSleep.lessThan |
query | number | No | Night sleep - Filter for entries with values less than the specified value | |
nightSleep.lessThanOrEqual |
query | number | No | Night sleep - Filter for entries with values less than or equal to the specified value | |
nightSleep.not.between |
query | array | No | Night sleep - Filter for entries with values between two specified values (inclusive) | |
nightSleep.not.equal |
query | number | No | Night sleep - Filter for entries with values not equal to the specified value | |
nightSleep.not.exists |
query | boolean | No | Night sleep - Filter for entries without a value | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
recreationalDrugs |
query | string | No | Recreational drugs - Filter for a matching concept code | |
recreationalDrugs.allOf |
query | array | No | Recreational drugs - Filter for entries matching all of the concepts | |
recreationalDrugs.anyOf |
query | array | No | Recreational drugs - Filter for a matching set of concept codes | |
recreationalDrugs.descendantsOf |
query | string | No | Recreational drugs - Filter for all child concepts of a given concepts code | |
recreationalDrugs.exists |
query | boolean | No | Recreational drugs - Filter for entries with a value | |
recreationalDrugs.not |
query | string | No | Recreational drugs - Filter for a mismatching concept code | |
recreationalDrugs.not.allOf |
query | array | No | Recreational drugs - Filter for entries mismatching all of the concepts | |
recreationalDrugs.not.anyOf |
query | array | No | Recreational drugs - Filter for a mismmatching set of concept codes | |
recreationalDrugs.not.exists |
query | boolean | No | Recreational drugs - Filter for entries without a value | |
smokingPackyears.between |
query | array | No | Smoking packyears - Filter for entries with values between two specified values (inclusive) | |
smokingPackyears.equal |
query | number | No | Smoking packyears - Filter for entries with values exactly equal to the specified value | |
smokingPackyears.exists |
query | boolean | No | Smoking packyears - Filter for entries with a value | |
smokingPackyears.greaterThan |
query | number | No | Smoking packyears - Filter for entries with values greater than the specified value | |
smokingPackyears.greaterThanOrEqual |
query | number | No | Smoking packyears - Filter for entries with values greater than or equal to the specified value | |
smokingPackyears.lessThan |
query | number | No | Smoking packyears - Filter for entries with values less than the specified value | |
smokingPackyears.lessThanOrEqual |
query | number | No | Smoking packyears - Filter for entries with values less than or equal to the specified value | |
smokingPackyears.not.between |
query | array | No | Smoking packyears - Filter for entries with values between two specified values (inclusive) | |
smokingPackyears.not.equal |
query | number | No | Smoking packyears - Filter for entries with values not equal to the specified value | |
smokingPackyears.not.exists |
query | boolean | No | Smoking packyears - Filter for entries without a value | |
smokingQuited.between |
query | array | No | Time since quitted smoking - Filter for entries with values between two specified values (inclusive) | |
smokingQuited.equal |
query | number | No | Time since quitted smoking - Filter for entries with values exactly equal to the specified value | |
smokingQuited.exists |
query | boolean | No | Time since quitted smoking - Filter for entries with a value | |
smokingQuited.greaterThan |
query | number | No | Time since quitted smoking - Filter for entries with values greater than the specified value | |
smokingQuited.greaterThanOrEqual |
query | number | No | Time since quitted smoking - Filter for entries with values greater than or equal to the specified value | |
smokingQuited.lessThan |
query | number | No | Time since quitted smoking - Filter for entries with values less than the specified value | |
smokingQuited.lessThanOrEqual |
query | number | No | Time since quitted smoking - Filter for entries with values less than or equal to the specified value | |
smokingQuited.not.between |
query | array | No | Time since quitted smoking - Filter for entries with values between two specified values (inclusive) | |
smokingQuited.not.equal |
query | number | No | Time since quitted smoking - Filter for entries with values not equal to the specified value | |
smokingQuited.not.exists |
query | boolean | No | Time since quitted smoking - Filter for entries without a value | |
smokingStatus |
query | string | No | Smoking Status - Filter for a matching concept code | |
smokingStatus.anyOf |
query | array | No | Smoking Status - Filter for a matching set of concept codes | |
smokingStatus.descendantsOf |
query | string | No | Smoking Status - Filter for all child concepts of a given concepts code | |
smokingStatus.exists |
query | boolean | No | Smoking Status - Filter for entries with a value | |
smokingStatus.not |
query | string | No | Smoking Status - Filter for a mismatching concept code | |
smokingStatus.not.anyOf |
query | array | No | Smoking Status - Filter for a mismmatching set of concept codes | |
smokingStatus.not.exists |
query | boolean | No | Smoking Status - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "053bfedc-a051-4fbc-aad8-f1b998cfd5ef",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "bb6f5d94-35bf-4ab0-80d0-e7ccd33b5f03",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"exposures": null
}
]
}
POST /api/v1/lifestyles¶
Create Lifestyle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "6e71885b-ff0d-4f7e-8c38-69b8d83dc151",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"exposures": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's lifestyle is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the patient's lifetyle was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"smokingStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Tobacco consumption status",
"title": "Smoking Status",
"x-terminology": "SmokingStatus"
},
"smokingPackyears": {
"description": "Smoking pack-years (if applicable)",
"title": "Smoking packyears",
"type": "number"
},
"smokingQuited": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated time since quitting smoking (if applicable)",
"title": "Time since quitted smoking",
"x-default-unit": "year",
"x-measure": "Time"
},
"alcoholConsumption": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Frequency of alcohol consumption",
"title": "Alcohol consumption",
"x-terminology": "AlcoholConsumptionFrequency"
},
"nightSleep": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated average sleep time per night",
"title": "Night sleep",
"x-default-unit": "hour",
"x-measure": "Time"
},
"recreationalDrugs": {
"description": "Any recreational drug(s) used by the patient",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Recreational drugs",
"type": "array",
"x-terminology": "RecreationalDrug"
},
"exposures": {
"description": "Environmental or occupational exposures to hazards or carcinogenic agents",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Exposures",
"type": "array",
"x-terminology": "ExposureAgent"
}
},
"required": [
"caseId",
"date"
],
"title": "LifestyleCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/lifestyles/{lifestyleId}¶
Get Lifestyle By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
lifestyleId |
path | string | No |
Responses
{
"anonymized": true,
"id": "94fbfec1-ac29-4b0c-9848-8641a534f4fa",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "528d02a4-e5dd-475e-a7fc-09b7eb0bbc1b",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"exposures": null
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's lifestyle is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the patient's lifetyle was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"smokingStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Tobacco consumption status",
"title": "Smoking Status",
"x-terminology": "SmokingStatus"
},
"smokingPackyears": {
"description": "Smoking pack-years (if applicable)",
"title": "Smoking packyears",
"type": "number"
},
"smokingQuited": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated time since quitting smoking (if applicable)",
"title": "Time since quitted smoking",
"x-default-unit": "year",
"x-measure": "Time"
},
"alcoholConsumption": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Frequency of alcohol consumption",
"title": "Alcohol consumption",
"x-terminology": "AlcoholConsumptionFrequency"
},
"nightSleep": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated average sleep time per night",
"title": "Night sleep",
"x-default-unit": "hour",
"x-measure": "Time"
},
"recreationalDrugs": {
"description": "Any recreational drug(s) used by the patient",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Recreational drugs",
"type": "array",
"x-terminology": "RecreationalDrug"
},
"exposures": {
"description": "Environmental or occupational exposures to hazards or carcinogenic agents",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Exposures",
"type": "array",
"x-terminology": "ExposureAgent"
}
},
"required": [
"id",
"description",
"caseId",
"date"
],
"title": "Lifestyle",
"type": "object"
}
PUT /api/v1/lifestyles/{lifestyleId}¶
Update Lifestyle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
lifestyleId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9ec7ae51-b3da-4658-8dcc-4c62ba23dcd4",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"exposures": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's lifestyle is assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the patient's lifetyle was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"smokingStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Tobacco consumption status",
"title": "Smoking Status",
"x-terminology": "SmokingStatus"
},
"smokingPackyears": {
"description": "Smoking pack-years (if applicable)",
"title": "Smoking packyears",
"type": "number"
},
"smokingQuited": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated time since quitting smoking (if applicable)",
"title": "Time since quitted smoking",
"x-default-unit": "year",
"x-measure": "Time"
},
"alcoholConsumption": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Frequency of alcohol consumption",
"title": "Alcohol consumption",
"x-terminology": "AlcoholConsumptionFrequency"
},
"nightSleep": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Estimated average sleep time per night",
"title": "Night sleep",
"x-default-unit": "hour",
"x-measure": "Time"
},
"recreationalDrugs": {
"description": "Any recreational drug(s) used by the patient",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Recreational drugs",
"type": "array",
"x-terminology": "RecreationalDrug"
},
"exposures": {
"description": "Environmental or occupational exposures to hazards or carcinogenic agents",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Exposures",
"type": "array",
"x-terminology": "ExposureAgent"
}
},
"required": [
"caseId",
"date"
],
"title": "LifestyleCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/lifestyles/{lifestyleId}¶
Delete Lifestyle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
lifestyleId |
path | string | No |
Responses
GET /api/v1/lifestyles/{lifestyleId}/history/events¶
Get All Lifestyle History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
lifestyleId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/lifestyles/{lifestyleId}/history/events/{eventId}¶
Get Lifestyle History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
lifestyleId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/lifestyles/{lifestyleId}/history/events/{eventId}/reversion¶
Revert Lifestyle To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
lifestyleId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Family Histories¶
GET /api/v1/family-histories¶
Get All Family Member Histories Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
contributedToDeath |
query | boolean | No | Contributed to death - Filter for yes/no statement | |
contributedToDeath.exists |
query | boolean | No | Contributed to death - Filter for entries with a value | |
contributedToDeath.not.exists |
query | boolean | No | Contributed to death - Filter for entries without a value | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
hadCancer |
query | boolean | No | Had cancer - Filter for yes/no statement | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
isDeceased |
query | boolean | No | Is deceased - Filter for yes/no statement | |
isDeceased.exists |
query | boolean | No | Is deceased - Filter for entries with a value | |
isDeceased.not.exists |
query | boolean | No | Is deceased - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
morphology |
query | string | No | Morphology - Filter for a matching concept code | |
morphology.anyOf |
query | array | No | Morphology - Filter for a matching set of concept codes | |
morphology.descendantsOf |
query | string | No | Morphology - Filter for all child concepts of a given concepts code | |
morphology.exists |
query | boolean | No | Morphology - Filter for entries with a value | |
morphology.not |
query | string | No | Morphology - Filter for a mismatching concept code | |
morphology.not.anyOf |
query | array | No | Morphology - Filter for a mismmatching set of concept codes | |
morphology.not.exists |
query | boolean | No | Morphology - Filter for entries without a value | |
offset |
query | integer | 0 | No | |
onsetAge.between |
query | array | No | Onset age - Filter for entries with values between two specified values (inclusive) | |
onsetAge.equal |
query | integer | No | Onset age - Filter for entries with values exactly equal to the specified value | |
onsetAge.exists |
query | boolean | No | Onset age - Filter for entries with a value | |
onsetAge.greaterThan |
query | integer | No | Onset age - Filter for entries with values greater than the specified value | |
onsetAge.greaterThanOrEqual |
query | integer | No | Onset age - Filter for entries with values greater than or equal to the specified value | |
onsetAge.lessThan |
query | integer | No | Onset age - Filter for entries with values less than the specified value | |
onsetAge.lessThanOrEqual |
query | integer | No | Onset age - Filter for entries with values less than or equal to the specified value | |
onsetAge.not.between |
query | array | No | Onset age - Filter for entries with values between two specified values (inclusive) | |
onsetAge.not.equal |
query | integer | No | Onset age - Filter for entries with values not equal to the specified value | |
onsetAge.not.exists |
query | boolean | No | Onset age - Filter for entries without a value | |
ordering |
query | No | |||
relationship |
query | string | No | Relationship - Filter for a matching concept code | |
relationship.anyOf |
query | array | No | Relationship - Filter for a matching set of concept codes | |
relationship.descendantsOf |
query | string | No | Relationship - Filter for all child concepts of a given concepts code | |
relationship.not |
query | string | No | Relationship - Filter for a mismatching concept code | |
relationship.not.anyOf |
query | array | No | Relationship - Filter for a mismmatching set of concept codes | |
topography |
query | string | No | Topography - Filter for a matching concept code | |
topography.anyOf |
query | array | No | Topography - Filter for a matching set of concept codes | |
topography.descendantsOf |
query | string | No | Topography - Filter for all child concepts of a given concepts code | |
topography.exists |
query | boolean | No | Topography - Filter for entries with a value | |
topography.not |
query | string | No | Topography - Filter for a mismatching concept code | |
topography.not.anyOf |
query | array | No | Topography - Filter for a mismmatching set of concept codes | |
topography.not.exists |
query | boolean | No | Topography - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "56392ecc-f198-4847-85fc-f00fb7f7a021",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c0f6b521-e491-4904-9543-12d14c79bc51",
"date": "2022-04-13",
"relationship": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"hadCancer": true,
"isDeceased": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null
}
]
}
POST /api/v1/family-histories¶
Create Family History
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b342ca83-a557-43c7-8b52-249f50e7bedb",
"date": "2022-04-13",
"relationship": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"hadCancer": true,
"isDeceased": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's family's history is being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the patient's family history was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"relationship": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Relationship to the patient",
"title": "Relationship",
"x-terminology": "FamilyMemberType"
},
"hadCancer": {
"description": "Whether the family member has a history of cancer",
"title": "Had cancer",
"type": "boolean"
},
"isDeceased": {
"description": "Whether the the family member is deceased",
"title": "Is deceased",
"type": "boolean"
},
"contributedToDeath": {
"description": "Whether the cancer contributed to the cause of death of the family member",
"title": "Contributed to death",
"type": "boolean"
},
"onsetAge": {
"description": "Age at which the family member's cancer manifested",
"title": "Onset age",
"type": "integer"
},
"topography": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Estimated or actual topography of the family member's cancer",
"title": "Topography",
"x-terminology": "CancerTopography"
},
"morphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the family member's cancer (if known)",
"title": "Morphology",
"x-terminology": "CancerMorphology"
}
},
"required": [
"caseId",
"date",
"relationship",
"hadCancer"
],
"title": "FamilyHistoryCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/family-histories/{familyHistoryId}¶
Get Family History By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
familyHistoryId |
path | string | No |
Responses
{
"anonymized": true,
"id": "17ce8a06-0a8b-4245-8a68-073bec798575",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5dfc0920-c084-4d79-a3b8-92dcbb9448de",
"date": "2022-04-13",
"relationship": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"hadCancer": true,
"isDeceased": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's family's history is being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the patient's family history was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"relationship": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Relationship to the patient",
"title": "Relationship",
"x-terminology": "FamilyMemberType"
},
"hadCancer": {
"description": "Whether the family member has a history of cancer",
"title": "Had cancer",
"type": "boolean"
},
"isDeceased": {
"description": "Whether the the family member is deceased",
"title": "Is deceased",
"type": "boolean"
},
"contributedToDeath": {
"description": "Whether the cancer contributed to the cause of death of the family member",
"title": "Contributed to death",
"type": "boolean"
},
"onsetAge": {
"description": "Age at which the family member's cancer manifested",
"title": "Onset age",
"type": "integer"
},
"topography": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Estimated or actual topography of the family member's cancer",
"title": "Topography",
"x-terminology": "CancerTopography"
},
"morphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the family member's cancer (if known)",
"title": "Morphology",
"x-terminology": "CancerMorphology"
}
},
"required": [
"id",
"description",
"caseId",
"date",
"relationship",
"hadCancer"
],
"title": "FamilyHistory",
"type": "object"
}
DELETE /api/v1/family-histories/{familyHistoryId}¶
Delete Family History
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
familyHistoryId |
path | string | No |
Responses
PUT /api/v1/family-histories/{familyHistoryId}¶
Update Family History
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
familyHistoryId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "59dbf538-0105-46c4-b56a-35d4d8959f73",
"date": "2022-04-13",
"relationship": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"hadCancer": true,
"isDeceased": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's family's history is being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the patient's family history was assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"relationship": {
"$ref": "#/components/schemas/CodedConcept",
"description": "Relationship to the patient",
"title": "Relationship",
"x-terminology": "FamilyMemberType"
},
"hadCancer": {
"description": "Whether the family member has a history of cancer",
"title": "Had cancer",
"type": "boolean"
},
"isDeceased": {
"description": "Whether the the family member is deceased",
"title": "Is deceased",
"type": "boolean"
},
"contributedToDeath": {
"description": "Whether the cancer contributed to the cause of death of the family member",
"title": "Contributed to death",
"type": "boolean"
},
"onsetAge": {
"description": "Age at which the family member's cancer manifested",
"title": "Onset age",
"type": "integer"
},
"topography": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Estimated or actual topography of the family member's cancer",
"title": "Topography",
"x-terminology": "CancerTopography"
},
"morphology": {
"allOf": [
{
"$ref": "#/components/schemas/CodedConcept"
}
],
"description": "Morphology of the family member's cancer (if known)",
"title": "Morphology",
"x-terminology": "CancerMorphology"
}
},
"required": [
"caseId",
"date",
"relationship",
"hadCancer"
],
"title": "FamilyHistoryCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/family-histories/{familyHistoryId}/history/events¶
Get All Family History History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
familyHistoryId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/family-histories/{familyHistoryId}/history/events/{eventId}¶
Get Family History History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
familyHistoryId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/family-histories/{familyHistoryId}/history/events/{eventId}/reversion¶
Revert Family History To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
familyHistoryId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Comorbidities Assessments¶
GET /api/v1/comorbidities-assessments¶
Get All Comorbidities Assessments Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
absentConditions |
query | string | No | Absent comorbid conditions - Filter for a matching concept code | |
absentConditions.allOf |
query | array | No | Absent comorbid conditions - Filter for entries matching all of the concepts | |
absentConditions.anyOf |
query | array | No | Absent comorbid conditions - Filter for a matching set of concept codes | |
absentConditions.descendantsOf |
query | string | No | Absent comorbid conditions - Filter for all child concepts of a given concepts code | |
absentConditions.exists |
query | boolean | No | Absent comorbid conditions - Filter for entries with a value | |
absentConditions.not |
query | string | No | Absent comorbid conditions - Filter for a mismatching concept code | |
absentConditions.not.allOf |
query | array | No | Absent comorbid conditions - Filter for entries mismatching all of the concepts | |
absentConditions.not.anyOf |
query | array | No | Absent comorbid conditions - Filter for a mismmatching set of concept codes | |
absentConditions.not.exists |
query | boolean | No | Absent comorbid conditions - Filter for entries without a value | |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
indexConditionId |
query | string | No | Index neoplastic entity - Filter for reference matches | |
indexConditionId.anyOf |
query | array | No | Index neoplastic entity - Filter for entries where at least one reference matches the query | |
indexConditionId.beginsWith |
query | string | No | Index neoplastic entity - Filter for entries starting with the text | |
indexConditionId.contains |
query | string | No | Index neoplastic entity - Filter for partial text matches | |
indexConditionId.endsWith |
query | string | No | Index neoplastic entity - Filter for entries ending with the text | |
indexConditionId.not |
query | string | No | Index neoplastic entity - Filter for reference mismatches | |
indexConditionId.not.anyOf |
query | array | No | Index neoplastic entity - Filter for entries where at least one reference mismatches the query | |
indexConditionId.not.beginsWith |
query | string | No | Index neoplastic entity - Filter for entries not starting with the text | |
indexConditionId.not.contains |
query | string | No | Index neoplastic entity - Filter for partial text mismatches | |
indexConditionId.not.endsWith |
query | string | No | Index neoplastic entity - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
panel |
query | No | Panel - Filter for single value choice | ||
panel.anyOf |
query | array | No | Panel - ('Filter for excluding a subset of value choices',) | |
panel.exists |
query | boolean | No | Panel - Filter for entries with a value | |
panel.not |
query | No | Panel - ('Filter for all but a single value choice',) | ||
panel.not.exists |
query | boolean | No | Panel - Filter for entries without a value | |
presentConditions |
query | string | No | Present comorbid conditions - Filter for a matching concept code | |
presentConditions.allOf |
query | array | No | Present comorbid conditions - Filter for entries matching all of the concepts | |
presentConditions.anyOf |
query | array | No | Present comorbid conditions - Filter for a matching set of concept codes | |
presentConditions.descendantsOf |
query | string | No | Present comorbid conditions - Filter for all child concepts of a given concepts code | |
presentConditions.exists |
query | boolean | No | Present comorbid conditions - Filter for entries with a value | |
presentConditions.not |
query | string | No | Present comorbid conditions - Filter for a mismatching concept code | |
presentConditions.not.allOf |
query | array | No | Present comorbid conditions - Filter for entries mismatching all of the concepts | |
presentConditions.not.anyOf |
query | array | No | Present comorbid conditions - Filter for a mismmatching set of concept codes | |
presentConditions.not.exists |
query | boolean | No | Present comorbid conditions - Filter for entries without a value | |
score.between |
query | array | No | Score - Filter for entries with values between two specified values (inclusive) | |
score.equal |
query | integer | No | Score - Filter for entries with values exactly equal to the specified value | |
score.exists |
query | boolean | No | Score - Filter for entries with a value | |
score.greaterThan |
query | integer | No | Score - Filter for entries with values greater than the specified value | |
score.greaterThanOrEqual |
query | integer | No | Score - Filter for entries with values greater than or equal to the specified value | |
score.lessThan |
query | integer | No | Score - Filter for entries with values less than the specified value | |
score.lessThanOrEqual |
query | integer | No | Score - Filter for entries with values less than or equal to the specified value | |
score.not.between |
query | array | No | Score - Filter for entries with values between two specified values (inclusive) | |
score.not.equal |
query | integer | No | Score - Filter for entries with values not equal to the specified value | |
score.not.exists |
query | boolean | No | Score - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "c9ece3a0-0d9e-48f6-b60e-45e0a1339df7",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "53616e19-d6ea-47fd-9b6c-2c9e91b71382",
"date": "2022-04-13",
"indexConditionId": "50199e35-9e64-4096-bbc3-9263280cddd5",
"panel": null,
"presentConditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"absentConditions": null,
"score": null
}
]
}
Schema of the response body
POST /api/v1/comorbidities-assessments¶
Create Comorbidities Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "48b75b36-0737-4341-b308-086c51f0972c",
"date": "2022-04-13",
"indexConditionId": "932e7fe9-fc9c-4705-9f1c-ab9d2ee1cf6c",
"panel": null,
"presentConditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"absentConditions": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's comorbidities are being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the patient's comorbidities were assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"indexConditionId": {
"description": "The primary neoplastic entity against which comorbidities are assessed",
"format": "uuid",
"title": "Index neoplastic entity",
"type": "string"
},
"panel": {
"allOf": [
{
"$ref": "#/components/schemas/ComorbiditiesAssessmentPanelChoices"
}
],
"description": "Comorbidities panel",
"title": "Panel"
},
"presentConditions": {
"description": "Present comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Present comorbid conditions",
"type": "array",
"x-terminology": "ICD10Condition"
},
"absentConditions": {
"description": "Absent comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Absent comorbid conditions",
"type": "array",
"x-terminology": "ICD10Condition"
}
},
"required": [
"caseId",
"date",
"indexConditionId"
],
"title": "ComorbiditiesAssessmentCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}¶
Get Comorbidities Assessment By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
comorbiditiesAssessmentId |
path | string | No |
Responses
{
"anonymized": true,
"id": "fb28634f-2b99-4159-a45a-55d007a7c596",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "94a4adeb-50dd-47f3-985f-6eb474833c5b",
"date": "2022-04-13",
"indexConditionId": "2558958a-b57a-4e04-a57a-c4cea6ea9de5",
"panel": null,
"presentConditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"absentConditions": null,
"score": null
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's comorbidities are being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the patient's comorbidities were assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"indexConditionId": {
"description": "The primary neoplastic entity against which comorbidities are assessed",
"format": "uuid",
"title": "Index neoplastic entity",
"type": "string"
},
"panel": {
"allOf": [
{
"$ref": "#/components/schemas/ComorbiditiesAssessmentPanelChoices"
}
],
"description": "Comorbidities panel",
"title": "Panel"
},
"presentConditions": {
"description": "Present comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Present comorbid conditions",
"type": "array",
"x-terminology": "ICD10Condition"
},
"absentConditions": {
"description": "Absent comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Absent comorbid conditions",
"type": "array",
"x-terminology": "ICD10Condition"
},
"score": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Comorbidity score",
"title": "Score"
}
},
"required": [
"id",
"description",
"caseId",
"date",
"indexConditionId"
],
"title": "ComorbiditiesAssessment",
"type": "object"
}
DELETE /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}¶
Delete Comorbidities Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
comorbiditiesAssessmentId |
path | string | No |
Responses
PUT /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}¶
Update Comorbidities Assessment
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
comorbiditiesAssessmentId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0ddd1afc-f3b6-4b99-89bd-907e40d6c9ac",
"date": "2022-04-13",
"indexConditionId": "c4561439-4a07-4c64-9369-6e8e31892e5c",
"panel": null,
"presentConditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
],
"absentConditions": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's comorbidities are being recorded",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the patient's comorbidities were assessed and recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"indexConditionId": {
"description": "The primary neoplastic entity against which comorbidities are assessed",
"format": "uuid",
"title": "Index neoplastic entity",
"type": "string"
},
"panel": {
"allOf": [
{
"$ref": "#/components/schemas/ComorbiditiesAssessmentPanelChoices"
}
],
"description": "Comorbidities panel",
"title": "Panel"
},
"presentConditions": {
"description": "Present comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Present comorbid conditions",
"type": "array",
"x-terminology": "ICD10Condition"
},
"absentConditions": {
"description": "Absent comorbid conditions",
"items": {
"$ref": "#/components/schemas/CodedConcept"
},
"title": "Absent comorbid conditions",
"type": "array",
"x-terminology": "ICD10Condition"
}
},
"required": [
"caseId",
"date",
"indexConditionId"
],
"title": "ComorbiditiesAssessmentCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}/history/events¶
Get All Comorbidities Assessment History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
comorbiditiesAssessmentId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}/history/events/{eventId}¶
Get Comorbidities Assessment History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
comorbiditiesAssessmentId |
path | string | No | ||
eventId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}/history/events/{eventId}/reversion¶
Revert Comorbidities Assessment To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
comorbiditiesAssessmentId |
path | string | No | ||
eventId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/comorbidities-assessments/meta/panels¶
Get All Comorbidities Panels
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Responses
[
{
"name": "string",
"categories": [
{
"label": "string",
"default": null,
"conditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
]
}
]
}
]
GET /api/v1/comorbidities-assessments/meta/panels/{panel}¶
Get Comorbidities Panel By Name
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
panel |
path | string | No | An enumeration of comorbidity panel types used in oncology models. Attributes: CHARLSON: Represents the Charlson comorbidity index panel. ELIXHAUSER: Represents the Elixhauser comorbidity index panel. NCI: Represents the National Cancer Institute (NCI) comorbidity index panel. |
Responses
{
"name": "string",
"categories": [
{
"label": "string",
"default": null,
"conditions": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
]
}
]
}
Schema of the response body
{
"properties": {
"name": {
"description": "Comorbidity panel name",
"title": "Name",
"type": "string"
},
"categories": {
"description": "Comorbidity panel categories",
"items": {
"$ref": "#/components/schemas/ComorbidityPanelCategory"
},
"title": "Categories",
"type": "array"
}
},
"required": [
"name",
"categories"
],
"title": "ComorbiditiesPanel",
"type": "object"
}
Vitals¶
GET /api/v1/vitals¶
Get All Vitals Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
bloodPressureDiastolic.between |
query | array | No | Diastolic blood pressure - Filter for entries with values between two specified values (inclusive) | |
bloodPressureDiastolic.equal |
query | number | No | Diastolic blood pressure - Filter for entries with values exactly equal to the specified value | |
bloodPressureDiastolic.exists |
query | boolean | No | Diastolic blood pressure - Filter for entries with a value | |
bloodPressureDiastolic.greaterThan |
query | number | No | Diastolic blood pressure - Filter for entries with values greater than the specified value | |
bloodPressureDiastolic.greaterThanOrEqual |
query | number | No | Diastolic blood pressure - Filter for entries with values greater than or equal to the specified value | |
bloodPressureDiastolic.lessThan |
query | number | No | Diastolic blood pressure - Filter for entries with values less than the specified value | |
bloodPressureDiastolic.lessThanOrEqual |
query | number | No | Diastolic blood pressure - Filter for entries with values less than or equal to the specified value | |
bloodPressureDiastolic.not.between |
query | array | No | Diastolic blood pressure - Filter for entries with values between two specified values (inclusive) | |
bloodPressureDiastolic.not.equal |
query | number | No | Diastolic blood pressure - Filter for entries with values not equal to the specified value | |
bloodPressureDiastolic.not.exists |
query | boolean | No | Diastolic blood pressure - Filter for entries without a value | |
bloodPressureSystolic.between |
query | array | No | Systolic blood pressure - Filter for entries with values between two specified values (inclusive) | |
bloodPressureSystolic.equal |
query | number | No | Systolic blood pressure - Filter for entries with values exactly equal to the specified value | |
bloodPressureSystolic.exists |
query | boolean | No | Systolic blood pressure - Filter for entries with a value | |
bloodPressureSystolic.greaterThan |
query | number | No | Systolic blood pressure - Filter for entries with values greater than the specified value | |
bloodPressureSystolic.greaterThanOrEqual |
query | number | No | Systolic blood pressure - Filter for entries with values greater than or equal to the specified value | |
bloodPressureSystolic.lessThan |
query | number | No | Systolic blood pressure - Filter for entries with values less than the specified value | |
bloodPressureSystolic.lessThanOrEqual |
query | number | No | Systolic blood pressure - Filter for entries with values less than or equal to the specified value | |
bloodPressureSystolic.not.between |
query | array | No | Systolic blood pressure - Filter for entries with values between two specified values (inclusive) | |
bloodPressureSystolic.not.equal |
query | number | No | Systolic blood pressure - Filter for entries with values not equal to the specified value | |
bloodPressureSystolic.not.exists |
query | boolean | No | Systolic blood pressure - Filter for entries without a value | |
bodyMassIndex.between |
query | array | No | Body mass index - Filter for entries with values between two specified values (inclusive) | |
bodyMassIndex.equal |
query | number | No | Body mass index - Filter for entries with values exactly equal to the specified value | |
bodyMassIndex.exists |
query | boolean | No | Body mass index - Filter for entries with a value | |
bodyMassIndex.greaterThan |
query | number | No | Body mass index - Filter for entries with values greater than the specified value | |
bodyMassIndex.greaterThanOrEqual |
query | number | No | Body mass index - Filter for entries with values greater than or equal to the specified value | |
bodyMassIndex.lessThan |
query | number | No | Body mass index - Filter for entries with values less than the specified value | |
bodyMassIndex.lessThanOrEqual |
query | number | No | Body mass index - Filter for entries with values less than or equal to the specified value | |
bodyMassIndex.not.between |
query | array | No | Body mass index - Filter for entries with values between two specified values (inclusive) | |
bodyMassIndex.not.equal |
query | number | No | Body mass index - Filter for entries with values not equal to the specified value | |
bodyMassIndex.not.exists |
query | boolean | No | Body mass index - Filter for entries without a value | |
caseId |
query | string | No | Patient case - Filter for reference matches | |
caseId.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference matches the query | |
caseId.beginsWith |
query | string | No | Patient case - Filter for entries starting with the text | |
caseId.contains |
query | string | No | Patient case - Filter for partial text matches | |
caseId.endsWith |
query | string | No | Patient case - Filter for entries ending with the text | |
caseId.not |
query | string | No | Patient case - Filter for reference mismatches | |
caseId.not.anyOf |
query | array | No | Patient case - Filter for entries where at least one reference mismatches the query | |
caseId.not.beginsWith |
query | string | No | Patient case - Filter for entries not starting with the text | |
caseId.not.contains |
query | string | No | Patient case - Filter for partial text mismatches | |
caseId.not.endsWith |
query | string | No | Patient case - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
date.after |
query | string | No | Assessment date - Filter for entries with dates after the specified value | |
date.before |
query | string | No | Assessment date - Filter for entries with dates before the specified value | |
date.between |
query | array | No | Assessment date - Filter for entries with dates between two specified values (inclusive) | |
date.not.between |
query | array | No | Assessment date - Filter for entries with dates not between two specified values (inclusive) | |
date.not.on |
query | string | No | Assessment date - Filter for entries with dates not matching the specified value | |
date.on |
query | string | No | Assessment date - Filter for entries with dates exactly matching the specified value | |
date.onOrAfter |
query | string | No | Assessment date - Filter for entries with dates on or after the specified value | |
date.onOrBefore |
query | string | No | Assessment date - Filter for entries with dates on or before the specified value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
height.between |
query | array | No | Height - Filter for entries with values between two specified values (inclusive) | |
height.equal |
query | number | No | Height - Filter for entries with values exactly equal to the specified value | |
height.exists |
query | boolean | No | Height - Filter for entries with a value | |
height.greaterThan |
query | number | No | Height - Filter for entries with values greater than the specified value | |
height.greaterThanOrEqual |
query | number | No | Height - Filter for entries with values greater than or equal to the specified value | |
height.lessThan |
query | number | No | Height - Filter for entries with values less than the specified value | |
height.lessThanOrEqual |
query | number | No | Height - Filter for entries with values less than or equal to the specified value | |
height.not.between |
query | array | No | Height - Filter for entries with values between two specified values (inclusive) | |
height.not.equal |
query | number | No | Height - Filter for entries with values not equal to the specified value | |
height.not.exists |
query | boolean | No | Height - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
temperature.between |
query | array | No | Temperature - Filter for entries with values between two specified values (inclusive) | |
temperature.equal |
query | number | No | Temperature - Filter for entries with values exactly equal to the specified value | |
temperature.exists |
query | boolean | No | Temperature - Filter for entries with a value | |
temperature.greaterThan |
query | number | No | Temperature - Filter for entries with values greater than the specified value | |
temperature.greaterThanOrEqual |
query | number | No | Temperature - Filter for entries with values greater than or equal to the specified value | |
temperature.lessThan |
query | number | No | Temperature - Filter for entries with values less than the specified value | |
temperature.lessThanOrEqual |
query | number | No | Temperature - Filter for entries with values less than or equal to the specified value | |
temperature.not.between |
query | array | No | Temperature - Filter for entries with values between two specified values (inclusive) | |
temperature.not.equal |
query | number | No | Temperature - Filter for entries with values not equal to the specified value | |
temperature.not.exists |
query | boolean | No | Temperature - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value | |
weight.between |
query | array | No | Weight - Filter for entries with values between two specified values (inclusive) | |
weight.equal |
query | number | No | Weight - Filter for entries with values exactly equal to the specified value | |
weight.exists |
query | boolean | No | Weight - Filter for entries with a value | |
weight.greaterThan |
query | number | No | Weight - Filter for entries with values greater than the specified value | |
weight.greaterThanOrEqual |
query | number | No | Weight - Filter for entries with values greater than or equal to the specified value | |
weight.lessThan |
query | number | No | Weight - Filter for entries with values less than the specified value | |
weight.lessThanOrEqual |
query | number | No | Weight - Filter for entries with values less than or equal to the specified value | |
weight.not.between |
query | array | No | Weight - Filter for entries with values between two specified values (inclusive) | |
weight.not.equal |
query | number | No | Weight - Filter for entries with values not equal to the specified value | |
weight.not.exists |
query | boolean | No | Weight - Filter for entries without a value |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "e78a64fd-c804-4cba-bd0b-8a6a300ab0d7",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "70e1e37d-e7a5-420b-b231-28d32b698985",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"bodyMassIndex": null
}
]
}
POST /api/v1/vitals¶
Create Vitals
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9c551b0b-b28c-416c-8e75-cd31bcaa62f5",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's vitals are assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the vitals were recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"height": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Height of the patient",
"title": "Height",
"x-default-unit": "m",
"x-measure": "Distance"
},
"weight": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Weight of the patient",
"title": "Weight",
"x-default-unit": "kg",
"x-measure": "Mass"
},
"bloodPressureSystolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Systolic blood pressure of the patient",
"title": "Systolic blood pressure",
"x-default-unit": "mmHg",
"x-measure": "Pressure"
},
"bloodPressureDiastolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Diastolic blood pressure of the patient",
"title": "Diastolic blood pressure",
"x-default-unit": "mmHg",
"x-measure": "Pressure"
},
"temperature": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Temperature of the patient",
"title": "Temperature",
"x-default-unit": "celsius",
"x-measure": "Temperature"
}
},
"required": [
"caseId",
"date"
],
"title": "VitalsCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/vitals/{vitalsId}¶
Get Vitals By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
vitalsId |
path | string | No |
Responses
{
"anonymized": true,
"id": "ece3a28e-6a0a-4bad-83a3-04da9e95a95d",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "aa15b68e-cd0e-44d0-839b-da39397067df",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"bodyMassIndex": null
}
Schema of the response body
{
"properties": {
"anonymized": {
"default": false,
"description": "Whether the data has been anonymized",
"title": "Is anonymized",
"type": "boolean"
},
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's vitals are assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the vitals were recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"height": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Height of the patient",
"title": "Height",
"x-default-unit": "m",
"x-measure": "Distance"
},
"weight": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Weight of the patient",
"title": "Weight",
"x-default-unit": "kg",
"x-measure": "Mass"
},
"bloodPressureSystolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Systolic blood pressure of the patient",
"title": "Systolic blood pressure",
"x-default-unit": "mmHg",
"x-measure": "Pressure"
},
"bloodPressureDiastolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Diastolic blood pressure of the patient",
"title": "Diastolic blood pressure",
"x-default-unit": "mmHg",
"x-measure": "Pressure"
},
"temperature": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Temperature of the patient",
"title": "Temperature",
"x-default-unit": "celsius",
"x-measure": "Temperature"
},
"bodyMassIndex": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Bodymass index of the patient",
"title": "Body mass index",
"x-measure": "MassPerArea"
}
},
"required": [
"id",
"description",
"caseId",
"date"
],
"title": "Vitals",
"type": "object"
}
PUT /api/v1/vitals/{vitalsId}¶
Update Vitals
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
vitalsId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"caseId": "523d4989-a940-4378-80de-e62f7cdec9a9",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"caseId": {
"description": "Indicates the case of the patient who's vitals are assesed",
"format": "uuid",
"title": "Patient case",
"type": "string"
},
"date": {
"description": "Clinically-relevant date at which the vitals were recorded.",
"format": "date",
"title": "Assessment date",
"type": "string"
},
"height": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Height of the patient",
"title": "Height",
"x-default-unit": "m",
"x-measure": "Distance"
},
"weight": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Weight of the patient",
"title": "Weight",
"x-default-unit": "kg",
"x-measure": "Mass"
},
"bloodPressureSystolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Systolic blood pressure of the patient",
"title": "Systolic blood pressure",
"x-default-unit": "mmHg",
"x-measure": "Pressure"
},
"bloodPressureDiastolic": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Diastolic blood pressure of the patient",
"title": "Diastolic blood pressure",
"x-default-unit": "mmHg",
"x-measure": "Pressure"
},
"temperature": {
"allOf": [
{
"$ref": "#/components/schemas/Measure"
}
],
"description": "Temperature of the patient",
"title": "Temperature",
"x-default-unit": "celsius",
"x-measure": "Temperature"
}
},
"required": [
"caseId",
"date"
],
"title": "VitalsCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
DELETE /api/v1/vitals/{vitalsId}¶
Delete Vitals
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
vitalsId |
path | string | No |
Responses
GET /api/v1/vitals/{vitalsId}/history/events¶
Get All Vitals History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
vitalsId |
path | string | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/vitals/{vitalsId}/history/events/{eventId}¶
Get Vitals History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
vitalsId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/vitals/{vitalsId}/history/events/{eventId}/reversion¶
Revert Vitals To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
eventId |
path | string | No | ||
vitalsId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Measures¶
GET /api/v1/measures/{measureName}/units¶
Get Measure Units
Description
Retrieves the available units for a specified measure.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
measureName |
path | string | No |
Responses
GET /api/v1/measures/{measureName}/units/default¶
Get Measure Default Units
Description
Retrieves the default unit for a specified measure.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
measureName |
path | string | No |
Responses
POST /api/v1/measures/{measureName}/units/conversion¶
Convert Units
Description
Converts a measurement from one unit to another using the specified measure class.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
measureName |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"description": "Represents a measure value and its intended conversion to a new unit.\n\nAttributes:\n value (float): The numerical value of the measure.\n unit (str): The unit of the measure.\n newUnit (str): The new unit to convert the measure to.",
"properties": {
"value": {
"description": "The numerical value of the measure to be converted.",
"title": "Value",
"type": "number"
},
"unit": {
"description": "The current unit of the measure.",
"title": "Original Unit",
"type": "string"
},
"newUnit": {
"description": "The target unit to convert the measure into.",
"title": "New Unit",
"type": "string"
}
},
"required": [
"value",
"unit",
"newUnit"
],
"title": "MeasureConversion",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a measurable quantity with its value and unit.\n\nAttributes:\n value (float): The numerical value of the measure.\n unit (str): The unit in which the value is expressed.",
"properties": {
"value": {
"description": "The numerical value of the measure.",
"title": "Value",
"type": "number"
},
"unit": {
"description": "The unit of measurement (e.g., 'kg', 'm', 'ml').",
"title": "Unit",
"type": "string"
}
},
"required": [
"value",
"unit"
],
"title": "Measure",
"type": "object"
}
Terminology¶
GET /api/v1/terminologies/{terminologyName}/concepts¶
Get Terminology Concepts
Description
Retrieves terminology concepts from the specified terminology, applying optional filters and search criteria.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
codes |
query | No | |||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
query |
query | No | |||
terminologyName |
path | string | No |
Responses
Cohorts¶
GET /api/v1/cohorts¶
Get All Cohorts Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
casesIds |
query | string | No | Cases - Filter for full text matches | |
casesIds.anyOf |
query | array | No | Cases - Filter for entries where at least one reference matches the query | |
casesIds.beginsWith |
query | string | No | Cases - Filter for entries starting with the text | |
casesIds.contains |
query | string | No | Cases - Filter for partial text matches | |
casesIds.endsWith |
query | string | No | Cases - Filter for entries ending with the text | |
casesIds.exists |
query | boolean | No | Cases - Filter for entries with a value | |
casesIds.not |
query | string | No | Cases - Filter for full text mismatches | |
casesIds.not.anyOf |
query | array | No | Cases - Filter for entries where at least one reference mismatches the query | |
casesIds.not.beginsWith |
query | string | No | Cases - Filter for entries not starting with the text | |
casesIds.not.contains |
query | string | No | Cases - Filter for partial text mismatches | |
casesIds.not.endsWith |
query | string | No | Cases - Filter for entries not ending with the text | |
casesIds.not.exists |
query | boolean | No | Cases - Filter for entries without a value | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
createdBy |
query | string | No | Filter for a particular cohort creator by its username | |
excludeCriteria.exists |
query | boolean | No | Exclusion critera - Filter for entries with a value | |
excludeCriteria.not.exists |
query | boolean | No | Exclusion critera - Filter for entries without a value | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
frozenSetIds |
query | string | No | Frozen cases - Filter for full text matches | |
frozenSetIds.anyOf |
query | array | No | Frozen cases - Filter for entries where at least one reference matches the query | |
frozenSetIds.beginsWith |
query | string | No | Frozen cases - Filter for entries starting with the text | |
frozenSetIds.contains |
query | string | No | Frozen cases - Filter for partial text matches | |
frozenSetIds.endsWith |
query | string | No | Frozen cases - Filter for entries ending with the text | |
frozenSetIds.exists |
query | boolean | No | Frozen cases - Filter for entries with a value | |
frozenSetIds.not |
query | string | No | Frozen cases - Filter for full text mismatches | |
frozenSetIds.not.anyOf |
query | array | No | Frozen cases - Filter for entries where at least one reference mismatches the query | |
frozenSetIds.not.beginsWith |
query | string | No | Frozen cases - Filter for entries not starting with the text | |
frozenSetIds.not.contains |
query | string | No | Frozen cases - Filter for partial text mismatches | |
frozenSetIds.not.endsWith |
query | string | No | Frozen cases - Filter for entries not ending with the text | |
frozenSetIds.not.exists |
query | boolean | No | Frozen cases - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
includeCriteria.exists |
query | boolean | No | Inclusion critera - Filter for entries with a value | |
includeCriteria.not.exists |
query | boolean | No | Inclusion critera - Filter for entries without a value | |
limit |
query | integer | 10 | No | |
manualChoicesIds |
query | string | No | Manually added cases - Filter for full text matches | |
manualChoicesIds.anyOf |
query | array | No | Manually added cases - Filter for entries where at least one reference matches the query | |
manualChoicesIds.beginsWith |
query | string | No | Manually added cases - Filter for entries starting with the text | |
manualChoicesIds.contains |
query | string | No | Manually added cases - Filter for partial text matches | |
manualChoicesIds.endsWith |
query | string | No | Manually added cases - Filter for entries ending with the text | |
manualChoicesIds.exists |
query | boolean | No | Manually added cases - Filter for entries with a value | |
manualChoicesIds.not |
query | string | No | Manually added cases - Filter for full text mismatches | |
manualChoicesIds.not.anyOf |
query | array | No | Manually added cases - Filter for entries where at least one reference mismatches the query | |
manualChoicesIds.not.beginsWith |
query | string | No | Manually added cases - Filter for entries not starting with the text | |
manualChoicesIds.not.contains |
query | string | No | Manually added cases - Filter for partial text mismatches | |
manualChoicesIds.not.endsWith |
query | string | No | Manually added cases - Filter for entries not ending with the text | |
manualChoicesIds.not.exists |
query | boolean | No | Manually added cases - Filter for entries without a value | |
name |
query | string | No | Cohort name - Filter for full text matches | |
name.anyOf |
query | array | No | Cohort name - Filter for entries where at least one reference matches the query | |
name.beginsWith |
query | string | No | Cohort name - Filter for entries starting with the text | |
name.contains |
query | string | No | Cohort name - Filter for partial text matches | |
name.endsWith |
query | string | No | Cohort name - Filter for entries ending with the text | |
name.not |
query | string | No | Cohort name - Filter for full text mismatches | |
name.not.anyOf |
query | array | No | Cohort name - Filter for entries where at least one reference mismatches the query | |
name.not.beginsWith |
query | string | No | Cohort name - Filter for entries not starting with the text | |
name.not.contains |
query | string | No | Cohort name - Filter for partial text mismatches | |
name.not.endsWith |
query | string | No | Cohort name - Filter for entries not ending with the text | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
population.between |
query | array | No | Population - Filter for entries with values between two specified values (inclusive) | |
population.equal |
query | integer | No | Population - Filter for entries with values exactly equal to the specified value | |
population.greaterThan |
query | integer | No | Population - Filter for entries with values greater than the specified value | |
population.greaterThanOrEqual |
query | integer | No | Population - Filter for entries with values greater than or equal to the specified value | |
population.lessThan |
query | integer | No | Population - Filter for entries with values less than the specified value | |
population.lessThanOrEqual |
query | integer | No | Population - Filter for entries with values less than or equal to the specified value | |
population.not.between |
query | array | No | Population - Filter for entries with values between two specified values (inclusive) | |
population.not.equal |
query | integer | No | Population - Filter for entries with values not equal to the specified value | |
projectId |
query | string | No | Project - Filter for reference matches | |
projectId.anyOf |
query | array | No | Project - Filter for entries where at least one reference matches the query | |
projectId.beginsWith |
query | string | No | Project - Filter for entries starting with the text | |
projectId.contains |
query | string | No | Project - Filter for partial text matches | |
projectId.endsWith |
query | string | No | Project - Filter for entries ending with the text | |
projectId.exists |
query | boolean | No | Project - Filter for entries with a value | |
projectId.not |
query | string | No | Project - Filter for reference mismatches | |
projectId.not.anyOf |
query | array | No | Project - Filter for entries where at least one reference mismatches the query | |
projectId.not.beginsWith |
query | string | No | Project - Filter for entries not starting with the text | |
projectId.not.contains |
query | string | No | Project - Filter for partial text mismatches | |
projectId.not.endsWith |
query | string | No | Project - Filter for entries not ending with the text | |
projectId.not.exists |
query | boolean | No | Project - Filter for entries without a value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"id": "712d8972-0d84-4084-9927-c12a31ede4a3",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"projectId": "89f66962-8eb1-421e-8ca9-ad12896a46a1",
"casesIds": [
"94dfa4a1-cbbe-4581-8fa6-b5b06f02663a"
],
"includeCriteria": null,
"excludeCriteria": null,
"manualChoicesIds": [
"4027cc44-8370-4d1a-86a4-0e352aa4661c"
],
"frozenSetIds": [
"14165c8e-bb06-4eb5-93c7-a270e1fa22ea"
],
"population": 0
}
]
}
POST /api/v1/cohorts¶
Create Cohort
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"projectId": "f88014ad-1394-44d6-a044-0d5d2dd8608f",
"casesIds": [
"127fe2be-d899-4559-9338-6da1705ed618"
],
"includeCriteria": null,
"excludeCriteria": null,
"manualChoicesIds": [
"795afe7f-bd67-4fe0-9ab9-be40f98374aa"
],
"frozenSetIds": [
"48868495-12c2-4644-bdb4-d55b9dd51546"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"name": {
"description": "Name of the cohort",
"maxLength": 255,
"title": "Cohort name",
"type": "string"
},
"projectId": {
"description": "Project to which the cohort is associated",
"format": "uuid",
"title": "Project",
"type": "string"
},
"casesIds": {
"description": "Cases composing the cohort",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Cases",
"type": "array"
},
"includeCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/CohortRuleset"
}
],
"description": "Logic rules to filter and constrain the cases to be included in the cohort",
"title": "Inclusion critera"
},
"excludeCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/CohortRuleset"
}
],
"description": "Logic rules to filter and constrain the cases to be excluded from the cohort",
"title": "Exclusion critera"
},
"manualChoicesIds": {
"description": "Manually added cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Manually added cases",
"type": "array"
},
"frozenSetIds": {
"description": "Frozen cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Frozen cases",
"type": "array"
}
},
"required": [
"name"
],
"title": "CohortCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/cohorts/{cohortId}¶
Get Cohort By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Responses
{
"id": "96668dbd-3ee0-41b4-a742-fb50da317f34",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"projectId": "7dbf3477-3d4a-4b84-a7b7-2ce1ef8cca25",
"casesIds": [
"7e32b121-2dee-43a6-ac75-833accb102bd"
],
"includeCriteria": null,
"excludeCriteria": null,
"manualChoicesIds": [
"8bb1da5f-a457-4651-b403-3ce011785310"
],
"frozenSetIds": [
"0c54fc46-7eec-4868-888c-9b8e83cc25e0"
],
"population": 0
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"name": {
"description": "Name of the cohort",
"maxLength": 255,
"title": "Cohort name",
"type": "string"
},
"projectId": {
"description": "Project to which the cohort is associated",
"format": "uuid",
"title": "Project",
"type": "string"
},
"casesIds": {
"description": "Cases composing the cohort",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Cases",
"type": "array"
},
"includeCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/CohortRuleset"
}
],
"description": "Logic rules to filter and constrain the cases to be included in the cohort",
"title": "Inclusion critera"
},
"excludeCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/CohortRuleset"
}
],
"description": "Logic rules to filter and constrain the cases to be excluded from the cohort",
"title": "Exclusion critera"
},
"manualChoicesIds": {
"description": "Manually added cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Manually added cases",
"type": "array"
},
"frozenSetIds": {
"description": "Frozen cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Frozen cases",
"type": "array"
},
"population": {
"description": "Cohort population",
"title": "Population",
"type": "integer"
}
},
"required": [
"id",
"description",
"name",
"population"
],
"title": "Cohort",
"type": "object"
}
DELETE /api/v1/cohorts/{cohortId}¶
Delete Cohort
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Responses
PUT /api/v1/cohorts/{cohortId}¶
Update Cohort
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Request body
{
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"projectId": "9ebbeb39-d3a3-4b1a-a335-ac9971dd89be",
"casesIds": [
"84e98a12-e2e9-4608-b269-3a856a309b89"
],
"includeCriteria": null,
"excludeCriteria": null,
"manualChoicesIds": [
"913286d0-b46e-454b-924a-680e17ceb453"
],
"frozenSetIds": [
"31a65dc7-f5dc-4f9f-aeca-b3852098d58e"
]
}
Schema of the request body
{
"properties": {
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"name": {
"description": "Name of the cohort",
"maxLength": 255,
"title": "Cohort name",
"type": "string"
},
"projectId": {
"description": "Project to which the cohort is associated",
"format": "uuid",
"title": "Project",
"type": "string"
},
"casesIds": {
"description": "Cases composing the cohort",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Cases",
"type": "array"
},
"includeCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/CohortRuleset"
}
],
"description": "Logic rules to filter and constrain the cases to be included in the cohort",
"title": "Inclusion critera"
},
"excludeCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/CohortRuleset"
}
],
"description": "Logic rules to filter and constrain the cases to be excluded from the cohort",
"title": "Exclusion critera"
},
"manualChoicesIds": {
"description": "Manually added cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Manually added cases",
"type": "array"
},
"frozenSetIds": {
"description": "Frozen cases",
"items": {
"format": "uuid",
"type": "string"
},
"title": "Frozen cases",
"type": "array"
}
},
"required": [
"name"
],
"title": "CohortCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/cohorts/{cohortId}/cases¶
Get Cohort Cases
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
anonymized |
query | boolean | True | No | Whether to anonymize the data or not (requires elevated permissions) |
cohortId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No |
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "d4e542e9-f366-4be7-a377-488d89cfdee6",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": {
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
},
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"pseudoidentifier": "string",
"age": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
]
}
]
}
GET /api/v1/cohorts/{cohortId}/contributors¶
Get Cohort Contributions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/cohorts/{cohortId}/export¶
Export Cohort Definition
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Responses
{
"exportedAt": "2022-04-13T15:42:05.901Z",
"exportedBy": "string",
"exportVersion": "string",
"checksum": "string",
"definition": {
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"projectId": "0cff6513-24b2-4534-92e0-cf84595041c4",
"casesIds": [
"56be5e1d-354c-40c7-be82-003191e2b642"
],
"includeCriteria": null,
"excludeCriteria": null,
"manualChoicesIds": [
"bbf8af15-befe-4120-a3c1-ee76c0760c63"
],
"frozenSetIds": [
"a865e26e-4ebb-4e64-a12d-04ce0502118e"
]
}
}
Schema of the response body
{
"description": "Represents an exported cohort definition along with its export metadata.\n\nAttributes:\n definition (CohortCreateSchema): The cohort definition, including its title and description.",
"properties": {
"exportedAt": {
"description": "The datetime when the resource was exported.",
"format": "date-time",
"title": "Export Timestamp",
"type": "string"
},
"exportedBy": {
"description": "Username of the user who performed the export.",
"title": "Exported By",
"type": "string"
},
"exportVersion": {
"description": "Version tag of the exporting system.",
"title": "Export Version",
"type": "string"
},
"checksum": {
"description": "Checksum (e.g., SHA256) of the exported content for integrity verification.",
"title": "Export Checksum",
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/CohortCreate",
"description": "The cohort definition",
"title": "Cohort Definition"
}
},
"required": [
"exportedAt",
"exportedBy",
"exportVersion",
"checksum",
"definition"
],
"title": "ExportedCohortDefinition",
"type": "object"
}
GET /api/v1/cohorts/{cohortId}/history/events¶
Get All Cohort History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/cohorts/{cohortId}/history/events/{eventId}¶
Get Cohort History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
eventId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/cohorts/{cohortId}/history/events/{eventId}/reversion¶
Revert Cohort To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
eventId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
POST /api/v1/cohorts/{cohortId}/dataset/{datasetId}/export¶
Export Cohort Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
datasetId |
path | string | No |
Responses
{
"exportedAt": "2022-04-13T15:42:05.901Z",
"exportedBy": "string",
"exportVersion": "string",
"checksum": "string",
"dataset": [
{
"anonymized": true,
"id": "58f2988c-58e5-4d21-9011-9d4a2e0d616c",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": null,
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"pseudoidentifier": "string",
"age": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"neoplasticEntities": [
{
"anonymized": true,
"id": "cc7f1840-f2d7-40d9-b806-7ba04b77281d",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c38209c3-9684-476d-a06e-fef93bde18de",
"relationship": null,
"relatedPrimaryId": "a5b8728c-9b3b-4abd-8eb4-851a0d93c1e9",
"assertionDate": "2022-04-13",
"topography": null,
"morphology": null,
"differentitation": null,
"laterality": null,
"topographyGroup": null
}
],
"tnmStagings": [
{
"anonymized": true,
"id": "74176bd7-595d-421c-9d88-6d32c8e76278",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d5fc4b1f-52a8-4914-ac8b-f9b1e2119938",
"date": "2022-04-13",
"stagedEntitiesIds": [
"a9612e98-c84d-43c3-883c-0515fd9d30ee"
],
"stage": null,
"methodology": null,
"pathological": true,
"primaryTumor": null,
"regionalNodes": null,
"distantMetastases": null,
"grade": null,
"residualTumor": null,
"lymphaticInvasion": null,
"venousInvasion": null,
"perineuralInvasion": null,
"serumTumorMarkerLevel": null
}
],
"figoStagings": null,
"binetStagings": [
{
"anonymized": true,
"id": "09e2a0ce-6655-43fe-92dd-8b2b0dbbde00",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "fc392acb-f78d-431d-9648-3c95f1139679",
"date": "2022-04-13",
"stagedEntitiesIds": [
"157f04de-5efc-4a75-b222-f7889a837b15"
],
"stage": null
}
],
"raiStagings": [
{
"anonymized": true,
"id": "ca59f505-0215-457a-85bb-24ba36704180",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "27087707-59f1-4d09-9f8b-10b6769abefa",
"date": "2022-04-13",
"stagedEntitiesIds": [
"e5fc7b0f-5d34-4465-bb8c-810738cc8d55"
],
"stage": null,
"methodology": null
}
],
"breslowStagings": [
{
"anonymized": true,
"id": "c3c73c17-dbb5-4b6f-8124-d2483f958445",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d8bfcbe8-a75a-433e-96e0-7be961816cc4",
"date": "2022-04-13",
"stagedEntitiesIds": [
"30c81e93-8ff4-48c7-a2f4-f8ecc2bffb45"
],
"depth": null,
"isUlcered": true,
"stage": null
}
],
"clarkStagings": [
{
"anonymized": true,
"id": "be3eb833-c137-410d-b45b-94d65d45ee3b",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2e8382a3-983f-4d16-80ac-f3988e84bb9c",
"date": "2022-04-13",
"stagedEntitiesIds": [
"446682cb-93e6-4ffa-9d9e-49ebcb6027c1"
],
"stage": null
}
],
"issStagings": [
{
"anonymized": true,
"id": "ef79be4f-87b5-4837-a6de-86fae14916e8",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "681f734f-9e08-4f86-aec5-54e6d49ffaf0",
"date": "2022-04-13",
"stagedEntitiesIds": [
"3172562f-87a3-4cbd-84ef-a0f29c7c367b"
],
"stage": null
}
],
"rissStagings": [
{
"anonymized": true,
"id": "73e5f1fa-9046-485a-9039-88315a9a1181",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "1a05bfb2-9d3f-4f3a-99cf-e0696eaf8034",
"date": "2022-04-13",
"stagedEntitiesIds": [
"065c8fda-61f5-476d-97ef-7e1bd0a0e8f3"
],
"stage": null
}
],
"inssStagings": [
{
"anonymized": true,
"id": "9e670b2d-3b16-42ba-9569-183732888eef",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "7a0ed805-cfd7-46b2-bc3a-e6047b3b4fb8",
"date": "2022-04-13",
"stagedEntitiesIds": [
"384c215d-bb06-4853-a99d-7ba14bbcd65f"
],
"stage": null
}
],
"inrgssStagings": [
{
"anonymized": true,
"id": "6808bd1c-f46b-4a76-ae30-2993902ce462",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "71ada5c5-004e-4ad9-829d-b36cbd9b06bd",
"date": "2022-04-13",
"stagedEntitiesIds": [
"b3925e3d-72e5-4cf3-8976-ff6074be677f"
],
"stage": null
}
],
"gleasonStagings": [
{
"anonymized": true,
"id": "d2442ecf-979b-4191-b20b-fe4695e03571",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b0412eef-83b9-486b-bd55-6d76acbd7b12",
"date": "2022-04-13",
"stagedEntitiesIds": [
"d07f4ddf-8de6-45bb-b8de-30dab45f34e4"
],
"stage": null
}
],
"rhabdomyosarcomaGroups": [
{
"anonymized": true,
"id": "3334a03a-1293-45d3-9176-222120f50457",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9ec0dbfa-a013-476a-a733-1d11fedcf244",
"date": "2022-04-13",
"stagedEntitiesIds": [
"ff23293a-5653-4eeb-ba4a-70d56c1bb44e"
],
"stage": null
}
],
"wilmsStagings": [
{
"anonymized": true,
"id": "07983f45-8ca5-45ac-9fa3-4b87dbeb4a39",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "01ce4e74-16ce-4388-86fd-b3f75ba80855",
"date": "2022-04-13",
"stagedEntitiesIds": [
"2bb07d37-fa54-4d9a-b1f1-0915e921c7c8"
],
"stage": null
}
],
"lymphomaStagings": [
{
"anonymized": true,
"id": "a219a22e-f019-4081-a92d-c58f447a8dc3",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "aacf5fd9-3dd7-482f-93c1-27bc935ac716",
"date": "2022-04-13",
"stagedEntitiesIds": [
"fef2b869-774b-49c5-93d7-9ef26d97e254"
],
"stage": null,
"methodology": null,
"bulky": true,
"pathological": true,
"modifiers": null
}
],
"tumorMarkers": [
{
"anonymized": true,
"id": "00284a68-7806-4341-ad31-a7d17ce74b32",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "72ba2c4d-1b3d-4fdc-88a6-6531f62b73e8",
"date": "2022-04-13",
"analyte": null,
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"7600aae8-e3d8-4e95-9e6d-052122cde7b6"
]
}
],
"riskAssessments": [
{
"anonymized": true,
"id": "e403388f-d504-4e16-bb6c-144c7ec11d51",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9ba82ed3-60b4-4580-95eb-248bb7352e4e",
"date": "2022-04-13",
"methodology": null,
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"83f773f0-cda2-4c70-955b-3666deadafa9"
]
}
],
"therapyLines": [
{
"anonymized": true,
"id": "51a81584-7137-4c86-8ba2-55cc69d978d5",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b28ae836-32b4-4d50-9866-7d02ae10a3af",
"ordinal": 0,
"intent": null,
"progressionDate": "2022-04-13",
"period": "string",
"label": "string",
"progressionFreeSurvival": 10.12
}
],
"systemicTherapies": [
{
"anonymized": true,
"id": "637aad49-4e9a-4505-8bc7-156626467c4e",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "782307cf-708a-4f11-8421-a315d41ed4a7",
"period": "string",
"cycles": 0,
"intent": null,
"adjunctiveRole": null,
"terminationReason": null,
"therapyLineId": "a4cc13a8-3434-45a6-981e-92ee290e9fb0",
"targetedEntitiesIds": [
"896a7cd1-fc4c-4ee9-b09f-02886dbe5e35"
],
"medications": [
{
"anonymized": true,
"id": "fa217fd2-f798-475b-b953-c8e447b8d3c4",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"drug": null,
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
],
"isAdjunctive": true,
"duration": null
}
],
"surgeries": [
{
"anonymized": true,
"id": "a5407ea9-2330-4d06-b363-829e876c9fac",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ed10cbf9-2fd6-4e55-90dd-75015edd64bf",
"date": "2022-04-13",
"procedure": null,
"intent": null,
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "1fbf7aed-19eb-453c-9cdc-f0941b17ec38",
"targetedEntitiesIds": [
"d5c41947-d23e-4be6-9228-b76dccda9cd6"
]
}
],
"radiotherapies": [
{
"anonymized": true,
"id": "2047b359-86f8-449a-8e82-5833abaa3084",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "bfc4ae7c-b1f6-4f2e-9791-37ba2042ba92",
"period": "string",
"sessions": 0,
"intent": null,
"terminationReason": null,
"therapyLineId": "4ef423f7-bbb9-4f65-b36f-3d57c4743194",
"targetedEntitiesIds": [
"e3e1e7ad-95f7-44eb-8071-3df602222ee2"
],
"duration": null,
"dosages": [
{
"anonymized": true,
"id": "f487494d-04f7-42e0-8b8a-a533dce43096",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": null,
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
],
"settings": [
{
"anonymized": true,
"id": "659b1c2a-b405-476d-a486-29c44a241228",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null
}
]
}
],
"adverseEvents": [
{
"anonymized": true,
"id": "0c06eecc-d072-46dd-aca5-16178e8102bd",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "8d57b0f0-1b7f-4cf6-a97a-48d9733f4ba8",
"date": "2022-04-13",
"event": null,
"grade": 0,
"outcome": null,
"dateResolved": "2022-04-13",
"suspectedCauses": [
{
"anonymized": true,
"id": "3ffa0478-0b08-4455-b08d-f4f958b2af09",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "527b5c0b-fcb3-4528-b272-305afad7bea4",
"medicationId": "7ffcb52b-3cad-4758-8b28-7a1cd6e3a97b",
"radiotherapyId": "5c75ce95-0ed9-4e78-9f8b-e88ad096847b",
"surgeryId": "86f9893a-96c8-44a2-ba83-a1e61e349c9f",
"causality": null
}
],
"mitigations": [
{
"anonymized": true,
"id": "4b583873-9549-46f3-b681-c2273fef499d",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"category": null,
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
]
}
],
"treatmentResponses": [
{
"anonymized": true,
"id": "e7ce1d50-ebbe-466b-94cd-f2ac5ed0e17b",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "a1885c9a-955a-478f-a0b8-04e3074320d7",
"date": "2022-04-13",
"recist": null,
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"88f6d0e8-8e1d-459c-8409-f774015dee3d"
],
"assessedBodysites": null
}
],
"performanceStatus": [
{
"anonymized": true,
"id": "d3ddeaaf-3a7e-4b6f-bc95-d1979eb2c33b",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ecde42ff-4f34-4960-a003-5cfcb36b89d3",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"ecogInterpretation": null,
"karnofskyInterpretation": null
}
],
"comorbidities": [
{
"anonymized": true,
"id": "26a6fa69-06d0-4e20-97d3-52f03d11a0d7",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "860adfd5-bf8c-4038-a1fc-8d65949f3b77",
"date": "2022-04-13",
"indexConditionId": "eb9174eb-3a4a-42cb-b704-8f5c4faea16d",
"panel": null,
"presentConditions": null,
"absentConditions": null,
"score": null
}
],
"genomicVariants": [
{
"anonymized": true,
"id": "ef212da0-8e1d-4bda-90b0-bee4c26bf6b1",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "856a8276-53e8-497f-9022-38a6fcdc002b",
"date": "2022-04-13",
"genes": null,
"dnaHgvs": "string",
"rnaHgvs": "string",
"proteinHgvs": "string",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"source": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"hgvsVersion": "string",
"isPathogenic": true,
"isVUS": true,
"cytogeneticLocation": "string",
"chromosomes": [
"string"
],
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
]
}
],
"tumorMutationalBurdens": [
{
"anonymized": true,
"id": "4301858a-d827-4754-8635-33520f16d183",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "565d05b0-d8d8-4f81-ac3f-04fbe02fa3c7",
"date": "2022-04-13",
"value": 10.12,
"status": null
}
],
"microsatelliteInstabilities": [
{
"anonymized": true,
"id": "aca99904-9ff2-4ce4-a6a5-b984022d1c66",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "4b67045b-61a6-4703-9733-076927c8db77",
"date": "2022-04-13",
"value": null
}
],
"lossesOfHeterozygosity": [
{
"anonymized": true,
"id": "736a81ce-5e05-41d6-893a-3cc92ca7300a",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b2a6a86c-05c8-404f-9f79-9fed8889f4f3",
"date": "2022-04-13",
"value": 10.12
}
],
"homologousRecombinationDeficiencies": [
{
"anonymized": true,
"id": "9deea1d7-5821-4011-8c7a-8a7fbad9cada",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "4cebd125-5c44-49b7-b37c-28077c4f9556",
"date": "2022-04-13",
"value": 10.12,
"interpretation": null
}
],
"tumorNeoantigenBurdens": [
{
"anonymized": true,
"id": "f155bfcd-a2ba-44b7-8817-babc1524dabb",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2dd23bd9-5d44-4bc2-adde-4cd0ce77445c",
"date": "2022-04-13",
"value": 10.12
}
],
"aneuploidScores": [
{
"anonymized": true,
"id": "6ff16538-acff-41f0-a504-45ba4240aa38",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "0fabd68b-5334-409b-8a54-c55017d3b9d2",
"date": "2022-04-13",
"value": 0
}
],
"vitals": [
{
"anonymized": true,
"id": "4c5b2014-c791-4978-a722-f3101def4beb",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "faab2835-8453-432f-bd6c-a100026350de",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"bodyMassIndex": null
}
],
"lifestyles": [
{
"anonymized": true,
"id": "835437b2-0ba3-4e83-aa9f-d833a19cc5b7",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5501ced4-906f-416e-8e68-fc515fb6ee08",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": null,
"exposures": null
}
],
"familyHistory": [
{
"anonymized": true,
"id": "48fc369b-597b-4042-b8b4-96ef9236ad51",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2e436981-a765-4074-b0fd-7725723cd6a1",
"date": "2022-04-13",
"relationship": null,
"hadCancer": true,
"isDeceased": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null
}
],
"unspecifiedTumorBoards": [
{
"anonymized": true,
"id": "faf8d38e-d188-4e52-bef3-38e20b6345da",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e27d011c-6cde-4690-88b8-153c505b5339",
"date": "2022-04-13",
"relatedEntitiesIds": [
"e2f999cc-bdf4-474f-bcf6-81a5c7b39040"
],
"recommendations": null
}
],
"molecularTumorBoards": null
}
]
}
Schema of the response body
{
"properties": {
"exportedAt": {
"description": "The datetime when the resource was exported.",
"format": "date-time",
"title": "Export Timestamp",
"type": "string"
},
"exportedBy": {
"description": "Username of the user who performed the export.",
"title": "Exported By",
"type": "string"
},
"exportVersion": {
"description": "Version tag of the exporting system.",
"title": "Export Version",
"type": "string"
},
"checksum": {
"description": "Checksum (e.g., SHA256) of the exported content for integrity verification.",
"title": "Export Checksum",
"type": "string"
},
"dataset": {
"description": "The dataset that was exported",
"items": {
"$ref": "#/components/schemas/PatientCaseDataset"
},
"title": "Dataset",
"type": "array"
}
},
"required": [
"exportedAt",
"exportedBy",
"exportVersion",
"checksum",
"dataset"
],
"title": "ExportedPatientCaseDataset",
"type": "object"
}
POST /api/v1/cohorts/{cohortId}/dataset¶
Construct Cohort Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Responses
{
"count": 0,
"items": [
{
"anonymized": true,
"id": "c5f89171-6ab1-47e7-87f1-16a45b1a0f26",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"clinicalCenter": "string",
"clinicalIdentifier": "string",
"consentStatus": null,
"gender": null,
"race": null,
"sexAtBirth": null,
"genderIdentity": null,
"dateOfBirth": null,
"vitalStatus": null,
"dateOfDeath": "2022-04-13",
"causeOfDeath": null,
"endOfRecords": "2022-04-13",
"pseudoidentifier": "string",
"age": null,
"overallSurvival": 10.12,
"ageAtDiagnosis": null,
"dataCompletionRate": 10.12,
"contributors": [
"string"
],
"neoplasticEntities": [
{
"anonymized": true,
"id": "2f939171-5b1e-4aa3-af87-cd8d0a25e0d7",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "7d10cb14-18ec-426e-b544-84ed2f44d3af",
"relationship": null,
"relatedPrimaryId": "a7802818-ee34-405a-8300-d74503eafb73",
"assertionDate": "2022-04-13",
"topography": null,
"morphology": null,
"differentitation": null,
"laterality": null,
"topographyGroup": null
}
],
"tnmStagings": [
{
"anonymized": true,
"id": "63e70bfb-cc54-4b26-8f84-07a94e53f9bd",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b779ee05-bc70-44e0-b7f8-bdb8028921ee",
"date": "2022-04-13",
"stagedEntitiesIds": [
"e0f00b96-7218-4c81-a03d-0c9aed821c89"
],
"stage": null,
"methodology": null,
"pathological": true,
"primaryTumor": null,
"regionalNodes": null,
"distantMetastases": null,
"grade": null,
"residualTumor": null,
"lymphaticInvasion": null,
"venousInvasion": null,
"perineuralInvasion": null,
"serumTumorMarkerLevel": null
}
],
"figoStagings": null,
"binetStagings": [
{
"anonymized": true,
"id": "5ade6c39-8f7f-4660-9df4-8a1fff138c32",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e4c88631-3757-4cda-a8f6-f32c2c333f0e",
"date": "2022-04-13",
"stagedEntitiesIds": [
"c63f4941-2eaa-434c-940b-6e8eb2a36646"
],
"stage": null
}
],
"raiStagings": [
{
"anonymized": true,
"id": "1c8ce613-5586-4b60-aa88-46f030a7ecd6",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "f859f9f2-11bd-4c22-b778-86e56c80d63e",
"date": "2022-04-13",
"stagedEntitiesIds": [
"91c8d896-16fa-4e2a-8a56-eb9b06a52904"
],
"stage": null,
"methodology": null
}
],
"breslowStagings": [
{
"anonymized": true,
"id": "eb4dedf6-d4d5-452c-abd8-5df63ea39af3",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "6306a19f-a544-448a-85ec-094f4d3754d8",
"date": "2022-04-13",
"stagedEntitiesIds": [
"6ab01674-1094-4e70-abf1-0023f90b3598"
],
"depth": null,
"isUlcered": true,
"stage": null
}
],
"clarkStagings": [
{
"anonymized": true,
"id": "fdf44bf6-404f-4a57-8e41-56c8e3c7728e",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "6306b8ef-f08a-4750-bdbc-2df96359fa23",
"date": "2022-04-13",
"stagedEntitiesIds": [
"d30dcf21-2e26-42c6-a355-84db15d3d46d"
],
"stage": null
}
],
"issStagings": [
{
"anonymized": true,
"id": "2a395439-0a08-4d04-a017-289732ddd714",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "72e6919e-8d37-428b-883a-4f1ad7c9d061",
"date": "2022-04-13",
"stagedEntitiesIds": [
"4b073d97-cd09-469c-a751-865aa6a62667"
],
"stage": null
}
],
"rissStagings": [
{
"anonymized": true,
"id": "cb08e5e1-3e81-4c30-9c0b-c10d517cbfff",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "86c0519f-53e3-406b-bd11-e9c90beceb1e",
"date": "2022-04-13",
"stagedEntitiesIds": [
"5b6ee885-55d3-4bd8-9d56-9e68181f454f"
],
"stage": null
}
],
"inssStagings": [
{
"anonymized": true,
"id": "66a3fee4-58b4-42d7-b3a4-9b2851d03e9c",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "7ad01ba5-e0be-431c-b0ae-ebfae61688d6",
"date": "2022-04-13",
"stagedEntitiesIds": [
"4ed660a9-66a3-48be-981a-e80c6cb3881e"
],
"stage": null
}
],
"inrgssStagings": [
{
"anonymized": true,
"id": "bd257c63-f47b-45ac-9bae-66f6643a4715",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2082b8d5-999f-4bdb-a0f9-f9905478c938",
"date": "2022-04-13",
"stagedEntitiesIds": [
"4075ea34-ff41-48d4-a9f7-9c6fdb6c530a"
],
"stage": null
}
],
"gleasonStagings": [
{
"anonymized": true,
"id": "f263de7b-7e30-4af2-bc30-3e77ec781a90",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b2cc201c-5410-4095-8e63-b19faa45111b",
"date": "2022-04-13",
"stagedEntitiesIds": [
"c5e155d0-099e-466f-a575-70bdfd4d50f9"
],
"stage": null
}
],
"rhabdomyosarcomaGroups": [
{
"anonymized": true,
"id": "771a3693-6e79-4f3f-9cbd-a3537f090d94",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5d141d1f-4c75-48aa-9686-129e7462c1a8",
"date": "2022-04-13",
"stagedEntitiesIds": [
"d841cf3e-1efb-4117-9d24-28be04a9550e"
],
"stage": null
}
],
"wilmsStagings": [
{
"anonymized": true,
"id": "7976c252-1a10-42a1-875b-a68279898f90",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "af39e2ce-103f-4d48-a2ab-7d97862c1b00",
"date": "2022-04-13",
"stagedEntitiesIds": [
"0bfa19bc-75de-4807-83c4-e4e1a92e0158"
],
"stage": null
}
],
"lymphomaStagings": [
{
"anonymized": true,
"id": "b5a2d37d-6bd9-4e14-a7cb-569f4a4a73f6",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"stagingDomain": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "a3368264-7136-4d88-88dd-75c9a6e827de",
"date": "2022-04-13",
"stagedEntitiesIds": [
"3d916c42-5ea3-45a5-941b-502dd72958b3"
],
"stage": null,
"methodology": null,
"bulky": true,
"pathological": true,
"modifiers": null
}
],
"tumorMarkers": [
{
"anonymized": true,
"id": "92d50891-9e67-493a-b82d-02f63b9fcfb4",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "2b0c74e6-6261-4e67-8483-645efc6719ee",
"date": "2022-04-13",
"analyte": null,
"massConcentration": null,
"arbitraryConcentration": null,
"substanceConcentration": null,
"fraction": null,
"multipleOfMedian": null,
"tumorProportionScore": null,
"immuneCellScore": null,
"combinedPositiveScore": null,
"immunohistochemicalScore": null,
"presence": null,
"nuclearExpressionStatus": null,
"relatedEntitiesIds": [
"a395b5cf-1c9e-4df1-86ea-532e0e1b54cf"
]
}
],
"riskAssessments": [
{
"anonymized": true,
"id": "97412c84-17f2-4cd8-b61b-b8c80886365d",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e146bfff-5c4f-4117-813b-eed6865c188c",
"date": "2022-04-13",
"methodology": null,
"risk": null,
"score": 10.12,
"assessedEntitiesIds": [
"dc44864f-9bce-4207-9c88-1afa1b3fc6b1"
]
}
],
"therapyLines": [
{
"anonymized": true,
"id": "31be8fcc-6699-4f73-ad2b-39400d2997c3",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "5d8efc0b-69a9-4609-ac65-682bc4094fa4",
"ordinal": 0,
"intent": null,
"progressionDate": "2022-04-13",
"period": "string",
"label": "string",
"progressionFreeSurvival": 10.12
}
],
"systemicTherapies": [
{
"anonymized": true,
"id": "6f54d6c4-3f5e-406f-9ff1-8e887e548f85",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "42dc30cf-7b56-40d4-a80f-9e90fa59be8d",
"period": "string",
"cycles": 0,
"intent": null,
"adjunctiveRole": null,
"terminationReason": null,
"therapyLineId": "2ac0df94-a63b-454a-bc0f-f7fa09494ad8",
"targetedEntitiesIds": [
"76ceac86-72b0-466f-8ed8-6a9d0689ce6f"
],
"medications": [
{
"anonymized": true,
"id": "47e80a2b-700b-42f0-b3b3-5f9488c88dab",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"drug": null,
"route": null,
"usedOfflabel": true,
"withinSoc": true,
"dosageMassConcentration": null,
"dosageMass": null,
"dosageVolume": null,
"dosageMassSurface": null,
"dosageRateMassConcentration": null,
"dosageRateMass": null,
"dosageRateVolume": null,
"dosageRateMassSurface": null
}
],
"isAdjunctive": true,
"duration": null
}
],
"surgeries": [
{
"anonymized": true,
"id": "34c002fb-87cc-4475-b889-d917bdb59316",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9a41f115-5ed9-44e8-97b0-1621857293c7",
"date": "2022-04-13",
"procedure": null,
"intent": null,
"bodysite": null,
"bodysiteQualifier": null,
"bodysiteLaterality": null,
"outcome": null,
"therapyLineId": "9ee84d8f-050a-480a-a841-7f5417bc31e3",
"targetedEntitiesIds": [
"a91838cb-8c29-477a-8880-4b9f6e6c91b0"
]
}
],
"radiotherapies": [
{
"anonymized": true,
"id": "8be6cb68-6d19-4f42-ae02-30a11b4356cc",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d1d51705-da7f-4817-83bb-6dcd5b3ba266",
"period": "string",
"sessions": 0,
"intent": null,
"terminationReason": null,
"therapyLineId": "b01f480a-2ed6-49ba-99e1-a3419b2c800a",
"targetedEntitiesIds": [
"cebd20a2-aeaa-4cb0-add6-45777b5df655"
],
"duration": null,
"dosages": [
{
"anonymized": true,
"id": "1ac193e9-ffca-439e-a724-3fd84ccc8f3a",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"fractions": 0,
"dose": null,
"irradiatedVolume": null,
"irradiatedVolumeMorphology": null,
"irradiatedVolumeQualifier": null
}
],
"settings": [
{
"anonymized": true,
"id": "ec5ef7e9-e199-4f87-bd5d-216efe4b7a54",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"modality": null,
"technique": null
}
]
}
],
"adverseEvents": [
{
"anonymized": true,
"id": "fe86786a-4ce4-41a1-b102-2b3b1850db48",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "9d7fc2cc-744b-4f64-b06e-b758235708a4",
"date": "2022-04-13",
"event": null,
"grade": 0,
"outcome": null,
"dateResolved": "2022-04-13",
"suspectedCauses": [
{
"anonymized": true,
"id": "ee071ed3-37ff-4a9c-8384-56daca33f73c",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"systemicTherapyId": "affb07f1-03e6-49d4-afd4-d9cbc7234750",
"medicationId": "6f1f4729-6292-48cd-b0c9-495e753dc851",
"radiotherapyId": "9154b3ac-b7d3-4c1b-a062-9961cc526c63",
"surgeryId": "8eb64d37-8123-497d-883b-6a66c1295ee0",
"causality": null
}
],
"mitigations": [
{
"anonymized": true,
"id": "dbe1064b-4307-49fa-9714-f832226f2cd9",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"category": null,
"adjustment": null,
"drug": null,
"procedure": null,
"management": null
}
]
}
],
"treatmentResponses": [
{
"anonymized": true,
"id": "ace84e6a-b9f6-40bd-8972-6fa9593a0a5b",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "925d546e-8642-4373-9fb4-53f98643a42c",
"date": "2022-04-13",
"recist": null,
"recistInterpreted": true,
"methodology": null,
"assessedEntitiesIds": [
"f18995ba-d9fa-4547-bad2-df1c2ccff9d5"
],
"assessedBodysites": null
}
],
"performanceStatus": [
{
"anonymized": true,
"id": "4950543f-c9af-4f2b-bb4d-66dd17378950",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ecc6af14-712a-489a-a936-edbd0be465c1",
"date": "2022-04-13",
"ecogScore": 0,
"karnofskyScore": 0,
"ecogInterpretation": null,
"karnofskyInterpretation": null
}
],
"comorbidities": [
{
"anonymized": true,
"id": "b2ff842d-1744-4796-abc3-1114ffe10a25",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "e73072d1-c9a3-4c2d-84f7-ee98f260b077",
"date": "2022-04-13",
"indexConditionId": "58c28812-a961-46e2-be52-ccc450c3767a",
"panel": null,
"presentConditions": null,
"absentConditions": null,
"score": null
}
],
"genomicVariants": [
{
"anonymized": true,
"id": "bb38e042-424a-4062-b8cd-5b0427b18a5e",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "ca7a390f-5353-41ae-980f-1ac06deb0985",
"date": "2022-04-13",
"genes": null,
"dnaHgvs": "string",
"rnaHgvs": "string",
"proteinHgvs": "string",
"assessmentDate": "2022-04-13",
"genePanel": "string",
"assessment": null,
"confidence": null,
"analysisMethod": null,
"clinicalRelevance": null,
"genomeAssemblyVersion": null,
"molecularConsequence": null,
"copyNumber": 0,
"alleleFrequency": 10.12,
"alleleDepth": 0,
"zygosity": null,
"source": null,
"inheritance": null,
"coordinateSystem": null,
"clinvar": "string",
"hgvsVersion": "string",
"isPathogenic": true,
"isVUS": true,
"cytogeneticLocation": "string",
"chromosomes": [
"string"
],
"dnaReferenceSequence": "string",
"dnaChangePosition": 0,
"dnaChangePositionRange": null,
"dnaChangeType": null,
"rnaReferenceSequence": "string",
"rnaChangePosition": "string",
"rnaChangeType": null,
"proteinReferenceSequence": "string",
"proteinChangeType": null,
"nucleotidesLength": 0,
"regions": [
"string"
]
}
],
"tumorMutationalBurdens": [
{
"anonymized": true,
"id": "5a708650-036b-485e-b76c-acbf2cbf3400",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "746badb7-f3a2-4091-b7a5-8f5ae045b8cd",
"date": "2022-04-13",
"value": 10.12,
"status": null
}
],
"microsatelliteInstabilities": [
{
"anonymized": true,
"id": "ef112254-93b4-4386-9e82-e795780d9e48",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "b9e85520-b3a3-40c4-aa30-01e11aa1d5ed",
"date": "2022-04-13",
"value": null
}
],
"lossesOfHeterozygosity": [
{
"anonymized": true,
"id": "a14a43d1-78c0-473e-99d7-9dd9e237d7cd",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "a39a8621-bc2c-4533-a6e8-1d1006183fba",
"date": "2022-04-13",
"value": 10.12
}
],
"homologousRecombinationDeficiencies": [
{
"anonymized": true,
"id": "3277500d-1a16-4d11-af60-d7b9f259c8ad",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "4dc227d0-2653-46b1-86c7-f1d71001e5a4",
"date": "2022-04-13",
"value": 10.12,
"interpretation": null
}
],
"tumorNeoantigenBurdens": [
{
"anonymized": true,
"id": "e094db53-2aaf-40c0-9640-426943fbc6d3",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "dfb5d093-2c03-4735-814f-a8b7489e805e",
"date": "2022-04-13",
"value": 10.12
}
],
"aneuploidScores": [
{
"anonymized": true,
"id": "9a32410a-1eaf-444f-9aff-5910670d0b3e",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c10715e5-0089-484f-b44b-7db5177b3be9",
"date": "2022-04-13",
"value": 0
}
],
"vitals": [
{
"anonymized": true,
"id": "d22a5d79-1791-4fe6-906f-6bf06a4c6d9f",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "7a5594ce-0e71-4f3a-86e8-f76fdaa8b9e0",
"date": "2022-04-13",
"height": null,
"weight": null,
"bloodPressureSystolic": null,
"bloodPressureDiastolic": null,
"temperature": null,
"bodyMassIndex": null
}
],
"lifestyles": [
{
"anonymized": true,
"id": "9ce1b45e-1c50-43bc-8081-e62d700b19de",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "d7694188-da90-4c92-b370-66f92f9adbde",
"date": "2022-04-13",
"smokingStatus": null,
"smokingPackyears": 10.12,
"smokingQuited": null,
"alcoholConsumption": null,
"nightSleep": null,
"recreationalDrugs": null,
"exposures": null
}
],
"familyHistory": [
{
"anonymized": true,
"id": "38088cfd-8e1e-4d92-b51e-a674eda43114",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"externalSource": "string",
"externalSourceId": "string",
"caseId": "af5134d4-97f3-4fd0-be24-007f9dcf3a99",
"date": "2022-04-13",
"relationship": null,
"hadCancer": true,
"isDeceased": true,
"contributedToDeath": true,
"onsetAge": 0,
"topography": null,
"morphology": null
}
],
"unspecifiedTumorBoards": [
{
"anonymized": true,
"id": "a85d9cb6-4ee8-44ad-9639-5f7db4273962",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"category": "string",
"externalSource": "string",
"externalSourceId": "string",
"caseId": "c7eb8120-6509-4891-950a-a02eff0155ea",
"date": "2022-04-13",
"relatedEntitiesIds": [
"82af0b47-f29f-4917-a388-83d847ca072d"
],
"recommendations": null
}
],
"molecularTumorBoards": null
}
]
}
Schema of the response body
GET /api/v1/cohorts/{cohortId}/traits¶
Get Cohort Traits Statistics
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Responses
{
"age": {
"median": null,
"interQuartalRange": null
},
"dataCompletion": null,
"overallSurvival": null,
"genders": [
{
"category": "string",
"counts": 0,
"percentage": 10.12
}
],
"neoplasticSites": null,
"therapyLines": null,
"consentStatus": null
}
Schema of the response body
{
"description": "Schema representing key traits and distributions within a patient cohort.\n\nAttributes:\n age (CohortTraitMedian): Median age of individuals in the cohort.\n dataCompletion (CohortTraitMedian): Median percentage of completed data per patient.\n overallSurvival (Nullable[CohortTraitMedian]): Median overall survival time in the cohort, if available.\n genders (List[CohortTraitCounts]): Distribution of genders within the cohort.\n neoplasticSites (List[CohortTraitCounts]): Distribution of neoplastic (tumor) sites in the cohort.\n therapyLines (List[CohortTraitCounts]): Distribution of therapy lines received by patients in the cohort.\n consentStatus (List[CohortTraitCounts]): Distribution of consent statuses for data use among cohort participants.",
"properties": {
"age": {
"$ref": "#/components/schemas/CohortTraitMedian",
"description": "Median age of individuals in the cohort.",
"title": "Age"
},
"dataCompletion": {
"$ref": "#/components/schemas/CohortTraitMedian",
"description": "Median percentage of completed data per patient.",
"title": "Data Completion"
},
"overallSurvival": {
"$ref": "#/components/schemas/CohortTraitMedian",
"description": "Median overall survival time in the cohort, if available.",
"title": "Overall Survival"
},
"genders": {
"description": "Distribution of genders within the cohort.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Genders",
"type": "array"
},
"neoplasticSites": {
"description": "Distribution of neoplastic (tumor) sites in the cohort.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Neoplastic Sites",
"type": "array"
},
"therapyLines": {
"description": "Distribution of therapy lines received by patients in the cohort.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Therapy Lines",
"type": "array"
},
"consentStatus": {
"description": "Distribution of consent statuses for data use among cohort participants.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Consent Status",
"type": "array"
}
},
"required": [
"age",
"dataCompletion",
"overallSurvival",
"genders",
"neoplasticSites",
"therapyLines",
"consentStatus"
],
"title": "CohortTraits",
"type": "object"
}
Data Analysis¶
GET /api/v1/cohorts/{cohortId}/analysis/distribution¶
Get Cohort Property Distribution
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
property |
query | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a statistical distribution of trait counts within a cohort.\n\nAttributes:\n items (List[CohortTraitCounts]): The entries in the distribution, each representing\n a category and its associated counts and percentage.",
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"items": {
"description": "The entries in the distribution.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Items",
"type": "array"
}
},
"required": [
"items"
],
"title": "Distribution",
"type": "object"
}
GET /api/v1/cohorts/{cohortId}/analysis/overall-survical/kaplan-meier¶
Get Cohort Overall Survival Curve
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
confidence |
query | number | 0.95 | No |
Responses
{
"metadata": null,
"months": [
10.12
],
"probabilities": [
10.12
],
"lowerConfidenceBand": [
10.12
],
"upperConfidenceBand": [
10.12
]
}
Schema of the response body
{
"description": "Schema representing a Kaplan-Meier survival curve, including survival probabilities and confidence intervals.\n\nAttributes:\n months (List[float]): List of time points (in months) for survival probability estimates.\n probabilities (List[float]): Survival probabilities at each time point.\n lowerConfidenceBand (List[float]): Lower bound of the survival probability confidence interval at each time point.\n upperConfidenceBand (List[float]): Upper bound of the survival probability confidence interval at each time point.",
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"months": {
"description": "List of time points (in months) for survival probability estimates.",
"items": {
"type": "number"
},
"title": "Months",
"type": "array"
},
"probabilities": {
"description": "Survival probabilities at each time point.",
"items": {
"type": "number"
},
"title": "Probabilities",
"type": "array"
},
"lowerConfidenceBand": {
"description": "Lower bound of the survival probability confidence interval at each time point.",
"items": {
"type": "number"
},
"title": "Lower Confidence Band",
"type": "array"
},
"upperConfidenceBand": {
"description": "Upper bound of the survival probability confidence interval at each time point.",
"items": {
"type": "number"
},
"title": "Upper Confidence Band",
"type": "array"
}
},
"required": [
"months",
"probabilities",
"lowerConfidenceBand",
"upperConfidenceBand"
],
"title": "KaplanMeierCurve",
"type": "object"
}
GET /api/v1/cohorts/{cohortId}/analysis/oncoplot¶
Get Cohort Oncoplot Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No |
Responses
{
"metadata": null,
"genes": [
"string"
],
"cases": [
"string"
],
"variants": [
{
"gene": "string",
"caseId": "string",
"hgvsExpression": "string",
"isPathogenic": true
}
]
}
Schema of the response body
{
"description": "Schema representing the dataset required for generating an Oncoplot visualization.\n\nAttributes:\n genes (List[str]): List of the most frequently encountered gene names.\n cases (List[str]): List of patient case identifiers.\n variants (List[OncoplotVariant]): List of variant records included in the Oncoplot.",
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"genes": {
"description": "List of most frequently encountered genes",
"items": {
"type": "string"
},
"title": "Genes",
"type": "array"
},
"cases": {
"description": "List of patient cases",
"items": {
"type": "string"
},
"title": "Cases",
"type": "array"
},
"variants": {
"description": "Variants included in the Oncoplot",
"items": {
"$ref": "#/components/schemas/OncoplotVariant"
},
"title": "Variants",
"type": "array"
}
},
"required": [
"genes",
"cases",
"variants"
],
"title": "OncoplotDataset",
"type": "object"
}
GET /api/v1/cohorts/{cohortId}/analysis/{therapyLine}/progression-free-survival/kaplan-meier¶
Get Cohort Line Progression Free Survival Curve
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
confidence |
query | number | 0.95 | No | |
therapyLine |
path | string | No |
Responses
{
"metadata": null,
"months": [
10.12
],
"probabilities": [
10.12
],
"lowerConfidenceBand": [
10.12
],
"upperConfidenceBand": [
10.12
]
}
Schema of the response body
{
"description": "Schema representing a Kaplan-Meier survival curve, including survival probabilities and confidence intervals.\n\nAttributes:\n months (List[float]): List of time points (in months) for survival probability estimates.\n probabilities (List[float]): Survival probabilities at each time point.\n lowerConfidenceBand (List[float]): Lower bound of the survival probability confidence interval at each time point.\n upperConfidenceBand (List[float]): Upper bound of the survival probability confidence interval at each time point.",
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"months": {
"description": "List of time points (in months) for survival probability estimates.",
"items": {
"type": "number"
},
"title": "Months",
"type": "array"
},
"probabilities": {
"description": "Survival probabilities at each time point.",
"items": {
"type": "number"
},
"title": "Probabilities",
"type": "array"
},
"lowerConfidenceBand": {
"description": "Lower bound of the survival probability confidence interval at each time point.",
"items": {
"type": "number"
},
"title": "Lower Confidence Band",
"type": "array"
},
"upperConfidenceBand": {
"description": "Upper bound of the survival probability confidence interval at each time point.",
"items": {
"type": "number"
},
"title": "Upper Confidence Band",
"type": "array"
}
},
"required": [
"months",
"probabilities",
"lowerConfidenceBand",
"upperConfidenceBand"
],
"title": "KaplanMeierCurve",
"type": "object"
}
GET /api/v1/cohorts/{cohortId}/analysis/{therapyLine}/progression-free-survivals/categories¶
Get Cohort Line Progression Free Survival By Categories
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
categorization |
query | No | |||
cohortId |
path | string | No | ||
therapyLine |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Schema for categorizing progression free survival (PFS) data within a cohort based on therapy-related groupings.\n\nAttributes:\n survivals (Dict[str, List[float]]): A dictionary mapping category names (e.g., drug combinations or therapy classifications) to lists of progression free survival values.",
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"survivals": {
"additionalProperties": {
"items": {
"type": "number"
},
"type": "array"
},
"title": "Survivals",
"type": "object"
}
},
"required": [
"survivals"
],
"title": "CategorizedSurvivals",
"type": "object"
}
GET /api/v1/cohorts/{cohortId}/analysis/{therapyLine}/distribution¶
Get Cohort Line Property Distribution
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortId |
path | string | No | ||
property |
query | string | No | ||
therapyLine |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a statistical distribution of trait counts within a cohort.\n\nAttributes:\n items (List[CohortTraitCounts]): The entries in the distribution, each representing\n a category and its associated counts and percentage.",
"properties": {
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/AnalysisMetadata"
},
{
"type": "null"
}
],
"description": "Metadata for the Kaplan-Meier curve.",
"title": "Metadata"
},
"items": {
"description": "The entries in the distribution.",
"items": {
"$ref": "#/components/schemas/CohortTraitCounts"
},
"title": "Items",
"type": "array"
}
},
"required": [
"items"
],
"title": "Distribution",
"type": "object"
}
Dashboard¶
GET /api/v1/dashboard/stats¶
Get Full Cohort Statistics
Description
Retrieves comprehensive statistics for the full cohort, including counts of cases, primary sites, entries, mutations, clinical centers, contributors, cohorts, and projects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Responses
{
"cases": 0,
"primarySites": 0,
"projects": 0,
"cohorts": 0,
"entries": 0,
"mutations": 0,
"clinicalCenters": 0,
"contributors": 0
}
Schema of the response body
{
"description": "Schema representing key statistics of the data platform.\n\nAttributes:\n cases (int): Total number of unique patient cases in the data platform.\n primarySites (int): Number of distinct primary anatomical sites represented.\n projects (int): Total number of research projects.\n cohorts (int): Number of defined cohorts in the platform.\n entries (int): Total number of individual data entries recorded.\n mutations (int): Total number of genetic mutations documented across all cases.\n clinicalCenters (int): Number of clinical centers contributing data.\n contributors (int): Total number of individual data contributors.",
"properties": {
"cases": {
"description": "Total number of unique patient cases in the data platform.",
"title": "Patient Cases",
"type": "integer"
},
"primarySites": {
"description": "Number of distinct primary anatomical sites represented.",
"title": "Primary Sites",
"type": "integer"
},
"projects": {
"description": "Total number of research projects.",
"title": "Projects",
"type": "integer"
},
"cohorts": {
"description": "Number of defined cohorts in the platform.",
"title": "Cohorts",
"type": "integer"
},
"entries": {
"description": "Total number of individual data entries recorded.",
"title": "Data Entries",
"type": "integer"
},
"mutations": {
"description": "Total number of genetic mutations documented across all cases.",
"title": "Mutations",
"type": "integer"
},
"clinicalCenters": {
"description": "Number of clinical centers contributing data.",
"title": "Clinical Centers",
"type": "integer"
},
"contributors": {
"description": "Total number of individual data contributors.",
"title": "Contributors",
"type": "integer"
}
},
"required": [
"cases",
"primarySites",
"projects",
"cohorts",
"entries",
"mutations",
"clinicalCenters",
"contributors"
],
"title": "DataPlatformStatistics",
"type": "object"
}
GET /api/v1/dashboard/primary-site-stats¶
Get Primary Site Statistics
Description
Retrieves statistical data for primary neoplastic entities grouped by topography.
This method performs the following steps:
- Selects distinct topography groups from primary neoplastic entities.
- For each topography group, identifies the cohort of patient cases associated with primary neoplastic entities matching the group's code.
- Calculates the population size and the median data completion rate for each cohort.
- Constructs a list of EntityStatistics objects containing the computed statistics and topography information.
- Sorts the statistics by population size in descending order.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Responses
GET /api/v1/dashboard/cases-over-time¶
Get Cases Over Time
Description
Retrieves the cumulative count of patient cases over time, grouped by month.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/dashboard/data-completion-stats¶
Get Data Completion Statistics
Description
Computes and returns statistics on data completion for patient cases.
- If there are no patient cases, returns zeroed statistics.
- Uses Django ORM aggregation and annotation for efficient computation.
- Identifies most incomplete categories and the most affected sites for each.
- Tracks completion progress over time using monthly aggregation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Responses
{
"totalCases": 0,
"overallCompletion": 10.12,
"mostIncompleteCategories": [
{
"category": "string",
"cases": 0,
"affectedSites": [
{
"code": "string",
"system": "string",
"display": "string",
"version": "string",
"synonyms": [
"string"
],
"properties": {}
}
]
}
],
"completionOverTime": [
{
"month": "2022-04-13",
"cumulativeCount": 0
}
]
}
Schema of the response body
{
"description": "Schema representing statistics on data completion for patient cases.\n\nAttributes:\n totalCases (int): Total number of patient cases analyzed for data completeness.\n overallCompletion (float): Overall percentage of data categories completed across all cases.\n mostIncompleteCategories (List[IncompleteCategory]): List of the most common categories with missing data.\n completionOverTime (List[CountsPerMonth]): Historical trend of cumulative data completeness by month.",
"properties": {
"totalCases": {
"description": "Total number of patient cases analyzed for data completeness.",
"title": "Total Cases",
"type": "integer"
},
"overallCompletion": {
"description": "Overall percentage of data categories completed across all cases.",
"title": "Overall Completion (%)",
"type": "number"
},
"mostIncompleteCategories": {
"description": "List of the most common categories with missing data.",
"items": {
"$ref": "#/components/schemas/IncompleteCategory"
},
"title": "Most Incomplete Categories",
"type": "array"
},
"completionOverTime": {
"description": "Historical trend of cumulative data completeness by month.",
"items": {
"$ref": "#/components/schemas/CountsPerMonth"
},
"title": "Completion Over Time",
"type": "array"
}
},
"required": [
"totalCases",
"overallCompletion",
"mostIncompleteCategories",
"completionOverTime"
],
"title": "DataCompletionStatistics",
"type": "object"
}
Datasets¶
GET /api/v1/datasets¶
Get All Datasets Matching The Query
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
cohortsIds |
query | string | No | Cohorts - Filter for full text matches | |
cohortsIds.anyOf |
query | array | No | Cohorts - Filter for entries where at least one reference matches the query | |
cohortsIds.beginsWith |
query | string | No | Cohorts - Filter for entries starting with the text | |
cohortsIds.contains |
query | string | No | Cohorts - Filter for partial text matches | |
cohortsIds.endsWith |
query | string | No | Cohorts - Filter for entries ending with the text | |
cohortsIds.not |
query | string | No | Cohorts - Filter for full text mismatches | |
cohortsIds.not.anyOf |
query | array | No | Cohorts - Filter for entries where at least one reference mismatches the query | |
cohortsIds.not.beginsWith |
query | string | No | Cohorts - Filter for entries not starting with the text | |
cohortsIds.not.contains |
query | string | No | Cohorts - Filter for partial text mismatches | |
cohortsIds.not.endsWith |
query | string | No | Cohorts - Filter for entries not ending with the text | |
createdAt.after |
query | string | No | Created at - Filter for entries with dates after the specified value | |
createdAt.before |
query | string | No | Created at - Filter for entries with dates before the specified value | |
createdAt.between |
query | array | No | Created at - Filter for entries with dates between two specified values (inclusive) | |
createdAt.exists |
query | boolean | No | Created at - Filter for entries with a value | |
createdAt.not.between |
query | array | No | Created at - Filter for entries with dates not between two specified values (inclusive) | |
createdAt.not.exists |
query | boolean | No | Created at - Filter for entries without a value | |
createdAt.not.on |
query | string | No | Created at - Filter for entries with dates not matching the specified value | |
createdAt.on |
query | string | No | Created at - Filter for entries with dates exactly matching the specified value | |
createdAt.onOrAfter |
query | string | No | Created at - Filter for entries with dates on or after the specified value | |
createdAt.onOrBefore |
query | string | No | Created at - Filter for entries with dates on or before the specified value | |
createdBy |
query | string | No | Filter datasets by the creator's username. | |
externalSource |
query | string | No | External data source - Filter for full text matches | |
externalSource.anyOf |
query | array | No | External data source - Filter for entries where at least one reference matches the query | |
externalSource.beginsWith |
query | string | No | External data source - Filter for entries starting with the text | |
externalSource.contains |
query | string | No | External data source - Filter for partial text matches | |
externalSource.endsWith |
query | string | No | External data source - Filter for entries ending with the text | |
externalSource.exists |
query | boolean | No | External data source - Filter for entries with a value | |
externalSource.not |
query | string | No | External data source - Filter for full text mismatches | |
externalSource.not.anyOf |
query | array | No | External data source - Filter for entries where at least one reference mismatches the query | |
externalSource.not.beginsWith |
query | string | No | External data source - Filter for entries not starting with the text | |
externalSource.not.contains |
query | string | No | External data source - Filter for partial text mismatches | |
externalSource.not.endsWith |
query | string | No | External data source - Filter for entries not ending with the text | |
externalSource.not.exists |
query | boolean | No | External data source - Filter for entries without a value | |
id |
query | string | No | Id - Filter for full text matches | |
id.anyOf |
query | array | No | Id - Filter for entries where at least one reference matches the query | |
id.beginsWith |
query | string | No | Id - Filter for entries starting with the text | |
id.contains |
query | string | No | Id - Filter for partial text matches | |
id.endsWith |
query | string | No | Id - Filter for entries ending with the text | |
id.not |
query | string | No | Id - Filter for full text mismatches | |
id.not.anyOf |
query | array | No | Id - Filter for entries where at least one reference mismatches the query | |
id.not.beginsWith |
query | string | No | Id - Filter for entries not starting with the text | |
id.not.contains |
query | string | No | Id - Filter for partial text mismatches | |
id.not.endsWith |
query | string | No | Id - Filter for entries not ending with the text | |
lastExport.after |
query | string | No | Last Export - Filter for entries with dates after the specified value | |
lastExport.before |
query | string | No | Last Export - Filter for entries with dates before the specified value | |
lastExport.between |
query | array | No | Last Export - Filter for entries with dates between two specified values (inclusive) | |
lastExport.exists |
query | boolean | No | Last Export - Filter for entries with a value | |
lastExport.not.between |
query | array | No | Last Export - Filter for entries with dates not between two specified values (inclusive) | |
lastExport.not.exists |
query | boolean | No | Last Export - Filter for entries without a value | |
lastExport.not.on |
query | string | No | Last Export - Filter for entries with dates not matching the specified value | |
lastExport.on |
query | string | No | Last Export - Filter for entries with dates exactly matching the specified value | |
lastExport.onOrAfter |
query | string | No | Last Export - Filter for entries with dates on or after the specified value | |
lastExport.onOrBefore |
query | string | No | Last Export - Filter for entries with dates on or before the specified value | |
limit |
query | integer | 10 | No | |
name |
query | string | No | Dataset name - Filter for full text matches | |
name.anyOf |
query | array | No | Dataset name - Filter for entries where at least one reference matches the query | |
name.beginsWith |
query | string | No | Dataset name - Filter for entries starting with the text | |
name.contains |
query | string | No | Dataset name - Filter for partial text matches | |
name.endsWith |
query | string | No | Dataset name - Filter for entries ending with the text | |
name.not |
query | string | No | Dataset name - Filter for full text mismatches | |
name.not.anyOf |
query | array | No | Dataset name - Filter for entries where at least one reference mismatches the query | |
name.not.beginsWith |
query | string | No | Dataset name - Filter for entries not starting with the text | |
name.not.contains |
query | string | No | Dataset name - Filter for partial text mismatches | |
name.not.endsWith |
query | string | No | Dataset name - Filter for entries not ending with the text | |
offset |
query | integer | 0 | No | |
ordering |
query | No | |||
projectId |
query | string | No | Project - Filter for reference matches | |
projectId.anyOf |
query | array | No | Project - Filter for entries where at least one reference matches the query | |
projectId.beginsWith |
query | string | No | Project - Filter for entries starting with the text | |
projectId.contains |
query | string | No | Project - Filter for partial text matches | |
projectId.endsWith |
query | string | No | Project - Filter for entries ending with the text | |
projectId.not |
query | string | No | Project - Filter for reference mismatches | |
projectId.not.anyOf |
query | array | No | Project - Filter for entries where at least one reference mismatches the query | |
projectId.not.beginsWith |
query | string | No | Project - Filter for entries not starting with the text | |
projectId.not.contains |
query | string | No | Project - Filter for partial text mismatches | |
projectId.not.endsWith |
query | string | No | Project - Filter for entries not ending with the text | |
rules.field |
query | string | No | Field - Filter for full text matches | |
rules.field.anyOf |
query | array | No | Field - Filter for entries where at least one reference matches the query | |
rules.field.beginsWith |
query | string | No | Field - Filter for entries starting with the text | |
rules.field.contains |
query | string | No | Field - Filter for partial text matches | |
rules.field.endsWith |
query | string | No | Field - Filter for entries ending with the text | |
rules.field.not |
query | string | No | Field - Filter for full text mismatches | |
rules.field.not.anyOf |
query | array | No | Field - Filter for entries where at least one reference mismatches the query | |
rules.field.not.beginsWith |
query | string | No | Field - Filter for entries not starting with the text | |
rules.field.not.contains |
query | string | No | Field - Filter for partial text mismatches | |
rules.field.not.endsWith |
query | string | No | Field - Filter for entries not ending with the text | |
rules.resource |
query | No | Resource - Filter for single value choice | ||
rules.resource.anyOf |
query | array | No | Resource - ('Filter for excluding a subset of value choices',) | |
rules.resource.not |
query | No | Resource - ('Filter for all but a single value choice',) | ||
rules.transform |
query | string | No | Transform - Filter for full text matches | |
rules.transform.anyOf |
query | array | No | Transform - Filter for entries where at least one reference matches the query | |
rules.transform.beginsWith |
query | string | No | Transform - Filter for entries starting with the text | |
rules.transform.contains |
query | string | No | Transform - Filter for partial text matches | |
rules.transform.endsWith |
query | string | No | Transform - Filter for entries ending with the text | |
rules.transform.exists |
query | boolean | No | Transform - Filter for entries with a value | |
rules.transform.not |
query | string | No | Transform - Filter for full text mismatches | |
rules.transform.not.anyOf |
query | array | No | Transform - Filter for entries where at least one reference mismatches the query | |
rules.transform.not.beginsWith |
query | string | No | Transform - Filter for entries not starting with the text | |
rules.transform.not.contains |
query | string | No | Transform - Filter for partial text mismatches | |
rules.transform.not.endsWith |
query | string | No | Transform - Filter for entries not ending with the text | |
rules.transform.not.exists |
query | boolean | No | Transform - Filter for entries without a value | |
summary |
query | string | No | Dataset summary - Filter for full text matches | |
summary.anyOf |
query | array | No | Dataset summary - Filter for entries where at least one reference matches the query | |
summary.beginsWith |
query | string | No | Dataset summary - Filter for entries starting with the text | |
summary.contains |
query | string | No | Dataset summary - Filter for partial text matches | |
summary.endsWith |
query | string | No | Dataset summary - Filter for entries ending with the text | |
summary.exists |
query | boolean | No | Dataset summary - Filter for entries with a value | |
summary.not |
query | string | No | Dataset summary - Filter for full text mismatches | |
summary.not.anyOf |
query | array | No | Dataset summary - Filter for entries where at least one reference mismatches the query | |
summary.not.beginsWith |
query | string | No | Dataset summary - Filter for entries not starting with the text | |
summary.not.contains |
query | string | No | Dataset summary - Filter for partial text mismatches | |
summary.not.endsWith |
query | string | No | Dataset summary - Filter for entries not ending with the text | |
summary.not.exists |
query | boolean | No | Dataset summary - Filter for entries without a value | |
totalExports.between |
query | array | No | Total Exports - Filter for entries with values between two specified values (inclusive) | |
totalExports.equal |
query | integer | No | Total Exports - Filter for entries with values exactly equal to the specified value | |
totalExports.greaterThan |
query | integer | No | Total Exports - Filter for entries with values greater than the specified value | |
totalExports.greaterThanOrEqual |
query | integer | No | Total Exports - Filter for entries with values greater than or equal to the specified value | |
totalExports.lessThan |
query | integer | No | Total Exports - Filter for entries with values less than the specified value | |
totalExports.lessThanOrEqual |
query | integer | No | Total Exports - Filter for entries with values less than or equal to the specified value | |
totalExports.not.between |
query | array | No | Total Exports - Filter for entries with values between two specified values (inclusive) | |
totalExports.not.equal |
query | integer | No | Total Exports - Filter for entries with values not equal to the specified value | |
updatedAt.after |
query | string | No | Updated at - Filter for entries with dates after the specified value | |
updatedAt.before |
query | string | No | Updated at - Filter for entries with dates before the specified value | |
updatedAt.between |
query | array | No | Updated at - Filter for entries with dates between two specified values (inclusive) | |
updatedAt.exists |
query | boolean | No | Updated at - Filter for entries with a value | |
updatedAt.not.between |
query | array | No | Updated at - Filter for entries with dates not between two specified values (inclusive) | |
updatedAt.not.exists |
query | boolean | No | Updated at - Filter for entries without a value | |
updatedAt.not.on |
query | string | No | Updated at - Filter for entries with dates not matching the specified value | |
updatedAt.on |
query | string | No | Updated at - Filter for entries with dates exactly matching the specified value | |
updatedAt.onOrAfter |
query | string | No | Updated at - Filter for entries with dates on or after the specified value | |
updatedAt.onOrBefore |
query | string | No | Updated at - Filter for entries with dates on or before the specified value |
Responses
{
"count": 0,
"items": [
{
"id": "bd347ccb-4825-4feb-9c87-01f23d48ef47",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"rules": [
{
"resource": "PatientCase",
"field": "string",
"transform": null
}
],
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"summary": "string",
"projectId": "28558307-5cc6-4321-b0c9-3a8af91e8f22",
"lastExport": "2022-04-13T15:42:05.901Z",
"totalExports": 0,
"cohortsIds": [
"string"
]
}
]
}
POST /api/v1/datasets¶
Create Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
Request body
{
"rules": [
{
"resource": "PatientCase",
"field": "string",
"transform": null
}
],
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"summary": "string",
"projectId": "ac78b774-625c-4bf2-8450-42188e3d25bf"
}
Schema of the request body
{
"properties": {
"rules": {
"default": [],
"description": "List of composition rules that define the dataset's structure.",
"items": {
"$ref": "#/components/schemas/DatasetRule"
},
"title": "Rules",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"name": {
"description": "Name of the dataset",
"maxLength": 255,
"title": "Dataset name",
"type": "string"
},
"summary": {
"description": "Summary of the dataset",
"title": "Dataset summary",
"type": "string"
},
"projectId": {
"description": "Project that the dataset is part of",
"format": "uuid",
"title": "Project",
"type": "string"
}
},
"required": [
"name",
"projectId"
],
"title": "DatasetCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/datasets/{datasetId}¶
Get Dataset By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No |
Responses
{
"id": "6dc9e06c-aa12-43ce-9639-fd97e804e061",
"description": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"createdBy": "string",
"updatedBy": [
"string"
],
"rules": [
{
"resource": "PatientCase",
"field": "string",
"transform": null
}
],
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"summary": "string",
"projectId": "e221d7ae-319d-42c7-ae95-ff4b7f57fd08",
"lastExport": "2022-04-13T15:42:05.901Z",
"totalExports": 0,
"cohortsIds": [
"string"
]
}
Schema of the response body
{
"properties": {
"id": {
"description": "Unique identifier of the resource (UUID v4).",
"format": "uuid",
"title": "Id",
"type": "string"
},
"description": {
"description": "Human-readable description",
"title": "Description",
"type": "string"
},
"createdAt": {
"description": "Date-time when the resource was created",
"format": "date-time",
"title": "Created at",
"type": "string"
},
"updatedAt": {
"description": "Date-time when the resource was last updated",
"format": "date-time",
"title": "Updated at",
"type": "string"
},
"createdBy": {
"description": "Username of the user who created the resource",
"title": "Created by",
"type": "string"
},
"updatedBy": {
"description": "Usernames of the users who have updated the resource",
"items": {
"type": "string"
},
"title": "Updated by",
"type": "array"
},
"rules": {
"default": [],
"description": "List of composition rules that define the dataset's structure.",
"items": {
"$ref": "#/components/schemas/DatasetRule"
},
"title": "Rules",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"name": {
"description": "Name of the dataset",
"maxLength": 255,
"title": "Dataset name",
"type": "string"
},
"summary": {
"description": "Summary of the dataset",
"title": "Dataset summary",
"type": "string"
},
"projectId": {
"description": "Project that the dataset is part of",
"format": "uuid",
"title": "Project",
"type": "string"
},
"lastExport": {
"description": "The datetime of the last export of this dataset",
"format": "date-time",
"title": "Last Export",
"type": "string"
},
"totalExports": {
"default": 0,
"description": "The total number times this dataset has been exported",
"title": "Total Exports",
"type": "integer"
},
"cohortsIds": {
"default": [],
"description": "List of cohort IDs that have been exported with this dataset",
"items": {
"type": "string"
},
"title": "Cohorts",
"type": "array"
}
},
"required": [
"id",
"description",
"name",
"projectId"
],
"title": "Dataset",
"type": "object"
}
DELETE /api/v1/datasets/{datasetId}¶
Delete Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No |
Responses
PUT /api/v1/datasets/{datasetId}¶
Update Dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No |
Request body
{
"rules": [
{
"resource": "PatientCase",
"field": "string",
"transform": null
}
],
"externalSource": "string",
"externalSourceId": "string",
"name": "string",
"summary": "string",
"projectId": "90d85efc-4dd7-4783-8b4a-f3c81a4c3858"
}
Schema of the request body
{
"properties": {
"rules": {
"default": [],
"description": "List of composition rules that define the dataset's structure.",
"items": {
"$ref": "#/components/schemas/DatasetRule"
},
"title": "Rules",
"type": "array"
},
"externalSource": {
"description": "The digital source of the data, relevant for automated data",
"title": "External data source",
"type": "string"
},
"externalSourceId": {
"description": "The data identifier at the digital source of the data, relevant for automated data",
"title": "External data source Id",
"type": "string"
},
"name": {
"description": "Name of the dataset",
"maxLength": 255,
"title": "Dataset name",
"type": "string"
},
"summary": {
"description": "Summary of the dataset",
"title": "Dataset summary",
"type": "string"
},
"projectId": {
"description": "Project that the dataset is part of",
"format": "uuid",
"title": "Project",
"type": "string"
}
},
"required": [
"name",
"projectId"
],
"title": "DatasetCreate",
"type": "object"
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
GET /api/v1/datasets/{datasetId}/history/events¶
Get All Dataset History Events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No | ||
limit |
query | integer | 10 | No | |
offset |
query | integer | 0 | No | |
ordering |
query | No |
Responses
{
"count": 0,
"items": [
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
]
}
Schema of the response body
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/HistoryEventWithSchema"
},
"title": "Items",
"type": "array"
}
},
"required": [
"count",
"items"
],
"title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
"type": "object"
}
GET /api/v1/datasets/{datasetId}/history/events/{eventId}¶
Get Dataset History Event By Id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No | ||
eventId |
path | string | No |
Responses
{
"id": null,
"resourceId": null,
"category": "create",
"timestamp": "2022-04-13T15:42:05.901Z",
"user": "string",
"url": "string",
"resource": "string",
"snapshot": {},
"differential": {},
"context": {}
}
Schema of the response body
{
"description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
"properties": {
"id": {
"description": "The unique identifier of the history event",
"title": "Event ID"
},
"resourceId": {
"description": "The unique identifier of the tracked resource",
"title": "Resource ID"
},
"category": {
"$ref": "#/components/schemas/HistoryEventCategory",
"description": "The type of history event",
"title": "Category"
},
"timestamp": {
"description": "Timestamp of the history event",
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"user": {
"description": "Username of the user that triggered the event, if applicable",
"title": "User",
"type": "string"
},
"url": {
"description": "Endpoint URL through which the event was triggered, if applicable",
"title": "Endpoint",
"type": "string"
},
"resource": {
"description": "Resource involved in the event, if applicable",
"title": "Resource",
"type": "string"
},
"snapshot": {
"additionalProperties": true,
"description": "Data snapshopt at the time of the event",
"title": "Data snapshopt",
"type": "object"
},
"differential": {
"additionalProperties": true,
"description": "Data changes introduced by the event, if applicable",
"title": "Data differential",
"type": "object"
},
"context": {
"additionalProperties": true,
"description": "Context sorrounding the event",
"title": "Context",
"type": "object"
}
},
"required": [
"id",
"resourceId",
"category",
"timestamp",
"snapshot",
"differential",
"context"
],
"title": "HistoryEventWithSchema",
"type": "object"
}
PUT /api/v1/datasets/{datasetId}/history/events/{eventId}/reversion¶
Revert Dataset To History Event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
XSessionTokenAuth |
header | string | N/A | No | API key |
datasetId |
path | string | No | ||
eventId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"description": "Represents a resource that was modified in the system.\n\nAttributes:\n id (UUID): Unique identifier (UUID4) of the modified resource.\n description (Optional[str]): A human-readable description of the modified resource.",
"properties": {
"id": {
"description": "Unique identifier (UUID4) of the modified resource.",
"format": "uuid",
"title": "ID",
"type": "string"
},
"description": {
"description": "A human-readable description of the modified resource.",
"title": "Description",
"type": "string"
}
},
"required": [
"id"
],
"title": "ModifiedResource",
"type": "object"
}
Schemas¶
AccessRoles¶
Type: string
AdverseEvent¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who had the adverse event being recorded |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the adverse event ocurred. |
dateResolved |
string(date) | The date when the adverse event ended or returned to baseline. |
description |
string | Human-readable description |
event |
CodedConcept | Classification of the adverse event using CTCAE criteria |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
grade |
integer | The grade associated with the severity of an adverse event, using CTCAE criteria. |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
mitigations |
Array<AdverseEventMitigation> | Mitigations of the adverse event |
outcome |
AdverseEventOutcomeChoices | The date when the adverse event ended or returned to baseline. |
suspectedCauses |
Array<AdverseEventSuspectedCause> | Suspected causes of the adverse event |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
AdverseEventCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who had the adverse event being recorded |
date |
string(date) | Clinically-relevant date at which the adverse event ocurred. |
dateResolved |
string(date) | The date when the adverse event ended or returned to baseline. |
event |
CodedConcept | Classification of the adverse event using CTCAE criteria |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
grade |
integer | The grade associated with the severity of an adverse event, using CTCAE criteria. |
outcome |
AdverseEventOutcomeChoices | The date when the adverse event ended or returned to baseline. |
AdverseEventFilters¶
| Name | Type | Description |
|---|---|---|
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Event date - Filter for entries with dates after the specified value |
date.before |
string(date) | Event date - Filter for entries with dates before the specified value |
date.between |
Array<> | Event date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Event date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Event date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Event date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Event date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Event date - Filter for entries with dates on or before the specified value |
dateResolved.after |
string(date) | Date resolved - Filter for entries with dates after the specified value |
dateResolved.before |
string(date) | Date resolved - Filter for entries with dates before the specified value |
dateResolved.between |
Array<> | Date resolved - Filter for entries with dates between two specified values (inclusive) |
dateResolved.exists |
boolean | Date resolved - Filter for entries with a value |
dateResolved.not.between |
Array<> | Date resolved - Filter for entries with dates not between two specified values (inclusive) |
dateResolved.not.exists |
boolean | Date resolved - Filter for entries without a value |
dateResolved.not.on |
string(date) | Date resolved - Filter for entries with dates not matching the specified value |
dateResolved.on |
string(date) | Date resolved - Filter for entries with dates exactly matching the specified value |
dateResolved.onOrAfter |
string(date) | Date resolved - Filter for entries with dates on or after the specified value |
dateResolved.onOrBefore |
string(date) | Date resolved - Filter for entries with dates on or before the specified value |
event |
string | Adverse event - Filter for a matching concept code |
event.anyOf |
Array<string> | Adverse event - Filter for a matching set of concept codes |
event.descendantsOf |
string | Adverse event - Filter for all child concepts of a given concepts code |
event.not |
string | Adverse event - Filter for a mismatching concept code |
event.not.anyOf |
Array<string> | Adverse event - Filter for a mismmatching set of concept codes |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
grade.between |
Array<> | Grade - Filter for entries with values between two specified values (inclusive) |
grade.equal |
integer | Grade - Filter for entries with values exactly equal to the specified value |
grade.greaterThan |
integer | Grade - Filter for entries with values greater than the specified value |
grade.greaterThanOrEqual |
integer | Grade - Filter for entries with values greater than or equal to the specified value |
grade.lessThan |
integer | Grade - Filter for entries with values less than the specified value |
grade.lessThanOrEqual |
integer | Grade - Filter for entries with values less than or equal to the specified value |
grade.not.between |
Array<> | Grade - Filter for entries with values between two specified values (inclusive) |
grade.not.equal |
integer | Grade - Filter for entries with values not equal to the specified value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
mitigations.adjustment |
string | Treatment Adjustment - Filter for a matching concept code |
mitigations.adjustment.anyOf |
Array<string> | Treatment Adjustment - Filter for a matching set of concept codes |
mitigations.adjustment.descendantsOf |
string | Treatment Adjustment - Filter for all child concepts of a given concepts code |
mitigations.adjustment.exists |
boolean | Treatment Adjustment - Filter for entries with a value |
mitigations.adjustment.not |
string | Treatment Adjustment - Filter for a mismatching concept code |
mitigations.adjustment.not.anyOf |
Array<string> | Treatment Adjustment - Filter for a mismmatching set of concept codes |
mitigations.adjustment.not.exists |
boolean | Treatment Adjustment - Filter for entries without a value |
mitigations.category |
Mitigation category - Filter for single value choice | |
mitigations.category.anyOf |
Array<string> | Mitigation category - ('Filter for excluding a subset of value choices',) |
mitigations.category.not |
Mitigation category - ('Filter for all but a single value choice',) | |
mitigations.createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
mitigations.createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
mitigations.createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
mitigations.createdAt.exists |
boolean | Created at - Filter for entries with a value |
mitigations.createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
mitigations.createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
mitigations.createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
mitigations.createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
mitigations.createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
mitigations.createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
mitigations.drug |
string | Pharmacological drug - Filter for a matching concept code |
mitigations.drug.anyOf |
Array<string> | Pharmacological drug - Filter for a matching set of concept codes |
mitigations.drug.descendantsOf |
string | Pharmacological drug - Filter for all child concepts of a given concepts code |
mitigations.drug.exists |
boolean | Pharmacological drug - Filter for entries with a value |
mitigations.drug.not |
string | Pharmacological drug - Filter for a mismatching concept code |
mitigations.drug.not.anyOf |
Array<string> | Pharmacological drug - Filter for a mismmatching set of concept codes |
mitigations.drug.not.exists |
boolean | Pharmacological drug - Filter for entries without a value |
mitigations.externalSource |
string | External data source - Filter for full text matches |
mitigations.externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
mitigations.externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
mitigations.externalSource.contains |
string | External data source - Filter for partial text matches |
mitigations.externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
mitigations.externalSource.exists |
boolean | External data source - Filter for entries with a value |
mitigations.externalSource.not |
string | External data source - Filter for full text mismatches |
mitigations.externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
mitigations.externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
mitigations.externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
mitigations.externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
mitigations.externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
mitigations.id |
string | Id - Filter for full text matches |
mitigations.id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
mitigations.id.beginsWith |
string | Id - Filter for entries starting with the text |
mitigations.id.contains |
string | Id - Filter for partial text matches |
mitigations.id.endsWith |
string | Id - Filter for entries ending with the text |
mitigations.id.not |
string | Id - Filter for full text mismatches |
mitigations.id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
mitigations.id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
mitigations.id.not.contains |
string | Id - Filter for partial text mismatches |
mitigations.id.not.endsWith |
string | Id - Filter for entries not ending with the text |
mitigations.management |
string | Management - Filter for a matching concept code |
mitigations.management.anyOf |
Array<string> | Management - Filter for a matching set of concept codes |
mitigations.management.descendantsOf |
string | Management - Filter for all child concepts of a given concepts code |
mitigations.management.exists |
boolean | Management - Filter for entries with a value |
mitigations.management.not |
string | Management - Filter for a mismatching concept code |
mitigations.management.not.anyOf |
Array<string> | Management - Filter for a mismmatching set of concept codes |
mitigations.management.not.exists |
boolean | Management - Filter for entries without a value |
mitigations.procedure |
string | Procedure - Filter for a matching concept code |
mitigations.procedure.anyOf |
Array<string> | Procedure - Filter for a matching set of concept codes |
mitigations.procedure.descendantsOf |
string | Procedure - Filter for all child concepts of a given concepts code |
mitigations.procedure.exists |
boolean | Procedure - Filter for entries with a value |
mitigations.procedure.not |
string | Procedure - Filter for a mismatching concept code |
mitigations.procedure.not.anyOf |
Array<string> | Procedure - Filter for a mismmatching set of concept codes |
mitigations.procedure.not.exists |
boolean | Procedure - Filter for entries without a value |
mitigations.updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
mitigations.updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
mitigations.updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
mitigations.updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
mitigations.updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
mitigations.updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
mitigations.updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
mitigations.updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
mitigations.updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
mitigations.updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
outcome |
Date resolved - Filter for single value choice | |
outcome.anyOf |
Array<string> | Date resolved - ('Filter for excluding a subset of value choices',) |
outcome.not |
Date resolved - ('Filter for all but a single value choice',) | |
suspectedCauses.causality |
Causality - Filter for single value choice | |
suspectedCauses.causality.anyOf |
Array<string> | Causality - ('Filter for excluding a subset of value choices',) |
suspectedCauses.causality.exists |
boolean | Causality - Filter for entries with a value |
suspectedCauses.causality.not |
Causality - ('Filter for all but a single value choice',) | |
suspectedCauses.causality.not.exists |
boolean | Causality - Filter for entries without a value |
suspectedCauses.createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
suspectedCauses.createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
suspectedCauses.createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
suspectedCauses.createdAt.exists |
boolean | Created at - Filter for entries with a value |
suspectedCauses.createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
suspectedCauses.createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
suspectedCauses.createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
suspectedCauses.createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
suspectedCauses.createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
suspectedCauses.createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
suspectedCauses.externalSource |
string | External data source - Filter for full text matches |
suspectedCauses.externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
suspectedCauses.externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
suspectedCauses.externalSource.contains |
string | External data source - Filter for partial text matches |
suspectedCauses.externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
suspectedCauses.externalSource.exists |
boolean | External data source - Filter for entries with a value |
suspectedCauses.externalSource.not |
string | External data source - Filter for full text mismatches |
suspectedCauses.externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
suspectedCauses.externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
suspectedCauses.externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
suspectedCauses.externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
suspectedCauses.externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
suspectedCauses.id |
string | Id - Filter for full text matches |
suspectedCauses.id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
suspectedCauses.id.beginsWith |
string | Id - Filter for entries starting with the text |
suspectedCauses.id.contains |
string | Id - Filter for partial text matches |
suspectedCauses.id.endsWith |
string | Id - Filter for entries ending with the text |
suspectedCauses.id.not |
string | Id - Filter for full text mismatches |
suspectedCauses.id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
suspectedCauses.id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
suspectedCauses.id.not.contains |
string | Id - Filter for partial text mismatches |
suspectedCauses.id.not.endsWith |
string | Id - Filter for entries not ending with the text |
suspectedCauses.medicationId |
string | Suspected systemic therapy medication - Filter for reference matches |
suspectedCauses.medicationId.anyOf |
Array<string> | Suspected systemic therapy medication - Filter for entries where at least one reference matches the query |
suspectedCauses.medicationId.beginsWith |
string | Suspected systemic therapy medication - Filter for entries starting with the text |
suspectedCauses.medicationId.contains |
string | Suspected systemic therapy medication - Filter for partial text matches |
suspectedCauses.medicationId.endsWith |
string | Suspected systemic therapy medication - Filter for entries ending with the text |
suspectedCauses.medicationId.exists |
boolean | Suspected systemic therapy medication - Filter for entries with a value |
suspectedCauses.medicationId.not |
string | Suspected systemic therapy medication - Filter for reference mismatches |
suspectedCauses.medicationId.not.anyOf |
Array<string> | Suspected systemic therapy medication - Filter for entries where at least one reference mismatches the query |
suspectedCauses.medicationId.not.beginsWith |
string | Suspected systemic therapy medication - Filter for entries not starting with the text |
suspectedCauses.medicationId.not.contains |
string | Suspected systemic therapy medication - Filter for partial text mismatches |
suspectedCauses.medicationId.not.endsWith |
string | Suspected systemic therapy medication - Filter for entries not ending with the text |
suspectedCauses.medicationId.not.exists |
boolean | Suspected systemic therapy medication - Filter for entries without a value |
suspectedCauses.radiotherapyId |
string | Suspected radiotherapy - Filter for reference matches |
suspectedCauses.radiotherapyId.anyOf |
Array<string> | Suspected radiotherapy - Filter for entries where at least one reference matches the query |
suspectedCauses.radiotherapyId.beginsWith |
string | Suspected radiotherapy - Filter for entries starting with the text |
suspectedCauses.radiotherapyId.contains |
string | Suspected radiotherapy - Filter for partial text matches |
suspectedCauses.radiotherapyId.endsWith |
string | Suspected radiotherapy - Filter for entries ending with the text |
suspectedCauses.radiotherapyId.exists |
boolean | Suspected radiotherapy - Filter for entries with a value |
suspectedCauses.radiotherapyId.not |
string | Suspected radiotherapy - Filter for reference mismatches |
suspectedCauses.radiotherapyId.not.anyOf |
Array<string> | Suspected radiotherapy - Filter for entries where at least one reference mismatches the query |
suspectedCauses.radiotherapyId.not.beginsWith |
string | Suspected radiotherapy - Filter for entries not starting with the text |
suspectedCauses.radiotherapyId.not.contains |
string | Suspected radiotherapy - Filter for partial text mismatches |
suspectedCauses.radiotherapyId.not.endsWith |
string | Suspected radiotherapy - Filter for entries not ending with the text |
suspectedCauses.radiotherapyId.not.exists |
boolean | Suspected radiotherapy - Filter for entries without a value |
suspectedCauses.surgeryId |
string | Suspected surgery - Filter for reference matches |
suspectedCauses.surgeryId.anyOf |
Array<string> | Suspected surgery - Filter for entries where at least one reference matches the query |
suspectedCauses.surgeryId.beginsWith |
string | Suspected surgery - Filter for entries starting with the text |
suspectedCauses.surgeryId.contains |
string | Suspected surgery - Filter for partial text matches |
suspectedCauses.surgeryId.endsWith |
string | Suspected surgery - Filter for entries ending with the text |
suspectedCauses.surgeryId.exists |
boolean | Suspected surgery - Filter for entries with a value |
suspectedCauses.surgeryId.not |
string | Suspected surgery - Filter for reference mismatches |
suspectedCauses.surgeryId.not.anyOf |
Array<string> | Suspected surgery - Filter for entries where at least one reference mismatches the query |
suspectedCauses.surgeryId.not.beginsWith |
string | Suspected surgery - Filter for entries not starting with the text |
suspectedCauses.surgeryId.not.contains |
string | Suspected surgery - Filter for partial text mismatches |
suspectedCauses.surgeryId.not.endsWith |
string | Suspected surgery - Filter for entries not ending with the text |
suspectedCauses.surgeryId.not.exists |
boolean | Suspected surgery - Filter for entries without a value |
suspectedCauses.systemicTherapyId |
string | Suspected systemic therapy - Filter for reference matches |
suspectedCauses.systemicTherapyId.anyOf |
Array<string> | Suspected systemic therapy - Filter for entries where at least one reference matches the query |
suspectedCauses.systemicTherapyId.beginsWith |
string | Suspected systemic therapy - Filter for entries starting with the text |
suspectedCauses.systemicTherapyId.contains |
string | Suspected systemic therapy - Filter for partial text matches |
suspectedCauses.systemicTherapyId.endsWith |
string | Suspected systemic therapy - Filter for entries ending with the text |
suspectedCauses.systemicTherapyId.exists |
boolean | Suspected systemic therapy - Filter for entries with a value |
suspectedCauses.systemicTherapyId.not |
string | Suspected systemic therapy - Filter for reference mismatches |
suspectedCauses.systemicTherapyId.not.anyOf |
Array<string> | Suspected systemic therapy - Filter for entries where at least one reference mismatches the query |
suspectedCauses.systemicTherapyId.not.beginsWith |
string | Suspected systemic therapy - Filter for entries not starting with the text |
suspectedCauses.systemicTherapyId.not.contains |
string | Suspected systemic therapy - Filter for partial text mismatches |
suspectedCauses.systemicTherapyId.not.endsWith |
string | Suspected systemic therapy - Filter for entries not ending with the text |
suspectedCauses.systemicTherapyId.not.exists |
boolean | Suspected systemic therapy - Filter for entries without a value |
suspectedCauses.updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
suspectedCauses.updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
suspectedCauses.updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
suspectedCauses.updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
suspectedCauses.updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
suspectedCauses.updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
suspectedCauses.updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
suspectedCauses.updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
suspectedCauses.updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
suspectedCauses.updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
AdverseEventMitigation¶
| Name | Type | Description |
|---|---|---|
adjustment |
Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable) | |
category |
AdverseEventMitigationCategoryChoices | Type of mitigation employed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
drug |
Classification of the pharmacological treatment used to mitigate the adverse event (if applicable) | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
management |
Management type of the adverse event mitigation | |
procedure |
Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable) | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
AdverseEventMitigationCategoryChoices¶
Type: string
AdverseEventMitigationCreate¶
| Name | Type | Description |
|---|---|---|
adjustment |
Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable) | |
category |
AdverseEventMitigationCategoryChoices | Type of mitigation employed |
drug |
Classification of the pharmacological treatment used to mitigate the adverse event (if applicable) | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
management |
Management type of the adverse event mitigation | |
procedure |
Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable) |
AdverseEventMitigationPartial¶
| Name | Type | Description |
|---|---|---|
adjustment |
Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable) | |
anonymized |
boolean | Whether the data has been anonymized |
category |
Type of mitigation employed | |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
drug |
Classification of the pharmacological treatment used to mitigate the adverse event (if applicable) | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
management |
Management type of the adverse event mitigation | |
procedure |
Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable) | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
AdverseEventOutcomeChoices¶
Type: string
AdverseEventPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who had the adverse event being recorded |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the adverse event ocurred. |
dateResolved |
string(date) | The date when the adverse event ended or returned to baseline. |
event |
Classification of the adverse event using CTCAE criteria | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
grade |
integer | The grade associated with the severity of an adverse event, using CTCAE criteria. |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
mitigations |
Array<AdverseEventMitigationPartial> | Mitigations of the adverse event |
outcome |
The date when the adverse event ended or returned to baseline. | |
suspectedCauses |
Array<AdverseEventSuspectedCausePartial> | Suspected causes of the adverse event |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
AdverseEventSuspectedCause¶
| Name | Type | Description |
|---|---|---|
causality |
Assessment of the potential causality | |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
medicationId |
string(uuid) | Systemic therapy medication suspected to be the cause of the adverse event |
radiotherapyId |
string(uuid) | Radiotherapy suspected to be the cause of the adverse event |
surgeryId |
string(uuid) | Surgery suspected to be the cause of the adverse event |
systemicTherapyId |
string(uuid) | Systemic therapy suspected to be the cause of the adverse event |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
AdverseEventSuspectedCauseCausalityChoices¶
Type: string
AdverseEventSuspectedCauseCreate¶
| Name | Type | Description |
|---|---|---|
causality |
Assessment of the potential causality | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
medicationId |
string(uuid) | Systemic therapy medication suspected to be the cause of the adverse event |
radiotherapyId |
string(uuid) | Radiotherapy suspected to be the cause of the adverse event |
surgeryId |
string(uuid) | Surgery suspected to be the cause of the adverse event |
systemicTherapyId |
string(uuid) | Systemic therapy suspected to be the cause of the adverse event |
AdverseEventSuspectedCausePartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
causality |
Assessment of the potential causality | |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
medicationId |
string(uuid) | Systemic therapy medication suspected to be the cause of the adverse event |
radiotherapyId |
string(uuid) | Radiotherapy suspected to be the cause of the adverse event |
surgeryId |
string(uuid) | Surgery suspected to be the cause of the adverse event |
systemicTherapyId |
string(uuid) | Systemic therapy suspected to be the cause of the adverse event |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
AgeBin¶
Type: string
AnalysisMetadata¶
| Name | Type | Description |
|---|---|---|
analyzedAt |
string(date-time) | The datetime at which the analysis was performed. |
cohortId |
string | The ID of the cohort for which the analysis was performed. |
cohortPopulation |
integer | The effective number of valid patient cases in the cohort used for the analysis. |
AnalyteDetails¶
| Name | Type | Description |
|---|---|---|
acronym |
string | |
display |
string | |
valueTypes |
Array<AnalyteResultType> |
AnalyteResultType¶
Type: string
AneuploidScore¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
integer | The actual aneuploid score (AS) value in total altered arms |
AneuploidScoreCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
value |
integer | The actual aneuploid score (AS) value in total altered arms |
AneuploidScorePartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
integer | The actual aneuploid score (AS) value in total altered arms |
AnyGenomicSignature¶
Type:
AnyStaging¶
Type:
AnyTumorBoard¶
Type:
AuthenticationMeta¶
| Name | Type | Description |
|---|---|---|
accessToken |
string | The access token for the authenticated session, if available. |
isAuthenticated |
boolean | Indicates whether the user is authenticated. |
sessionToken |
string | The session token associated with the authentication, if available. |
BinetStaging¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
CodedConcept | The value of the Binet stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
BinetStagingCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
stage |
CodedConcept | The value of the Binet stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
BinetStagingPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
The value of the Binet stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
BreslowDepth¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
depth |
Measure | Breslow depth |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
isUlcered |
boolean | Whether the primary tumour presents ulceration |
stage |
CodedConcept | The value of the Breslow stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
BreslowDepthCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
depth |
Measure | Breslow depth |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
isUlcered |
boolean | Whether the primary tumour presents ulceration |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
BreslowDepthPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
depth |
Breslow depth | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
isUlcered |
boolean | Whether the primary tumour presents ulceration |
stage |
The value of the Breslow stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
CategorizedSurvivals¶
| Name | Type | Description |
|---|---|---|
metadata |
Metadata for the Kaplan-Meier curve. | |
survivals |
ClarkStaging¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
CodedConcept | The value of the Clark level stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
ClarkStagingCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
stage |
CodedConcept | The value of the Clark level stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
ClarkStagingPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
The value of the Clark level stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
CodedConcept¶
| Name | Type | Description |
|---|---|---|
code |
string | Unique code within a coding system that identifies a concept. |
display |
string | Human-readable description of the concept. |
properties |
Additional properties associated with the concept. | |
synonyms |
Array<string> | List of synonyms or alternative representations of the concept. |
system |
string | Canonical URL of the code system defining the concept. |
version |
string | Release version of the code system, if applicable. |
Cohort¶
| Name | Type | Description |
|---|---|---|
casesIds |
Array<string(uuid)> | Cases composing the cohort |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
excludeCriteria |
Logic rules to filter and constrain the cases to be excluded from the cohort | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
frozenSetIds |
Array<string(uuid)> | Frozen cases |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
includeCriteria |
Logic rules to filter and constrain the cases to be included in the cohort | |
manualChoicesIds |
Array<string(uuid)> | Manually added cases |
name |
string | Name of the cohort |
population |
integer | Cohort population |
projectId |
string(uuid) | Project to which the cohort is associated |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
CohortContribution¶
| Name | Type | Description |
|---|---|---|
contributions |
integer | The number of records or actions contributed by this user. |
contributor |
string | Username or identifier of the contributing user. |
CohortCreate¶
| Name | Type | Description |
|---|---|---|
casesIds |
Array<string(uuid)> | Cases composing the cohort |
excludeCriteria |
Logic rules to filter and constrain the cases to be excluded from the cohort | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
frozenSetIds |
Array<string(uuid)> | Frozen cases |
includeCriteria |
Logic rules to filter and constrain the cases to be included in the cohort | |
manualChoicesIds |
Array<string(uuid)> | Manually added cases |
name |
string | Name of the cohort |
projectId |
string(uuid) | Project to which the cohort is associated |
CohortFilters¶
| Name | Type | Description |
|---|---|---|
casesIds |
string | Cases - Filter for full text matches |
casesIds.anyOf |
Array<string> | Cases - Filter for entries where at least one reference matches the query |
casesIds.beginsWith |
string | Cases - Filter for entries starting with the text |
casesIds.contains |
string | Cases - Filter for partial text matches |
casesIds.endsWith |
string | Cases - Filter for entries ending with the text |
casesIds.exists |
boolean | Cases - Filter for entries with a value |
casesIds.not |
string | Cases - Filter for full text mismatches |
casesIds.not.anyOf |
Array<string> | Cases - Filter for entries where at least one reference mismatches the query |
casesIds.not.beginsWith |
string | Cases - Filter for entries not starting with the text |
casesIds.not.contains |
string | Cases - Filter for partial text mismatches |
casesIds.not.endsWith |
string | Cases - Filter for entries not ending with the text |
casesIds.not.exists |
boolean | Cases - Filter for entries without a value |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
createdBy |
string | Filter for a particular cohort creator by its username |
excludeCriteria.exists |
boolean | Exclusion critera - Filter for entries with a value |
excludeCriteria.not.exists |
boolean | Exclusion critera - Filter for entries without a value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
frozenSetIds |
string | Frozen cases - Filter for full text matches |
frozenSetIds.anyOf |
Array<string> | Frozen cases - Filter for entries where at least one reference matches the query |
frozenSetIds.beginsWith |
string | Frozen cases - Filter for entries starting with the text |
frozenSetIds.contains |
string | Frozen cases - Filter for partial text matches |
frozenSetIds.endsWith |
string | Frozen cases - Filter for entries ending with the text |
frozenSetIds.exists |
boolean | Frozen cases - Filter for entries with a value |
frozenSetIds.not |
string | Frozen cases - Filter for full text mismatches |
frozenSetIds.not.anyOf |
Array<string> | Frozen cases - Filter for entries where at least one reference mismatches the query |
frozenSetIds.not.beginsWith |
string | Frozen cases - Filter for entries not starting with the text |
frozenSetIds.not.contains |
string | Frozen cases - Filter for partial text mismatches |
frozenSetIds.not.endsWith |
string | Frozen cases - Filter for entries not ending with the text |
frozenSetIds.not.exists |
boolean | Frozen cases - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
includeCriteria.exists |
boolean | Inclusion critera - Filter for entries with a value |
includeCriteria.not.exists |
boolean | Inclusion critera - Filter for entries without a value |
manualChoicesIds |
string | Manually added cases - Filter for full text matches |
manualChoicesIds.anyOf |
Array<string> | Manually added cases - Filter for entries where at least one reference matches the query |
manualChoicesIds.beginsWith |
string | Manually added cases - Filter for entries starting with the text |
manualChoicesIds.contains |
string | Manually added cases - Filter for partial text matches |
manualChoicesIds.endsWith |
string | Manually added cases - Filter for entries ending with the text |
manualChoicesIds.exists |
boolean | Manually added cases - Filter for entries with a value |
manualChoicesIds.not |
string | Manually added cases - Filter for full text mismatches |
manualChoicesIds.not.anyOf |
Array<string> | Manually added cases - Filter for entries where at least one reference mismatches the query |
manualChoicesIds.not.beginsWith |
string | Manually added cases - Filter for entries not starting with the text |
manualChoicesIds.not.contains |
string | Manually added cases - Filter for partial text mismatches |
manualChoicesIds.not.endsWith |
string | Manually added cases - Filter for entries not ending with the text |
manualChoicesIds.not.exists |
boolean | Manually added cases - Filter for entries without a value |
name |
string | Cohort name - Filter for full text matches |
name.anyOf |
Array<string> | Cohort name - Filter for entries where at least one reference matches the query |
name.beginsWith |
string | Cohort name - Filter for entries starting with the text |
name.contains |
string | Cohort name - Filter for partial text matches |
name.endsWith |
string | Cohort name - Filter for entries ending with the text |
name.not |
string | Cohort name - Filter for full text mismatches |
name.not.anyOf |
Array<string> | Cohort name - Filter for entries where at least one reference mismatches the query |
name.not.beginsWith |
string | Cohort name - Filter for entries not starting with the text |
name.not.contains |
string | Cohort name - Filter for partial text mismatches |
name.not.endsWith |
string | Cohort name - Filter for entries not ending with the text |
population.between |
Array<> | Population - Filter for entries with values between two specified values (inclusive) |
population.equal |
integer | Population - Filter for entries with values exactly equal to the specified value |
population.greaterThan |
integer | Population - Filter for entries with values greater than the specified value |
population.greaterThanOrEqual |
integer | Population - Filter for entries with values greater than or equal to the specified value |
population.lessThan |
integer | Population - Filter for entries with values less than the specified value |
population.lessThanOrEqual |
integer | Population - Filter for entries with values less than or equal to the specified value |
population.not.between |
Array<> | Population - Filter for entries with values between two specified values (inclusive) |
population.not.equal |
integer | Population - Filter for entries with values not equal to the specified value |
projectId |
string | Project - Filter for reference matches |
projectId.anyOf |
Array<string> | Project - Filter for entries where at least one reference matches the query |
projectId.beginsWith |
string | Project - Filter for entries starting with the text |
projectId.contains |
string | Project - Filter for partial text matches |
projectId.endsWith |
string | Project - Filter for entries ending with the text |
projectId.exists |
boolean | Project - Filter for entries with a value |
projectId.not |
string | Project - Filter for reference mismatches |
projectId.not.anyOf |
Array<string> | Project - Filter for entries where at least one reference mismatches the query |
projectId.not.beginsWith |
string | Project - Filter for entries not starting with the text |
projectId.not.contains |
string | Project - Filter for partial text mismatches |
projectId.not.endsWith |
string | Project - Filter for entries not ending with the text |
projectId.not.exists |
boolean | Project - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
CohortQueryEntity¶
Type: string
CohortQueryFilter¶
Type: string
CohortRule¶
| Name | Type | Description |
|---|---|---|
entity |
CohortQueryEntity | Name of the case-related resource |
filters |
Array<CohortRuleFilter> | List of filters to be applied to the resource |
CohortRuleFilter¶
| Name | Type | Description |
|---|---|---|
field |
string | Dot-separated path of the resource field (e.g. 'medications.drug') |
operator |
CohortQueryFilter | Name of the filter operator to be applied to the field |
value |
Filter value to be applied to the field using the rule's oprerator |
CohortRuleset¶
| Name | Type | Description |
|---|---|---|
condition |
Logical condition used to chain the rules within the ruleset | |
rules |
Array<> | List of rules or nested rulesets that define the fields and values to use for the filtering. |
CohortTraitCounts¶
| Name | Type | Description |
|---|---|---|
category |
string | The category or group label for the cohort trait value. |
counts |
integer | The number of records in this category. |
percentage |
number | The percentage of the total cohort population in this category. |
CohortTraitMedian¶
| Name | Type | Description |
|---|---|---|
interQuartalRange |
The lower and upper bounds of the interquartile range. | |
median |
The median value for the cohort trait. |
CohortTraits¶
| Name | Type | Description |
|---|---|---|
age |
CohortTraitMedian | Median age of individuals in the cohort. |
consentStatus |
Array<CohortTraitCounts> | Distribution of consent statuses for data use among cohort participants. |
dataCompletion |
CohortTraitMedian | Median percentage of completed data per patient. |
genders |
Array<CohortTraitCounts> | Distribution of genders within the cohort. |
neoplasticSites |
Array<CohortTraitCounts> | Distribution of neoplastic (tumor) sites in the cohort. |
overallSurvival |
CohortTraitMedian | Median overall survival time in the cohort, if available. |
therapyLines |
Array<CohortTraitCounts> | Distribution of therapy lines received by patients in the cohort. |
ComorbiditiesAssessment¶
| Name | Type | Description |
|---|---|---|
absentConditions |
Array<CodedConcept> | Absent comorbid conditions |
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's comorbidities are being recorded |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's comorbidities were assessed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
indexConditionId |
string(uuid) | The primary neoplastic entity against which comorbidities are assessed |
panel |
Comorbidities panel | |
presentConditions |
Array<CodedConcept> | Present comorbid conditions |
score |
Comorbidity score | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
ComorbiditiesAssessmentCreate¶
| Name | Type | Description |
|---|---|---|
absentConditions |
Array<CodedConcept> | Absent comorbid conditions |
caseId |
string(uuid) | Indicates the case of the patient who's comorbidities are being recorded |
date |
string(date) | Clinically-relevant date at which the patient's comorbidities were assessed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
indexConditionId |
string(uuid) | The primary neoplastic entity against which comorbidities are assessed |
panel |
Comorbidities panel | |
presentConditions |
Array<CodedConcept> | Present comorbid conditions |
ComorbiditiesAssessmentFilters¶
| Name | Type | Description |
|---|---|---|
absentConditions |
string | Absent comorbid conditions - Filter for a matching concept code |
absentConditions.allOf |
Array<string> | Absent comorbid conditions - Filter for entries matching all of the concepts |
absentConditions.anyOf |
Array<string> | Absent comorbid conditions - Filter for a matching set of concept codes |
absentConditions.descendantsOf |
string | Absent comorbid conditions - Filter for all child concepts of a given concepts code |
absentConditions.exists |
boolean | Absent comorbid conditions - Filter for entries with a value |
absentConditions.not |
string | Absent comorbid conditions - Filter for a mismatching concept code |
absentConditions.not.allOf |
Array<string> | Absent comorbid conditions - Filter for entries mismatching all of the concepts |
absentConditions.not.anyOf |
Array<string> | Absent comorbid conditions - Filter for a mismmatching set of concept codes |
absentConditions.not.exists |
boolean | Absent comorbid conditions - Filter for entries without a value |
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Assessment date - Filter for entries with dates after the specified value |
date.before |
string(date) | Assessment date - Filter for entries with dates before the specified value |
date.between |
Array<> | Assessment date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Assessment date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Assessment date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Assessment date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Assessment date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Assessment date - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
indexConditionId |
string | Index neoplastic entity - Filter for reference matches |
indexConditionId.anyOf |
Array<string> | Index neoplastic entity - Filter for entries where at least one reference matches the query |
indexConditionId.beginsWith |
string | Index neoplastic entity - Filter for entries starting with the text |
indexConditionId.contains |
string | Index neoplastic entity - Filter for partial text matches |
indexConditionId.endsWith |
string | Index neoplastic entity - Filter for entries ending with the text |
indexConditionId.not |
string | Index neoplastic entity - Filter for reference mismatches |
indexConditionId.not.anyOf |
Array<string> | Index neoplastic entity - Filter for entries where at least one reference mismatches the query |
indexConditionId.not.beginsWith |
string | Index neoplastic entity - Filter for entries not starting with the text |
indexConditionId.not.contains |
string | Index neoplastic entity - Filter for partial text mismatches |
indexConditionId.not.endsWith |
string | Index neoplastic entity - Filter for entries not ending with the text |
panel |
Panel - Filter for single value choice | |
panel.anyOf |
Array<string> | Panel - ('Filter for excluding a subset of value choices',) |
panel.exists |
boolean | Panel - Filter for entries with a value |
panel.not |
Panel - ('Filter for all but a single value choice',) | |
panel.not.exists |
boolean | Panel - Filter for entries without a value |
presentConditions |
string | Present comorbid conditions - Filter for a matching concept code |
presentConditions.allOf |
Array<string> | Present comorbid conditions - Filter for entries matching all of the concepts |
presentConditions.anyOf |
Array<string> | Present comorbid conditions - Filter for a matching set of concept codes |
presentConditions.descendantsOf |
string | Present comorbid conditions - Filter for all child concepts of a given concepts code |
presentConditions.exists |
boolean | Present comorbid conditions - Filter for entries with a value |
presentConditions.not |
string | Present comorbid conditions - Filter for a mismatching concept code |
presentConditions.not.allOf |
Array<string> | Present comorbid conditions - Filter for entries mismatching all of the concepts |
presentConditions.not.anyOf |
Array<string> | Present comorbid conditions - Filter for a mismmatching set of concept codes |
presentConditions.not.exists |
boolean | Present comorbid conditions - Filter for entries without a value |
score.between |
Array<> | Score - Filter for entries with values between two specified values (inclusive) |
score.equal |
integer | Score - Filter for entries with values exactly equal to the specified value |
score.exists |
boolean | Score - Filter for entries with a value |
score.greaterThan |
integer | Score - Filter for entries with values greater than the specified value |
score.greaterThanOrEqual |
integer | Score - Filter for entries with values greater than or equal to the specified value |
score.lessThan |
integer | Score - Filter for entries with values less than the specified value |
score.lessThanOrEqual |
integer | Score - Filter for entries with values less than or equal to the specified value |
score.not.between |
Array<> | Score - Filter for entries with values between two specified values (inclusive) |
score.not.equal |
integer | Score - Filter for entries with values not equal to the specified value |
score.not.exists |
boolean | Score - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
ComorbiditiesAssessmentPanelChoices¶
Type: string
ComorbiditiesAssessmentPartial¶
| Name | Type | Description |
|---|---|---|
absentConditions |
Absent comorbid conditions | |
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's comorbidities are being recorded |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's comorbidities were assessed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
indexConditionId |
string(uuid) | The primary neoplastic entity against which comorbidities are assessed |
panel |
Comorbidities panel | |
presentConditions |
Present comorbid conditions | |
score |
Comorbidity score | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
ComorbiditiesPanel¶
| Name | Type | Description |
|---|---|---|
categories |
Array<ComorbidityPanelCategory> | Comorbidity panel categories |
name |
string | Comorbidity panel name |
ComorbidityPanelCategory¶
| Name | Type | Description |
|---|---|---|
conditions |
Array<CodedConcept> | List of conditions included in the panel category |
default |
Default choice for category | |
label |
string | Label of the comorbidity panel category |
ConflictResolution¶
Type: string
CountsPerMonth¶
| Name | Type | Description |
|---|---|---|
cumulativeCount |
integer | Total number of entries accumulated up to and including the given month. |
month |
string(date) | The month (as date) representing the period of data aggregation. |
DataCompletionStatistics¶
| Name | Type | Description |
|---|---|---|
completionOverTime |
Array<CountsPerMonth> | Historical trend of cumulative data completeness by month. |
mostIncompleteCategories |
Array<IncompleteCategory> | List of the most common categories with missing data. |
overallCompletion |
number | Overall percentage of data categories completed across all cases. |
totalCases |
integer | Total number of patient cases analyzed for data completeness. |
DataPlatformStatistics¶
| Name | Type | Description |
|---|---|---|
cases |
integer | Total number of unique patient cases in the data platform. |
clinicalCenters |
integer | Number of clinical centers contributing data. |
cohorts |
integer | Number of defined cohorts in the platform. |
contributors |
integer | Total number of individual data contributors. |
entries |
integer | Total number of individual data entries recorded. |
mutations |
integer | Total number of genetic mutations documented across all cases. |
primarySites |
integer | Number of distinct primary anatomical sites represented. |
projects |
integer | Total number of research projects. |
DataResource¶
Type: string
Dataset¶
| Name | Type | Description |
|---|---|---|
cohortsIds |
Array<string> | List of cohort IDs that have been exported with this dataset |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
lastExport |
string(date-time) | The datetime of the last export of this dataset |
name |
string | Name of the dataset |
projectId |
string(uuid) | Project that the dataset is part of |
rules |
Array<DatasetRule> | List of composition rules that define the dataset's structure. |
summary |
string | Summary of the dataset |
totalExports |
integer | The total number times this dataset has been exported |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
DatasetCreate¶
| Name | Type | Description |
|---|---|---|
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
name |
string | Name of the dataset |
projectId |
string(uuid) | Project that the dataset is part of |
rules |
Array<DatasetRule> | List of composition rules that define the dataset's structure. |
summary |
string | Summary of the dataset |
DatasetFilters¶
| Name | Type | Description |
|---|---|---|
cohortsIds |
string | Cohorts - Filter for full text matches |
cohortsIds.anyOf |
Array<string> | Cohorts - Filter for entries where at least one reference matches the query |
cohortsIds.beginsWith |
string | Cohorts - Filter for entries starting with the text |
cohortsIds.contains |
string | Cohorts - Filter for partial text matches |
cohortsIds.endsWith |
string | Cohorts - Filter for entries ending with the text |
cohortsIds.not |
string | Cohorts - Filter for full text mismatches |
cohortsIds.not.anyOf |
Array<string> | Cohorts - Filter for entries where at least one reference mismatches the query |
cohortsIds.not.beginsWith |
string | Cohorts - Filter for entries not starting with the text |
cohortsIds.not.contains |
string | Cohorts - Filter for partial text mismatches |
cohortsIds.not.endsWith |
string | Cohorts - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
createdBy |
string | Filter datasets by the creator's username. |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
lastExport.after |
string(date) | Last Export - Filter for entries with dates after the specified value |
lastExport.before |
string(date) | Last Export - Filter for entries with dates before the specified value |
lastExport.between |
Array<> | Last Export - Filter for entries with dates between two specified values (inclusive) |
lastExport.exists |
boolean | Last Export - Filter for entries with a value |
lastExport.not.between |
Array<> | Last Export - Filter for entries with dates not between two specified values (inclusive) |
lastExport.not.exists |
boolean | Last Export - Filter for entries without a value |
lastExport.not.on |
string(date) | Last Export - Filter for entries with dates not matching the specified value |
lastExport.on |
string(date) | Last Export - Filter for entries with dates exactly matching the specified value |
lastExport.onOrAfter |
string(date) | Last Export - Filter for entries with dates on or after the specified value |
lastExport.onOrBefore |
string(date) | Last Export - Filter for entries with dates on or before the specified value |
name |
string | Dataset name - Filter for full text matches |
name.anyOf |
Array<string> | Dataset name - Filter for entries where at least one reference matches the query |
name.beginsWith |
string | Dataset name - Filter for entries starting with the text |
name.contains |
string | Dataset name - Filter for partial text matches |
name.endsWith |
string | Dataset name - Filter for entries ending with the text |
name.not |
string | Dataset name - Filter for full text mismatches |
name.not.anyOf |
Array<string> | Dataset name - Filter for entries where at least one reference mismatches the query |
name.not.beginsWith |
string | Dataset name - Filter for entries not starting with the text |
name.not.contains |
string | Dataset name - Filter for partial text mismatches |
name.not.endsWith |
string | Dataset name - Filter for entries not ending with the text |
projectId |
string | Project - Filter for reference matches |
projectId.anyOf |
Array<string> | Project - Filter for entries where at least one reference matches the query |
projectId.beginsWith |
string | Project - Filter for entries starting with the text |
projectId.contains |
string | Project - Filter for partial text matches |
projectId.endsWith |
string | Project - Filter for entries ending with the text |
projectId.not |
string | Project - Filter for reference mismatches |
projectId.not.anyOf |
Array<string> | Project - Filter for entries where at least one reference mismatches the query |
projectId.not.beginsWith |
string | Project - Filter for entries not starting with the text |
projectId.not.contains |
string | Project - Filter for partial text mismatches |
projectId.not.endsWith |
string | Project - Filter for entries not ending with the text |
rules.field |
string | Field - Filter for full text matches |
rules.field.anyOf |
Array<string> | Field - Filter for entries where at least one reference matches the query |
rules.field.beginsWith |
string | Field - Filter for entries starting with the text |
rules.field.contains |
string | Field - Filter for partial text matches |
rules.field.endsWith |
string | Field - Filter for entries ending with the text |
rules.field.not |
string | Field - Filter for full text mismatches |
rules.field.not.anyOf |
Array<string> | Field - Filter for entries where at least one reference mismatches the query |
rules.field.not.beginsWith |
string | Field - Filter for entries not starting with the text |
rules.field.not.contains |
string | Field - Filter for partial text mismatches |
rules.field.not.endsWith |
string | Field - Filter for entries not ending with the text |
rules.resource |
Resource - Filter for single value choice | |
rules.resource.anyOf |
Array<string> | Resource - ('Filter for excluding a subset of value choices',) |
rules.resource.not |
Resource - ('Filter for all but a single value choice',) | |
rules.transform |
string | Transform - Filter for full text matches |
rules.transform.anyOf |
Array<string> | Transform - Filter for entries where at least one reference matches the query |
rules.transform.beginsWith |
string | Transform - Filter for entries starting with the text |
rules.transform.contains |
string | Transform - Filter for partial text matches |
rules.transform.endsWith |
string | Transform - Filter for entries ending with the text |
rules.transform.exists |
boolean | Transform - Filter for entries with a value |
rules.transform.not |
string | Transform - Filter for full text mismatches |
rules.transform.not.anyOf |
Array<string> | Transform - Filter for entries where at least one reference mismatches the query |
rules.transform.not.beginsWith |
string | Transform - Filter for entries not starting with the text |
rules.transform.not.contains |
string | Transform - Filter for partial text mismatches |
rules.transform.not.endsWith |
string | Transform - Filter for entries not ending with the text |
rules.transform.not.exists |
boolean | Transform - Filter for entries without a value |
summary |
string | Dataset summary - Filter for full text matches |
summary.anyOf |
Array<string> | Dataset summary - Filter for entries where at least one reference matches the query |
summary.beginsWith |
string | Dataset summary - Filter for entries starting with the text |
summary.contains |
string | Dataset summary - Filter for partial text matches |
summary.endsWith |
string | Dataset summary - Filter for entries ending with the text |
summary.exists |
boolean | Dataset summary - Filter for entries with a value |
summary.not |
string | Dataset summary - Filter for full text mismatches |
summary.not.anyOf |
Array<string> | Dataset summary - Filter for entries where at least one reference mismatches the query |
summary.not.beginsWith |
string | Dataset summary - Filter for entries not starting with the text |
summary.not.contains |
string | Dataset summary - Filter for partial text mismatches |
summary.not.endsWith |
string | Dataset summary - Filter for entries not ending with the text |
summary.not.exists |
boolean | Dataset summary - Filter for entries without a value |
totalExports.between |
Array<> | Total Exports - Filter for entries with values between two specified values (inclusive) |
totalExports.equal |
integer | Total Exports - Filter for entries with values exactly equal to the specified value |
totalExports.greaterThan |
integer | Total Exports - Filter for entries with values greater than the specified value |
totalExports.greaterThanOrEqual |
integer | Total Exports - Filter for entries with values greater than or equal to the specified value |
totalExports.lessThan |
integer | Total Exports - Filter for entries with values less than the specified value |
totalExports.lessThanOrEqual |
integer | Total Exports - Filter for entries with values less than or equal to the specified value |
totalExports.not.between |
Array<> | Total Exports - Filter for entries with values between two specified values (inclusive) |
totalExports.not.equal |
integer | Total Exports - Filter for entries with values not equal to the specified value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
DatasetRule¶
| Name | Type | Description |
|---|---|---|
field |
string | Dot-separated path of the field within the resource (e.g. 'medications.drug'). |
resource |
DataResource | The oncology resource this rule references. |
transform |
Nullable transform expression or mapping applied to the field's value. |
Distribution¶
| Name | Type | Description |
|---|---|---|
items |
Array<CohortTraitCounts> | The entries in the distribution. |
metadata |
Metadata for the Kaplan-Meier curve. |
DNAChangeType¶
Type: string
EntityStatistics¶
| Name | Type | Description |
|---|---|---|
dataCompletionMedian |
number | Median percentage of case completion |
population |
integer | Number of cases |
topographyCode |
string | ICD-O-3 topography code of the entity |
topographyGroup |
string | ICD-O-3 topography code of the entity group |
ExportedCohortDefinition¶
| Name | Type | Description |
|---|---|---|
checksum |
string | Checksum (e.g., SHA256) of the exported content for integrity verification. |
definition |
CohortCreate | The cohort definition |
exportedAt |
string(date-time) | The datetime when the resource was exported. |
exportedBy |
string | Username of the user who performed the export. |
exportVersion |
string | Version tag of the exporting system. |
ExportedPatientCaseDataset¶
| Name | Type | Description |
|---|---|---|
checksum |
string | Checksum (e.g., SHA256) of the exported content for integrity verification. |
dataset |
Array<PatientCaseDataset> | The dataset that was exported |
exportedAt |
string(date-time) | The datetime when the resource was exported. |
exportedBy |
string | Username of the user who performed the export. |
exportVersion |
string | Version tag of the exporting system. |
FamilyHistory¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's family's history is being recorded |
contributedToDeath |
boolean | Whether the cancer contributed to the cause of death of the family member |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's family history was assessed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
hadCancer |
boolean | Whether the family member has a history of cancer |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
isDeceased |
boolean | Whether the the family member is deceased |
morphology |
Morphology of the family member's cancer (if known) | |
onsetAge |
integer | Age at which the family member's cancer manifested |
relationship |
CodedConcept | Relationship to the patient |
topography |
Estimated or actual topography of the family member's cancer | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
FamilyHistoryCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's family's history is being recorded |
contributedToDeath |
boolean | Whether the cancer contributed to the cause of death of the family member |
date |
string(date) | Clinically-relevant date at which the patient's family history was assessed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
hadCancer |
boolean | Whether the family member has a history of cancer |
isDeceased |
boolean | Whether the the family member is deceased |
morphology |
Morphology of the family member's cancer (if known) | |
onsetAge |
integer | Age at which the family member's cancer manifested |
relationship |
CodedConcept | Relationship to the patient |
topography |
Estimated or actual topography of the family member's cancer |
FamilyHistoryFilters¶
| Name | Type | Description |
|---|---|---|
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
contributedToDeath |
boolean | Contributed to death - Filter for yes/no statement |
contributedToDeath.exists |
boolean | Contributed to death - Filter for entries with a value |
contributedToDeath.not.exists |
boolean | Contributed to death - Filter for entries without a value |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Assessment date - Filter for entries with dates after the specified value |
date.before |
string(date) | Assessment date - Filter for entries with dates before the specified value |
date.between |
Array<> | Assessment date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Assessment date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Assessment date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Assessment date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Assessment date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Assessment date - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
hadCancer |
boolean | Had cancer - Filter for yes/no statement |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
isDeceased |
boolean | Is deceased - Filter for yes/no statement |
isDeceased.exists |
boolean | Is deceased - Filter for entries with a value |
isDeceased.not.exists |
boolean | Is deceased - Filter for entries without a value |
morphology |
string | Morphology - Filter for a matching concept code |
morphology.anyOf |
Array<string> | Morphology - Filter for a matching set of concept codes |
morphology.descendantsOf |
string | Morphology - Filter for all child concepts of a given concepts code |
morphology.exists |
boolean | Morphology - Filter for entries with a value |
morphology.not |
string | Morphology - Filter for a mismatching concept code |
morphology.not.anyOf |
Array<string> | Morphology - Filter for a mismmatching set of concept codes |
morphology.not.exists |
boolean | Morphology - Filter for entries without a value |
onsetAge.between |
Array<> | Onset age - Filter for entries with values between two specified values (inclusive) |
onsetAge.equal |
integer | Onset age - Filter for entries with values exactly equal to the specified value |
onsetAge.exists |
boolean | Onset age - Filter for entries with a value |
onsetAge.greaterThan |
integer | Onset age - Filter for entries with values greater than the specified value |
onsetAge.greaterThanOrEqual |
integer | Onset age - Filter for entries with values greater than or equal to the specified value |
onsetAge.lessThan |
integer | Onset age - Filter for entries with values less than the specified value |
onsetAge.lessThanOrEqual |
integer | Onset age - Filter for entries with values less than or equal to the specified value |
onsetAge.not.between |
Array<> | Onset age - Filter for entries with values between two specified values (inclusive) |
onsetAge.not.equal |
integer | Onset age - Filter for entries with values not equal to the specified value |
onsetAge.not.exists |
boolean | Onset age - Filter for entries without a value |
relationship |
string | Relationship - Filter for a matching concept code |
relationship.anyOf |
Array<string> | Relationship - Filter for a matching set of concept codes |
relationship.descendantsOf |
string | Relationship - Filter for all child concepts of a given concepts code |
relationship.not |
string | Relationship - Filter for a mismatching concept code |
relationship.not.anyOf |
Array<string> | Relationship - Filter for a mismmatching set of concept codes |
topography |
string | Topography - Filter for a matching concept code |
topography.anyOf |
Array<string> | Topography - Filter for a matching set of concept codes |
topography.descendantsOf |
string | Topography - Filter for all child concepts of a given concepts code |
topography.exists |
boolean | Topography - Filter for entries with a value |
topography.not |
string | Topography - Filter for a mismatching concept code |
topography.not.anyOf |
Array<string> | Topography - Filter for a mismmatching set of concept codes |
topography.not.exists |
boolean | Topography - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
FamilyHistoryPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's family's history is being recorded |
contributedToDeath |
boolean | Whether the cancer contributed to the cause of death of the family member |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's family history was assessed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
hadCancer |
boolean | Whether the family member has a history of cancer |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
isDeceased |
boolean | Whether the the family member is deceased |
morphology |
Morphology of the family member's cancer (if known) | |
onsetAge |
integer | Age at which the family member's cancer manifested |
relationship |
Relationship to the patient | |
topography |
Estimated or actual topography of the family member's cancer | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
FIGOStaging¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
methodology |
Methodology used for the FIGO staging | |
stage |
CodedConcept | The value of the FIGO stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
FIGOStagingCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
methodology |
Methodology used for the FIGO staging | |
stage |
CodedConcept | The value of the FIGO stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
GenomicSignatureFilters¶
| Name | Type | Description |
|---|---|---|
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
category |
Category - Filter for single value choice | |
category.anyOf |
Array<string> | Category - ('Filter for excluding a subset of value choices',) |
category.not |
Category - ('Filter for all but a single value choice',) | |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Assessment date - Filter for entries with dates after the specified value |
date.before |
string(date) | Assessment date - Filter for entries with dates before the specified value |
date.between |
Array<> | Assessment date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Assessment date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Assessment date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Assessment date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Assessment date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Assessment date - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
GenomicSignatureTypes¶
Type: string
GenomicVariant¶
| Name | Type | Description |
|---|---|---|
alleleDepth |
integer | Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides. |
alleleFrequency |
number | The relative frequency (value in range [0,1]) of the allele at a given locus in the sample. |
analysisMethod |
Analysis method used to detect the variant | |
anonymized |
boolean | Whether the data has been anonymized |
assessment |
Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants. | |
assessmentDate |
string(date) | Date at which the genomic variant was assessed and/or reported. |
caseId |
string(uuid) | Indicates the case of the patient who' genomic variant is described |
chromosomes |
Array<string> | Chromosomes involved in the variant (e.g. 17, X) |
clinicalRelevance |
Classification of the clinical relevance or pathogenicity of the variant. | |
clinvar |
string | Accession number in the ClinVar variant database, given for cross-reference. |
confidence |
Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores. | |
coordinateSystem |
Genomic coordinate system used for identifying nucleotides or amino acids within a sequence. | |
copyNumber |
integer | Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion. |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
cytogeneticLocation |
string | Cytogenetic location of the variant (e.g. 17q21.31) |
date |
string(date) | Clinically-relevant date of the genomic variant (e.g. the specimen collection date). |
description |
string | Human-readable description |
dnaChangePosition |
integer | DNA-level single-nucleotide position where the variant was found. |
dnaChangePositionRange |
DNA-level single-nucleotide position where the variant was found. | |
dnaChangeType |
DNA variant type of variant. | |
dnaHgvs |
string | DNA HGVS expression (g-coordinate expression, HGVS version >=21.1) |
dnaReferenceSequence |
string | DNA reference sequence identifier used as dna HGVS reference. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
genePanel |
string | Commercial or official name of the gene panel tested to identify the variant |
genes |
Array<CodedConcept> | Gene(s) affected by this variant |
genomeAssemblyVersion |
The reference genome assembly versionused in this analysis. | |
hgvsVersion |
string | Version of the HGVS nomenclature used for the HGVS expressions |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
inheritance |
Variant inheritance origin (if known). | |
isPathogenic |
boolean | Whether the genomic variant is considered pathogenic in a clinical setting |
isVUS |
boolean | Whether the genomic variant is considered a variant of unknown signifiance (VUS) |
molecularConsequence |
The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence. | |
nucleotidesLength |
integer | Length of the variant in nucleotides |
proteinChangeType |
Protein variant type of variant. | |
proteinHgvs |
string | Protein HGVS expression (g-coordinate expression, HGVS version >=21.1) |
proteinReferenceSequence |
string | Protein reference sequence identifier used as protein HGVS reference. |
regions |
Array<string> | Gene regions (exons, introns, UTRs) affected by the variant. Estimated from MANE reference sequences. |
rnaChangePosition |
string | RNA-level nucleotide position/range where the variant was found. |
rnaChangeType |
RNA variant type of variant. | |
rnaHgvs |
string | RNA HGVS expression (g-coordinate expression, HGVS version >=21.1) |
rnaReferenceSequence |
string | RNA reference sequence identifier used as rna HGVS reference. |
source |
Variant genomic source (if known). | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
zygosity |
The observed level of occurrence of the variant in the set of chromosomes. |
GenomicVariantAssessmentChoices¶
Type: string
GenomicVariantClinicalRelevanceChoices¶
Type: string
GenomicVariantConfidenceChoices¶
Type: string
GenomicVariantCreate¶
| Name | Type | Description |
|---|---|---|
alleleDepth |
integer | Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides. |
alleleFrequency |
number | The relative frequency (value in range [0,1]) of the allele at a given locus in the sample. |
analysisMethod |
Analysis method used to detect the variant | |
assessment |
Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants. | |
assessmentDate |
string(date) | Date at which the genomic variant was assessed and/or reported. |
caseId |
string(uuid) | Indicates the case of the patient who' genomic variant is described |
clinicalRelevance |
Classification of the clinical relevance or pathogenicity of the variant. | |
clinvar |
string | Accession number in the ClinVar variant database, given for cross-reference. |
confidence |
Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores. | |
coordinateSystem |
Genomic coordinate system used for identifying nucleotides or amino acids within a sequence. | |
copyNumber |
integer | Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion. |
date |
string(date) | Clinically-relevant date of the genomic variant (e.g. the specimen collection date). |
dnaHgvs |
string | DNA HGVS expression (g-coordinate expression, HGVS version >=21.1) |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
genePanel |
string | Commercial or official name of the gene panel tested to identify the variant |
genes |
Array<CodedConcept> | Gene(s) affected by this variant |
genomeAssemblyVersion |
The reference genome assembly versionused in this analysis. | |
inheritance |
Variant inheritance origin (if known). | |
molecularConsequence |
The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence. | |
proteinHgvs |
string | Protein HGVS expression (g-coordinate expression, HGVS version >=21.1) |
rnaHgvs |
string | RNA HGVS expression (g-coordinate expression, HGVS version >=21.1) |
source |
Variant genomic source (if known). | |
zygosity |
The observed level of occurrence of the variant in the set of chromosomes. |
GenomicVariantFilters¶
| Name | Type | Description |
|---|---|---|
alleleDepth.between |
Array<> | Allele depth (reads) - Filter for entries with values between two specified values (inclusive) |
alleleDepth.equal |
integer | Allele depth (reads) - Filter for entries with values exactly equal to the specified value |
alleleDepth.exists |
boolean | Allele depth (reads) - Filter for entries with a value |
alleleDepth.greaterThan |
integer | Allele depth (reads) - Filter for entries with values greater than the specified value |
alleleDepth.greaterThanOrEqual |
integer | Allele depth (reads) - Filter for entries with values greater than or equal to the specified value |
alleleDepth.lessThan |
integer | Allele depth (reads) - Filter for entries with values less than the specified value |
alleleDepth.lessThanOrEqual |
integer | Allele depth (reads) - Filter for entries with values less than or equal to the specified value |
alleleDepth.not.between |
Array<> | Allele depth (reads) - Filter for entries with values between two specified values (inclusive) |
alleleDepth.not.equal |
integer | Allele depth (reads) - Filter for entries with values not equal to the specified value |
alleleDepth.not.exists |
boolean | Allele depth (reads) - Filter for entries without a value |
alleleFrequency.between |
Array<> | Allele frequency - Filter for entries with values between two specified values (inclusive) |
alleleFrequency.equal |
number | Allele frequency - Filter for entries with values exactly equal to the specified value |
alleleFrequency.exists |
boolean | Allele frequency - Filter for entries with a value |
alleleFrequency.greaterThan |
number | Allele frequency - Filter for entries with values greater than the specified value |
alleleFrequency.greaterThanOrEqual |
number | Allele frequency - Filter for entries with values greater than or equal to the specified value |
alleleFrequency.lessThan |
number | Allele frequency - Filter for entries with values less than the specified value |
alleleFrequency.lessThanOrEqual |
number | Allele frequency - Filter for entries with values less than or equal to the specified value |
alleleFrequency.not.between |
Array<> | Allele frequency - Filter for entries with values between two specified values (inclusive) |
alleleFrequency.not.equal |
number | Allele frequency - Filter for entries with values not equal to the specified value |
alleleFrequency.not.exists |
boolean | Allele frequency - Filter for entries without a value |
analysisMethod |
string | Analysis method - Filter for a matching concept code |
analysisMethod.anyOf |
Array<string> | Analysis method - Filter for a matching set of concept codes |
analysisMethod.descendantsOf |
string | Analysis method - Filter for all child concepts of a given concepts code |
analysisMethod.exists |
boolean | Analysis method - Filter for entries with a value |
analysisMethod.not |
string | Analysis method - Filter for a mismatching concept code |
analysisMethod.not.anyOf |
Array<string> | Analysis method - Filter for a mismmatching set of concept codes |
analysisMethod.not.exists |
boolean | Analysis method - Filter for entries without a value |
assessment |
Assessment - Filter for single value choice | |
assessment.anyOf |
Array<string> | Assessment - ('Filter for excluding a subset of value choices',) |
assessment.exists |
boolean | Assessment - Filter for entries with a value |
assessment.not |
Assessment - ('Filter for all but a single value choice',) | |
assessment.not.exists |
boolean | Assessment - Filter for entries without a value |
assessmentDate.after |
string(date) | Assessment date - Filter for entries with dates after the specified value |
assessmentDate.before |
string(date) | Assessment date - Filter for entries with dates before the specified value |
assessmentDate.between |
Array<> | Assessment date - Filter for entries with dates between two specified values (inclusive) |
assessmentDate.exists |
boolean | Assessment date - Filter for entries with a value |
assessmentDate.not.between |
Array<> | Assessment date - Filter for entries with dates not between two specified values (inclusive) |
assessmentDate.not.exists |
boolean | Assessment date - Filter for entries without a value |
assessmentDate.not.on |
string(date) | Assessment date - Filter for entries with dates not matching the specified value |
assessmentDate.on |
string(date) | Assessment date - Filter for entries with dates exactly matching the specified value |
assessmentDate.onOrAfter |
string(date) | Assessment date - Filter for entries with dates on or after the specified value |
assessmentDate.onOrBefore |
string(date) | Assessment date - Filter for entries with dates on or before the specified value |
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
chromosomes |
string | Chromosomes - Filter for full text matches |
chromosomes.anyOf |
Array<string> | Chromosomes - Filter for entries where at least one reference matches the query |
chromosomes.beginsWith |
string | Chromosomes - Filter for entries starting with the text |
chromosomes.contains |
string | Chromosomes - Filter for partial text matches |
chromosomes.endsWith |
string | Chromosomes - Filter for entries ending with the text |
chromosomes.exists |
boolean | Chromosomes - Filter for entries with a value |
chromosomes.not |
string | Chromosomes - Filter for full text mismatches |
chromosomes.not.anyOf |
Array<string> | Chromosomes - Filter for entries where at least one reference mismatches the query |
chromosomes.not.beginsWith |
string | Chromosomes - Filter for entries not starting with the text |
chromosomes.not.contains |
string | Chromosomes - Filter for partial text mismatches |
chromosomes.not.endsWith |
string | Chromosomes - Filter for entries not ending with the text |
chromosomes.not.exists |
boolean | Chromosomes - Filter for entries without a value |
clinicalRelevance |
Clinical relevance - Filter for single value choice | |
clinicalRelevance.anyOf |
Array<string> | Clinical relevance - ('Filter for excluding a subset of value choices',) |
clinicalRelevance.exists |
boolean | Clinical relevance - Filter for entries with a value |
clinicalRelevance.not |
Clinical relevance - ('Filter for all but a single value choice',) | |
clinicalRelevance.not.exists |
boolean | Clinical relevance - Filter for entries without a value |
clinvar |
string | ClinVar accession number - Filter for full text matches |
clinvar.anyOf |
Array<string> | ClinVar accession number - Filter for entries where at least one reference matches the query |
clinvar.beginsWith |
string | ClinVar accession number - Filter for entries starting with the text |
clinvar.contains |
string | ClinVar accession number - Filter for partial text matches |
clinvar.endsWith |
string | ClinVar accession number - Filter for entries ending with the text |
clinvar.exists |
boolean | ClinVar accession number - Filter for entries with a value |
clinvar.not |
string | ClinVar accession number - Filter for full text mismatches |
clinvar.not.anyOf |
Array<string> | ClinVar accession number - Filter for entries where at least one reference mismatches the query |
clinvar.not.beginsWith |
string | ClinVar accession number - Filter for entries not starting with the text |
clinvar.not.contains |
string | ClinVar accession number - Filter for partial text mismatches |
clinvar.not.endsWith |
string | ClinVar accession number - Filter for entries not ending with the text |
clinvar.not.exists |
boolean | ClinVar accession number - Filter for entries without a value |
confidence |
Confidence - Filter for single value choice | |
confidence.anyOf |
Array<string> | Confidence - ('Filter for excluding a subset of value choices',) |
confidence.exists |
boolean | Confidence - Filter for entries with a value |
confidence.not |
Confidence - ('Filter for all but a single value choice',) | |
confidence.not.exists |
boolean | Confidence - Filter for entries without a value |
coordinateSystem |
string | Coordinate system - Filter for a matching concept code |
coordinateSystem.anyOf |
Array<string> | Coordinate system - Filter for a matching set of concept codes |
coordinateSystem.descendantsOf |
string | Coordinate system - Filter for all child concepts of a given concepts code |
coordinateSystem.exists |
boolean | Coordinate system - Filter for entries with a value |
coordinateSystem.not |
string | Coordinate system - Filter for a mismatching concept code |
coordinateSystem.not.anyOf |
Array<string> | Coordinate system - Filter for a mismmatching set of concept codes |
coordinateSystem.not.exists |
boolean | Coordinate system - Filter for entries without a value |
copyNumber.between |
Array<> | Copy number - Filter for entries with values between two specified values (inclusive) |
copyNumber.equal |
integer | Copy number - Filter for entries with values exactly equal to the specified value |
copyNumber.exists |
boolean | Copy number - Filter for entries with a value |
copyNumber.greaterThan |
integer | Copy number - Filter for entries with values greater than the specified value |
copyNumber.greaterThanOrEqual |
integer | Copy number - Filter for entries with values greater than or equal to the specified value |
copyNumber.lessThan |
integer | Copy number - Filter for entries with values less than the specified value |
copyNumber.lessThanOrEqual |
integer | Copy number - Filter for entries with values less than or equal to the specified value |
copyNumber.not.between |
Array<> | Copy number - Filter for entries with values between two specified values (inclusive) |
copyNumber.not.equal |
integer | Copy number - Filter for entries with values not equal to the specified value |
copyNumber.not.exists |
boolean | Copy number - Filter for entries without a value |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
cytogeneticLocation |
string | Cytogenetic Location - Filter for full text matches |
cytogeneticLocation.anyOf |
Array<string> | Cytogenetic Location - Filter for entries where at least one reference matches the query |
cytogeneticLocation.beginsWith |
string | Cytogenetic Location - Filter for entries starting with the text |
cytogeneticLocation.contains |
string | Cytogenetic Location - Filter for partial text matches |
cytogeneticLocation.endsWith |
string | Cytogenetic Location - Filter for entries ending with the text |
cytogeneticLocation.exists |
boolean | Cytogenetic Location - Filter for entries with a value |
cytogeneticLocation.not |
string | Cytogenetic Location - Filter for full text mismatches |
cytogeneticLocation.not.anyOf |
Array<string> | Cytogenetic Location - Filter for entries where at least one reference mismatches the query |
cytogeneticLocation.not.beginsWith |
string | Cytogenetic Location - Filter for entries not starting with the text |
cytogeneticLocation.not.contains |
string | Cytogenetic Location - Filter for partial text mismatches |
cytogeneticLocation.not.endsWith |
string | Cytogenetic Location - Filter for entries not ending with the text |
cytogeneticLocation.not.exists |
boolean | Cytogenetic Location - Filter for entries without a value |
date.after |
string(date) | Date - Filter for entries with dates after the specified value |
date.before |
string(date) | Date - Filter for entries with dates before the specified value |
date.between |
Array<> | Date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Date - Filter for entries with dates on or before the specified value |
dnaChangePosition.between |
Array<> | DNA change position - Filter for entries with values between two specified values (inclusive) |
dnaChangePosition.equal |
integer | DNA change position - Filter for entries with values exactly equal to the specified value |
dnaChangePosition.exists |
boolean | DNA change position - Filter for entries with a value |
dnaChangePosition.greaterThan |
integer | DNA change position - Filter for entries with values greater than the specified value |
dnaChangePosition.greaterThanOrEqual |
integer | DNA change position - Filter for entries with values greater than or equal to the specified value |
dnaChangePosition.lessThan |
integer | DNA change position - Filter for entries with values less than the specified value |
dnaChangePosition.lessThanOrEqual |
integer | DNA change position - Filter for entries with values less than or equal to the specified value |
dnaChangePosition.not.between |
Array<> | DNA change position - Filter for entries with values between two specified values (inclusive) |
dnaChangePosition.not.equal |
integer | DNA change position - Filter for entries with values not equal to the specified value |
dnaChangePosition.not.exists |
boolean | DNA change position - Filter for entries without a value |
dnaChangePositionRange.containedBy |
Array<> | DNA change range - Filter for entries whose Range are contined by the range |
dnaChangePositionRange.contains |
Array<> | DNA change range - Filter for entries containing the range |
dnaChangePositionRange.exists |
boolean | DNA change range - Filter for entries with a value |
dnaChangePositionRange.not.containedBy |
Array<> | DNA change range - Filter for entries whose Range are not contined by the range |
dnaChangePositionRange.not.contains |
Array<> | DNA change range - Filter for entries not containing the range |
dnaChangePositionRange.not.exists |
boolean | DNA change range - Filter for entries without a value |
dnaChangePositionRange.not.overlaps |
Array<> | DNA change range - Filter for entries not overlapping with the range |
dnaChangePositionRange.overlaps |
Array<> | DNA change range - Filter for entries overlapping with the range |
dnaChangeType |
DNA change type - Filter for single value choice | |
dnaChangeType.anyOf |
Array<string> | DNA change type - ('Filter for excluding a subset of value choices',) |
dnaChangeType.exists |
boolean | DNA change type - Filter for entries with a value |
dnaChangeType.not |
DNA change type - ('Filter for all but a single value choice',) | |
dnaChangeType.not.exists |
boolean | DNA change type - Filter for entries without a value |
dnaHgvs |
string | DNA HGVS - Filter for full text matches |
dnaHgvs.anyOf |
Array<string> | DNA HGVS - Filter for entries where at least one reference matches the query |
dnaHgvs.beginsWith |
string | DNA HGVS - Filter for entries starting with the text |
dnaHgvs.contains |
string | DNA HGVS - Filter for partial text matches |
dnaHgvs.endsWith |
string | DNA HGVS - Filter for entries ending with the text |
dnaHgvs.exists |
boolean | DNA HGVS - Filter for entries with a value |
dnaHgvs.not |
string | DNA HGVS - Filter for full text mismatches |
dnaHgvs.not.anyOf |
Array<string> | DNA HGVS - Filter for entries where at least one reference mismatches the query |
dnaHgvs.not.beginsWith |
string | DNA HGVS - Filter for entries not starting with the text |
dnaHgvs.not.contains |
string | DNA HGVS - Filter for partial text mismatches |
dnaHgvs.not.endsWith |
string | DNA HGVS - Filter for entries not ending with the text |
dnaHgvs.not.exists |
boolean | DNA HGVS - Filter for entries without a value |
dnaReferenceSequence |
string | DNA HGVS RefSeq - Filter for full text matches |
dnaReferenceSequence.anyOf |
Array<string> | DNA HGVS RefSeq - Filter for entries where at least one reference matches the query |
dnaReferenceSequence.beginsWith |
string | DNA HGVS RefSeq - Filter for entries starting with the text |
dnaReferenceSequence.contains |
string | DNA HGVS RefSeq - Filter for partial text matches |
dnaReferenceSequence.endsWith |
string | DNA HGVS RefSeq - Filter for entries ending with the text |
dnaReferenceSequence.exists |
boolean | DNA HGVS RefSeq - Filter for entries with a value |
dnaReferenceSequence.not |
string | DNA HGVS RefSeq - Filter for full text mismatches |
dnaReferenceSequence.not.anyOf |
Array<string> | DNA HGVS RefSeq - Filter for entries where at least one reference mismatches the query |
dnaReferenceSequence.not.beginsWith |
string | DNA HGVS RefSeq - Filter for entries not starting with the text |
dnaReferenceSequence.not.contains |
string | DNA HGVS RefSeq - Filter for partial text mismatches |
dnaReferenceSequence.not.endsWith |
string | DNA HGVS RefSeq - Filter for entries not ending with the text |
dnaReferenceSequence.not.exists |
boolean | DNA HGVS RefSeq - Filter for entries without a value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
genePanel |
string | Gene panel - Filter for full text matches |
genePanel.anyOf |
Array<string> | Gene panel - Filter for entries where at least one reference matches the query |
genePanel.beginsWith |
string | Gene panel - Filter for entries starting with the text |
genePanel.contains |
string | Gene panel - Filter for partial text matches |
genePanel.endsWith |
string | Gene panel - Filter for entries ending with the text |
genePanel.exists |
boolean | Gene panel - Filter for entries with a value |
genePanel.not |
string | Gene panel - Filter for full text mismatches |
genePanel.not.anyOf |
Array<string> | Gene panel - Filter for entries where at least one reference mismatches the query |
genePanel.not.beginsWith |
string | Gene panel - Filter for entries not starting with the text |
genePanel.not.contains |
string | Gene panel - Filter for partial text mismatches |
genePanel.not.endsWith |
string | Gene panel - Filter for entries not ending with the text |
genePanel.not.exists |
boolean | Gene panel - Filter for entries without a value |
genes |
string | Gene(s) - Filter for a matching concept code |
genes.allOf |
Array<string> | Gene(s) - Filter for entries matching all of the concepts |
genes.anyOf |
Array<string> | Gene(s) - Filter for a matching set of concept codes |
genes.descendantsOf |
string | Gene(s) - Filter for all child concepts of a given concepts code |
genes.not |
string | Gene(s) - Filter for a mismatching concept code |
genes.not.allOf |
Array<string> | Gene(s) - Filter for entries mismatching all of the concepts |
genes.not.anyOf |
Array<string> | Gene(s) - Filter for a mismmatching set of concept codes |
genomeAssemblyVersion |
string | Genome assembly version - Filter for a matching concept code |
genomeAssemblyVersion.anyOf |
Array<string> | Genome assembly version - Filter for a matching set of concept codes |
genomeAssemblyVersion.descendantsOf |
string | Genome assembly version - Filter for all child concepts of a given concepts code |
genomeAssemblyVersion.exists |
boolean | Genome assembly version - Filter for entries with a value |
genomeAssemblyVersion.not |
string | Genome assembly version - Filter for a mismatching concept code |
genomeAssemblyVersion.not.anyOf |
Array<string> | Genome assembly version - Filter for a mismmatching set of concept codes |
genomeAssemblyVersion.not.exists |
boolean | Genome assembly version - Filter for entries without a value |
hgvsVersion |
string | HGVS Version - Filter for full text matches |
hgvsVersion.anyOf |
Array<string> | HGVS Version - Filter for entries where at least one reference matches the query |
hgvsVersion.beginsWith |
string | HGVS Version - Filter for entries starting with the text |
hgvsVersion.contains |
string | HGVS Version - Filter for partial text matches |
hgvsVersion.endsWith |
string | HGVS Version - Filter for entries ending with the text |
hgvsVersion.not |
string | HGVS Version - Filter for full text mismatches |
hgvsVersion.not.anyOf |
Array<string> | HGVS Version - Filter for entries where at least one reference mismatches the query |
hgvsVersion.not.beginsWith |
string | HGVS Version - Filter for entries not starting with the text |
hgvsVersion.not.contains |
string | HGVS Version - Filter for partial text mismatches |
hgvsVersion.not.endsWith |
string | HGVS Version - Filter for entries not ending with the text |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
inheritance |
string | Inheritance - Filter for a matching concept code |
inheritance.anyOf |
Array<string> | Inheritance - Filter for a matching set of concept codes |
inheritance.descendantsOf |
string | Inheritance - Filter for all child concepts of a given concepts code |
inheritance.exists |
boolean | Inheritance - Filter for entries with a value |
inheritance.not |
string | Inheritance - Filter for a mismatching concept code |
inheritance.not.anyOf |
Array<string> | Inheritance - Filter for a mismmatching set of concept codes |
inheritance.not.exists |
boolean | Inheritance - Filter for entries without a value |
isPathogenic |
boolean | Is Pathogenic - Filter for yes/no statement |
isPathogenic.exists |
boolean | Is Pathogenic - Filter for entries with a value |
isPathogenic.not.exists |
boolean | Is Pathogenic - Filter for entries without a value |
isVUS |
boolean | Is VUS - Filter for yes/no statement |
isVUS.exists |
boolean | Is VUS - Filter for entries with a value |
isVUS.not.exists |
boolean | Is VUS - Filter for entries without a value |
molecularConsequence |
string | Molecular consequence - Filter for a matching concept code |
molecularConsequence.anyOf |
Array<string> | Molecular consequence - Filter for a matching set of concept codes |
molecularConsequence.descendantsOf |
string | Molecular consequence - Filter for all child concepts of a given concepts code |
molecularConsequence.exists |
boolean | Molecular consequence - Filter for entries with a value |
molecularConsequence.not |
string | Molecular consequence - Filter for a mismatching concept code |
molecularConsequence.not.anyOf |
Array<string> | Molecular consequence - Filter for a mismmatching set of concept codes |
molecularConsequence.not.exists |
boolean | Molecular consequence - Filter for entries without a value |
nucleotidesLength.between |
Array<> | Variant length - Filter for entries with values between two specified values (inclusive) |
nucleotidesLength.equal |
integer | Variant length - Filter for entries with values exactly equal to the specified value |
nucleotidesLength.exists |
boolean | Variant length - Filter for entries with a value |
nucleotidesLength.greaterThan |
integer | Variant length - Filter for entries with values greater than the specified value |
nucleotidesLength.greaterThanOrEqual |
integer | Variant length - Filter for entries with values greater than or equal to the specified value |
nucleotidesLength.lessThan |
integer | Variant length - Filter for entries with values less than the specified value |
nucleotidesLength.lessThanOrEqual |
integer | Variant length - Filter for entries with values less than or equal to the specified value |
nucleotidesLength.not.between |
Array<> | Variant length - Filter for entries with values between two specified values (inclusive) |
nucleotidesLength.not.equal |
integer | Variant length - Filter for entries with values not equal to the specified value |
nucleotidesLength.not.exists |
boolean | Variant length - Filter for entries without a value |
proteinChangeType |
Protein change type - Filter for single value choice | |
proteinChangeType.anyOf |
Array<string> | Protein change type - ('Filter for excluding a subset of value choices',) |
proteinChangeType.exists |
boolean | Protein change type - Filter for entries with a value |
proteinChangeType.not |
Protein change type - ('Filter for all but a single value choice',) | |
proteinChangeType.not.exists |
boolean | Protein change type - Filter for entries without a value |
proteinHgvs |
string | Protein HGVS - Filter for full text matches |
proteinHgvs.anyOf |
Array<string> | Protein HGVS - Filter for entries where at least one reference matches the query |
proteinHgvs.beginsWith |
string | Protein HGVS - Filter for entries starting with the text |
proteinHgvs.contains |
string | Protein HGVS - Filter for partial text matches |
proteinHgvs.endsWith |
string | Protein HGVS - Filter for entries ending with the text |
proteinHgvs.exists |
boolean | Protein HGVS - Filter for entries with a value |
proteinHgvs.not |
string | Protein HGVS - Filter for full text mismatches |
proteinHgvs.not.anyOf |
Array<string> | Protein HGVS - Filter for entries where at least one reference mismatches the query |
proteinHgvs.not.beginsWith |
string | Protein HGVS - Filter for entries not starting with the text |
proteinHgvs.not.contains |
string | Protein HGVS - Filter for partial text mismatches |
proteinHgvs.not.endsWith |
string | Protein HGVS - Filter for entries not ending with the text |
proteinHgvs.not.exists |
boolean | Protein HGVS - Filter for entries without a value |
proteinReferenceSequence |
string | Protein HGVS RefSeq - Filter for full text matches |
proteinReferenceSequence.anyOf |
Array<string> | Protein HGVS RefSeq - Filter for entries where at least one reference matches the query |
proteinReferenceSequence.beginsWith |
string | Protein HGVS RefSeq - Filter for entries starting with the text |
proteinReferenceSequence.contains |
string | Protein HGVS RefSeq - Filter for partial text matches |
proteinReferenceSequence.endsWith |
string | Protein HGVS RefSeq - Filter for entries ending with the text |
proteinReferenceSequence.exists |
boolean | Protein HGVS RefSeq - Filter for entries with a value |
proteinReferenceSequence.not |
string | Protein HGVS RefSeq - Filter for full text mismatches |
proteinReferenceSequence.not.anyOf |
Array<string> | Protein HGVS RefSeq - Filter for entries where at least one reference mismatches the query |
proteinReferenceSequence.not.beginsWith |
string | Protein HGVS RefSeq - Filter for entries not starting with the text |
proteinReferenceSequence.not.contains |
string | Protein HGVS RefSeq - Filter for partial text mismatches |
proteinReferenceSequence.not.endsWith |
string | Protein HGVS RefSeq - Filter for entries not ending with the text |
proteinReferenceSequence.not.exists |
boolean | Protein HGVS RefSeq - Filter for entries without a value |
regions |
string | Gene regions - Filter for full text matches |
regions.anyOf |
Array<string> | Gene regions - Filter for entries where at least one reference matches the query |
regions.beginsWith |
string | Gene regions - Filter for entries starting with the text |
regions.contains |
string | Gene regions - Filter for partial text matches |
regions.endsWith |
string | Gene regions - Filter for entries ending with the text |
regions.exists |
boolean | Gene regions - Filter for entries with a value |
regions.not |
string | Gene regions - Filter for full text mismatches |
regions.not.anyOf |
Array<string> | Gene regions - Filter for entries where at least one reference mismatches the query |
regions.not.beginsWith |
string | Gene regions - Filter for entries not starting with the text |
regions.not.contains |
string | Gene regions - Filter for partial text mismatches |
regions.not.endsWith |
string | Gene regions - Filter for entries not ending with the text |
regions.not.exists |
boolean | Gene regions - Filter for entries without a value |
rnaChangePosition |
string | RNA change position - Filter for full text matches |
rnaChangePosition.anyOf |
Array<string> | RNA change position - Filter for entries where at least one reference matches the query |
rnaChangePosition.beginsWith |
string | RNA change position - Filter for entries starting with the text |
rnaChangePosition.contains |
string | RNA change position - Filter for partial text matches |
rnaChangePosition.endsWith |
string | RNA change position - Filter for entries ending with the text |
rnaChangePosition.exists |
boolean | RNA change position - Filter for entries with a value |
rnaChangePosition.not |
string | RNA change position - Filter for full text mismatches |
rnaChangePosition.not.anyOf |
Array<string> | RNA change position - Filter for entries where at least one reference mismatches the query |
rnaChangePosition.not.beginsWith |
string | RNA change position - Filter for entries not starting with the text |
rnaChangePosition.not.contains |
string | RNA change position - Filter for partial text mismatches |
rnaChangePosition.not.endsWith |
string | RNA change position - Filter for entries not ending with the text |
rnaChangePosition.not.exists |
boolean | RNA change position - Filter for entries without a value |
rnaChangeType |
RNA change type - Filter for single value choice | |
rnaChangeType.anyOf |
Array<string> | RNA change type - ('Filter for excluding a subset of value choices',) |
rnaChangeType.exists |
boolean | RNA change type - Filter for entries with a value |
rnaChangeType.not |
RNA change type - ('Filter for all but a single value choice',) | |
rnaChangeType.not.exists |
boolean | RNA change type - Filter for entries without a value |
rnaHgvs |
string | RNA HGVS - Filter for full text matches |
rnaHgvs.anyOf |
Array<string> | RNA HGVS - Filter for entries where at least one reference matches the query |
rnaHgvs.beginsWith |
string | RNA HGVS - Filter for entries starting with the text |
rnaHgvs.contains |
string | RNA HGVS - Filter for partial text matches |
rnaHgvs.endsWith |
string | RNA HGVS - Filter for entries ending with the text |
rnaHgvs.exists |
boolean | RNA HGVS - Filter for entries with a value |
rnaHgvs.not |
string | RNA HGVS - Filter for full text mismatches |
rnaHgvs.not.anyOf |
Array<string> | RNA HGVS - Filter for entries where at least one reference mismatches the query |
rnaHgvs.not.beginsWith |
string | RNA HGVS - Filter for entries not starting with the text |
rnaHgvs.not.contains |
string | RNA HGVS - Filter for partial text mismatches |
rnaHgvs.not.endsWith |
string | RNA HGVS - Filter for entries not ending with the text |
rnaHgvs.not.exists |
boolean | RNA HGVS - Filter for entries without a value |
rnaReferenceSequence |
string | RNA HGVS RefSeq - Filter for full text matches |
rnaReferenceSequence.anyOf |
Array<string> | RNA HGVS RefSeq - Filter for entries where at least one reference matches the query |
rnaReferenceSequence.beginsWith |
string | RNA HGVS RefSeq - Filter for entries starting with the text |
rnaReferenceSequence.contains |
string | RNA HGVS RefSeq - Filter for partial text matches |
rnaReferenceSequence.endsWith |
string | RNA HGVS RefSeq - Filter for entries ending with the text |
rnaReferenceSequence.exists |
boolean | RNA HGVS RefSeq - Filter for entries with a value |
rnaReferenceSequence.not |
string | RNA HGVS RefSeq - Filter for full text mismatches |
rnaReferenceSequence.not.anyOf |
Array<string> | RNA HGVS RefSeq - Filter for entries where at least one reference mismatches the query |
rnaReferenceSequence.not.beginsWith |
string | RNA HGVS RefSeq - Filter for entries not starting with the text |
rnaReferenceSequence.not.contains |
string | RNA HGVS RefSeq - Filter for partial text mismatches |
rnaReferenceSequence.not.endsWith |
string | RNA HGVS RefSeq - Filter for entries not ending with the text |
rnaReferenceSequence.not.exists |
boolean | RNA HGVS RefSeq - Filter for entries without a value |
source |
string | Source - Filter for a matching concept code |
source.anyOf |
Array<string> | Source - Filter for a matching set of concept codes |
source.descendantsOf |
string | Source - Filter for all child concepts of a given concepts code |
source.exists |
boolean | Source - Filter for entries with a value |
source.not |
string | Source - Filter for a mismatching concept code |
source.not.anyOf |
Array<string> | Source - Filter for a mismmatching set of concept codes |
source.not.exists |
boolean | Source - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
zygosity |
string | Zygosity - Filter for a matching concept code |
zygosity.anyOf |
Array<string> | Zygosity - Filter for a matching set of concept codes |
zygosity.descendantsOf |
string | Zygosity - Filter for all child concepts of a given concepts code |
zygosity.exists |
boolean | Zygosity - Filter for entries with a value |
zygosity.not |
string | Zygosity - Filter for a mismatching concept code |
zygosity.not.anyOf |
Array<string> | Zygosity - Filter for a mismmatching set of concept codes |
zygosity.not.exists |
boolean | Zygosity - Filter for entries without a value |
GenomicVariantPartial¶
| Name | Type | Description |
|---|---|---|
alleleDepth |
integer | Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides. |
alleleFrequency |
number | The relative frequency (value in range [0,1]) of the allele at a given locus in the sample. |
analysisMethod |
Analysis method used to detect the variant | |
anonymized |
boolean | Whether the data has been anonymized |
assessment |
Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants. | |
assessmentDate |
string(date) | Date at which the genomic variant was assessed and/or reported. |
caseId |
string(uuid) | Indicates the case of the patient who' genomic variant is described |
chromosomes |
Array<string> | Chromosomes involved in the variant (e.g. 17, X) |
clinicalRelevance |
Classification of the clinical relevance or pathogenicity of the variant. | |
clinvar |
string | Accession number in the ClinVar variant database, given for cross-reference. |
confidence |
Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores. | |
coordinateSystem |
Genomic coordinate system used for identifying nucleotides or amino acids within a sequence. | |
copyNumber |
integer | Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion. |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
cytogeneticLocation |
string | Cytogenetic location of the variant (e.g. 17q21.31) |
date |
string(date) | Clinically-relevant date of the genomic variant (e.g. the specimen collection date). |
dnaChangePosition |
integer | DNA-level single-nucleotide position where the variant was found. |
dnaChangePositionRange |
DNA-level single-nucleotide position where the variant was found. | |
dnaChangeType |
DNA variant type of variant. | |
dnaHgvs |
string | DNA HGVS expression (g-coordinate expression, HGVS version >=21.1) |
dnaReferenceSequence |
string | DNA reference sequence identifier used as dna HGVS reference. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
genePanel |
string | Commercial or official name of the gene panel tested to identify the variant |
genes |
Gene(s) affected by this variant | |
genomeAssemblyVersion |
The reference genome assembly versionused in this analysis. | |
hgvsVersion |
string | Version of the HGVS nomenclature used for the HGVS expressions |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
inheritance |
Variant inheritance origin (if known). | |
isPathogenic |
boolean | Whether the genomic variant is considered pathogenic in a clinical setting |
isVUS |
boolean | Whether the genomic variant is considered a variant of unknown signifiance (VUS) |
molecularConsequence |
The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence. | |
nucleotidesLength |
integer | Length of the variant in nucleotides |
proteinChangeType |
Protein variant type of variant. | |
proteinHgvs |
string | Protein HGVS expression (g-coordinate expression, HGVS version >=21.1) |
proteinReferenceSequence |
string | Protein reference sequence identifier used as protein HGVS reference. |
regions |
Array<string> | Gene regions (exons, introns, UTRs) affected by the variant. Estimated from MANE reference sequences. |
rnaChangePosition |
string | RNA-level nucleotide position/range where the variant was found. |
rnaChangeType |
RNA variant type of variant. | |
rnaHgvs |
string | RNA HGVS expression (g-coordinate expression, HGVS version >=21.1) |
rnaReferenceSequence |
string | RNA reference sequence identifier used as rna HGVS reference. |
source |
Variant genomic source (if known). | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
zygosity |
The observed level of occurrence of the variant in the set of chromosomes. |
GleasonGrade¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
CodedConcept | The value of the Gleason grade stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
GleasonGradeCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
stage |
CodedConcept | The value of the Gleason grade stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
GleasonGradePartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
The value of the Gleason grade stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
HealthCheck¶
| Name | Type | Description |
|---|---|---|
database |
Whether the database is online | |
database_connection_time_ms |
Database connection time in milliseconds | |
migrations |
Whether there are pending migrations | |
server |
string | Whether the server is online |
HistoryEvent¶
| Name | Type | Description |
|---|---|---|
category |
HistoryEventCategory | The type of history event |
context |
Context sorrounding the event | |
differential |
Data changes introduced by the event, if applicable | |
id |
The unique identifier of the history event | |
resource |
string | Resource involved in the event, if applicable |
resourceId |
The unique identifier of the tracked resource | |
snapshot |
Data snapshopt at the time of the event | |
timestamp |
string(date-time) | Timestamp of the history event |
url |
string | Endpoint URL through which the event was triggered, if applicable |
user |
string | Username of the user that triggered the event, if applicable |
HistoryEventCategory¶
Type: string
HistoryEventWithSchema¶
| Name | Type | Description |
|---|---|---|
category |
HistoryEventCategory | The type of history event |
context |
Context sorrounding the event | |
differential |
Data changes introduced by the event, if applicable | |
id |
The unique identifier of the history event | |
resource |
string | Resource involved in the event, if applicable |
resourceId |
The unique identifier of the tracked resource | |
snapshot |
Data snapshopt at the time of the event | |
timestamp |
string(date-time) | Timestamp of the history event |
url |
string | Endpoint URL through which the event was triggered, if applicable |
user |
string | Username of the user that triggered the event, if applicable |
HomologousRecombinationDeficiency¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
interpretation |
Homologous recombination deficiency (HRD) interpretation | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
number | Homologous recombination deficiency (HRD) score value |
HomologousRecombinationDeficiencyCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
interpretation |
Homologous recombination deficiency (HRD) interpretation | |
value |
number | Homologous recombination deficiency (HRD) score value |
HomologousRecombinationDeficiencyInterpretationChoices¶
Type: string
HomologousRecombinationDeficiencyPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
interpretation |
Homologous recombination deficiency (HRD) interpretation | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
number | Homologous recombination deficiency (HRD) score value |
IncompleteCategory¶
| Name | Type | Description |
|---|---|---|
affectedSites |
Array<CodedConcept> | List of anatomical sites affected by this data incompleteness. |
cases |
integer | Number of cases affected with the incomplete data category. |
category |
string | The data category with cases where it is incomplete. |
Input¶
| Name | Type | Description |
|---|---|---|
limit |
integer | |
offset |
integer |
INRGSSStage¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
CodedConcept | The value of the INRGSS stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
INRGSSStageCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
stage |
CodedConcept | The value of the INRGSS stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
INRGSSStagePartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
The value of the INRGSS stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
INSSStage¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
CodedConcept | The value of the INSS stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
INSSStageCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
stage |
CodedConcept | The value of the INSS stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
INSSStagePartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
The value of the INSS stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
ISSStaging¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
CodedConcept | The value of theISS stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
ISSStagingCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
stage |
CodedConcept | The value of theISS stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
ISSStagingPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
The value of theISS stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
KaplanMeierCurve¶
| Name | Type | Description |
|---|---|---|
lowerConfidenceBand |
Array<number> | Lower bound of the survival probability confidence interval at each time point. |
metadata |
Metadata for the Kaplan-Meier curve. | |
months |
Array<number> | List of time points (in months) for survival probability estimates. |
probabilities |
Array<number> | Survival probabilities at each time point. |
upperConfidenceBand |
Array<number> | Upper bound of the survival probability confidence interval at each time point. |
Lifestyle¶
| Name | Type | Description |
|---|---|---|
alcoholConsumption |
Frequency of alcohol consumption | |
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's lifetyle was assessed and recorded. |
description |
string | Human-readable description |
exposures |
Array<CodedConcept> | Environmental or occupational exposures to hazards or carcinogenic agents |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
nightSleep |
Estimated average sleep time per night | |
recreationalDrugs |
Array<CodedConcept> | Any recreational drug(s) used by the patient |
smokingPackyears |
number | Smoking pack-years (if applicable) |
smokingQuited |
Estimated time since quitting smoking (if applicable) | |
smokingStatus |
Tobacco consumption status | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
LifestyleCreate¶
| Name | Type | Description |
|---|---|---|
alcoholConsumption |
Frequency of alcohol consumption | |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
date |
string(date) | Clinically-relevant date at which the patient's lifetyle was assessed and recorded. |
exposures |
Array<CodedConcept> | Environmental or occupational exposures to hazards or carcinogenic agents |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
nightSleep |
Estimated average sleep time per night | |
recreationalDrugs |
Array<CodedConcept> | Any recreational drug(s) used by the patient |
smokingPackyears |
number | Smoking pack-years (if applicable) |
smokingQuited |
Estimated time since quitting smoking (if applicable) | |
smokingStatus |
Tobacco consumption status |
LifestyleFilters¶
| Name | Type | Description |
|---|---|---|
alcoholConsumption |
string | Alcohol consumption - Filter for a matching concept code |
alcoholConsumption.anyOf |
Array<string> | Alcohol consumption - Filter for a matching set of concept codes |
alcoholConsumption.descendantsOf |
string | Alcohol consumption - Filter for all child concepts of a given concepts code |
alcoholConsumption.exists |
boolean | Alcohol consumption - Filter for entries with a value |
alcoholConsumption.not |
string | Alcohol consumption - Filter for a mismatching concept code |
alcoholConsumption.not.anyOf |
Array<string> | Alcohol consumption - Filter for a mismmatching set of concept codes |
alcoholConsumption.not.exists |
boolean | Alcohol consumption - Filter for entries without a value |
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Assessment date - Filter for entries with dates after the specified value |
date.before |
string(date) | Assessment date - Filter for entries with dates before the specified value |
date.between |
Array<> | Assessment date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Assessment date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Assessment date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Assessment date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Assessment date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Assessment date - Filter for entries with dates on or before the specified value |
exposures |
string | Exposures - Filter for a matching concept code |
exposures.allOf |
Array<string> | Exposures - Filter for entries matching all of the concepts |
exposures.anyOf |
Array<string> | Exposures - Filter for a matching set of concept codes |
exposures.descendantsOf |
string | Exposures - Filter for all child concepts of a given concepts code |
exposures.exists |
boolean | Exposures - Filter for entries with a value |
exposures.not |
string | Exposures - Filter for a mismatching concept code |
exposures.not.allOf |
Array<string> | Exposures - Filter for entries mismatching all of the concepts |
exposures.not.anyOf |
Array<string> | Exposures - Filter for a mismmatching set of concept codes |
exposures.not.exists |
boolean | Exposures - Filter for entries without a value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
nightSleep.between |
Array<> | Night sleep - Filter for entries with values between two specified values (inclusive) |
nightSleep.equal |
number | Night sleep - Filter for entries with values exactly equal to the specified value |
nightSleep.exists |
boolean | Night sleep - Filter for entries with a value |
nightSleep.greaterThan |
number | Night sleep - Filter for entries with values greater than the specified value |
nightSleep.greaterThanOrEqual |
number | Night sleep - Filter for entries with values greater than or equal to the specified value |
nightSleep.lessThan |
number | Night sleep - Filter for entries with values less than the specified value |
nightSleep.lessThanOrEqual |
number | Night sleep - Filter for entries with values less than or equal to the specified value |
nightSleep.not.between |
Array<> | Night sleep - Filter for entries with values between two specified values (inclusive) |
nightSleep.not.equal |
number | Night sleep - Filter for entries with values not equal to the specified value |
nightSleep.not.exists |
boolean | Night sleep - Filter for entries without a value |
recreationalDrugs |
string | Recreational drugs - Filter for a matching concept code |
recreationalDrugs.allOf |
Array<string> | Recreational drugs - Filter for entries matching all of the concepts |
recreationalDrugs.anyOf |
Array<string> | Recreational drugs - Filter for a matching set of concept codes |
recreationalDrugs.descendantsOf |
string | Recreational drugs - Filter for all child concepts of a given concepts code |
recreationalDrugs.exists |
boolean | Recreational drugs - Filter for entries with a value |
recreationalDrugs.not |
string | Recreational drugs - Filter for a mismatching concept code |
recreationalDrugs.not.allOf |
Array<string> | Recreational drugs - Filter for entries mismatching all of the concepts |
recreationalDrugs.not.anyOf |
Array<string> | Recreational drugs - Filter for a mismmatching set of concept codes |
recreationalDrugs.not.exists |
boolean | Recreational drugs - Filter for entries without a value |
smokingPackyears.between |
Array<> | Smoking packyears - Filter for entries with values between two specified values (inclusive) |
smokingPackyears.equal |
number | Smoking packyears - Filter for entries with values exactly equal to the specified value |
smokingPackyears.exists |
boolean | Smoking packyears - Filter for entries with a value |
smokingPackyears.greaterThan |
number | Smoking packyears - Filter for entries with values greater than the specified value |
smokingPackyears.greaterThanOrEqual |
number | Smoking packyears - Filter for entries with values greater than or equal to the specified value |
smokingPackyears.lessThan |
number | Smoking packyears - Filter for entries with values less than the specified value |
smokingPackyears.lessThanOrEqual |
number | Smoking packyears - Filter for entries with values less than or equal to the specified value |
smokingPackyears.not.between |
Array<> | Smoking packyears - Filter for entries with values between two specified values (inclusive) |
smokingPackyears.not.equal |
number | Smoking packyears - Filter for entries with values not equal to the specified value |
smokingPackyears.not.exists |
boolean | Smoking packyears - Filter for entries without a value |
smokingQuited.between |
Array<> | Time since quitted smoking - Filter for entries with values between two specified values (inclusive) |
smokingQuited.equal |
number | Time since quitted smoking - Filter for entries with values exactly equal to the specified value |
smokingQuited.exists |
boolean | Time since quitted smoking - Filter for entries with a value |
smokingQuited.greaterThan |
number | Time since quitted smoking - Filter for entries with values greater than the specified value |
smokingQuited.greaterThanOrEqual |
number | Time since quitted smoking - Filter for entries with values greater than or equal to the specified value |
smokingQuited.lessThan |
number | Time since quitted smoking - Filter for entries with values less than the specified value |
smokingQuited.lessThanOrEqual |
number | Time since quitted smoking - Filter for entries with values less than or equal to the specified value |
smokingQuited.not.between |
Array<> | Time since quitted smoking - Filter for entries with values between two specified values (inclusive) |
smokingQuited.not.equal |
number | Time since quitted smoking - Filter for entries with values not equal to the specified value |
smokingQuited.not.exists |
boolean | Time since quitted smoking - Filter for entries without a value |
smokingStatus |
string | Smoking Status - Filter for a matching concept code |
smokingStatus.anyOf |
Array<string> | Smoking Status - Filter for a matching set of concept codes |
smokingStatus.descendantsOf |
string | Smoking Status - Filter for all child concepts of a given concepts code |
smokingStatus.exists |
boolean | Smoking Status - Filter for entries with a value |
smokingStatus.not |
string | Smoking Status - Filter for a mismatching concept code |
smokingStatus.not.anyOf |
Array<string> | Smoking Status - Filter for a mismmatching set of concept codes |
smokingStatus.not.exists |
boolean | Smoking Status - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
LifestylePartial¶
| Name | Type | Description |
|---|---|---|
alcoholConsumption |
Frequency of alcohol consumption | |
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's lifetyle was assessed and recorded. |
exposures |
Environmental or occupational exposures to hazards or carcinogenic agents | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
nightSleep |
Estimated average sleep time per night | |
recreationalDrugs |
Any recreational drug(s) used by the patient | |
smokingPackyears |
number | Smoking pack-years (if applicable) |
smokingQuited |
Estimated time since quitting smoking (if applicable) | |
smokingStatus |
Tobacco consumption status | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
LossOfHeterozygosity¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
number | Loss of heterozygosity (LOH) as a percentage |
LossOfHeterozygosityCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
value |
number | Loss of heterozygosity (LOH) as a percentage |
LossOfHeterozygosityPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
number | Loss of heterozygosity (LOH) as a percentage |
LymphomaStaging¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
bulky |
boolean | Bulky modifier indicating if the lymphoma has the presence of bulky disease. |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
methodology |
Methodology used for the Lymphoma staging | |
modifiers |
Array<CodedConcept> | Qualifier acting as modifier for the lymphoma stage |
pathological |
boolean | Whether the staging was based on clinical or pathologic evidence. |
stage |
CodedConcept | The value of the Lymphoma stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
LymphomaStagingCreate¶
| Name | Type | Description |
|---|---|---|
bulky |
boolean | Bulky modifier indicating if the lymphoma has the presence of bulky disease. |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
methodology |
Methodology used for the Lymphoma staging | |
modifiers |
Array<CodedConcept> | Qualifier acting as modifier for the lymphoma stage |
pathological |
boolean | Whether the staging was based on clinical or pathologic evidence. |
stage |
CodedConcept | The value of the Lymphoma stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
LymphomaStagingPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
bulky |
boolean | Bulky modifier indicating if the lymphoma has the presence of bulky disease. |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
methodology |
Methodology used for the Lymphoma staging | |
modifiers |
Qualifier acting as modifier for the lymphoma stage | |
pathological |
boolean | Whether the staging was based on clinical or pathologic evidence. |
stage |
The value of the Lymphoma stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
Measure¶
| Name | Type | Description |
|---|---|---|
unit |
string | The unit of measurement (e.g., 'kg', 'm', 'ml'). |
value |
number | The numerical value of the measure. |
MeasureConversion¶
| Name | Type | Description |
|---|---|---|
newUnit |
string | The target unit to convert the measure into. |
unit |
string | The current unit of the measure. |
value |
number | The numerical value of the measure to be converted. |
MicrosatelliteInstability¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
CodedConcept | Microsatellite instability (MSI) classification |
MicrosatelliteInstabilityCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
value |
CodedConcept | Microsatellite instability (MSI) classification |
MicrosatelliteInstabilityPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
Microsatellite instability (MSI) classification |
ModifiedResource¶
| Name | Type | Description |
|---|---|---|
description |
string | A human-readable description of the modified resource. |
id |
string(uuid) | Unique identifier (UUID4) of the modified resource. |
MolecularTherapeuticRecommendation¶
| Name | Type | Description |
|---|---|---|
clinicalTrial |
string | Clinical trial (NCT-Iddentifier) recommended by the board for enrollment |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
drugs |
Array<CodedConcept> | Drugs(s) being recommended |
expectedEffect |
Classification of the expected effect of the drug | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
offLabelUse |
boolean | Whether the medication(s) recommended were off-label |
supportingGenomicSignaturesIds |
Array<string(uuid)> | Genomic signatures that support the recommendation |
supportingGenomicVariantsIds |
Array<string(uuid)> | Genomic variants that support the recommendation |
supportingTumorMarkersIds |
Array<string(uuid)> | Tumor markers that support the recommendation |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
withinSoc |
boolean | Whether the medication(s) recommended were within standard of care |
MolecularTherapeuticRecommendationCreate¶
| Name | Type | Description |
|---|---|---|
clinicalTrial |
string | Clinical trial (NCT-Iddentifier) recommended by the board for enrollment |
drugs |
Array<CodedConcept> | Drugs(s) being recommended |
expectedEffect |
Classification of the expected effect of the drug | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
offLabelUse |
boolean | Whether the medication(s) recommended were off-label |
supportingGenomicSignaturesIds |
Array<string(uuid)> | Genomic signatures that support the recommendation |
supportingGenomicVariantsIds |
Array<string(uuid)> | Genomic variants that support the recommendation |
supportingTumorMarkersIds |
Array<string(uuid)> | Tumor markers that support the recommendation |
withinSoc |
boolean | Whether the medication(s) recommended were within standard of care |
MolecularTumorBoard¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient which was discussed at the tumor board |
category |
string | Tumor board discriminator category |
characterizedCup |
boolean | Whether the cancer of unknown primary (CUP) characterization was successful. |
conductedCupCharacterization |
boolean | Whether there was a cancer of unknown primary (CUP) characterization during the molecular tumor board. |
conductedMolecularComparison |
boolean | Indicates whether a molecular comparison was conducted during the molecular tumor board |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Date at which the tumor board took place and/or when the board provided a recommendation. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
molecularComparisonMatchId |
string(uuid) | The neoplastic entity that was matched during the molecular comparison |
recommendations |
Array<CodedConcept> | Recommendation(s) provided by the board regarding the patient's care |
relatedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the tumor board. |
reviewedReports |
Array<string> | List of genomic reports reviewed during the board meeting. |
therapeuticRecommendations |
Array<MolecularTherapeuticRecommendation> | Therapeutic recommendations of the molecular tumor board |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
MolecularTumorBoardCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient which was discussed at the tumor board |
category |
string | Tumor board discriminator category |
characterizedCup |
boolean | Whether the cancer of unknown primary (CUP) characterization was successful. |
conductedCupCharacterization |
boolean | Whether there was a cancer of unknown primary (CUP) characterization during the molecular tumor board. |
conductedMolecularComparison |
boolean | Indicates whether a molecular comparison was conducted during the molecular tumor board |
date |
string(date) | Date at which the tumor board took place and/or when the board provided a recommendation. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
molecularComparisonMatchId |
string(uuid) | The neoplastic entity that was matched during the molecular comparison |
recommendations |
Array<CodedConcept> | Recommendation(s) provided by the board regarding the patient's care |
relatedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the tumor board. |
reviewedReports |
Array<string> | List of genomic reports reviewed during the board meeting. |
NeoplasticEntity¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
assertionDate |
string(date) | The date on which the existence of the neoplasm(s) was first asserted or acknowledged |
caseId |
string(uuid) | Indicates the case of the patient who's neoplasm(s) are recorded |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
differentitation |
Morphologic differentitation characteristics of the neoplasm(s) | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
laterality |
Laterality qualifier for the location of the neoplasm(s) | |
morphology |
CodedConcept | Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself |
relatedPrimaryId |
string(uuid) | Reference to the primary neoplasm of which the neoplasm(s) originated from. |
relationship |
NeoplasticEntityRelationshipChoices | Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease. |
topography |
CodedConcept | Anatomical location of the neoplasm(s) |
topographyGroup |
Broad anatomical location of the neoplastic entity | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
NeoplasticEntityCreate¶
| Name | Type | Description |
|---|---|---|
assertionDate |
string(date) | The date on which the existence of the neoplasm(s) was first asserted or acknowledged |
caseId |
string(uuid) | Indicates the case of the patient who's neoplasm(s) are recorded |
differentitation |
Morphologic differentitation characteristics of the neoplasm(s) | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
laterality |
Laterality qualifier for the location of the neoplasm(s) | |
morphology |
CodedConcept | Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself |
relatedPrimaryId |
string(uuid) | Reference to the primary neoplasm of which the neoplasm(s) originated from. |
relationship |
NeoplasticEntityRelationshipChoices | Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease. |
topography |
CodedConcept | Anatomical location of the neoplasm(s) |
NeoplasticEntityFilters¶
| Name | Type | Description |
|---|---|---|
assertionDate.after |
string(date) | Assertion date - Filter for entries with dates after the specified value |
assertionDate.before |
string(date) | Assertion date - Filter for entries with dates before the specified value |
assertionDate.between |
Array<> | Assertion date - Filter for entries with dates between two specified values (inclusive) |
assertionDate.not.between |
Array<> | Assertion date - Filter for entries with dates not between two specified values (inclusive) |
assertionDate.not.on |
string(date) | Assertion date - Filter for entries with dates not matching the specified value |
assertionDate.on |
string(date) | Assertion date - Filter for entries with dates exactly matching the specified value |
assertionDate.onOrAfter |
string(date) | Assertion date - Filter for entries with dates on or after the specified value |
assertionDate.onOrBefore |
string(date) | Assertion date - Filter for entries with dates on or before the specified value |
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
differentitation |
string | Differentiation - Filter for a matching concept code |
differentitation.anyOf |
Array<string> | Differentiation - Filter for a matching set of concept codes |
differentitation.descendantsOf |
string | Differentiation - Filter for all child concepts of a given concepts code |
differentitation.exists |
boolean | Differentiation - Filter for entries with a value |
differentitation.not |
string | Differentiation - Filter for a mismatching concept code |
differentitation.not.anyOf |
Array<string> | Differentiation - Filter for a mismmatching set of concept codes |
differentitation.not.exists |
boolean | Differentiation - Filter for entries without a value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
laterality |
string | Laterality - Filter for a matching concept code |
laterality.anyOf |
Array<string> | Laterality - Filter for a matching set of concept codes |
laterality.descendantsOf |
string | Laterality - Filter for all child concepts of a given concepts code |
laterality.exists |
boolean | Laterality - Filter for entries with a value |
laterality.not |
string | Laterality - Filter for a mismatching concept code |
laterality.not.anyOf |
Array<string> | Laterality - Filter for a mismmatching set of concept codes |
laterality.not.exists |
boolean | Laterality - Filter for entries without a value |
morphology |
string | Morphology - Filter for a matching concept code |
morphology.anyOf |
Array<string> | Morphology - Filter for a matching set of concept codes |
morphology.descendantsOf |
string | Morphology - Filter for all child concepts of a given concepts code |
morphology.not |
string | Morphology - Filter for a mismatching concept code |
morphology.not.anyOf |
Array<string> | Morphology - Filter for a mismmatching set of concept codes |
relatedPrimaryId |
string | Related primary neoplasm - Filter for reference matches |
relatedPrimaryId.anyOf |
Array<string> | Related primary neoplasm - Filter for entries where at least one reference matches the query |
relatedPrimaryId.beginsWith |
string | Related primary neoplasm - Filter for entries starting with the text |
relatedPrimaryId.contains |
string | Related primary neoplasm - Filter for partial text matches |
relatedPrimaryId.endsWith |
string | Related primary neoplasm - Filter for entries ending with the text |
relatedPrimaryId.exists |
boolean | Related primary neoplasm - Filter for entries with a value |
relatedPrimaryId.not |
string | Related primary neoplasm - Filter for reference mismatches |
relatedPrimaryId.not.anyOf |
Array<string> | Related primary neoplasm - Filter for entries where at least one reference mismatches the query |
relatedPrimaryId.not.beginsWith |
string | Related primary neoplasm - Filter for entries not starting with the text |
relatedPrimaryId.not.contains |
string | Related primary neoplasm - Filter for partial text mismatches |
relatedPrimaryId.not.endsWith |
string | Related primary neoplasm - Filter for entries not ending with the text |
relatedPrimaryId.not.exists |
boolean | Related primary neoplasm - Filter for entries without a value |
relationship |
Neoplastic relationship - Filter for single value choice | |
relationship.anyOf |
Array<string> | Neoplastic relationship - ('Filter for excluding a subset of value choices',) |
relationship.not |
Neoplastic relationship - ('Filter for all but a single value choice',) | |
topography |
string | Topography - Filter for a matching concept code |
topography.anyOf |
Array<string> | Topography - Filter for a matching set of concept codes |
topography.descendantsOf |
string | Topography - Filter for all child concepts of a given concepts code |
topography.not |
string | Topography - Filter for a mismatching concept code |
topography.not.anyOf |
Array<string> | Topography - Filter for a mismmatching set of concept codes |
topographyGroup |
string | Topographical group - Filter for a matching concept code |
topographyGroup.anyOf |
Array<string> | Topographical group - Filter for a matching set of concept codes |
topographyGroup.descendantsOf |
string | Topographical group - Filter for all child concepts of a given concepts code |
topographyGroup.exists |
boolean | Topographical group - Filter for entries with a value |
topographyGroup.not |
string | Topographical group - Filter for a mismatching concept code |
topographyGroup.not.anyOf |
Array<string> | Topographical group - Filter for a mismmatching set of concept codes |
topographyGroup.not.exists |
boolean | Topographical group - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
NeoplasticEntityPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
assertionDate |
string(date) | The date on which the existence of the neoplasm(s) was first asserted or acknowledged |
caseId |
string(uuid) | Indicates the case of the patient who's neoplasm(s) are recorded |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
differentitation |
Morphologic differentitation characteristics of the neoplasm(s) | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
laterality |
Laterality qualifier for the location of the neoplasm(s) | |
morphology |
Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself | |
relatedPrimaryId |
string(uuid) | Reference to the primary neoplasm of which the neoplasm(s) originated from. |
relationship |
Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease. | |
topography |
Anatomical location of the neoplasm(s) | |
topographyGroup |
Broad anatomical location of the neoplastic entity | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
NeoplasticEntityRelationshipChoices¶
Type: string
ninja__pagination__LimitOffsetPagination__Input¶
| Name | Type | Description |
|---|---|---|
limit |
integer | |
offset |
integer |
ninja_extra__ordering__Ordering__Input¶
| Name | Type | Description |
|---|---|---|
ordering |
onconova__core__anonymization__decorator__AnonymizationBase__Input¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether to anonymize the data or not (requires elevated permissions) |
OncoplotDataset¶
| Name | Type | Description |
|---|---|---|
cases |
Array<string> | List of patient cases |
genes |
Array<string> | List of most frequently encountered genes |
metadata |
Metadata for the Kaplan-Meier curve. | |
variants |
Array<OncoplotVariant> | Variants included in the Oncoplot |
OncoplotVariant¶
| Name | Type | Description |
|---|---|---|
caseId |
string | |
gene |
string | |
hgvsExpression |
string | |
isPathogenic |
boolean |
Paginated_AdverseEvent_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<AdverseEvent> |
Paginated_AnyGenomicSignature_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<AnyGenomicSignature> |
Paginated_AnyStaging_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<AnyStaging> |
Paginated_AnyTumorBoard_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<AnyTumorBoard> |
Paginated_CodedConcept_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<CodedConcept> |
Paginated_Cohort_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<Cohort> |
Paginated_ComorbiditiesAssessment_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<ComorbiditiesAssessment> |
Paginated_Dataset_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<Dataset> |
Paginated_FamilyHistory_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<FamilyHistory> |
Paginated_GenomicVariant_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<GenomicVariant> |
Paginated_HistoryEvent_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<HistoryEvent> |
Paginated_HistoryEventWithSchema_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<HistoryEventWithSchema> |
Paginated_Lifestyle_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<Lifestyle> |
Paginated_NeoplasticEntity_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<NeoplasticEntity> |
Paginated_PatientCase_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<PatientCase> |
Paginated_PatientCaseDataset_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<PatientCaseDataset> |
Paginated_PerformanceStatus_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<PerformanceStatus> |
Paginated_Project_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<Project> |
Paginated_ProjectDataManagerGrant_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<ProjectDataManagerGrant> |
Paginated_Radiotherapy_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<Radiotherapy> |
Paginated_RiskAssessment_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<RiskAssessment> |
Paginated_Surgery_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<Surgery> |
Paginated_SystemicTherapy_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<SystemicTherapy> |
Paginated_TherapyLine_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<TherapyLine> |
Paginated_TreatmentResponse_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<TreatmentResponse> |
Paginated_TumorMarker_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<TumorMarker> |
Paginated_User_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<User> |
Paginated_Vitals_¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
items |
Array<Vitals> |
PatientCase¶
| Name | Type | Description |
|---|---|---|
age |
Approximate age of the patient in years | |
ageAtDiagnosis |
Approximate age of the patient in years at the time of the initial diagnosis | |
anonymized |
boolean | Whether the data has been anonymized |
causeOfDeath |
Classification of the cause of death. | |
clinicalCenter |
string | Medical center where the patient data originally resides |
clinicalIdentifier |
string | Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient |
consentStatus |
Status of the general consent by the patient for the use of their data for research purposes | |
contributors |
Array<string> | Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order. |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
dataCompletionRate |
number | Percentage indicating the completeness of a case in terms of its data. |
dateOfBirth |
Date of birth of the patient | |
dateOfDeath |
string(date) | Anonymized date of death (year/month). The day is set to the first day of the month by convention. |
description |
string | Human-readable description |
endOfRecords |
string(date) | Date of the last known record about the patient if lost to followup or vital status is unknown. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
gender |
CodedConcept | Gender of the patient for legal/administrative purposes |
genderIdentity |
The patient's innate sense of their gender as reported | |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
overallSurvival |
number | Overall survival of the patient since diagnosis |
pseudoidentifier |
string | Pseudoidentifier of the patient |
race |
Race of the patient | |
sexAtBirth |
Sex assigned at birth | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
vitalStatus |
Whether the patient is known to be alive or decaeased or is unknkown. |
PatientCaseBundle¶
| Name | Type | Description |
|---|---|---|
adverseEvents |
Array<AdverseEvent> | |
age |
Approximate age of the patient in years | |
ageAtDiagnosis |
Approximate age of the patient in years at the time of the initial diagnosis | |
anonymized |
boolean | Whether the data has been anonymized |
causeOfDeath |
Classification of the cause of death. | |
clinicalCenter |
string | Medical center where the patient data originally resides |
clinicalIdentifier |
string | Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient |
comorbidities |
Array<ComorbiditiesAssessment> | |
completedDataCategories |
||
consentStatus |
Status of the general consent by the patient for the use of their data for research purposes | |
contributors |
Array<string> | Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order. |
contributorsDetails |
Array<UserExport> | |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
dataCompletionRate |
number | Percentage indicating the completeness of a case in terms of its data. |
dateOfBirth |
Date of birth of the patient | |
dateOfDeath |
string(date) | Anonymized date of death (year/month). The day is set to the first day of the month by convention. |
description |
string | Human-readable description |
endOfRecords |
string(date) | Date of the last known record about the patient if lost to followup or vital status is unknown. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
familyHistory |
Array<FamilyHistory> | |
gender |
CodedConcept | Gender of the patient for legal/administrative purposes |
genderIdentity |
The patient's innate sense of their gender as reported | |
genomicSignatures |
Array<> | |
genomicVariants |
Array<GenomicVariant> | |
history |
Array<HistoryEvent> | |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
lifestyles |
Array<Lifestyle> | |
neoplasticEntities |
Array<NeoplasticEntity> | |
overallSurvival |
number | Overall survival of the patient since diagnosis |
performanceStatus |
Array<PerformanceStatus> | |
pseudoidentifier |
string | Pseudoidentifier of the patient |
race |
Race of the patient | |
radiotherapies |
Array<Radiotherapy> | |
riskAssessments |
Array<RiskAssessment> | |
sexAtBirth |
Sex assigned at birth | |
stagings |
Array<> | |
surgeries |
Array<Surgery> | |
systemicTherapies |
Array<SystemicTherapy> | |
therapyLines |
Array<TherapyLine> | |
treatmentResponses |
Array<TreatmentResponse> | |
tumorBoards |
Array<> | |
tumorMarkers |
Array<TumorMarker> | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
vitals |
Array<Vitals> | |
vitalStatus |
Whether the patient is known to be alive or decaeased or is unknkown. |
PatientCaseConsentStatusChoices¶
Type: string
PatientCaseCreate¶
| Name | Type | Description |
|---|---|---|
causeOfDeath |
Classification of the cause of death. | |
clinicalCenter |
string | Medical center where the patient data originally resides |
clinicalIdentifier |
string | Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient |
consentStatus |
Status of the general consent by the patient for the use of their data for research purposes | |
dateOfBirth |
string(date) | Anonymized date of birth (year/month). The day is set to the first day of the month by convention. |
dateOfDeath |
string(date) | Anonymized date of death (year/month). The day is set to the first day of the month by convention. |
endOfRecords |
string(date) | Date of the last known record about the patient if lost to followup or vital status is unknown. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
gender |
CodedConcept | Gender of the patient for legal/administrative purposes |
genderIdentity |
The patient's innate sense of their gender as reported | |
race |
Race of the patient | |
sexAtBirth |
Sex assigned at birth | |
vitalStatus |
Whether the patient is known to be alive or decaeased or is unknkown. |
PatientCaseDataCategoryChoices¶
Type: string
PatientCaseDataCompletionStatus¶
| Name | Type | Description |
|---|---|---|
status |
boolean | Boolean indicating whether the data category has been marked as completed |
timestamp |
string(date-time) | Username of the person who marked the category as completed |
username |
string | Username of the person who marked the category as completed |
PatientCaseDataset¶
| Name | Type | Description |
|---|---|---|
adverseEvents |
Array<AdverseEventPartial> | Adverse events associated with the patient case |
age |
Approximate age of the patient in years | |
ageAtDiagnosis |
Approximate age of the patient in years at the time of the initial diagnosis | |
aneuploidScores |
Array<AneuploidScorePartial> | Aneuploid scores associated with the patient case |
anonymized |
boolean | Whether the data has been anonymized |
binetStagings |
Array<BinetStagingPartial> | Binet stagings associated with the patient case |
breslowStagings |
Array<BreslowDepthPartial> | Breslow stagings associated with the patient case |
causeOfDeath |
Classification of the cause of death. | |
clarkStagings |
Array<ClarkStagingPartial> | Clark stagings associated with the patient case |
clinicalCenter |
string | Medical center where the patient data originally resides |
clinicalIdentifier |
string | Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient |
comorbidities |
Array<ComorbiditiesAssessmentPartial> | Comorbidities associated with the patient case |
consentStatus |
Status of the general consent by the patient for the use of their data for research purposes | |
contributors |
Array<string> | Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order. |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
dataCompletionRate |
number | Percentage indicating the completeness of a case in terms of its data. |
dateOfBirth |
Date of birth of the patient | |
dateOfDeath |
string(date) | Anonymized date of death (year/month). The day is set to the first day of the month by convention. |
endOfRecords |
string(date) | Date of the last known record about the patient if lost to followup or vital status is unknown. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
familyHistory |
Array<FamilyHistoryPartial> | Family history associated with the patient case |
figoStagings |
Array<TNMStagingPartial> | FIGO stagings associated with the patient case |
gender |
Gender of the patient for legal/administrative purposes | |
genderIdentity |
The patient's innate sense of their gender as reported | |
genomicVariants |
Array<GenomicVariantPartial> | Genomic variants associated with the patient case |
gleasonStagings |
Array<GleasonGradePartial> | Gleason stagings associated with the patient case |
homologousRecombinationDeficiencies |
Array<HomologousRecombinationDeficiencyPartial> | HRDness associated with the patient case |
id |
string(uuid) | Unique identifier of the patient case |
inrgssStagings |
Array<INRGSSStagePartial> | INRGSS stagings associated with the patient case |
inssStagings |
Array<INSSStagePartial> | INSS stagings associated with the patient case |
issStagings |
Array<ISSStagingPartial> | ISS stagings associated with the patient case |
lifestyles |
Array<LifestylePartial> | Lifestyles associated with the patient case |
lossesOfHeterozygosity |
Array<LossOfHeterozygosityPartial> | Losses of heterozygosity associated with the patient case |
lymphomaStagings |
Array<LymphomaStagingPartial> | Lymphoma stagings associated with the patient case |
microsatelliteInstabilities |
Array<MicrosatelliteInstabilityPartial> | Microsatellite instabilities associated with the patient case |
molecularTumorBoards |
Array<UnspecifiedTumorBoardPartial> | Molecular tumor boards associated with the patient case |
neoplasticEntities |
Array<NeoplasticEntityPartial> | Neoplastic entities associated with the patient case |
overallSurvival |
number | Overall survival of the patient since diagnosis |
performanceStatus |
Array<PerformanceStatusPartial> | Performance status associated with the patient case |
pseudoidentifier |
string | Internal identificator of the patient case |
race |
Race of the patient | |
radiotherapies |
Array<RadiotherapyPartial> | Radiotherapies associated with the patient case |
raiStagings |
Array<RaiStagingPartial> | Rai stagings associated with the patient case |
rhabdomyosarcomaGroups |
Array<RhabdomyosarcomaClinicalGroupPartial> | Rhabdomyosarcoma group stagings associated with the patient case |
riskAssessments |
Array<RiskAssessmentPartial> | Risk assessments associated with the patient case |
rissStagings |
Array<RISSStagingPartial> | RISS stagings associated with the patient case |
sexAtBirth |
Sex assigned at birth | |
surgeries |
Array<SurgeryPartial> | Surgeries associated with the patient case |
systemicTherapies |
Array<SystemicTherapyPartial> | Systemic therapies associated with the patient case |
therapyLines |
Array<TherapyLinePartial> | Therapy lines associated with the patient case |
tnmStagings |
Array<TNMStagingPartial> | TNM stagings associated with the patient case |
treatmentResponses |
Array<TreatmentResponsePartial> | Treatment responses associated with the patient case |
tumorMarkers |
Array<TumorMarkerPartial> | Tumor markers associated with the patient case |
tumorMutationalBurdens |
Array<TumorMutationalBurdenPartial> | Tumor mutational burdens associated with the patient case |
tumorNeoantigenBurdens |
Array<TumorNeoantigenBurdenPartial> | TNB values associated with the patient case |
unspecifiedTumorBoards |
Array<UnspecifiedTumorBoardPartial> | Tumor boards associated with the patient case |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
vitals |
Array<VitalsPartial> | Vitals associated with the patient case |
vitalStatus |
Whether the patient is known to be alive or decaeased or is unknkown. | |
wilmsStagings |
Array<WilmsStagePartial> | Wilms stagings associated with the patient case |
PatientCaseFilters¶
| Name | Type | Description |
|---|---|---|
age.between |
Array<> | Age - Filter for entries with values between two specified values (inclusive) |
age.equal |
integer | Age - Filter for entries with values exactly equal to the specified value |
age.greaterThan |
integer | Age - Filter for entries with values greater than the specified value |
age.greaterThanOrEqual |
integer | Age - Filter for entries with values greater than or equal to the specified value |
age.lessThan |
integer | Age - Filter for entries with values less than the specified value |
age.lessThanOrEqual |
integer | Age - Filter for entries with values less than or equal to the specified value |
age.not.between |
Array<> | Age - Filter for entries with values between two specified values (inclusive) |
age.not.equal |
integer | Age - Filter for entries with values not equal to the specified value |
ageAtDiagnosis.between |
Array<> | Age at diagnosis - Filter for entries with values between two specified values (inclusive) |
ageAtDiagnosis.equal |
integer | Age at diagnosis - Filter for entries with values exactly equal to the specified value |
ageAtDiagnosis.exists |
boolean | Age at diagnosis - Filter for entries with a value |
ageAtDiagnosis.greaterThan |
integer | Age at diagnosis - Filter for entries with values greater than the specified value |
ageAtDiagnosis.greaterThanOrEqual |
integer | Age at diagnosis - Filter for entries with values greater than or equal to the specified value |
ageAtDiagnosis.lessThan |
integer | Age at diagnosis - Filter for entries with values less than the specified value |
ageAtDiagnosis.lessThanOrEqual |
integer | Age at diagnosis - Filter for entries with values less than or equal to the specified value |
ageAtDiagnosis.not.between |
Array<> | Age at diagnosis - Filter for entries with values between two specified values (inclusive) |
ageAtDiagnosis.not.equal |
integer | Age at diagnosis - Filter for entries with values not equal to the specified value |
ageAtDiagnosis.not.exists |
boolean | Age at diagnosis - Filter for entries without a value |
causeOfDeath |
string | Cause of death - Filter for a matching concept code |
causeOfDeath.anyOf |
Array<string> | Cause of death - Filter for a matching set of concept codes |
causeOfDeath.descendantsOf |
string | Cause of death - Filter for all child concepts of a given concepts code |
causeOfDeath.exists |
boolean | Cause of death - Filter for entries with a value |
causeOfDeath.not |
string | Cause of death - Filter for a mismatching concept code |
causeOfDeath.not.anyOf |
Array<string> | Cause of death - Filter for a mismmatching set of concept codes |
causeOfDeath.not.exists |
boolean | Cause of death - Filter for entries without a value |
consentStatus |
Consent status - Filter for single value choice | |
consentStatus.anyOf |
Array<string> | Consent status - ('Filter for excluding a subset of value choices',) |
consentStatus.not |
Consent status - ('Filter for all but a single value choice',) | |
contributors |
Array<string> | Data contributors - Filter for exact array matches |
contributors.containedBy |
Array<string> | Data contributors - Filter for entries where where the data is a subset of the values passed |
contributors.contains |
Array<string> | Data contributors - Filter for entries where where the values passed are a subset of the data |
contributors.not |
Array<string> | Data contributors - Filter for exact array mismatches |
contributors.not.containedBy |
Array<string> | Data contributors - Filter for entries where the data is not a subset of the values passed |
contributors.not.contains |
Array<string> | Data contributors - Filter for entries where the values passed are not a subset of the data |
contributors.not.overlaps |
Array<string> | Data contributors - Filter for entries where the data shares not any results with the values passed. |
contributors.overlaps |
Array<string> | Data contributors - Filter for entries where the data shares any results with the values passed. |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
dataCompletionRate.between |
Array<> | Data completion rate - Filter for entries with values between two specified values (inclusive) |
dataCompletionRate.equal |
number | Data completion rate - Filter for entries with values exactly equal to the specified value |
dataCompletionRate.greaterThan |
number | Data completion rate - Filter for entries with values greater than the specified value |
dataCompletionRate.greaterThanOrEqual |
number | Data completion rate - Filter for entries with values greater than or equal to the specified value |
dataCompletionRate.lessThan |
number | Data completion rate - Filter for entries with values less than the specified value |
dataCompletionRate.lessThanOrEqual |
number | Data completion rate - Filter for entries with values less than or equal to the specified value |
dataCompletionRate.not.between |
Array<> | Data completion rate - Filter for entries with values between two specified values (inclusive) |
dataCompletionRate.not.equal |
number | Data completion rate - Filter for entries with values not equal to the specified value |
endOfRecords.after |
string(date) | End of records - Filter for entries with dates after the specified value |
endOfRecords.before |
string(date) | End of records - Filter for entries with dates before the specified value |
endOfRecords.between |
Array<> | End of records - Filter for entries with dates between two specified values (inclusive) |
endOfRecords.exists |
boolean | End of records - Filter for entries with a value |
endOfRecords.not.between |
Array<> | End of records - Filter for entries with dates not between two specified values (inclusive) |
endOfRecords.not.exists |
boolean | End of records - Filter for entries without a value |
endOfRecords.not.on |
string(date) | End of records - Filter for entries with dates not matching the specified value |
endOfRecords.on |
string(date) | End of records - Filter for entries with dates exactly matching the specified value |
endOfRecords.onOrAfter |
string(date) | End of records - Filter for entries with dates on or after the specified value |
endOfRecords.onOrBefore |
string(date) | End of records - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
gender |
string | Gender - Filter for a matching concept code |
gender.anyOf |
Array<string> | Gender - Filter for a matching set of concept codes |
gender.descendantsOf |
string | Gender - Filter for all child concepts of a given concepts code |
gender.not |
string | Gender - Filter for a mismatching concept code |
gender.not.anyOf |
Array<string> | Gender - Filter for a mismmatching set of concept codes |
genderIdentity |
string | Gender identity - Filter for a matching concept code |
genderIdentity.anyOf |
Array<string> | Gender identity - Filter for a matching set of concept codes |
genderIdentity.descendantsOf |
string | Gender identity - Filter for all child concepts of a given concepts code |
genderIdentity.exists |
boolean | Gender identity - Filter for entries with a value |
genderIdentity.not |
string | Gender identity - Filter for a mismatching concept code |
genderIdentity.not.anyOf |
Array<string> | Gender identity - Filter for a mismmatching set of concept codes |
genderIdentity.not.exists |
boolean | Gender identity - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
morphology |
string | Morphology - Filters for matching primary morphology code. |
overallSurvival.between |
Array<> | Overall survival - Filter for entries with values between two specified values (inclusive) |
overallSurvival.equal |
number | Overall survival - Filter for entries with values exactly equal to the specified value |
overallSurvival.exists |
boolean | Overall survival - Filter for entries with a value |
overallSurvival.greaterThan |
number | Overall survival - Filter for entries with values greater than the specified value |
overallSurvival.greaterThanOrEqual |
number | Overall survival - Filter for entries with values greater than or equal to the specified value |
overallSurvival.lessThan |
number | Overall survival - Filter for entries with values less than the specified value |
overallSurvival.lessThanOrEqual |
number | Overall survival - Filter for entries with values less than or equal to the specified value |
overallSurvival.not.between |
Array<> | Overall survival - Filter for entries with values between two specified values (inclusive) |
overallSurvival.not.equal |
number | Overall survival - Filter for entries with values not equal to the specified value |
overallSurvival.not.exists |
boolean | Overall survival - Filter for entries without a value |
primarySite |
string | Primary site - Filters for matching primary topography code. |
pseudoidentifier |
string | Pseudoidentifier - Filter for full text matches |
pseudoidentifier.anyOf |
Array<string> | Pseudoidentifier - Filter for entries where at least one reference matches the query |
pseudoidentifier.beginsWith |
string | Pseudoidentifier - Filter for entries starting with the text |
pseudoidentifier.contains |
string | Pseudoidentifier - Filter for partial text matches |
pseudoidentifier.endsWith |
string | Pseudoidentifier - Filter for entries ending with the text |
pseudoidentifier.not |
string | Pseudoidentifier - Filter for full text mismatches |
pseudoidentifier.not.anyOf |
Array<string> | Pseudoidentifier - Filter for entries where at least one reference mismatches the query |
pseudoidentifier.not.beginsWith |
string | Pseudoidentifier - Filter for entries not starting with the text |
pseudoidentifier.not.contains |
string | Pseudoidentifier - Filter for partial text mismatches |
pseudoidentifier.not.endsWith |
string | Pseudoidentifier - Filter for entries not ending with the text |
race |
string | Race - Filter for a matching concept code |
race.anyOf |
Array<string> | Race - Filter for a matching set of concept codes |
race.descendantsOf |
string | Race - Filter for all child concepts of a given concepts code |
race.exists |
boolean | Race - Filter for entries with a value |
race.not |
string | Race - Filter for a mismatching concept code |
race.not.anyOf |
Array<string> | Race - Filter for a mismmatching set of concept codes |
race.not.exists |
boolean | Race - Filter for entries without a value |
sexAtBirth |
string | Birth sex - Filter for a matching concept code |
sexAtBirth.anyOf |
Array<string> | Birth sex - Filter for a matching set of concept codes |
sexAtBirth.descendantsOf |
string | Birth sex - Filter for all child concepts of a given concepts code |
sexAtBirth.exists |
boolean | Birth sex - Filter for entries with a value |
sexAtBirth.not |
string | Birth sex - Filter for a mismatching concept code |
sexAtBirth.not.anyOf |
Array<string> | Birth sex - Filter for a mismmatching set of concept codes |
sexAtBirth.not.exists |
boolean | Birth sex - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
vitalStatus |
Vital status - Filter for single value choice | |
vitalStatus.anyOf |
Array<string> | Vital status - ('Filter for excluding a subset of value choices',) |
vitalStatus.not |
Vital status - ('Filter for all but a single value choice',) |
PatientCaseIdentifier¶
Type: string
PatientCaseVitalStatusChoices¶
Type: string
PerformanceStatus¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's performance status is assesed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the performance score was performed and recorded. |
description |
string | Human-readable description |
ecogInterpretation |
Official interpretation of the ECOG score | |
ecogScore |
integer | ECOG Performance Status Score |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
karnofskyInterpretation |
Official interpretation of the Karnofsky score | |
karnofskyScore |
integer | Karnofsky Performance Status Score |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
PerformanceStatusCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's performance status is assesed |
date |
string(date) | Clinically-relevant date at which the performance score was performed and recorded. |
ecogScore |
integer | ECOG Performance Status Score |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
karnofskyScore |
integer | Karnofsky Performance Status Score |
PerformanceStatusFilters¶
| Name | Type | Description |
|---|---|---|
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Assessment date - Filter for entries with dates after the specified value |
date.before |
string(date) | Assessment date - Filter for entries with dates before the specified value |
date.between |
Array<> | Assessment date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Assessment date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Assessment date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Assessment date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Assessment date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Assessment date - Filter for entries with dates on or before the specified value |
ecogInterpretation |
string | ECOG Interpreation - Filter for a matching concept code |
ecogInterpretation.anyOf |
Array<string> | ECOG Interpreation - Filter for a matching set of concept codes |
ecogInterpretation.descendantsOf |
string | ECOG Interpreation - Filter for all child concepts of a given concepts code |
ecogInterpretation.exists |
boolean | ECOG Interpreation - Filter for entries with a value |
ecogInterpretation.not |
string | ECOG Interpreation - Filter for a mismatching concept code |
ecogInterpretation.not.anyOf |
Array<string> | ECOG Interpreation - Filter for a mismmatching set of concept codes |
ecogInterpretation.not.exists |
boolean | ECOG Interpreation - Filter for entries without a value |
ecogScore.between |
Array<> | ECOG Score - Filter for entries with values between two specified values (inclusive) |
ecogScore.equal |
integer | ECOG Score - Filter for entries with values exactly equal to the specified value |
ecogScore.exists |
boolean | ECOG Score - Filter for entries with a value |
ecogScore.greaterThan |
integer | ECOG Score - Filter for entries with values greater than the specified value |
ecogScore.greaterThanOrEqual |
integer | ECOG Score - Filter for entries with values greater than or equal to the specified value |
ecogScore.lessThan |
integer | ECOG Score - Filter for entries with values less than the specified value |
ecogScore.lessThanOrEqual |
integer | ECOG Score - Filter for entries with values less than or equal to the specified value |
ecogScore.not.between |
Array<> | ECOG Score - Filter for entries with values between two specified values (inclusive) |
ecogScore.not.equal |
integer | ECOG Score - Filter for entries with values not equal to the specified value |
ecogScore.not.exists |
boolean | ECOG Score - Filter for entries without a value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
karnofskyInterpretation |
string | Karnofsky Interpreation - Filter for a matching concept code |
karnofskyInterpretation.anyOf |
Array<string> | Karnofsky Interpreation - Filter for a matching set of concept codes |
karnofskyInterpretation.descendantsOf |
string | Karnofsky Interpreation - Filter for all child concepts of a given concepts code |
karnofskyInterpretation.exists |
boolean | Karnofsky Interpreation - Filter for entries with a value |
karnofskyInterpretation.not |
string | Karnofsky Interpreation - Filter for a mismatching concept code |
karnofskyInterpretation.not.anyOf |
Array<string> | Karnofsky Interpreation - Filter for a mismmatching set of concept codes |
karnofskyInterpretation.not.exists |
boolean | Karnofsky Interpreation - Filter for entries without a value |
karnofskyScore.between |
Array<> | Karnofsky Score - Filter for entries with values between two specified values (inclusive) |
karnofskyScore.equal |
integer | Karnofsky Score - Filter for entries with values exactly equal to the specified value |
karnofskyScore.exists |
boolean | Karnofsky Score - Filter for entries with a value |
karnofskyScore.greaterThan |
integer | Karnofsky Score - Filter for entries with values greater than the specified value |
karnofskyScore.greaterThanOrEqual |
integer | Karnofsky Score - Filter for entries with values greater than or equal to the specified value |
karnofskyScore.lessThan |
integer | Karnofsky Score - Filter for entries with values less than the specified value |
karnofskyScore.lessThanOrEqual |
integer | Karnofsky Score - Filter for entries with values less than or equal to the specified value |
karnofskyScore.not.between |
Array<> | Karnofsky Score - Filter for entries with values between two specified values (inclusive) |
karnofskyScore.not.equal |
integer | Karnofsky Score - Filter for entries with values not equal to the specified value |
karnofskyScore.not.exists |
boolean | Karnofsky Score - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
PerformanceStatusPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's performance status is assesed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the performance score was performed and recorded. |
ecogInterpretation |
Official interpretation of the ECOG score | |
ecogScore |
integer | ECOG Performance Status Score |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
karnofskyInterpretation |
Official interpretation of the Karnofsky score | |
karnofskyScore |
integer | Karnofsky Performance Status Score |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
Period¶
| Name | Type | Description |
|---|---|---|
end |
string(date) | The end date of the period. |
start |
string(date) | The start date of the period. |
Project¶
| Name | Type | Description |
|---|---|---|
clinicalCenters |
Array<string> | Clinical centers that are part of the project |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
dataConstraints |
Data constraints of the project | |
description |
string | Human-readable description |
ethicsApprovalNumber |
string | Ethics approval number of the project |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
leader |
string | User responsible for the project and its members |
members |
Array<string> | Users that are part of the project |
status |
Status of the project | |
summary |
string | Description of the project |
title |
string | Title of the project |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
ProjectCreate¶
| Name | Type | Description |
|---|---|---|
clinicalCenters |
Array<string> | Clinical centers that are part of the project |
dataConstraints |
Data constraints of the project | |
ethicsApprovalNumber |
string | Ethics approval number of the project |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
leader |
string | User responsible for the project and its members |
members |
Array<string> | Users that are part of the project |
status |
Status of the project | |
summary |
string | Description of the project |
title |
string | Title of the project |
ProjectDataManagerGrant¶
| Name | Type | Description |
|---|---|---|
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
isValid |
boolean | Whether the authorization grant is valid today |
member |
string | Manager of the project data |
projectId |
string(uuid) | Project under which the permission is granted |
revoked |
boolean | A flag that indicated whether the authorization has been revoked |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
validityPeriod |
Period | Period of validity |
ProjectDataManagerGrantCreate¶
| Name | Type | Description |
|---|---|---|
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
revoked |
boolean | A flag that indicated whether the authorization has been revoked |
validityPeriod |
Period | Period of validity |
ProjectFilters¶
| Name | Type | Description |
|---|---|---|
clinicalCenters |
string | Clinical Centers - Filter for full text matches |
clinicalCenters.anyOf |
Array<string> | Clinical Centers - Filter for entries where at least one reference matches the query |
clinicalCenters.beginsWith |
string | Clinical Centers - Filter for entries starting with the text |
clinicalCenters.contains |
string | Clinical Centers - Filter for partial text matches |
clinicalCenters.endsWith |
string | Clinical Centers - Filter for entries ending with the text |
clinicalCenters.not |
string | Clinical Centers - Filter for full text mismatches |
clinicalCenters.not.anyOf |
Array<string> | Clinical Centers - Filter for entries where at least one reference mismatches the query |
clinicalCenters.not.beginsWith |
string | Clinical Centers - Filter for entries not starting with the text |
clinicalCenters.not.contains |
string | Clinical Centers - Filter for partial text mismatches |
clinicalCenters.not.endsWith |
string | Clinical Centers - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
dataConstraints.exists |
boolean | Data constraints - Filter for entries with a value |
dataConstraints.not.exists |
boolean | Data constraints - Filter for entries without a value |
ethicsApprovalNumber |
string | Ethics approval number - Filter for full text matches |
ethicsApprovalNumber.anyOf |
Array<string> | Ethics approval number - Filter for entries where at least one reference matches the query |
ethicsApprovalNumber.beginsWith |
string | Ethics approval number - Filter for entries starting with the text |
ethicsApprovalNumber.contains |
string | Ethics approval number - Filter for partial text matches |
ethicsApprovalNumber.endsWith |
string | Ethics approval number - Filter for entries ending with the text |
ethicsApprovalNumber.not |
string | Ethics approval number - Filter for full text mismatches |
ethicsApprovalNumber.not.anyOf |
Array<string> | Ethics approval number - Filter for entries where at least one reference mismatches the query |
ethicsApprovalNumber.not.beginsWith |
string | Ethics approval number - Filter for entries not starting with the text |
ethicsApprovalNumber.not.contains |
string | Ethics approval number - Filter for partial text mismatches |
ethicsApprovalNumber.not.endsWith |
string | Ethics approval number - Filter for entries not ending with the text |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
leader.username |
string | Project leader - Filter for username matches |
leader.username.anyOf |
Array<string> | Project leader - Filter for entries where at least one reference mismatches the query |
leader.username.not |
string | Project leader - Filter for username mismatches |
leader.username.not.anyOf |
string | Project leader - Filter for entries where at least one reference matches the query |
members.exists |
boolean | Project members - Filter for entries with a value |
members.not.exists |
boolean | Project members - Filter for entries without a value |
members.username |
string | Project members - Filter for username matches |
members.username.anyOf |
Array<string> | Project members - Filter for entries where at least one reference mismatches the query |
members.username.not |
string | Project members - Filter for username mismatches |
members.username.not.anyOf |
string | Project members - Filter for entries where at least one reference matches the query |
status |
Project status - Filter for single value choice | |
status.anyOf |
Array<string> | Project status - ('Filter for excluding a subset of value choices',) |
status.exists |
boolean | Project status - Filter for entries with a value |
status.not |
Project status - ('Filter for all but a single value choice',) | |
status.not.exists |
boolean | Project status - Filter for entries without a value |
summary |
string | Project description - Filter for full text matches |
summary.anyOf |
Array<string> | Project description - Filter for entries where at least one reference matches the query |
summary.beginsWith |
string | Project description - Filter for entries starting with the text |
summary.contains |
string | Project description - Filter for partial text matches |
summary.endsWith |
string | Project description - Filter for entries ending with the text |
summary.not |
string | Project description - Filter for full text mismatches |
summary.not.anyOf |
Array<string> | Project description - Filter for entries where at least one reference mismatches the query |
summary.not.beginsWith |
string | Project description - Filter for entries not starting with the text |
summary.not.contains |
string | Project description - Filter for partial text mismatches |
summary.not.endsWith |
string | Project description - Filter for entries not ending with the text |
title |
string | Project title - Filter for full text matches |
title.anyOf |
Array<string> | Project title - Filter for entries where at least one reference matches the query |
title.beginsWith |
string | Project title - Filter for entries starting with the text |
title.contains |
string | Project title - Filter for partial text matches |
title.endsWith |
string | Project title - Filter for entries ending with the text |
title.not |
string | Project title - Filter for full text mismatches |
title.not.anyOf |
Array<string> | Project title - Filter for entries where at least one reference mismatches the query |
title.not.beginsWith |
string | Project title - Filter for entries not starting with the text |
title.not.contains |
string | Project title - Filter for partial text mismatches |
title.not.endsWith |
string | Project title - Filter for entries not ending with the text |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
ProjectStatusChoices¶
Type: string
ProteinChangeType¶
Type: string
Radiotherapy¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who received the radiotherapy |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
dosages |
Array<RadiotherapyDosage> | Radiation doses administered during the radiotherapy |
duration |
Measure | Duration of treatment |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
intent |
RadiotherapyIntentChoices | Treatment intent of the system therapy |
period |
Period | Clinically-relevant period during which the radiotherapy was administered to the patient. |
sessions |
integer | The total number of radiotherapy sessions over the treatment period. |
settings |
Array<RadiotherapySetting> | Settings of the radiotherapy irradiation procedure |
targetedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were targeted by the radiotherapy |
terminationReason |
Explanation for the premature or planned termination of the radiotherapy | |
therapyLineId |
string(uuid) | Therapy line to which the radiotherapy is assigned to |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RadiotherapyCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who received the radiotherapy |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
intent |
RadiotherapyIntentChoices | Treatment intent of the system therapy |
period |
Period | Clinically-relevant period during which the radiotherapy was administered to the patient. |
sessions |
integer | The total number of radiotherapy sessions over the treatment period. |
targetedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were targeted by the radiotherapy |
terminationReason |
Explanation for the premature or planned termination of the radiotherapy | |
therapyLineId |
string(uuid) | Therapy line to which the radiotherapy is assigned to |
RadiotherapyDosage¶
| Name | Type | Description |
|---|---|---|
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
dose |
Total radiation dose delivered over the full radiotherapy course | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
fractions |
integer | The total number of radiotherapy fractions delivered over the treatment period. |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
irradiatedVolume |
CodedConcept | Anatomical location of the irradiated volume |
irradiatedVolumeMorphology |
Morphology of the anatomical location of the irradiated volume | |
irradiatedVolumeQualifier |
General qualifier for the anatomical location of the irradiated volume | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RadiotherapyDosageCreate¶
| Name | Type | Description |
|---|---|---|
dose |
Total radiation dose delivered over the full radiotherapy course | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
fractions |
integer | The total number of radiotherapy fractions delivered over the treatment period. |
irradiatedVolume |
CodedConcept | Anatomical location of the irradiated volume |
irradiatedVolumeMorphology |
Morphology of the anatomical location of the irradiated volume | |
irradiatedVolumeQualifier |
General qualifier for the anatomical location of the irradiated volume |
RadiotherapyDosagePartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
dose |
Total radiation dose delivered over the full radiotherapy course | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
fractions |
integer | The total number of radiotherapy fractions delivered over the treatment period. |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
irradiatedVolume |
Anatomical location of the irradiated volume | |
irradiatedVolumeMorphology |
Morphology of the anatomical location of the irradiated volume | |
irradiatedVolumeQualifier |
General qualifier for the anatomical location of the irradiated volume | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RadiotherapyFilters¶
| Name | Type | Description |
|---|---|---|
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
dosages.createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
dosages.createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
dosages.createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
dosages.createdAt.exists |
boolean | Created at - Filter for entries with a value |
dosages.createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
dosages.createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
dosages.createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
dosages.createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
dosages.createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
dosages.createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
dosages.dose.between |
Array<> | Total radiation dose - Filter for entries with values between two specified values (inclusive) |
dosages.dose.equal |
number | Total radiation dose - Filter for entries with values exactly equal to the specified value |
dosages.dose.exists |
boolean | Total radiation dose - Filter for entries with a value |
dosages.dose.greaterThan |
number | Total radiation dose - Filter for entries with values greater than the specified value |
dosages.dose.greaterThanOrEqual |
number | Total radiation dose - Filter for entries with values greater than or equal to the specified value |
dosages.dose.lessThan |
number | Total radiation dose - Filter for entries with values less than the specified value |
dosages.dose.lessThanOrEqual |
number | Total radiation dose - Filter for entries with values less than or equal to the specified value |
dosages.dose.not.between |
Array<> | Total radiation dose - Filter for entries with values between two specified values (inclusive) |
dosages.dose.not.equal |
number | Total radiation dose - Filter for entries with values not equal to the specified value |
dosages.dose.not.exists |
boolean | Total radiation dose - Filter for entries without a value |
dosages.externalSource |
string | External data source - Filter for full text matches |
dosages.externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
dosages.externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
dosages.externalSource.contains |
string | External data source - Filter for partial text matches |
dosages.externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
dosages.externalSource.exists |
boolean | External data source - Filter for entries with a value |
dosages.externalSource.not |
string | External data source - Filter for full text mismatches |
dosages.externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
dosages.externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
dosages.externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
dosages.externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
dosages.externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
dosages.fractions.between |
Array<> | Total fractions - Filter for entries with values between two specified values (inclusive) |
dosages.fractions.equal |
integer | Total fractions - Filter for entries with values exactly equal to the specified value |
dosages.fractions.exists |
boolean | Total fractions - Filter for entries with a value |
dosages.fractions.greaterThan |
integer | Total fractions - Filter for entries with values greater than the specified value |
dosages.fractions.greaterThanOrEqual |
integer | Total fractions - Filter for entries with values greater than or equal to the specified value |
dosages.fractions.lessThan |
integer | Total fractions - Filter for entries with values less than the specified value |
dosages.fractions.lessThanOrEqual |
integer | Total fractions - Filter for entries with values less than or equal to the specified value |
dosages.fractions.not.between |
Array<> | Total fractions - Filter for entries with values between two specified values (inclusive) |
dosages.fractions.not.equal |
integer | Total fractions - Filter for entries with values not equal to the specified value |
dosages.fractions.not.exists |
boolean | Total fractions - Filter for entries without a value |
dosages.id |
string | Id - Filter for full text matches |
dosages.id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
dosages.id.beginsWith |
string | Id - Filter for entries starting with the text |
dosages.id.contains |
string | Id - Filter for partial text matches |
dosages.id.endsWith |
string | Id - Filter for entries ending with the text |
dosages.id.not |
string | Id - Filter for full text mismatches |
dosages.id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
dosages.id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
dosages.id.not.contains |
string | Id - Filter for partial text mismatches |
dosages.id.not.endsWith |
string | Id - Filter for entries not ending with the text |
dosages.irradiatedVolume |
string | Irradiated volume - Filter for a matching concept code |
dosages.irradiatedVolume.anyOf |
Array<string> | Irradiated volume - Filter for a matching set of concept codes |
dosages.irradiatedVolume.descendantsOf |
string | Irradiated volume - Filter for all child concepts of a given concepts code |
dosages.irradiatedVolume.not |
string | Irradiated volume - Filter for a mismatching concept code |
dosages.irradiatedVolume.not.anyOf |
Array<string> | Irradiated volume - Filter for a mismmatching set of concept codes |
dosages.irradiatedVolumeMorphology |
string | Irradiated volume morphology - Filter for a matching concept code |
dosages.irradiatedVolumeMorphology.anyOf |
Array<string> | Irradiated volume morphology - Filter for a matching set of concept codes |
dosages.irradiatedVolumeMorphology.descendantsOf |
string | Irradiated volume morphology - Filter for all child concepts of a given concepts code |
dosages.irradiatedVolumeMorphology.exists |
boolean | Irradiated volume morphology - Filter for entries with a value |
dosages.irradiatedVolumeMorphology.not |
string | Irradiated volume morphology - Filter for a mismatching concept code |
dosages.irradiatedVolumeMorphology.not.anyOf |
Array<string> | Irradiated volume morphology - Filter for a mismmatching set of concept codes |
dosages.irradiatedVolumeMorphology.not.exists |
boolean | Irradiated volume morphology - Filter for entries without a value |
dosages.irradiatedVolumeQualifier |
string | Irradiated volume qualifier - Filter for a matching concept code |
dosages.irradiatedVolumeQualifier.anyOf |
Array<string> | Irradiated volume qualifier - Filter for a matching set of concept codes |
dosages.irradiatedVolumeQualifier.descendantsOf |
string | Irradiated volume qualifier - Filter for all child concepts of a given concepts code |
dosages.irradiatedVolumeQualifier.exists |
boolean | Irradiated volume qualifier - Filter for entries with a value |
dosages.irradiatedVolumeQualifier.not |
string | Irradiated volume qualifier - Filter for a mismatching concept code |
dosages.irradiatedVolumeQualifier.not.anyOf |
Array<string> | Irradiated volume qualifier - Filter for a mismmatching set of concept codes |
dosages.irradiatedVolumeQualifier.not.exists |
boolean | Irradiated volume qualifier - Filter for entries without a value |
dosages.updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
dosages.updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
dosages.updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
dosages.updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
dosages.updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
dosages.updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
dosages.updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
dosages.updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
dosages.updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
dosages.updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
duration.between |
Array<> | Duration - Filter for entries with values between two specified values (inclusive) |
duration.equal |
number | Duration - Filter for entries with values exactly equal to the specified value |
duration.greaterThan |
number | Duration - Filter for entries with values greater than the specified value |
duration.greaterThanOrEqual |
number | Duration - Filter for entries with values greater than or equal to the specified value |
duration.lessThan |
number | Duration - Filter for entries with values less than the specified value |
duration.lessThanOrEqual |
number | Duration - Filter for entries with values less than or equal to the specified value |
duration.not.between |
Array<> | Duration - Filter for entries with values between two specified values (inclusive) |
duration.not.equal |
number | Duration - Filter for entries with values not equal to the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
intent |
Intent - Filter for single value choice | |
intent.anyOf |
Array<string> | Intent - ('Filter for excluding a subset of value choices',) |
intent.not |
Intent - ('Filter for all but a single value choice',) | |
period.containedBy |
Array<> | Treatment period - Filter for entries whose period are contined by the time period |
period.contains |
Array<> | Treatment period - Filter for entries containing the time period |
period.not.containedBy |
Array<> | Treatment period - Filter for entries whose period are not contined by the time period |
period.not.contains |
Array<> | Treatment period - Filter for entries not containing the time period |
period.not.overlaps |
Array<> | Treatment period - Filter for entries not overlapping with the time period |
period.overlaps |
Array<> | Treatment period - Filter for entries overlapping with the time period |
sessions.between |
Array<> | Total sessions - Filter for entries with values between two specified values (inclusive) |
sessions.equal |
integer | Total sessions - Filter for entries with values exactly equal to the specified value |
sessions.greaterThan |
integer | Total sessions - Filter for entries with values greater than the specified value |
sessions.greaterThanOrEqual |
integer | Total sessions - Filter for entries with values greater than or equal to the specified value |
sessions.lessThan |
integer | Total sessions - Filter for entries with values less than the specified value |
sessions.lessThanOrEqual |
integer | Total sessions - Filter for entries with values less than or equal to the specified value |
sessions.not.between |
Array<> | Total sessions - Filter for entries with values between two specified values (inclusive) |
sessions.not.equal |
integer | Total sessions - Filter for entries with values not equal to the specified value |
settings.createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
settings.createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
settings.createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
settings.createdAt.exists |
boolean | Created at - Filter for entries with a value |
settings.createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
settings.createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
settings.createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
settings.createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
settings.createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
settings.createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
settings.externalSource |
string | External data source - Filter for full text matches |
settings.externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
settings.externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
settings.externalSource.contains |
string | External data source - Filter for partial text matches |
settings.externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
settings.externalSource.exists |
boolean | External data source - Filter for entries with a value |
settings.externalSource.not |
string | External data source - Filter for full text mismatches |
settings.externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
settings.externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
settings.externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
settings.externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
settings.externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
settings.id |
string | Id - Filter for full text matches |
settings.id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
settings.id.beginsWith |
string | Id - Filter for entries starting with the text |
settings.id.contains |
string | Id - Filter for partial text matches |
settings.id.endsWith |
string | Id - Filter for entries ending with the text |
settings.id.not |
string | Id - Filter for full text mismatches |
settings.id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
settings.id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
settings.id.not.contains |
string | Id - Filter for partial text mismatches |
settings.id.not.endsWith |
string | Id - Filter for entries not ending with the text |
settings.modality |
string | Modality - Filter for a matching concept code |
settings.modality.anyOf |
Array<string> | Modality - Filter for a matching set of concept codes |
settings.modality.descendantsOf |
string | Modality - Filter for all child concepts of a given concepts code |
settings.modality.not |
string | Modality - Filter for a mismatching concept code |
settings.modality.not.anyOf |
Array<string> | Modality - Filter for a mismmatching set of concept codes |
settings.technique |
string | Technique - Filter for a matching concept code |
settings.technique.anyOf |
Array<string> | Technique - Filter for a matching set of concept codes |
settings.technique.descendantsOf |
string | Technique - Filter for all child concepts of a given concepts code |
settings.technique.not |
string | Technique - Filter for a mismatching concept code |
settings.technique.not.anyOf |
Array<string> | Technique - Filter for a mismmatching set of concept codes |
settings.updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
settings.updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
settings.updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
settings.updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
settings.updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
settings.updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
settings.updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
settings.updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
settings.updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
settings.updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
targetedEntitiesIds |
string | Targeted neoplastic entities - Filter for full text matches |
targetedEntitiesIds.anyOf |
Array<string> | Targeted neoplastic entities - Filter for entries where at least one reference matches the query |
targetedEntitiesIds.beginsWith |
string | Targeted neoplastic entities - Filter for entries starting with the text |
targetedEntitiesIds.contains |
string | Targeted neoplastic entities - Filter for partial text matches |
targetedEntitiesIds.endsWith |
string | Targeted neoplastic entities - Filter for entries ending with the text |
targetedEntitiesIds.exists |
boolean | Targeted neoplastic entities - Filter for entries with a value |
targetedEntitiesIds.not |
string | Targeted neoplastic entities - Filter for full text mismatches |
targetedEntitiesIds.not.anyOf |
Array<string> | Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query |
targetedEntitiesIds.not.beginsWith |
string | Targeted neoplastic entities - Filter for entries not starting with the text |
targetedEntitiesIds.not.contains |
string | Targeted neoplastic entities - Filter for partial text mismatches |
targetedEntitiesIds.not.endsWith |
string | Targeted neoplastic entities - Filter for entries not ending with the text |
targetedEntitiesIds.not.exists |
boolean | Targeted neoplastic entities - Filter for entries without a value |
terminationReason |
string | Termination reason - Filter for a matching concept code |
terminationReason.anyOf |
Array<string> | Termination reason - Filter for a matching set of concept codes |
terminationReason.descendantsOf |
string | Termination reason - Filter for all child concepts of a given concepts code |
terminationReason.exists |
boolean | Termination reason - Filter for entries with a value |
terminationReason.not |
string | Termination reason - Filter for a mismatching concept code |
terminationReason.not.anyOf |
Array<string> | Termination reason - Filter for a mismmatching set of concept codes |
terminationReason.not.exists |
boolean | Termination reason - Filter for entries without a value |
therapyLineId |
string | Therapy line - Filter for reference matches |
therapyLineId.anyOf |
Array<string> | Therapy line - Filter for entries where at least one reference matches the query |
therapyLineId.beginsWith |
string | Therapy line - Filter for entries starting with the text |
therapyLineId.contains |
string | Therapy line - Filter for partial text matches |
therapyLineId.endsWith |
string | Therapy line - Filter for entries ending with the text |
therapyLineId.exists |
boolean | Therapy line - Filter for entries with a value |
therapyLineId.not |
string | Therapy line - Filter for reference mismatches |
therapyLineId.not.anyOf |
Array<string> | Therapy line - Filter for entries where at least one reference mismatches the query |
therapyLineId.not.beginsWith |
string | Therapy line - Filter for entries not starting with the text |
therapyLineId.not.contains |
string | Therapy line - Filter for partial text mismatches |
therapyLineId.not.endsWith |
string | Therapy line - Filter for entries not ending with the text |
therapyLineId.not.exists |
boolean | Therapy line - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
RadiotherapyIntentChoices¶
Type: string
RadiotherapyPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who received the radiotherapy |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
dosages |
Array<RadiotherapyDosagePartial> | Radiation doses administered during the radiotherapy |
duration |
Duration of treatment | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
intent |
Treatment intent of the system therapy | |
period |
string | Clinically-relevant period during which the radiotherapy was administered to the patient. |
sessions |
integer | The total number of radiotherapy sessions over the treatment period. |
settings |
Array<RadiotherapySettingPartial> | Settings of the radiotherapy irradiation procedure |
targetedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were targeted by the radiotherapy |
terminationReason |
Explanation for the premature or planned termination of the radiotherapy | |
therapyLineId |
string(uuid) | Therapy line to which the radiotherapy is assigned to |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RadiotherapySetting¶
| Name | Type | Description |
|---|---|---|
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
modality |
CodedConcept | Modality of external beam or brachytherapy radiation procedures |
technique |
CodedConcept | Technique of external beam or brachytherapy radiation procedures |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RadiotherapySettingCreate¶
| Name | Type | Description |
|---|---|---|
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
modality |
CodedConcept | Modality of external beam or brachytherapy radiation procedures |
technique |
CodedConcept | Technique of external beam or brachytherapy radiation procedures |
RadiotherapySettingPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
modality |
Modality of external beam or brachytherapy radiation procedures | |
technique |
Technique of external beam or brachytherapy radiation procedures | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RaiStaging¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
methodology |
Methodology used for the Rai staging | |
stage |
CodedConcept | The value of the Rai stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RaiStagingCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
methodology |
Methodology used for the Rai staging | |
stage |
CodedConcept | The value of the Rai stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
RaiStagingPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
methodology |
Methodology used for the Rai staging | |
stage |
The value of the Rai stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
Range¶
| Name | Type | Description |
|---|---|---|
end |
The upper bound of the range. If not provided, assumed unbounded. | |
start |
The lower bound of the range. |
RhabdomyosarcomaClinicalGroup¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
CodedConcept | The value of the rhabdomyosarcoma clinical group |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RhabdomyosarcomaClinicalGroupCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
stage |
CodedConcept | The value of the rhabdomyosarcoma clinical group |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
RhabdomyosarcomaClinicalGroupPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
The value of the rhabdomyosarcoma clinical group | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RiskAssessment¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
assessedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were assessed to estimate the risk. |
caseId |
string(uuid) | Indicates the case of the patient who's cancer risk is assesed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the risk assessment was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
methodology |
CodedConcept | Indicates the method or type of risk assessment |
risk |
CodedConcept | Assessed risk |
score |
number | Quantitative score used to classify the risk |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RiskAssessmentCreate¶
| Name | Type | Description |
|---|---|---|
assessedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were assessed to estimate the risk. |
caseId |
string(uuid) | Indicates the case of the patient who's cancer risk is assesed |
date |
string(date) | Clinically-relevant date at which the risk assessment was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
methodology |
CodedConcept | Indicates the method or type of risk assessment |
risk |
CodedConcept | Assessed risk |
score |
number | Quantitative score used to classify the risk |
RiskAssessmentFilters¶
| Name | Type | Description |
|---|---|---|
assessedEntitiesIds |
string | Assessed neoplastic entities - Filter for full text matches |
assessedEntitiesIds.anyOf |
Array<string> | Assessed neoplastic entities - Filter for entries where at least one reference matches the query |
assessedEntitiesIds.beginsWith |
string | Assessed neoplastic entities - Filter for entries starting with the text |
assessedEntitiesIds.contains |
string | Assessed neoplastic entities - Filter for partial text matches |
assessedEntitiesIds.endsWith |
string | Assessed neoplastic entities - Filter for entries ending with the text |
assessedEntitiesIds.exists |
boolean | Assessed neoplastic entities - Filter for entries with a value |
assessedEntitiesIds.not |
string | Assessed neoplastic entities - Filter for full text mismatches |
assessedEntitiesIds.not.anyOf |
Array<string> | Assessed neoplastic entities - Filter for entries where at least one reference mismatches the query |
assessedEntitiesIds.not.beginsWith |
string | Assessed neoplastic entities - Filter for entries not starting with the text |
assessedEntitiesIds.not.contains |
string | Assessed neoplastic entities - Filter for partial text mismatches |
assessedEntitiesIds.not.endsWith |
string | Assessed neoplastic entities - Filter for entries not ending with the text |
assessedEntitiesIds.not.exists |
boolean | Assessed neoplastic entities - Filter for entries without a value |
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Assessment date - Filter for entries with dates after the specified value |
date.before |
string(date) | Assessment date - Filter for entries with dates before the specified value |
date.between |
Array<> | Assessment date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Assessment date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Assessment date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Assessment date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Assessment date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Assessment date - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
methodology |
string | Assessment methodology - Filter for a matching concept code |
methodology.anyOf |
Array<string> | Assessment methodology - Filter for a matching set of concept codes |
methodology.descendantsOf |
string | Assessment methodology - Filter for all child concepts of a given concepts code |
methodology.not |
string | Assessment methodology - Filter for a mismatching concept code |
methodology.not.anyOf |
Array<string> | Assessment methodology - Filter for a mismmatching set of concept codes |
risk |
string | Risk - Filter for a matching concept code |
risk.anyOf |
Array<string> | Risk - Filter for a matching set of concept codes |
risk.descendantsOf |
string | Risk - Filter for all child concepts of a given concepts code |
risk.not |
string | Risk - Filter for a mismatching concept code |
risk.not.anyOf |
Array<string> | Risk - Filter for a mismmatching set of concept codes |
score.between |
Array<> | Score - Filter for entries with values between two specified values (inclusive) |
score.equal |
number | Score - Filter for entries with values exactly equal to the specified value |
score.exists |
boolean | Score - Filter for entries with a value |
score.greaterThan |
number | Score - Filter for entries with values greater than the specified value |
score.greaterThanOrEqual |
number | Score - Filter for entries with values greater than or equal to the specified value |
score.lessThan |
number | Score - Filter for entries with values less than the specified value |
score.lessThanOrEqual |
number | Score - Filter for entries with values less than or equal to the specified value |
score.not.between |
Array<> | Score - Filter for entries with values between two specified values (inclusive) |
score.not.equal |
number | Score - Filter for entries with values not equal to the specified value |
score.not.exists |
boolean | Score - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
RiskAssessmentPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
assessedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were assessed to estimate the risk. |
caseId |
string(uuid) | Indicates the case of the patient who's cancer risk is assesed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the risk assessment was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
methodology |
Indicates the method or type of risk assessment | |
risk |
Assessed risk | |
score |
number | Quantitative score used to classify the risk |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RISSStaging¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
CodedConcept | The value of the RISS stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RISSStagingCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
stage |
CodedConcept | The value of the RISS stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
RISSStagingPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
The value of the RISS stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
RNAChangeType¶
Type: string
RulesetCondition¶
Type: string
StagingDomain¶
Type: string
StagingFilters¶
| Name | Type | Description |
|---|---|---|
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Staging date - Filter for entries with dates after the specified value |
date.before |
string(date) | Staging date - Filter for entries with dates before the specified value |
date.between |
Array<> | Staging date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Staging date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Staging date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Staging date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Staging date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Staging date - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
stage |
string | Stage - Filter for a matching concept code |
stage.anyOf |
Array<string> | Stage - Filter for a matching set of concept codes |
stage.descendantsOf |
string | Stage - Filter for all child concepts of a given concepts code |
stage.not |
string | Stage - Filter for a mismatching concept code |
stage.not.anyOf |
Array<string> | Stage - Filter for a mismmatching set of concept codes |
stagedEntitiesIds |
string | Staged neoplastic entities - Filter for full text matches |
stagedEntitiesIds.anyOf |
Array<string> | Staged neoplastic entities - Filter for entries where at least one reference matches the query |
stagedEntitiesIds.beginsWith |
string | Staged neoplastic entities - Filter for entries starting with the text |
stagedEntitiesIds.contains |
string | Staged neoplastic entities - Filter for partial text matches |
stagedEntitiesIds.endsWith |
string | Staged neoplastic entities - Filter for entries ending with the text |
stagedEntitiesIds.exists |
boolean | Staged neoplastic entities - Filter for entries with a value |
stagedEntitiesIds.not |
string | Staged neoplastic entities - Filter for full text mismatches |
stagedEntitiesIds.not.anyOf |
Array<string> | Staged neoplastic entities - Filter for entries where at least one reference mismatches the query |
stagedEntitiesIds.not.beginsWith |
string | Staged neoplastic entities - Filter for entries not starting with the text |
stagedEntitiesIds.not.contains |
string | Staged neoplastic entities - Filter for partial text mismatches |
stagedEntitiesIds.not.endsWith |
string | Staged neoplastic entities - Filter for entries not ending with the text |
stagedEntitiesIds.not.exists |
boolean | Staged neoplastic entities - Filter for entries without a value |
stagingDomain |
Staging domain - Filter for single value choice | |
stagingDomain.anyOf |
Array<string> | Staging domain - ('Filter for excluding a subset of value choices',) |
stagingDomain.not |
Staging domain - ('Filter for all but a single value choice',) | |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
Surgery¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
bodysite |
Anatomical location of the surgery | |
bodysiteLaterality |
Laterality for the anatomical location of the surgery | |
bodysiteQualifier |
General qualifier for the anatomical location of the surgery | |
caseId |
string(uuid) | Indicates the case of the patient who received the surgical procedure |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date of the surgical procedure. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
intent |
SurgeryIntentChoices | Therapeutic intent of the surgery |
outcome |
The outcome of the surgery | |
procedure |
CodedConcept | The specific surgical procedure that was performed |
targetedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were targeted by the surgery |
therapyLineId |
string(uuid) | Therapy line to which the surgery is assigned to |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
SurgeryCreate¶
| Name | Type | Description |
|---|---|---|
bodysite |
Anatomical location of the surgery | |
bodysiteLaterality |
Laterality for the anatomical location of the surgery | |
bodysiteQualifier |
General qualifier for the anatomical location of the surgery | |
caseId |
string(uuid) | Indicates the case of the patient who received the surgical procedure |
date |
string(date) | Clinically-relevant date of the surgical procedure. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
intent |
SurgeryIntentChoices | Therapeutic intent of the surgery |
outcome |
The outcome of the surgery | |
procedure |
CodedConcept | The specific surgical procedure that was performed |
targetedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were targeted by the surgery |
therapyLineId |
string(uuid) | Therapy line to which the surgery is assigned to |
SurgeryFilters¶
| Name | Type | Description |
|---|---|---|
bodysite |
string | Anatomical location - Filter for a matching concept code |
bodysite.anyOf |
Array<string> | Anatomical location - Filter for a matching set of concept codes |
bodysite.descendantsOf |
string | Anatomical location - Filter for all child concepts of a given concepts code |
bodysite.exists |
boolean | Anatomical location - Filter for entries with a value |
bodysite.not |
string | Anatomical location - Filter for a mismatching concept code |
bodysite.not.anyOf |
Array<string> | Anatomical location - Filter for a mismmatching set of concept codes |
bodysite.not.exists |
boolean | Anatomical location - Filter for entries without a value |
bodysiteLaterality |
string | Anatomical location laterality - Filter for a matching concept code |
bodysiteLaterality.anyOf |
Array<string> | Anatomical location laterality - Filter for a matching set of concept codes |
bodysiteLaterality.descendantsOf |
string | Anatomical location laterality - Filter for all child concepts of a given concepts code |
bodysiteLaterality.exists |
boolean | Anatomical location laterality - Filter for entries with a value |
bodysiteLaterality.not |
string | Anatomical location laterality - Filter for a mismatching concept code |
bodysiteLaterality.not.anyOf |
Array<string> | Anatomical location laterality - Filter for a mismmatching set of concept codes |
bodysiteLaterality.not.exists |
boolean | Anatomical location laterality - Filter for entries without a value |
bodysiteQualifier |
string | Anatomical location qualifier - Filter for a matching concept code |
bodysiteQualifier.anyOf |
Array<string> | Anatomical location qualifier - Filter for a matching set of concept codes |
bodysiteQualifier.descendantsOf |
string | Anatomical location qualifier - Filter for all child concepts of a given concepts code |
bodysiteQualifier.exists |
boolean | Anatomical location qualifier - Filter for entries with a value |
bodysiteQualifier.not |
string | Anatomical location qualifier - Filter for a mismatching concept code |
bodysiteQualifier.not.anyOf |
Array<string> | Anatomical location qualifier - Filter for a mismmatching set of concept codes |
bodysiteQualifier.not.exists |
boolean | Anatomical location qualifier - Filter for entries without a value |
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Assessment date - Filter for entries with dates after the specified value |
date.before |
string(date) | Assessment date - Filter for entries with dates before the specified value |
date.between |
Array<> | Assessment date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Assessment date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Assessment date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Assessment date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Assessment date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Assessment date - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
intent |
Intent - Filter for single value choice | |
intent.anyOf |
Array<string> | Intent - ('Filter for excluding a subset of value choices',) |
intent.not |
Intent - ('Filter for all but a single value choice',) | |
outcome |
string | Outcome - Filter for a matching concept code |
outcome.anyOf |
Array<string> | Outcome - Filter for a matching set of concept codes |
outcome.descendantsOf |
string | Outcome - Filter for all child concepts of a given concepts code |
outcome.exists |
boolean | Outcome - Filter for entries with a value |
outcome.not |
string | Outcome - Filter for a mismatching concept code |
outcome.not.anyOf |
Array<string> | Outcome - Filter for a mismmatching set of concept codes |
outcome.not.exists |
boolean | Outcome - Filter for entries without a value |
procedure |
string | Surgical procedure - Filter for a matching concept code |
procedure.anyOf |
Array<string> | Surgical procedure - Filter for a matching set of concept codes |
procedure.descendantsOf |
string | Surgical procedure - Filter for all child concepts of a given concepts code |
procedure.not |
string | Surgical procedure - Filter for a mismatching concept code |
procedure.not.anyOf |
Array<string> | Surgical procedure - Filter for a mismmatching set of concept codes |
targetedEntitiesIds |
string | Targeted neoplastic entities - Filter for full text matches |
targetedEntitiesIds.anyOf |
Array<string> | Targeted neoplastic entities - Filter for entries where at least one reference matches the query |
targetedEntitiesIds.beginsWith |
string | Targeted neoplastic entities - Filter for entries starting with the text |
targetedEntitiesIds.contains |
string | Targeted neoplastic entities - Filter for partial text matches |
targetedEntitiesIds.endsWith |
string | Targeted neoplastic entities - Filter for entries ending with the text |
targetedEntitiesIds.exists |
boolean | Targeted neoplastic entities - Filter for entries with a value |
targetedEntitiesIds.not |
string | Targeted neoplastic entities - Filter for full text mismatches |
targetedEntitiesIds.not.anyOf |
Array<string> | Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query |
targetedEntitiesIds.not.beginsWith |
string | Targeted neoplastic entities - Filter for entries not starting with the text |
targetedEntitiesIds.not.contains |
string | Targeted neoplastic entities - Filter for partial text mismatches |
targetedEntitiesIds.not.endsWith |
string | Targeted neoplastic entities - Filter for entries not ending with the text |
targetedEntitiesIds.not.exists |
boolean | Targeted neoplastic entities - Filter for entries without a value |
therapyLineId |
string | Therapy line - Filter for reference matches |
therapyLineId.anyOf |
Array<string> | Therapy line - Filter for entries where at least one reference matches the query |
therapyLineId.beginsWith |
string | Therapy line - Filter for entries starting with the text |
therapyLineId.contains |
string | Therapy line - Filter for partial text matches |
therapyLineId.endsWith |
string | Therapy line - Filter for entries ending with the text |
therapyLineId.exists |
boolean | Therapy line - Filter for entries with a value |
therapyLineId.not |
string | Therapy line - Filter for reference mismatches |
therapyLineId.not.anyOf |
Array<string> | Therapy line - Filter for entries where at least one reference mismatches the query |
therapyLineId.not.beginsWith |
string | Therapy line - Filter for entries not starting with the text |
therapyLineId.not.contains |
string | Therapy line - Filter for partial text mismatches |
therapyLineId.not.endsWith |
string | Therapy line - Filter for entries not ending with the text |
therapyLineId.not.exists |
boolean | Therapy line - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
SurgeryIntentChoices¶
Type: string
SurgeryPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
bodysite |
Anatomical location of the surgery | |
bodysiteLaterality |
Laterality for the anatomical location of the surgery | |
bodysiteQualifier |
General qualifier for the anatomical location of the surgery | |
caseId |
string(uuid) | Indicates the case of the patient who received the surgical procedure |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date of the surgical procedure. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
intent |
Therapeutic intent of the surgery | |
outcome |
The outcome of the surgery | |
procedure |
The specific surgical procedure that was performed | |
targetedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were targeted by the surgery |
therapyLineId |
string(uuid) | Therapy line to which the surgery is assigned to |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
SystemicTherapy¶
| Name | Type | Description |
|---|---|---|
adjunctiveRole |
Indicates the role of the adjunctive therapy (if applicable). | |
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who received the systemic therapy |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
cycles |
integer | The total number of treatment cycles during the treatment period. |
description |
string | Human-readable description |
duration |
Measure | Duration of treatment |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
intent |
SystemicTherapyIntentChoices | Treatment intent of the system therapy |
isAdjunctive |
boolean | Indicates whether it is adjunctive therapy instead of a primary therapy |
medications |
Array<SystemicTherapyMedication> | Medications administered during the systemic therapy |
period |
Period | Clinically-relevant period during which the therapy was administered to the patient. |
targetedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were targeted by the systemic therapy |
terminationReason |
Explanation for the premature or planned termination of the systemic therapy | |
therapyLineId |
string(uuid) | Therapy line to which the systemic therapy is assigned to |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
SystemicTherapyCreate¶
| Name | Type | Description |
|---|---|---|
adjunctiveRole |
Indicates the role of the adjunctive therapy (if applicable). | |
caseId |
string(uuid) | Indicates the case of the patient who received the systemic therapy |
cycles |
integer | The total number of treatment cycles during the treatment period. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
intent |
SystemicTherapyIntentChoices | Treatment intent of the system therapy |
period |
Period | Clinically-relevant period during which the therapy was administered to the patient. |
targetedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were targeted by the systemic therapy |
terminationReason |
Explanation for the premature or planned termination of the systemic therapy | |
therapyLineId |
string(uuid) | Therapy line to which the systemic therapy is assigned to |
SystemicTherapyFilters¶
| Name | Type | Description |
|---|---|---|
adjunctiveRole |
string | Treatment Role - Filter for a matching concept code |
adjunctiveRole.anyOf |
Array<string> | Treatment Role - Filter for a matching set of concept codes |
adjunctiveRole.descendantsOf |
string | Treatment Role - Filter for all child concepts of a given concepts code |
adjunctiveRole.exists |
boolean | Treatment Role - Filter for entries with a value |
adjunctiveRole.not |
string | Treatment Role - Filter for a mismatching concept code |
adjunctiveRole.not.anyOf |
Array<string> | Treatment Role - Filter for a mismmatching set of concept codes |
adjunctiveRole.not.exists |
boolean | Treatment Role - Filter for entries without a value |
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
cycles.between |
Array<> | Cycles - Filter for entries with values between two specified values (inclusive) |
cycles.equal |
integer | Cycles - Filter for entries with values exactly equal to the specified value |
cycles.exists |
boolean | Cycles - Filter for entries with a value |
cycles.greaterThan |
integer | Cycles - Filter for entries with values greater than the specified value |
cycles.greaterThanOrEqual |
integer | Cycles - Filter for entries with values greater than or equal to the specified value |
cycles.lessThan |
integer | Cycles - Filter for entries with values less than the specified value |
cycles.lessThanOrEqual |
integer | Cycles - Filter for entries with values less than or equal to the specified value |
cycles.not.between |
Array<> | Cycles - Filter for entries with values between two specified values (inclusive) |
cycles.not.equal |
integer | Cycles - Filter for entries with values not equal to the specified value |
cycles.not.exists |
boolean | Cycles - Filter for entries without a value |
duration.between |
Array<> | Duration - Filter for entries with values between two specified values (inclusive) |
duration.equal |
number | Duration - Filter for entries with values exactly equal to the specified value |
duration.greaterThan |
number | Duration - Filter for entries with values greater than the specified value |
duration.greaterThanOrEqual |
number | Duration - Filter for entries with values greater than or equal to the specified value |
duration.lessThan |
number | Duration - Filter for entries with values less than the specified value |
duration.lessThanOrEqual |
number | Duration - Filter for entries with values less than or equal to the specified value |
duration.not.between |
Array<> | Duration - Filter for entries with values between two specified values (inclusive) |
duration.not.equal |
number | Duration - Filter for entries with values not equal to the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
intent |
Intent - Filter for single value choice | |
intent.anyOf |
Array<string> | Intent - ('Filter for excluding a subset of value choices',) |
intent.not |
Intent - ('Filter for all but a single value choice',) | |
isAdjunctive |
boolean | Treatment Role - Filter for yes/no statement |
medications.createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
medications.createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
medications.createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
medications.createdAt.exists |
boolean | Created at - Filter for entries with a value |
medications.createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
medications.createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
medications.createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
medications.createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
medications.createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
medications.createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
medications.dosageMass.between |
Array<> | Dosage - Fixed Mass - Filter for entries with values between two specified values (inclusive) |
medications.dosageMass.equal |
number | Dosage - Fixed Mass - Filter for entries with values exactly equal to the specified value |
medications.dosageMass.exists |
boolean | Dosage - Fixed Mass - Filter for entries with a value |
medications.dosageMass.greaterThan |
number | Dosage - Fixed Mass - Filter for entries with values greater than the specified value |
medications.dosageMass.greaterThanOrEqual |
number | Dosage - Fixed Mass - Filter for entries with values greater than or equal to the specified value |
medications.dosageMass.lessThan |
number | Dosage - Fixed Mass - Filter for entries with values less than the specified value |
medications.dosageMass.lessThanOrEqual |
number | Dosage - Fixed Mass - Filter for entries with values less than or equal to the specified value |
medications.dosageMass.not.between |
Array<> | Dosage - Fixed Mass - Filter for entries with values between two specified values (inclusive) |
medications.dosageMass.not.equal |
number | Dosage - Fixed Mass - Filter for entries with values not equal to the specified value |
medications.dosageMass.not.exists |
boolean | Dosage - Fixed Mass - Filter for entries without a value |
medications.dosageMassConcentration.between |
Array<> | Dosage - Mass concentration - Filter for entries with values between two specified values (inclusive) |
medications.dosageMassConcentration.equal |
number | Dosage - Mass concentration - Filter for entries with values exactly equal to the specified value |
medications.dosageMassConcentration.exists |
boolean | Dosage - Mass concentration - Filter for entries with a value |
medications.dosageMassConcentration.greaterThan |
number | Dosage - Mass concentration - Filter for entries with values greater than the specified value |
medications.dosageMassConcentration.greaterThanOrEqual |
number | Dosage - Mass concentration - Filter for entries with values greater than or equal to the specified value |
medications.dosageMassConcentration.lessThan |
number | Dosage - Mass concentration - Filter for entries with values less than the specified value |
medications.dosageMassConcentration.lessThanOrEqual |
number | Dosage - Mass concentration - Filter for entries with values less than or equal to the specified value |
medications.dosageMassConcentration.not.between |
Array<> | Dosage - Mass concentration - Filter for entries with values between two specified values (inclusive) |
medications.dosageMassConcentration.not.equal |
number | Dosage - Mass concentration - Filter for entries with values not equal to the specified value |
medications.dosageMassConcentration.not.exists |
boolean | Dosage - Mass concentration - Filter for entries without a value |
medications.dosageMassSurface.between |
Array<> | Dosage - Mass per body surface - Filter for entries with values between two specified values (inclusive) |
medications.dosageMassSurface.equal |
number | Dosage - Mass per body surface - Filter for entries with values exactly equal to the specified value |
medications.dosageMassSurface.exists |
boolean | Dosage - Mass per body surface - Filter for entries with a value |
medications.dosageMassSurface.greaterThan |
number | Dosage - Mass per body surface - Filter for entries with values greater than the specified value |
medications.dosageMassSurface.greaterThanOrEqual |
number | Dosage - Mass per body surface - Filter for entries with values greater than or equal to the specified value |
medications.dosageMassSurface.lessThan |
number | Dosage - Mass per body surface - Filter for entries with values less than the specified value |
medications.dosageMassSurface.lessThanOrEqual |
number | Dosage - Mass per body surface - Filter for entries with values less than or equal to the specified value |
medications.dosageMassSurface.not.between |
Array<> | Dosage - Mass per body surface - Filter for entries with values between two specified values (inclusive) |
medications.dosageMassSurface.not.equal |
number | Dosage - Mass per body surface - Filter for entries with values not equal to the specified value |
medications.dosageMassSurface.not.exists |
boolean | Dosage - Mass per body surface - Filter for entries without a value |
medications.dosageRateMass.between |
Array<> | Dosage rate - Fixed Mass - Filter for entries with values between two specified values (inclusive) |
medications.dosageRateMass.equal |
number | Dosage rate - Fixed Mass - Filter for entries with values exactly equal to the specified value |
medications.dosageRateMass.exists |
boolean | Dosage rate - Fixed Mass - Filter for entries with a value |
medications.dosageRateMass.greaterThan |
number | Dosage rate - Fixed Mass - Filter for entries with values greater than the specified value |
medications.dosageRateMass.greaterThanOrEqual |
number | Dosage rate - Fixed Mass - Filter for entries with values greater than or equal to the specified value |
medications.dosageRateMass.lessThan |
number | Dosage rate - Fixed Mass - Filter for entries with values less than the specified value |
medications.dosageRateMass.lessThanOrEqual |
number | Dosage rate - Fixed Mass - Filter for entries with values less than or equal to the specified value |
medications.dosageRateMass.not.between |
Array<> | Dosage rate - Fixed Mass - Filter for entries with values between two specified values (inclusive) |
medications.dosageRateMass.not.equal |
number | Dosage rate - Fixed Mass - Filter for entries with values not equal to the specified value |
medications.dosageRateMass.not.exists |
boolean | Dosage rate - Fixed Mass - Filter for entries without a value |
medications.dosageRateMassConcentration.between |
Array<> | Dosage rate - Mass concentration - Filter for entries with values between two specified values (inclusive) |
medications.dosageRateMassConcentration.equal |
number | Dosage rate - Mass concentration - Filter for entries with values exactly equal to the specified value |
medications.dosageRateMassConcentration.exists |
boolean | Dosage rate - Mass concentration - Filter for entries with a value |
medications.dosageRateMassConcentration.greaterThan |
number | Dosage rate - Mass concentration - Filter for entries with values greater than the specified value |
medications.dosageRateMassConcentration.greaterThanOrEqual |
number | Dosage rate - Mass concentration - Filter for entries with values greater than or equal to the specified value |
medications.dosageRateMassConcentration.lessThan |
number | Dosage rate - Mass concentration - Filter for entries with values less than the specified value |
medications.dosageRateMassConcentration.lessThanOrEqual |
number | Dosage rate - Mass concentration - Filter for entries with values less than or equal to the specified value |
medications.dosageRateMassConcentration.not.between |
Array<> | Dosage rate - Mass concentration - Filter for entries with values between two specified values (inclusive) |
medications.dosageRateMassConcentration.not.equal |
number | Dosage rate - Mass concentration - Filter for entries with values not equal to the specified value |
medications.dosageRateMassConcentration.not.exists |
boolean | Dosage rate - Mass concentration - Filter for entries without a value |
medications.dosageRateMassSurface.between |
Array<> | Dosage rate - Mass per body surface - Filter for entries with values between two specified values (inclusive) |
medications.dosageRateMassSurface.equal |
number | Dosage rate - Mass per body surface - Filter for entries with values exactly equal to the specified value |
medications.dosageRateMassSurface.exists |
boolean | Dosage rate - Mass per body surface - Filter for entries with a value |
medications.dosageRateMassSurface.greaterThan |
number | Dosage rate - Mass per body surface - Filter for entries with values greater than the specified value |
medications.dosageRateMassSurface.greaterThanOrEqual |
number | Dosage rate - Mass per body surface - Filter for entries with values greater than or equal to the specified value |
medications.dosageRateMassSurface.lessThan |
number | Dosage rate - Mass per body surface - Filter for entries with values less than the specified value |
medications.dosageRateMassSurface.lessThanOrEqual |
number | Dosage rate - Mass per body surface - Filter for entries with values less than or equal to the specified value |
medications.dosageRateMassSurface.not.between |
Array<> | Dosage rate - Mass per body surface - Filter for entries with values between two specified values (inclusive) |
medications.dosageRateMassSurface.not.equal |
number | Dosage rate - Mass per body surface - Filter for entries with values not equal to the specified value |
medications.dosageRateMassSurface.not.exists |
boolean | Dosage rate - Mass per body surface - Filter for entries without a value |
medications.dosageRateVolume.between |
Array<> | Dosage rate - Volume - Filter for entries with values between two specified values (inclusive) |
medications.dosageRateVolume.equal |
number | Dosage rate - Volume - Filter for entries with values exactly equal to the specified value |
medications.dosageRateVolume.exists |
boolean | Dosage rate - Volume - Filter for entries with a value |
medications.dosageRateVolume.greaterThan |
number | Dosage rate - Volume - Filter for entries with values greater than the specified value |
medications.dosageRateVolume.greaterThanOrEqual |
number | Dosage rate - Volume - Filter for entries with values greater than or equal to the specified value |
medications.dosageRateVolume.lessThan |
number | Dosage rate - Volume - Filter for entries with values less than the specified value |
medications.dosageRateVolume.lessThanOrEqual |
number | Dosage rate - Volume - Filter for entries with values less than or equal to the specified value |
medications.dosageRateVolume.not.between |
Array<> | Dosage rate - Volume - Filter for entries with values between two specified values (inclusive) |
medications.dosageRateVolume.not.equal |
number | Dosage rate - Volume - Filter for entries with values not equal to the specified value |
medications.dosageRateVolume.not.exists |
boolean | Dosage rate - Volume - Filter for entries without a value |
medications.dosageVolume.between |
Array<> | Dosage - Volume - Filter for entries with values between two specified values (inclusive) |
medications.dosageVolume.equal |
number | Dosage - Volume - Filter for entries with values exactly equal to the specified value |
medications.dosageVolume.exists |
boolean | Dosage - Volume - Filter for entries with a value |
medications.dosageVolume.greaterThan |
number | Dosage - Volume - Filter for entries with values greater than the specified value |
medications.dosageVolume.greaterThanOrEqual |
number | Dosage - Volume - Filter for entries with values greater than or equal to the specified value |
medications.dosageVolume.lessThan |
number | Dosage - Volume - Filter for entries with values less than the specified value |
medications.dosageVolume.lessThanOrEqual |
number | Dosage - Volume - Filter for entries with values less than or equal to the specified value |
medications.dosageVolume.not.between |
Array<> | Dosage - Volume - Filter for entries with values between two specified values (inclusive) |
medications.dosageVolume.not.equal |
number | Dosage - Volume - Filter for entries with values not equal to the specified value |
medications.dosageVolume.not.exists |
boolean | Dosage - Volume - Filter for entries without a value |
medications.drug |
string | Antineoplastic Drug - Filter for a matching concept code |
medications.drug.anyOf |
Array<string> | Antineoplastic Drug - Filter for a matching set of concept codes |
medications.drug.descendantsOf |
string | Antineoplastic Drug - Filter for all child concepts of a given concepts code |
medications.drug.not |
string | Antineoplastic Drug - Filter for a mismatching concept code |
medications.drug.not.anyOf |
Array<string> | Antineoplastic Drug - Filter for a mismmatching set of concept codes |
medications.externalSource |
string | External data source - Filter for full text matches |
medications.externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
medications.externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
medications.externalSource.contains |
string | External data source - Filter for partial text matches |
medications.externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
medications.externalSource.exists |
boolean | External data source - Filter for entries with a value |
medications.externalSource.not |
string | External data source - Filter for full text mismatches |
medications.externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
medications.externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
medications.externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
medications.externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
medications.externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
medications.id |
string | Id - Filter for full text matches |
medications.id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
medications.id.beginsWith |
string | Id - Filter for entries starting with the text |
medications.id.contains |
string | Id - Filter for partial text matches |
medications.id.endsWith |
string | Id - Filter for entries ending with the text |
medications.id.not |
string | Id - Filter for full text mismatches |
medications.id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
medications.id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
medications.id.not.contains |
string | Id - Filter for partial text mismatches |
medications.id.not.endsWith |
string | Id - Filter for entries not ending with the text |
medications.route |
string | Route - Filter for a matching concept code |
medications.route.anyOf |
Array<string> | Route - Filter for a matching set of concept codes |
medications.route.descendantsOf |
string | Route - Filter for all child concepts of a given concepts code |
medications.route.exists |
boolean | Route - Filter for entries with a value |
medications.route.not |
string | Route - Filter for a mismatching concept code |
medications.route.not.anyOf |
Array<string> | Route - Filter for a mismmatching set of concept codes |
medications.route.not.exists |
boolean | Route - Filter for entries without a value |
medications.updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
medications.updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
medications.updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
medications.updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
medications.updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
medications.updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
medications.updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
medications.updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
medications.updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
medications.updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
medications.usedOfflabel |
boolean | Off-label use - Filter for yes/no statement |
medications.usedOfflabel.exists |
boolean | Off-label use - Filter for entries with a value |
medications.usedOfflabel.not.exists |
boolean | Off-label use - Filter for entries without a value |
medications.withinSoc |
boolean | Within SOC - Filter for yes/no statement |
medications.withinSoc.exists |
boolean | Within SOC - Filter for entries with a value |
medications.withinSoc.not.exists |
boolean | Within SOC - Filter for entries without a value |
period.containedBy |
Array<> | Treatment period - Filter for entries whose period are contined by the time period |
period.contains |
Array<> | Treatment period - Filter for entries containing the time period |
period.not.containedBy |
Array<> | Treatment period - Filter for entries whose period are not contined by the time period |
period.not.contains |
Array<> | Treatment period - Filter for entries not containing the time period |
period.not.overlaps |
Array<> | Treatment period - Filter for entries not overlapping with the time period |
period.overlaps |
Array<> | Treatment period - Filter for entries overlapping with the time period |
targetedEntitiesIds |
string | Targeted neoplastic entities - Filter for full text matches |
targetedEntitiesIds.anyOf |
Array<string> | Targeted neoplastic entities - Filter for entries where at least one reference matches the query |
targetedEntitiesIds.beginsWith |
string | Targeted neoplastic entities - Filter for entries starting with the text |
targetedEntitiesIds.contains |
string | Targeted neoplastic entities - Filter for partial text matches |
targetedEntitiesIds.endsWith |
string | Targeted neoplastic entities - Filter for entries ending with the text |
targetedEntitiesIds.exists |
boolean | Targeted neoplastic entities - Filter for entries with a value |
targetedEntitiesIds.not |
string | Targeted neoplastic entities - Filter for full text mismatches |
targetedEntitiesIds.not.anyOf |
Array<string> | Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query |
targetedEntitiesIds.not.beginsWith |
string | Targeted neoplastic entities - Filter for entries not starting with the text |
targetedEntitiesIds.not.contains |
string | Targeted neoplastic entities - Filter for partial text mismatches |
targetedEntitiesIds.not.endsWith |
string | Targeted neoplastic entities - Filter for entries not ending with the text |
targetedEntitiesIds.not.exists |
boolean | Targeted neoplastic entities - Filter for entries without a value |
terminationReason |
string | Termination reason - Filter for a matching concept code |
terminationReason.anyOf |
Array<string> | Termination reason - Filter for a matching set of concept codes |
terminationReason.descendantsOf |
string | Termination reason - Filter for all child concepts of a given concepts code |
terminationReason.exists |
boolean | Termination reason - Filter for entries with a value |
terminationReason.not |
string | Termination reason - Filter for a mismatching concept code |
terminationReason.not.anyOf |
Array<string> | Termination reason - Filter for a mismmatching set of concept codes |
terminationReason.not.exists |
boolean | Termination reason - Filter for entries without a value |
therapyLineId |
string | Therapy line - Filter for reference matches |
therapyLineId.anyOf |
Array<string> | Therapy line - Filter for entries where at least one reference matches the query |
therapyLineId.beginsWith |
string | Therapy line - Filter for entries starting with the text |
therapyLineId.contains |
string | Therapy line - Filter for partial text matches |
therapyLineId.endsWith |
string | Therapy line - Filter for entries ending with the text |
therapyLineId.exists |
boolean | Therapy line - Filter for entries with a value |
therapyLineId.not |
string | Therapy line - Filter for reference mismatches |
therapyLineId.not.anyOf |
Array<string> | Therapy line - Filter for entries where at least one reference mismatches the query |
therapyLineId.not.beginsWith |
string | Therapy line - Filter for entries not starting with the text |
therapyLineId.not.contains |
string | Therapy line - Filter for partial text mismatches |
therapyLineId.not.endsWith |
string | Therapy line - Filter for entries not ending with the text |
therapyLineId.not.exists |
boolean | Therapy line - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
SystemicTherapyIntentChoices¶
Type: string
SystemicTherapyMedication¶
| Name | Type | Description |
|---|---|---|
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
dosageMass |
Dosage of the medication expressed in a fixed mass (if revelant/appliccable) | |
dosageMassConcentration |
Dosage of the medication expressed in mass concentration (if revelant/appliccable) | |
dosageMassSurface |
Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable) | |
dosageRateMass |
Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable) | |
dosageRateMassConcentration |
Dosage rate of the medication expressed in mass concentration (if revelant/appliccable) | |
dosageRateMassSurface |
Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable) | |
dosageRateVolume |
Dosage rate of the medication expressed in a volume (if revelant/appliccable) | |
dosageVolume |
Dosage of the medication expressed in a volume (if revelant/appliccable) | |
drug |
CodedConcept | Antineoplastic drug/medication administered to the patient |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
route |
Drug administration route | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
usedOfflabel |
boolean | Indicates whether a medication was used off-label at the time of administration |
withinSoc |
boolean | Indicates whether a medication was within standard of care (SOC) at the time of administration. |
SystemicTherapyMedicationCreate¶
| Name | Type | Description |
|---|---|---|
dosageMass |
Dosage of the medication expressed in a fixed mass (if revelant/appliccable) | |
dosageMassConcentration |
Dosage of the medication expressed in mass concentration (if revelant/appliccable) | |
dosageMassSurface |
Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable) | |
dosageRateMass |
Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable) | |
dosageRateMassConcentration |
Dosage rate of the medication expressed in mass concentration (if revelant/appliccable) | |
dosageRateMassSurface |
Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable) | |
dosageRateVolume |
Dosage rate of the medication expressed in a volume (if revelant/appliccable) | |
dosageVolume |
Dosage of the medication expressed in a volume (if revelant/appliccable) | |
drug |
CodedConcept | Antineoplastic drug/medication administered to the patient |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
route |
Drug administration route | |
usedOfflabel |
boolean | Indicates whether a medication was used off-label at the time of administration |
withinSoc |
boolean | Indicates whether a medication was within standard of care (SOC) at the time of administration. |
SystemicTherapyMedicationPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
dosageMass |
Dosage of the medication expressed in a fixed mass (if revelant/appliccable) | |
dosageMassConcentration |
Dosage of the medication expressed in mass concentration (if revelant/appliccable) | |
dosageMassSurface |
Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable) | |
dosageRateMass |
Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable) | |
dosageRateMassConcentration |
Dosage rate of the medication expressed in mass concentration (if revelant/appliccable) | |
dosageRateMassSurface |
Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable) | |
dosageRateVolume |
Dosage rate of the medication expressed in a volume (if revelant/appliccable) | |
dosageVolume |
Dosage of the medication expressed in a volume (if revelant/appliccable) | |
drug |
Antineoplastic drug/medication administered to the patient | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
route |
Drug administration route | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
usedOfflabel |
boolean | Indicates whether a medication was used off-label at the time of administration |
withinSoc |
boolean | Indicates whether a medication was within standard of care (SOC) at the time of administration. |
SystemicTherapyPartial¶
| Name | Type | Description |
|---|---|---|
adjunctiveRole |
Indicates the role of the adjunctive therapy (if applicable). | |
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who received the systemic therapy |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
cycles |
integer | The total number of treatment cycles during the treatment period. |
duration |
Duration of treatment | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
intent |
Treatment intent of the system therapy | |
isAdjunctive |
boolean | Indicates whether it is adjunctive therapy instead of a primary therapy |
medications |
Array<SystemicTherapyMedicationPartial> | Medications administered during the systemic therapy |
period |
string | Clinically-relevant period during which the therapy was administered to the patient. |
targetedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were targeted by the systemic therapy |
terminationReason |
Explanation for the premature or planned termination of the systemic therapy | |
therapyLineId |
string(uuid) | Therapy line to which the systemic therapy is assigned to |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
TerminologyFilters¶
| Name | Type | Description |
|---|---|---|
codes |
||
query |
TherapyLine¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient to whom this therapy line is associated |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
intent |
TherapyLineIntentChoices | Treatment intent of the system therapy |
label |
string | Label categorizing the therapy line |
ordinal |
integer | Number indicating the sequence in which this block of treatments were administered to the patient |
period |
Time period of the therapy line | |
progressionDate |
string(date) | Date at which progression was first detected, if applicable |
progressionFreeSurvival |
number | Progression-free survival (PFS) of the patient for the therapy line |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
TherapyLineCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient to whom this therapy line is associated |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
intent |
TherapyLineIntentChoices | Treatment intent of the system therapy |
ordinal |
integer | Number indicating the sequence in which this block of treatments were administered to the patient |
progressionDate |
string(date) | Date at which progression was first detected, if applicable |
TherapyLineFilters¶
| Name | Type | Description |
|---|---|---|
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
intent |
Intent - Filter for single value choice | |
intent.anyOf |
Array<string> | Intent - ('Filter for excluding a subset of value choices',) |
intent.not |
Intent - ('Filter for all but a single value choice',) | |
label |
string | Label - Filter for full text matches |
label.anyOf |
Array<string> | Label - Filter for entries where at least one reference matches the query |
label.beginsWith |
string | Label - Filter for entries starting with the text |
label.contains |
string | Label - Filter for partial text matches |
label.endsWith |
string | Label - Filter for entries ending with the text |
label.not |
string | Label - Filter for full text mismatches |
label.not.anyOf |
Array<string> | Label - Filter for entries where at least one reference mismatches the query |
label.not.beginsWith |
string | Label - Filter for entries not starting with the text |
label.not.contains |
string | Label - Filter for partial text mismatches |
label.not.endsWith |
string | Label - Filter for entries not ending with the text |
ordinal.between |
Array<> | Line ordinal number - Filter for entries with values between two specified values (inclusive) |
ordinal.equal |
integer | Line ordinal number - Filter for entries with values exactly equal to the specified value |
ordinal.greaterThan |
integer | Line ordinal number - Filter for entries with values greater than the specified value |
ordinal.greaterThanOrEqual |
integer | Line ordinal number - Filter for entries with values greater than or equal to the specified value |
ordinal.lessThan |
integer | Line ordinal number - Filter for entries with values less than the specified value |
ordinal.lessThanOrEqual |
integer | Line ordinal number - Filter for entries with values less than or equal to the specified value |
ordinal.not.between |
Array<> | Line ordinal number - Filter for entries with values between two specified values (inclusive) |
ordinal.not.equal |
integer | Line ordinal number - Filter for entries with values not equal to the specified value |
period.containedBy |
Array<> | Period - Filter for entries whose period are contined by the time period |
period.contains |
Array<> | Period - Filter for entries containing the time period |
period.exists |
boolean | Period - Filter for entries with a value |
period.not.containedBy |
Array<> | Period - Filter for entries whose period are not contined by the time period |
period.not.contains |
Array<> | Period - Filter for entries not containing the time period |
period.not.exists |
boolean | Period - Filter for entries without a value |
period.not.overlaps |
Array<> | Period - Filter for entries not overlapping with the time period |
period.overlaps |
Array<> | Period - Filter for entries overlapping with the time period |
progressionDate.after |
string(date) | Begin of progression - Filter for entries with dates after the specified value |
progressionDate.before |
string(date) | Begin of progression - Filter for entries with dates before the specified value |
progressionDate.between |
Array<> | Begin of progression - Filter for entries with dates between two specified values (inclusive) |
progressionDate.exists |
boolean | Begin of progression - Filter for entries with a value |
progressionDate.not.between |
Array<> | Begin of progression - Filter for entries with dates not between two specified values (inclusive) |
progressionDate.not.exists |
boolean | Begin of progression - Filter for entries without a value |
progressionDate.not.on |
string(date) | Begin of progression - Filter for entries with dates not matching the specified value |
progressionDate.on |
string(date) | Begin of progression - Filter for entries with dates exactly matching the specified value |
progressionDate.onOrAfter |
string(date) | Begin of progression - Filter for entries with dates on or after the specified value |
progressionDate.onOrBefore |
string(date) | Begin of progression - Filter for entries with dates on or before the specified value |
progressionFreeSurvival.between |
Array<> | Progression-free survival in months - Filter for entries with values between two specified values (inclusive) |
progressionFreeSurvival.equal |
number | Progression-free survival in months - Filter for entries with values exactly equal to the specified value |
progressionFreeSurvival.exists |
boolean | Progression-free survival in months - Filter for entries with a value |
progressionFreeSurvival.greaterThan |
number | Progression-free survival in months - Filter for entries with values greater than the specified value |
progressionFreeSurvival.greaterThanOrEqual |
number | Progression-free survival in months - Filter for entries with values greater than or equal to the specified value |
progressionFreeSurvival.lessThan |
number | Progression-free survival in months - Filter for entries with values less than the specified value |
progressionFreeSurvival.lessThanOrEqual |
number | Progression-free survival in months - Filter for entries with values less than or equal to the specified value |
progressionFreeSurvival.not.between |
Array<> | Progression-free survival in months - Filter for entries with values between two specified values (inclusive) |
progressionFreeSurvival.not.equal |
number | Progression-free survival in months - Filter for entries with values not equal to the specified value |
progressionFreeSurvival.not.exists |
boolean | Progression-free survival in months - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
TherapyLineIntentChoices¶
Type: string
TherapyLinePartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient to whom this therapy line is associated |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
intent |
Treatment intent of the system therapy | |
label |
string | Label categorizing the therapy line |
ordinal |
integer | Number indicating the sequence in which this block of treatments were administered to the patient |
period |
string | Time period of the therapy line |
progressionDate |
string(date) | Date at which progression was first detected, if applicable |
progressionFreeSurvival |
number | Progression-free survival (PFS) of the patient for the therapy line |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
TNMStaging¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
distantMetastases |
M stage (presence of distant metastasis) | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
grade |
G stage (grade of the cancer cells) | |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
lymphaticInvasion |
L stage (invasion into lymphatic vessels) | |
methodology |
Methodology used for TNM staging | |
pathological |
boolean | Whether the staging was based on pathological (true) or clinical (false) evidence. |
perineuralInvasion |
Pn stage (invasion into adjunct nerves) | |
primaryTumor |
T stage (extent of the primary tumor) | |
regionalNodes |
N stage (degree of spread to regional lymph nodes) | |
residualTumor |
R stage (extent of residual tumor cells after operation) | |
serumTumorMarkerLevel |
S stage (serum tumor marker level) | |
stage |
CodedConcept | The classification of the TNM stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
venousInvasion |
V stage (invasion into venous vessels) |
TNMStagingCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
distantMetastases |
M stage (presence of distant metastasis) | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
grade |
G stage (grade of the cancer cells) | |
lymphaticInvasion |
L stage (invasion into lymphatic vessels) | |
methodology |
Methodology used for TNM staging | |
pathological |
boolean | Whether the staging was based on pathological (true) or clinical (false) evidence. |
perineuralInvasion |
Pn stage (invasion into adjunct nerves) | |
primaryTumor |
T stage (extent of the primary tumor) | |
regionalNodes |
N stage (degree of spread to regional lymph nodes) | |
residualTumor |
R stage (extent of residual tumor cells after operation) | |
serumTumorMarkerLevel |
S stage (serum tumor marker level) | |
stage |
CodedConcept | The classification of the TNM stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
venousInvasion |
V stage (invasion into venous vessels) |
TNMStagingPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
distantMetastases |
M stage (presence of distant metastasis) | |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
grade |
G stage (grade of the cancer cells) | |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
lymphaticInvasion |
L stage (invasion into lymphatic vessels) | |
methodology |
Methodology used for TNM staging | |
pathological |
boolean | Whether the staging was based on pathological (true) or clinical (false) evidence. |
perineuralInvasion |
Pn stage (invasion into adjunct nerves) | |
primaryTumor |
T stage (extent of the primary tumor) | |
regionalNodes |
N stage (degree of spread to regional lymph nodes) | |
residualTumor |
R stage (extent of residual tumor cells after operation) | |
serumTumorMarkerLevel |
S stage (serum tumor marker level) | |
stage |
The classification of the TNM stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
venousInvasion |
V stage (invasion into venous vessels) |
TreatmentResponse¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
assessedBodysites |
Array<CodedConcept> | Anatomical location assessed to determine the treatment response |
assessedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were assesed for treatment response |
caseId |
string(uuid) | Indicates the case of the patient who's treatment response is asseessed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date of the treatment response assessment |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
methodology |
CodedConcept | Method used to assess and classify the treatment response |
recist |
CodedConcept | The classification of the treatment response according to RECIST |
recistInterpreted |
boolean | Indicates whether the RECIST value was interpreted or taken from the radiology report |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
TreatmentResponseCreate¶
| Name | Type | Description |
|---|---|---|
assessedBodysites |
Array<CodedConcept> | Anatomical location assessed to determine the treatment response |
assessedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were assesed for treatment response |
caseId |
string(uuid) | Indicates the case of the patient who's treatment response is asseessed |
date |
string(date) | Clinically-relevant date of the treatment response assessment |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
methodology |
CodedConcept | Method used to assess and classify the treatment response |
recist |
CodedConcept | The classification of the treatment response according to RECIST |
recistInterpreted |
boolean | Indicates whether the RECIST value was interpreted or taken from the radiology report |
TreatmentResponseFilters¶
| Name | Type | Description |
|---|---|---|
assessedBodysites |
string | Assessed anatomical location - Filter for a matching concept code |
assessedBodysites.allOf |
Array<string> | Assessed anatomical location - Filter for entries matching all of the concepts |
assessedBodysites.anyOf |
Array<string> | Assessed anatomical location - Filter for a matching set of concept codes |
assessedBodysites.descendantsOf |
string | Assessed anatomical location - Filter for all child concepts of a given concepts code |
assessedBodysites.exists |
boolean | Assessed anatomical location - Filter for entries with a value |
assessedBodysites.not |
string | Assessed anatomical location - Filter for a mismatching concept code |
assessedBodysites.not.allOf |
Array<string> | Assessed anatomical location - Filter for entries mismatching all of the concepts |
assessedBodysites.not.anyOf |
Array<string> | Assessed anatomical location - Filter for a mismmatching set of concept codes |
assessedBodysites.not.exists |
boolean | Assessed anatomical location - Filter for entries without a value |
assessedEntitiesIds |
string | Assessed neoplastic entities - Filter for full text matches |
assessedEntitiesIds.anyOf |
Array<string> | Assessed neoplastic entities - Filter for entries where at least one reference matches the query |
assessedEntitiesIds.beginsWith |
string | Assessed neoplastic entities - Filter for entries starting with the text |
assessedEntitiesIds.contains |
string | Assessed neoplastic entities - Filter for partial text matches |
assessedEntitiesIds.endsWith |
string | Assessed neoplastic entities - Filter for entries ending with the text |
assessedEntitiesIds.exists |
boolean | Assessed neoplastic entities - Filter for entries with a value |
assessedEntitiesIds.not |
string | Assessed neoplastic entities - Filter for full text mismatches |
assessedEntitiesIds.not.anyOf |
Array<string> | Assessed neoplastic entities - Filter for entries where at least one reference mismatches the query |
assessedEntitiesIds.not.beginsWith |
string | Assessed neoplastic entities - Filter for entries not starting with the text |
assessedEntitiesIds.not.contains |
string | Assessed neoplastic entities - Filter for partial text mismatches |
assessedEntitiesIds.not.endsWith |
string | Assessed neoplastic entities - Filter for entries not ending with the text |
assessedEntitiesIds.not.exists |
boolean | Assessed neoplastic entities - Filter for entries without a value |
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Assessment date - Filter for entries with dates after the specified value |
date.before |
string(date) | Assessment date - Filter for entries with dates before the specified value |
date.between |
Array<> | Assessment date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Assessment date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Assessment date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Assessment date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Assessment date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Assessment date - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
methodology |
string | Assessment method - Filter for a matching concept code |
methodology.anyOf |
Array<string> | Assessment method - Filter for a matching set of concept codes |
methodology.descendantsOf |
string | Assessment method - Filter for all child concepts of a given concepts code |
methodology.not |
string | Assessment method - Filter for a mismatching concept code |
methodology.not.anyOf |
Array<string> | Assessment method - Filter for a mismmatching set of concept codes |
recist |
string | RECIST - Filter for a matching concept code |
recist.anyOf |
Array<string> | RECIST - Filter for a matching set of concept codes |
recist.descendantsOf |
string | RECIST - Filter for all child concepts of a given concepts code |
recist.not |
string | RECIST - Filter for a mismatching concept code |
recist.not.anyOf |
Array<string> | RECIST - Filter for a mismmatching set of concept codes |
recistInterpreted |
boolean | RECIST Interpreted? - Filter for yes/no statement |
recistInterpreted.exists |
boolean | RECIST Interpreted? - Filter for entries with a value |
recistInterpreted.not.exists |
boolean | RECIST Interpreted? - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
TreatmentResponsePartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
assessedBodysites |
Anatomical location assessed to determine the treatment response | |
assessedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were assesed for treatment response |
caseId |
string(uuid) | Indicates the case of the patient who's treatment response is asseessed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date of the treatment response assessment |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
methodology |
Method used to assess and classify the treatment response | |
recist |
The classification of the treatment response according to RECIST | |
recistInterpreted |
boolean | Indicates whether the RECIST value was interpreted or taken from the radiology report |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
TumorBoardFilters¶
| Name | Type | Description |
|---|---|---|
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Date - Filter for entries with dates after the specified value |
date.before |
string(date) | Date - Filter for entries with dates before the specified value |
date.between |
Array<> | Date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Date - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
recommendations |
string | Recommendations - Filter for a matching concept code |
recommendations.allOf |
Array<string> | Recommendations - Filter for entries matching all of the concepts |
recommendations.anyOf |
Array<string> | Recommendations - Filter for a matching set of concept codes |
recommendations.descendantsOf |
string | Recommendations - Filter for all child concepts of a given concepts code |
recommendations.exists |
boolean | Recommendations - Filter for entries with a value |
recommendations.not |
string | Recommendations - Filter for a mismatching concept code |
recommendations.not.allOf |
Array<string> | Recommendations - Filter for entries mismatching all of the concepts |
recommendations.not.anyOf |
Array<string> | Recommendations - Filter for a mismmatching set of concept codes |
recommendations.not.exists |
boolean | Recommendations - Filter for entries without a value |
relatedEntitiesIds |
string | Related neoplastic entities - Filter for full text matches |
relatedEntitiesIds.anyOf |
Array<string> | Related neoplastic entities - Filter for entries where at least one reference matches the query |
relatedEntitiesIds.beginsWith |
string | Related neoplastic entities - Filter for entries starting with the text |
relatedEntitiesIds.contains |
string | Related neoplastic entities - Filter for partial text matches |
relatedEntitiesIds.endsWith |
string | Related neoplastic entities - Filter for entries ending with the text |
relatedEntitiesIds.exists |
boolean | Related neoplastic entities - Filter for entries with a value |
relatedEntitiesIds.not |
string | Related neoplastic entities - Filter for full text mismatches |
relatedEntitiesIds.not.anyOf |
Array<string> | Related neoplastic entities - Filter for entries where at least one reference mismatches the query |
relatedEntitiesIds.not.beginsWith |
string | Related neoplastic entities - Filter for entries not starting with the text |
relatedEntitiesIds.not.contains |
string | Related neoplastic entities - Filter for partial text mismatches |
relatedEntitiesIds.not.endsWith |
string | Related neoplastic entities - Filter for entries not ending with the text |
relatedEntitiesIds.not.exists |
boolean | Related neoplastic entities - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
TumorMarker¶
| Name | Type | Description |
|---|---|---|
analyte |
CodedConcept | The chemical or biological substance/agent that is analyzed. |
anonymized |
boolean | Whether the data has been anonymized |
arbitraryConcentration |
Arbitrary concentration of the analyte (if revelant/measured) | |
caseId |
string(uuid) | Indicates the case of the patient related to the tumor marker result |
combinedPositiveScore |
The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100 | |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the tumor marker was analyzed. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
fraction |
Analyte fraction (if revelant/measured) | |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
immuneCellScore |
Categorization of the percentage of PD-L1 positive immune cells | |
immunohistochemicalScore |
Categorization of the number of analyte-positive cells in a sample | |
massConcentration |
Mass concentration of the analyte (if revelant/measured) | |
multipleOfMedian |
Multiples of the median analyte (if revelant/measured) | |
nuclearExpressionStatus |
Categorization of the status of expression of the analyte | |
presence |
Whether an analyte has tested positive or negative. | |
relatedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that are related or the focus of the tumor marker analysis. |
substanceConcentration |
Substance concentration of the analyte (if revelant/measured) | |
tumorProportionScore |
Categorization of the percentage of cells in a tumor that express PD-L1 | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
TumorMarkerCreate¶
| Name | Type | Description |
|---|---|---|
analyte |
CodedConcept | The chemical or biological substance/agent that is analyzed. |
arbitraryConcentration |
Arbitrary concentration of the analyte (if revelant/measured) | |
caseId |
string(uuid) | Indicates the case of the patient related to the tumor marker result |
combinedPositiveScore |
The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100 | |
date |
string(date) | Clinically-relevant date at which the tumor marker was analyzed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
fraction |
Analyte fraction (if revelant/measured) | |
immuneCellScore |
Categorization of the percentage of PD-L1 positive immune cells | |
immunohistochemicalScore |
Categorization of the number of analyte-positive cells in a sample | |
massConcentration |
Mass concentration of the analyte (if revelant/measured) | |
multipleOfMedian |
Multiples of the median analyte (if revelant/measured) | |
nuclearExpressionStatus |
Categorization of the status of expression of the analyte | |
presence |
Whether an analyte has tested positive or negative. | |
relatedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that are related or the focus of the tumor marker analysis. |
substanceConcentration |
Substance concentration of the analyte (if revelant/measured) | |
tumorProportionScore |
Categorization of the percentage of cells in a tumor that express PD-L1 |
TumorMarkerFilters¶
| Name | Type | Description |
|---|---|---|
analyte |
string | Analyte - Filter for a matching concept code |
analyte.anyOf |
Array<string> | Analyte - Filter for a matching set of concept codes |
analyte.descendantsOf |
string | Analyte - Filter for all child concepts of a given concepts code |
analyte.not |
string | Analyte - Filter for a mismatching concept code |
analyte.not.anyOf |
Array<string> | Analyte - Filter for a mismmatching set of concept codes |
arbitraryConcentration.between |
Array<> | Arbitrary concentration - Filter for entries with values between two specified values (inclusive) |
arbitraryConcentration.equal |
number | Arbitrary concentration - Filter for entries with values exactly equal to the specified value |
arbitraryConcentration.exists |
boolean | Arbitrary concentration - Filter for entries with a value |
arbitraryConcentration.greaterThan |
number | Arbitrary concentration - Filter for entries with values greater than the specified value |
arbitraryConcentration.greaterThanOrEqual |
number | Arbitrary concentration - Filter for entries with values greater than or equal to the specified value |
arbitraryConcentration.lessThan |
number | Arbitrary concentration - Filter for entries with values less than the specified value |
arbitraryConcentration.lessThanOrEqual |
number | Arbitrary concentration - Filter for entries with values less than or equal to the specified value |
arbitraryConcentration.not.between |
Array<> | Arbitrary concentration - Filter for entries with values between two specified values (inclusive) |
arbitraryConcentration.not.equal |
number | Arbitrary concentration - Filter for entries with values not equal to the specified value |
arbitraryConcentration.not.exists |
boolean | Arbitrary concentration - Filter for entries without a value |
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
combinedPositiveScore.between |
Array<> | Combined Positive Score (CPS) - Filter for entries with values between two specified values (inclusive) |
combinedPositiveScore.equal |
number | Combined Positive Score (CPS) - Filter for entries with values exactly equal to the specified value |
combinedPositiveScore.exists |
boolean | Combined Positive Score (CPS) - Filter for entries with a value |
combinedPositiveScore.greaterThan |
number | Combined Positive Score (CPS) - Filter for entries with values greater than the specified value |
combinedPositiveScore.greaterThanOrEqual |
number | Combined Positive Score (CPS) - Filter for entries with values greater than or equal to the specified value |
combinedPositiveScore.lessThan |
number | Combined Positive Score (CPS) - Filter for entries with values less than the specified value |
combinedPositiveScore.lessThanOrEqual |
number | Combined Positive Score (CPS) - Filter for entries with values less than or equal to the specified value |
combinedPositiveScore.not.between |
Array<> | Combined Positive Score (CPS) - Filter for entries with values between two specified values (inclusive) |
combinedPositiveScore.not.equal |
number | Combined Positive Score (CPS) - Filter for entries with values not equal to the specified value |
combinedPositiveScore.not.exists |
boolean | Combined Positive Score (CPS) - Filter for entries without a value |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Date - Filter for entries with dates after the specified value |
date.before |
string(date) | Date - Filter for entries with dates before the specified value |
date.between |
Array<> | Date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Date - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
fraction.between |
Array<> | Fraction - Filter for entries with values between two specified values (inclusive) |
fraction.equal |
number | Fraction - Filter for entries with values exactly equal to the specified value |
fraction.exists |
boolean | Fraction - Filter for entries with a value |
fraction.greaterThan |
number | Fraction - Filter for entries with values greater than the specified value |
fraction.greaterThanOrEqual |
number | Fraction - Filter for entries with values greater than or equal to the specified value |
fraction.lessThan |
number | Fraction - Filter for entries with values less than the specified value |
fraction.lessThanOrEqual |
number | Fraction - Filter for entries with values less than or equal to the specified value |
fraction.not.between |
Array<> | Fraction - Filter for entries with values between two specified values (inclusive) |
fraction.not.equal |
number | Fraction - Filter for entries with values not equal to the specified value |
fraction.not.exists |
boolean | Fraction - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
immuneCellScore |
Immune Cells Score (ICS) - Filter for single value choice | |
immuneCellScore.anyOf |
Array<string> | Immune Cells Score (ICS) - ('Filter for excluding a subset of value choices',) |
immuneCellScore.exists |
boolean | Immune Cells Score (ICS) - Filter for entries with a value |
immuneCellScore.not |
Immune Cells Score (ICS) - ('Filter for all but a single value choice',) | |
immuneCellScore.not.exists |
boolean | Immune Cells Score (ICS) - Filter for entries without a value |
immunohistochemicalScore |
Immunohistochemical Score - Filter for single value choice | |
immunohistochemicalScore.anyOf |
Array<string> | Immunohistochemical Score - ('Filter for excluding a subset of value choices',) |
immunohistochemicalScore.exists |
boolean | Immunohistochemical Score - Filter for entries with a value |
immunohistochemicalScore.not |
Immunohistochemical Score - ('Filter for all but a single value choice',) | |
immunohistochemicalScore.not.exists |
boolean | Immunohistochemical Score - Filter for entries without a value |
massConcentration.between |
Array<> | Mass concentration - Filter for entries with values between two specified values (inclusive) |
massConcentration.equal |
number | Mass concentration - Filter for entries with values exactly equal to the specified value |
massConcentration.exists |
boolean | Mass concentration - Filter for entries with a value |
massConcentration.greaterThan |
number | Mass concentration - Filter for entries with values greater than the specified value |
massConcentration.greaterThanOrEqual |
number | Mass concentration - Filter for entries with values greater than or equal to the specified value |
massConcentration.lessThan |
number | Mass concentration - Filter for entries with values less than the specified value |
massConcentration.lessThanOrEqual |
number | Mass concentration - Filter for entries with values less than or equal to the specified value |
massConcentration.not.between |
Array<> | Mass concentration - Filter for entries with values between two specified values (inclusive) |
massConcentration.not.equal |
number | Mass concentration - Filter for entries with values not equal to the specified value |
massConcentration.not.exists |
boolean | Mass concentration - Filter for entries without a value |
multipleOfMedian.between |
Array<> | Multiples of the median - Filter for entries with values between two specified values (inclusive) |
multipleOfMedian.equal |
number | Multiples of the median - Filter for entries with values exactly equal to the specified value |
multipleOfMedian.exists |
boolean | Multiples of the median - Filter for entries with a value |
multipleOfMedian.greaterThan |
number | Multiples of the median - Filter for entries with values greater than the specified value |
multipleOfMedian.greaterThanOrEqual |
number | Multiples of the median - Filter for entries with values greater than or equal to the specified value |
multipleOfMedian.lessThan |
number | Multiples of the median - Filter for entries with values less than the specified value |
multipleOfMedian.lessThanOrEqual |
number | Multiples of the median - Filter for entries with values less than or equal to the specified value |
multipleOfMedian.not.between |
Array<> | Multiples of the median - Filter for entries with values between two specified values (inclusive) |
multipleOfMedian.not.equal |
number | Multiples of the median - Filter for entries with values not equal to the specified value |
multipleOfMedian.not.exists |
boolean | Multiples of the median - Filter for entries without a value |
nuclearExpressionStatus |
Nuclear expression status - Filter for single value choice | |
nuclearExpressionStatus.anyOf |
Array<string> | Nuclear expression status - ('Filter for excluding a subset of value choices',) |
nuclearExpressionStatus.exists |
boolean | Nuclear expression status - Filter for entries with a value |
nuclearExpressionStatus.not |
Nuclear expression status - ('Filter for all but a single value choice',) | |
nuclearExpressionStatus.not.exists |
boolean | Nuclear expression status - Filter for entries without a value |
presence |
Presence - Filter for single value choice | |
presence.anyOf |
Array<string> | Presence - ('Filter for excluding a subset of value choices',) |
presence.exists |
boolean | Presence - Filter for entries with a value |
presence.not |
Presence - ('Filter for all but a single value choice',) | |
presence.not.exists |
boolean | Presence - Filter for entries without a value |
relatedEntitiesIds |
string | Related neoplastic entities - Filter for full text matches |
relatedEntitiesIds.anyOf |
Array<string> | Related neoplastic entities - Filter for entries where at least one reference matches the query |
relatedEntitiesIds.beginsWith |
string | Related neoplastic entities - Filter for entries starting with the text |
relatedEntitiesIds.contains |
string | Related neoplastic entities - Filter for partial text matches |
relatedEntitiesIds.endsWith |
string | Related neoplastic entities - Filter for entries ending with the text |
relatedEntitiesIds.exists |
boolean | Related neoplastic entities - Filter for entries with a value |
relatedEntitiesIds.not |
string | Related neoplastic entities - Filter for full text mismatches |
relatedEntitiesIds.not.anyOf |
Array<string> | Related neoplastic entities - Filter for entries where at least one reference mismatches the query |
relatedEntitiesIds.not.beginsWith |
string | Related neoplastic entities - Filter for entries not starting with the text |
relatedEntitiesIds.not.contains |
string | Related neoplastic entities - Filter for partial text mismatches |
relatedEntitiesIds.not.endsWith |
string | Related neoplastic entities - Filter for entries not ending with the text |
relatedEntitiesIds.not.exists |
boolean | Related neoplastic entities - Filter for entries without a value |
substanceConcentration.between |
Array<> | Substance concentration - Filter for entries with values between two specified values (inclusive) |
substanceConcentration.equal |
number | Substance concentration - Filter for entries with values exactly equal to the specified value |
substanceConcentration.exists |
boolean | Substance concentration - Filter for entries with a value |
substanceConcentration.greaterThan |
number | Substance concentration - Filter for entries with values greater than the specified value |
substanceConcentration.greaterThanOrEqual |
number | Substance concentration - Filter for entries with values greater than or equal to the specified value |
substanceConcentration.lessThan |
number | Substance concentration - Filter for entries with values less than the specified value |
substanceConcentration.lessThanOrEqual |
number | Substance concentration - Filter for entries with values less than or equal to the specified value |
substanceConcentration.not.between |
Array<> | Substance concentration - Filter for entries with values between two specified values (inclusive) |
substanceConcentration.not.equal |
number | Substance concentration - Filter for entries with values not equal to the specified value |
substanceConcentration.not.exists |
boolean | Substance concentration - Filter for entries without a value |
tumorProportionScore |
Immune Cells Score (ICS) - Filter for single value choice | |
tumorProportionScore.anyOf |
Array<string> | Immune Cells Score (ICS) - ('Filter for excluding a subset of value choices',) |
tumorProportionScore.exists |
boolean | Immune Cells Score (ICS) - Filter for entries with a value |
tumorProportionScore.not |
Immune Cells Score (ICS) - ('Filter for all but a single value choice',) | |
tumorProportionScore.not.exists |
boolean | Immune Cells Score (ICS) - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
TumorMarkerImmuneCellScoreChoices¶
Type: string
TumorMarkerImmunohistochemicalScoreChoices¶
Type: string
TumorMarkerNuclearExpressionStatusChoices¶
Type: string
TumorMarkerPartial¶
| Name | Type | Description |
|---|---|---|
analyte |
The chemical or biological substance/agent that is analyzed. | |
anonymized |
boolean | Whether the data has been anonymized |
arbitraryConcentration |
Arbitrary concentration of the analyte (if revelant/measured) | |
caseId |
string(uuid) | Indicates the case of the patient related to the tumor marker result |
combinedPositiveScore |
The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100 | |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the tumor marker was analyzed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
fraction |
Analyte fraction (if revelant/measured) | |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
immuneCellScore |
Categorization of the percentage of PD-L1 positive immune cells | |
immunohistochemicalScore |
Categorization of the number of analyte-positive cells in a sample | |
massConcentration |
Mass concentration of the analyte (if revelant/measured) | |
multipleOfMedian |
Multiples of the median analyte (if revelant/measured) | |
nuclearExpressionStatus |
Categorization of the status of expression of the analyte | |
presence |
Whether an analyte has tested positive or negative. | |
relatedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that are related or the focus of the tumor marker analysis. |
substanceConcentration |
Substance concentration of the analyte (if revelant/measured) | |
tumorProportionScore |
Categorization of the percentage of cells in a tumor that express PD-L1 | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
TumorMarkerPresenceChoices¶
Type: string
TumorMarkerTumorProportionScoreChoices¶
Type: string
TumorMutationalBurden¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
status |
Cclassification of the tumor mutational burden (TMB) status | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
number | The actual tumor mutational burden (TMB) value in mutations/Mb |
TumorMutationalBurdenCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
status |
Cclassification of the tumor mutational burden (TMB) status | |
value |
number | The actual tumor mutational burden (TMB) value in mutations/Mb |
TumorMutationalBurdenPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
status |
Cclassification of the tumor mutational burden (TMB) status | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
number | The actual tumor mutational burden (TMB) value in mutations/Mb |
TumorMutationalBurdenStatusChoices¶
Type: string
TumorNeoantigenBurden¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
number | The actual tumor neoantigen burden (TNB) value in neoantigens/Mb |
TumorNeoantigenBurdenCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
value |
number | The actual tumor neoantigen burden (TNB) value in neoantigens/Mb |
TumorNeoantigenBurdenPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's lifestyle is assesed |
category |
string | Genomic signature discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the patient's genomic signature was assessed. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
value |
number | The actual tumor neoantigen burden (TNB) value in neoantigens/Mb |
UnspecifiedTumorBoard¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient which was discussed at the tumor board |
category |
string | Tumor board discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Date at which the tumor board took place and/or when the board provided a recommendation. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
recommendations |
Array<CodedConcept> | Recommendation(s) provided by the board regarding the patient's care |
relatedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the tumor board. |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
UnspecifiedTumorBoardCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient which was discussed at the tumor board |
category |
string | Tumor board discriminator category |
date |
string(date) | Date at which the tumor board took place and/or when the board provided a recommendation. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
recommendations |
Array<CodedConcept> | Recommendation(s) provided by the board regarding the patient's care |
relatedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the tumor board. |
UnspecifiedTumorBoardPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient which was discussed at the tumor board |
category |
string | Tumor board discriminator category |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Date at which the tumor board took place and/or when the board provided a recommendation. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
recommendations |
Recommendation(s) provided by the board regarding the patient's care | |
relatedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the tumor board. |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
User¶
| Name | Type | Description |
|---|---|---|
accessLevel |
integer | Level of access of the user in terms of permissions |
canExportData |
boolean | Permission to export data out of the system. |
canManageCases |
boolean | Permission to manage cases. |
canManageProjects |
boolean | Permission to manage projects. |
canManageUsers |
boolean | Permission to create and manage users. |
canViewCases |
boolean | Permission to view cases. |
canViewCohorts |
boolean | Permission to view cohorts. |
canViewDatasets |
boolean | Permission to view available datasets. |
canViewProjects |
boolean | Permission to view projects. |
canViewUsers |
boolean | Permission to view other user accounts. |
department |
string | Department within an organization to which the user belongs to |
email |
string | |
externalSource |
string | Name of the source from which the user originated, if imported |
externalSourceId |
string | Unique identifier within the source from which the user originated, if imported |
firstName |
string | |
fullName |
string | The user's full name. |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
isActive |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
isProvided |
boolean | Indicates whether the user account is externally provided. |
isServiceAccount |
boolean | Whether the user is a technical service account |
isSystemAdmin |
boolean | Whether the user is a system administrator. |
lastLogin |
string(date-time) | |
lastName |
string | |
organization |
string | Organization to which the user belongs to |
provider |
string | The external authentication provider, if applicable. |
role |
AccessRoles | The user's assigned access role. |
shareable |
boolean | Whether user has consented to its data to be shared with other Onconova instances |
title |
string | Personal title of the user |
username |
string | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
UserCreate¶
| Name | Type | Description |
|---|---|---|
accessLevel |
integer | Level of access of the user in terms of permissions |
department |
string | Department within an organization to which the user belongs to |
email |
string | |
externalSource |
string | Name of the source from which the user originated, if imported |
externalSourceId |
string | Unique identifier within the source from which the user originated, if imported |
firstName |
string | |
isActive |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
isServiceAccount |
boolean | Whether the user is a technical service account |
lastLogin |
string(date-time) | |
lastName |
string | |
organization |
string | Organization to which the user belongs to |
shareable |
boolean | Whether user has consented to its data to be shared with other Onconova instances |
title |
string | Personal title of the user |
username |
string | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
UserCredentials¶
| Name | Type | Description |
|---|---|---|
password |
string | The password associated with the username. |
username |
string | The username of the user. |
UserExport¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
email |
string | The user's primary email address. |
externalSource |
string | Name of the source from which the user originated, if imported |
externalSourceId |
string | Unique identifier within the source from which the user originated, if imported |
firstName |
string | The user's given name. |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
lastName |
string | The user's surname. |
organization |
string | The user's affiliated organization. |
username |
string | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
UserFilters¶
| Name | Type | Description |
|---|---|---|
accessLevel.between |
Array<> | Access level - Filter for entries with values between two specified values (inclusive) |
accessLevel.equal |
integer | Access level - Filter for entries with values exactly equal to the specified value |
accessLevel.greaterThan |
integer | Access level - Filter for entries with values greater than the specified value |
accessLevel.greaterThanOrEqual |
integer | Access level - Filter for entries with values greater than or equal to the specified value |
accessLevel.lessThan |
integer | Access level - Filter for entries with values less than the specified value |
accessLevel.lessThanOrEqual |
integer | Access level - Filter for entries with values less than or equal to the specified value |
accessLevel.not.between |
Array<> | Access level - Filter for entries with values between two specified values (inclusive) |
accessLevel.not.equal |
integer | Access level - Filter for entries with values not equal to the specified value |
canExportData |
boolean | Export Data - Filter for yes/no statement |
canManageCases |
boolean | Manage Cases - Filter for yes/no statement |
canManageProjects |
boolean | Manage Projects - Filter for yes/no statement |
canManageUsers |
boolean | Manage Users - Filter for yes/no statement |
canViewCases |
boolean | View Cases - Filter for yes/no statement |
canViewCohorts |
boolean | View Cohorts - Filter for yes/no statement |
canViewDatasets |
boolean | View Datasets - Filter for yes/no statement |
canViewProjects |
boolean | View Projects - Filter for yes/no statement |
canViewUsers |
boolean | View Users - Filter for yes/no statement |
department |
string | Department - Filter for full text matches |
department.anyOf |
Array<string> | Department - Filter for entries where at least one reference matches the query |
department.beginsWith |
string | Department - Filter for entries starting with the text |
department.contains |
string | Department - Filter for partial text matches |
department.endsWith |
string | Department - Filter for entries ending with the text |
department.exists |
boolean | Department - Filter for entries with a value |
department.not |
string | Department - Filter for full text mismatches |
department.not.anyOf |
Array<string> | Department - Filter for entries where at least one reference mismatches the query |
department.not.beginsWith |
string | Department - Filter for entries not starting with the text |
department.not.contains |
string | Department - Filter for partial text mismatches |
department.not.endsWith |
string | Department - Filter for entries not ending with the text |
department.not.exists |
boolean | Department - Filter for entries without a value |
email |
string | Email Address - Filter for full text matches |
email.anyOf |
Array<string> | Email Address - Filter for entries where at least one reference matches the query |
email.beginsWith |
string | Email Address - Filter for entries starting with the text |
email.contains |
string | Email Address - Filter for partial text matches |
email.endsWith |
string | Email Address - Filter for entries ending with the text |
email.exists |
boolean | Email Address - Filter for entries with a value |
email.not |
string | Email Address - Filter for full text mismatches |
email.not.anyOf |
Array<string> | Email Address - Filter for entries where at least one reference mismatches the query |
email.not.beginsWith |
string | Email Address - Filter for entries not starting with the text |
email.not.contains |
string | Email Address - Filter for partial text mismatches |
email.not.endsWith |
string | Email Address - Filter for entries not ending with the text |
email.not.exists |
boolean | Email Address - Filter for entries without a value |
externalSource |
string | External source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External source - Filter for entries starting with the text |
externalSource.contains |
string | External source - Filter for partial text matches |
externalSource.endsWith |
string | External source - Filter for entries ending with the text |
externalSource.exists |
boolean | External source - Filter for entries with a value |
externalSource.not |
string | External source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External source - Filter for entries without a value |
firstName |
string | First Name - Filter for full text matches |
firstName.anyOf |
Array<string> | First Name - Filter for entries where at least one reference matches the query |
firstName.beginsWith |
string | First Name - Filter for entries starting with the text |
firstName.contains |
string | First Name - Filter for partial text matches |
firstName.endsWith |
string | First Name - Filter for entries ending with the text |
firstName.exists |
boolean | First Name - Filter for entries with a value |
firstName.not |
string | First Name - Filter for full text mismatches |
firstName.not.anyOf |
Array<string> | First Name - Filter for entries where at least one reference mismatches the query |
firstName.not.beginsWith |
string | First Name - Filter for entries not starting with the text |
firstName.not.contains |
string | First Name - Filter for partial text mismatches |
firstName.not.endsWith |
string | First Name - Filter for entries not ending with the text |
firstName.not.exists |
boolean | First Name - Filter for entries without a value |
fullName |
string | Full Name - Filter for full text matches |
fullName.anyOf |
Array<string> | Full Name - Filter for entries where at least one reference matches the query |
fullName.beginsWith |
string | Full Name - Filter for entries starting with the text |
fullName.contains |
string | Full Name - Filter for partial text matches |
fullName.endsWith |
string | Full Name - Filter for entries ending with the text |
fullName.not |
string | Full Name - Filter for full text mismatches |
fullName.not.anyOf |
Array<string> | Full Name - Filter for entries where at least one reference mismatches the query |
fullName.not.beginsWith |
string | Full Name - Filter for entries not starting with the text |
fullName.not.contains |
string | Full Name - Filter for partial text mismatches |
fullName.not.endsWith |
string | Full Name - Filter for entries not ending with the text |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
isActive |
boolean | Active - Filter for yes/no statement |
isProvided |
boolean | Is Provided - Filter for yes/no statement |
isServiceAccount |
boolean | Is service account? - Filter for yes/no statement |
isSystemAdmin |
boolean | System Administrator - Filter for yes/no statement |
lastLogin.after |
string(date) | Last Login - Filter for entries with dates after the specified value |
lastLogin.before |
string(date) | Last Login - Filter for entries with dates before the specified value |
lastLogin.between |
Array<> | Last Login - Filter for entries with dates between two specified values (inclusive) |
lastLogin.exists |
boolean | Last Login - Filter for entries with a value |
lastLogin.not.between |
Array<> | Last Login - Filter for entries with dates not between two specified values (inclusive) |
lastLogin.not.exists |
boolean | Last Login - Filter for entries without a value |
lastLogin.not.on |
string(date) | Last Login - Filter for entries with dates not matching the specified value |
lastLogin.on |
string(date) | Last Login - Filter for entries with dates exactly matching the specified value |
lastLogin.onOrAfter |
string(date) | Last Login - Filter for entries with dates on or after the specified value |
lastLogin.onOrBefore |
string(date) | Last Login - Filter for entries with dates on or before the specified value |
lastName |
string | Last Name - Filter for full text matches |
lastName.anyOf |
Array<string> | Last Name - Filter for entries where at least one reference matches the query |
lastName.beginsWith |
string | Last Name - Filter for entries starting with the text |
lastName.contains |
string | Last Name - Filter for partial text matches |
lastName.endsWith |
string | Last Name - Filter for entries ending with the text |
lastName.exists |
boolean | Last Name - Filter for entries with a value |
lastName.not |
string | Last Name - Filter for full text mismatches |
lastName.not.anyOf |
Array<string> | Last Name - Filter for entries where at least one reference mismatches the query |
lastName.not.beginsWith |
string | Last Name - Filter for entries not starting with the text |
lastName.not.contains |
string | Last Name - Filter for partial text mismatches |
lastName.not.endsWith |
string | Last Name - Filter for entries not ending with the text |
lastName.not.exists |
boolean | Last Name - Filter for entries without a value |
organization |
string | Organization - Filter for full text matches |
organization.anyOf |
Array<string> | Organization - Filter for entries where at least one reference matches the query |
organization.beginsWith |
string | Organization - Filter for entries starting with the text |
organization.contains |
string | Organization - Filter for partial text matches |
organization.endsWith |
string | Organization - Filter for entries ending with the text |
organization.exists |
boolean | Organization - Filter for entries with a value |
organization.not |
string | Organization - Filter for full text mismatches |
organization.not.anyOf |
Array<string> | Organization - Filter for entries where at least one reference mismatches the query |
organization.not.beginsWith |
string | Organization - Filter for entries not starting with the text |
organization.not.contains |
string | Organization - Filter for partial text mismatches |
organization.not.endsWith |
string | Organization - Filter for entries not ending with the text |
organization.not.exists |
boolean | Organization - Filter for entries without a value |
provider |
string | Provider - Filter for full text matches |
provider.anyOf |
Array<string> | Provider - Filter for entries where at least one reference matches the query |
provider.beginsWith |
string | Provider - Filter for entries starting with the text |
provider.contains |
string | Provider - Filter for partial text matches |
provider.endsWith |
string | Provider - Filter for entries ending with the text |
provider.exists |
boolean | Provider - Filter for entries with a value |
provider.not |
string | Provider - Filter for full text mismatches |
provider.not.anyOf |
Array<string> | Provider - Filter for entries where at least one reference mismatches the query |
provider.not.beginsWith |
string | Provider - Filter for entries not starting with the text |
provider.not.contains |
string | Provider - Filter for partial text mismatches |
provider.not.endsWith |
string | Provider - Filter for entries not ending with the text |
provider.not.exists |
boolean | Provider - Filter for entries without a value |
role |
Role - Filter for single value choice | |
role.anyOf |
Array<string> | Role - ('Filter for excluding a subset of value choices',) |
role.not |
Role - ('Filter for all but a single value choice',) | |
shareable |
boolean | Shareable - Filter for yes/no statement |
shareable.exists |
boolean | Shareable - Filter for entries with a value |
shareable.not.exists |
boolean | Shareable - Filter for entries without a value |
title |
string | Title - Filter for full text matches |
title.anyOf |
Array<string> | Title - Filter for entries where at least one reference matches the query |
title.beginsWith |
string | Title - Filter for entries starting with the text |
title.contains |
string | Title - Filter for partial text matches |
title.endsWith |
string | Title - Filter for entries ending with the text |
title.exists |
boolean | Title - Filter for entries with a value |
title.not |
string | Title - Filter for full text mismatches |
title.not.anyOf |
Array<string> | Title - Filter for entries where at least one reference mismatches the query |
title.not.beginsWith |
string | Title - Filter for entries not starting with the text |
title.not.contains |
string | Title - Filter for partial text mismatches |
title.not.endsWith |
string | Title - Filter for entries not ending with the text |
title.not.exists |
boolean | Title - Filter for entries without a value |
username |
string | Username - Filter for full text matches |
username.anyOf |
Array<string> | Username - Filter for entries where at least one reference matches the query |
username.beginsWith |
string | Username - Filter for entries starting with the text |
username.contains |
string | Username - Filter for partial text matches |
username.endsWith |
string | Username - Filter for entries ending with the text |
username.not |
string | Username - Filter for full text mismatches |
username.not.anyOf |
Array<string> | Username - Filter for entries where at least one reference mismatches the query |
username.not.beginsWith |
string | Username - Filter for entries not starting with the text |
username.not.contains |
string | Username - Filter for partial text mismatches |
username.not.endsWith |
string | Username - Filter for entries not ending with the text |
UserPasswordReset¶
| Name | Type | Description |
|---|---|---|
newPassword |
string | The user's new password to be set. |
oldPassword |
string | The user's current password. |
UserProfile¶
| Name | Type | Description |
|---|---|---|
department |
string | The user's department within the organization. |
email |
string | The user's primary email address. |
firstName |
string | The user's given name. |
lastName |
string | The user's surname. |
organization |
string | The user's affiliated organization. |
title |
string | The user's job title or position. |
UserProviderClientToken¶
| Name | Type | Description |
|---|---|---|
access_token |
string | The access token issued by the authentication provider, if available. |
client_id |
string | The unique identifier for the client application. |
id_token |
string | The ID token issued by the authentication provider, if available. |
UserProviderToken¶
| Name | Type | Description |
|---|---|---|
process |
The process type, either 'login' or 'connect'. | |
provider |
string | The name of the authentication provider (e.g., 'google', 'facebook'). |
token |
UserProviderClientToken | The token object containing provider-specific authentication details. |
Vitals¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
bloodPressureDiastolic |
Diastolic blood pressure of the patient | |
bloodPressureSystolic |
Systolic blood pressure of the patient | |
bodyMassIndex |
Bodymass index of the patient | |
caseId |
string(uuid) | Indicates the case of the patient who's vitals are assesed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the vitals were recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
height |
Height of the patient | |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
temperature |
Temperature of the patient | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
weight |
Weight of the patient |
VitalsCreate¶
| Name | Type | Description |
|---|---|---|
bloodPressureDiastolic |
Diastolic blood pressure of the patient | |
bloodPressureSystolic |
Systolic blood pressure of the patient | |
caseId |
string(uuid) | Indicates the case of the patient who's vitals are assesed |
date |
string(date) | Clinically-relevant date at which the vitals were recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
height |
Height of the patient | |
temperature |
Temperature of the patient | |
weight |
Weight of the patient |
VitalsFilters¶
| Name | Type | Description |
|---|---|---|
bloodPressureDiastolic.between |
Array<> | Diastolic blood pressure - Filter for entries with values between two specified values (inclusive) |
bloodPressureDiastolic.equal |
number | Diastolic blood pressure - Filter for entries with values exactly equal to the specified value |
bloodPressureDiastolic.exists |
boolean | Diastolic blood pressure - Filter for entries with a value |
bloodPressureDiastolic.greaterThan |
number | Diastolic blood pressure - Filter for entries with values greater than the specified value |
bloodPressureDiastolic.greaterThanOrEqual |
number | Diastolic blood pressure - Filter for entries with values greater than or equal to the specified value |
bloodPressureDiastolic.lessThan |
number | Diastolic blood pressure - Filter for entries with values less than the specified value |
bloodPressureDiastolic.lessThanOrEqual |
number | Diastolic blood pressure - Filter for entries with values less than or equal to the specified value |
bloodPressureDiastolic.not.between |
Array<> | Diastolic blood pressure - Filter for entries with values between two specified values (inclusive) |
bloodPressureDiastolic.not.equal |
number | Diastolic blood pressure - Filter for entries with values not equal to the specified value |
bloodPressureDiastolic.not.exists |
boolean | Diastolic blood pressure - Filter for entries without a value |
bloodPressureSystolic.between |
Array<> | Systolic blood pressure - Filter for entries with values between two specified values (inclusive) |
bloodPressureSystolic.equal |
number | Systolic blood pressure - Filter for entries with values exactly equal to the specified value |
bloodPressureSystolic.exists |
boolean | Systolic blood pressure - Filter for entries with a value |
bloodPressureSystolic.greaterThan |
number | Systolic blood pressure - Filter for entries with values greater than the specified value |
bloodPressureSystolic.greaterThanOrEqual |
number | Systolic blood pressure - Filter for entries with values greater than or equal to the specified value |
bloodPressureSystolic.lessThan |
number | Systolic blood pressure - Filter for entries with values less than the specified value |
bloodPressureSystolic.lessThanOrEqual |
number | Systolic blood pressure - Filter for entries with values less than or equal to the specified value |
bloodPressureSystolic.not.between |
Array<> | Systolic blood pressure - Filter for entries with values between two specified values (inclusive) |
bloodPressureSystolic.not.equal |
number | Systolic blood pressure - Filter for entries with values not equal to the specified value |
bloodPressureSystolic.not.exists |
boolean | Systolic blood pressure - Filter for entries without a value |
bodyMassIndex.between |
Array<> | Body mass index - Filter for entries with values between two specified values (inclusive) |
bodyMassIndex.equal |
number | Body mass index - Filter for entries with values exactly equal to the specified value |
bodyMassIndex.exists |
boolean | Body mass index - Filter for entries with a value |
bodyMassIndex.greaterThan |
number | Body mass index - Filter for entries with values greater than the specified value |
bodyMassIndex.greaterThanOrEqual |
number | Body mass index - Filter for entries with values greater than or equal to the specified value |
bodyMassIndex.lessThan |
number | Body mass index - Filter for entries with values less than the specified value |
bodyMassIndex.lessThanOrEqual |
number | Body mass index - Filter for entries with values less than or equal to the specified value |
bodyMassIndex.not.between |
Array<> | Body mass index - Filter for entries with values between two specified values (inclusive) |
bodyMassIndex.not.equal |
number | Body mass index - Filter for entries with values not equal to the specified value |
bodyMassIndex.not.exists |
boolean | Body mass index - Filter for entries without a value |
caseId |
string | Patient case - Filter for reference matches |
caseId.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference matches the query |
caseId.beginsWith |
string | Patient case - Filter for entries starting with the text |
caseId.contains |
string | Patient case - Filter for partial text matches |
caseId.endsWith |
string | Patient case - Filter for entries ending with the text |
caseId.not |
string | Patient case - Filter for reference mismatches |
caseId.not.anyOf |
Array<string> | Patient case - Filter for entries where at least one reference mismatches the query |
caseId.not.beginsWith |
string | Patient case - Filter for entries not starting with the text |
caseId.not.contains |
string | Patient case - Filter for partial text mismatches |
caseId.not.endsWith |
string | Patient case - Filter for entries not ending with the text |
createdAt.after |
string(date) | Created at - Filter for entries with dates after the specified value |
createdAt.before |
string(date) | Created at - Filter for entries with dates before the specified value |
createdAt.between |
Array<> | Created at - Filter for entries with dates between two specified values (inclusive) |
createdAt.exists |
boolean | Created at - Filter for entries with a value |
createdAt.not.between |
Array<> | Created at - Filter for entries with dates not between two specified values (inclusive) |
createdAt.not.exists |
boolean | Created at - Filter for entries without a value |
createdAt.not.on |
string(date) | Created at - Filter for entries with dates not matching the specified value |
createdAt.on |
string(date) | Created at - Filter for entries with dates exactly matching the specified value |
createdAt.onOrAfter |
string(date) | Created at - Filter for entries with dates on or after the specified value |
createdAt.onOrBefore |
string(date) | Created at - Filter for entries with dates on or before the specified value |
date.after |
string(date) | Assessment date - Filter for entries with dates after the specified value |
date.before |
string(date) | Assessment date - Filter for entries with dates before the specified value |
date.between |
Array<> | Assessment date - Filter for entries with dates between two specified values (inclusive) |
date.not.between |
Array<> | Assessment date - Filter for entries with dates not between two specified values (inclusive) |
date.not.on |
string(date) | Assessment date - Filter for entries with dates not matching the specified value |
date.on |
string(date) | Assessment date - Filter for entries with dates exactly matching the specified value |
date.onOrAfter |
string(date) | Assessment date - Filter for entries with dates on or after the specified value |
date.onOrBefore |
string(date) | Assessment date - Filter for entries with dates on or before the specified value |
externalSource |
string | External data source - Filter for full text matches |
externalSource.anyOf |
Array<string> | External data source - Filter for entries where at least one reference matches the query |
externalSource.beginsWith |
string | External data source - Filter for entries starting with the text |
externalSource.contains |
string | External data source - Filter for partial text matches |
externalSource.endsWith |
string | External data source - Filter for entries ending with the text |
externalSource.exists |
boolean | External data source - Filter for entries with a value |
externalSource.not |
string | External data source - Filter for full text mismatches |
externalSource.not.anyOf |
Array<string> | External data source - Filter for entries where at least one reference mismatches the query |
externalSource.not.beginsWith |
string | External data source - Filter for entries not starting with the text |
externalSource.not.contains |
string | External data source - Filter for partial text mismatches |
externalSource.not.endsWith |
string | External data source - Filter for entries not ending with the text |
externalSource.not.exists |
boolean | External data source - Filter for entries without a value |
height.between |
Array<> | Height - Filter for entries with values between two specified values (inclusive) |
height.equal |
number | Height - Filter for entries with values exactly equal to the specified value |
height.exists |
boolean | Height - Filter for entries with a value |
height.greaterThan |
number | Height - Filter for entries with values greater than the specified value |
height.greaterThanOrEqual |
number | Height - Filter for entries with values greater than or equal to the specified value |
height.lessThan |
number | Height - Filter for entries with values less than the specified value |
height.lessThanOrEqual |
number | Height - Filter for entries with values less than or equal to the specified value |
height.not.between |
Array<> | Height - Filter for entries with values between two specified values (inclusive) |
height.not.equal |
number | Height - Filter for entries with values not equal to the specified value |
height.not.exists |
boolean | Height - Filter for entries without a value |
id |
string | Id - Filter for full text matches |
id.anyOf |
Array<string> | Id - Filter for entries where at least one reference matches the query |
id.beginsWith |
string | Id - Filter for entries starting with the text |
id.contains |
string | Id - Filter for partial text matches |
id.endsWith |
string | Id - Filter for entries ending with the text |
id.not |
string | Id - Filter for full text mismatches |
id.not.anyOf |
Array<string> | Id - Filter for entries where at least one reference mismatches the query |
id.not.beginsWith |
string | Id - Filter for entries not starting with the text |
id.not.contains |
string | Id - Filter for partial text mismatches |
id.not.endsWith |
string | Id - Filter for entries not ending with the text |
temperature.between |
Array<> | Temperature - Filter for entries with values between two specified values (inclusive) |
temperature.equal |
number | Temperature - Filter for entries with values exactly equal to the specified value |
temperature.exists |
boolean | Temperature - Filter for entries with a value |
temperature.greaterThan |
number | Temperature - Filter for entries with values greater than the specified value |
temperature.greaterThanOrEqual |
number | Temperature - Filter for entries with values greater than or equal to the specified value |
temperature.lessThan |
number | Temperature - Filter for entries with values less than the specified value |
temperature.lessThanOrEqual |
number | Temperature - Filter for entries with values less than or equal to the specified value |
temperature.not.between |
Array<> | Temperature - Filter for entries with values between two specified values (inclusive) |
temperature.not.equal |
number | Temperature - Filter for entries with values not equal to the specified value |
temperature.not.exists |
boolean | Temperature - Filter for entries without a value |
updatedAt.after |
string(date) | Updated at - Filter for entries with dates after the specified value |
updatedAt.before |
string(date) | Updated at - Filter for entries with dates before the specified value |
updatedAt.between |
Array<> | Updated at - Filter for entries with dates between two specified values (inclusive) |
updatedAt.exists |
boolean | Updated at - Filter for entries with a value |
updatedAt.not.between |
Array<> | Updated at - Filter for entries with dates not between two specified values (inclusive) |
updatedAt.not.exists |
boolean | Updated at - Filter for entries without a value |
updatedAt.not.on |
string(date) | Updated at - Filter for entries with dates not matching the specified value |
updatedAt.on |
string(date) | Updated at - Filter for entries with dates exactly matching the specified value |
updatedAt.onOrAfter |
string(date) | Updated at - Filter for entries with dates on or after the specified value |
updatedAt.onOrBefore |
string(date) | Updated at - Filter for entries with dates on or before the specified value |
weight.between |
Array<> | Weight - Filter for entries with values between two specified values (inclusive) |
weight.equal |
number | Weight - Filter for entries with values exactly equal to the specified value |
weight.exists |
boolean | Weight - Filter for entries with a value |
weight.greaterThan |
number | Weight - Filter for entries with values greater than the specified value |
weight.greaterThanOrEqual |
number | Weight - Filter for entries with values greater than or equal to the specified value |
weight.lessThan |
number | Weight - Filter for entries with values less than the specified value |
weight.lessThanOrEqual |
number | Weight - Filter for entries with values less than or equal to the specified value |
weight.not.between |
Array<> | Weight - Filter for entries with values between two specified values (inclusive) |
weight.not.equal |
number | Weight - Filter for entries with values not equal to the specified value |
weight.not.exists |
boolean | Weight - Filter for entries without a value |
VitalsPartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
bloodPressureDiastolic |
Diastolic blood pressure of the patient | |
bloodPressureSystolic |
Systolic blood pressure of the patient | |
bodyMassIndex |
Bodymass index of the patient | |
caseId |
string(uuid) | Indicates the case of the patient who's vitals are assesed |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the vitals were recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
height |
Height of the patient | |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
temperature |
Temperature of the patient | |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
weight |
Weight of the patient |
WilmsStage¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
description |
string | Human-readable description |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
CodedConcept | The value of the Wilms stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
WilmsStageCreate¶
| Name | Type | Description |
|---|---|---|
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
stage |
CodedConcept | The value of the Wilms stage |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
WilmsStagePartial¶
| Name | Type | Description |
|---|---|---|
anonymized |
boolean | Whether the data has been anonymized |
caseId |
string(uuid) | Indicates the case of the patient who's cancer is staged |
createdAt |
string(date-time) | Date-time when the resource was created |
createdBy |
string | Username of the user who created the resource |
date |
string(date) | Clinically-relevant date at which the staging was performed and recorded. |
externalSource |
string | The digital source of the data, relevant for automated data |
externalSourceId |
string | The data identifier at the digital source of the data, relevant for automated data |
id |
string(uuid) | Unique identifier of the resource (UUID v4). |
stage |
The value of the Wilms stage | |
stagedEntitiesIds |
Array<string(uuid)> | References to the neoplastic entities that were the focus of the staging. |
stagingDomain |
string | Staging domain discriminator category |
updatedAt |
string(date-time) | Date-time when the resource was last updated |
updatedBy |
Array<string> | Usernames of the users who have updated the resource |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| XSessionTokenAuth | apiKey |
runner