Snowstorm

https://snomedbrowser.org/snowstorm/snomed-ct/
Admin
Snowstorm is a SNOMED CT Terminology Server REST API that provides access to SNOMED CT terminology...
Tokens:21,283
Snippets:111
Trust Score:4.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Build Information

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves the software build version and timestamp.

```APIDOC
## GET /version

### Description
Retrieves the software build version and timestamp.

### Method
GET

### Endpoint
/version

### Response
#### Success Response (200)
- Returns a BuildVersion object.

#### Response Example
{
  "example": "{\n  \"version\": \"1.0.0\",\n  \"timestamp\": \"2023-10-27T10:00:00Z\"\n}"
}
```

--------------------------------

### Get All Dependencies

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves all dependencies for a specified code system, including their version information. This is crucial for understanding relationships and planning upgrades.

```APIDOC
## GET /codesystems/{shortName}/dependencies

### Description
Retrieves all existing dependencies for the specified code system, including their version information. This endpoint provides a complete view of what other code systems the specified code system depends on, which is essential for understanding dependency relationships and planning upgrades.

### Method
GET

### Endpoint
/codesystems/{shortName}/dependencies

#### Path Parameters
- **shortName** (string) - Required - The code system to retrieve dependencies for.

### Response
#### Success Response (200)
- **Array of DependencyInfo objects** - Each object contains `codeSystem` (string) and `version` (string).

**Special Cases:**
- **SNOMEDCT**: Returns an empty array `[]`.
- **Non-existent code systems**: Returns HTTP 404 Not Found.
- **System errors**: Returns HTTP 500 Internal Server Error.
```

--------------------------------

### Get New Concepts

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of new concepts created on a given branch.

```APIDOC
## GET /{branch}/authoring-stats/new-concepts

### Description
Retrieve new concepts from a branch.

### Method
GET

### Endpoint
/{branch}/authoring-stats/new-concepts

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch path.

### Response
#### Success Response (200)
- The response is an array of ConceptMicro objects.
```

--------------------------------

### Get Reactivated Synonyms

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of reactivated synonyms for a given branch.

```APIDOC
## GET /{branch}/authoring-stats/reactivated-synonyms

### Description
Retrieve reactivated synonyms from a branch.

### Method
GET

### Endpoint
/{branch}/authoring-stats/reactivated-synonyms

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch path.

### Response
#### Success Response (200)
- The response is an array of ConceptMicro objects.
```

--------------------------------

### Get All Dependencies for a Code System

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves all dependencies for a specified code system, including their version information. SNOMEDCT, as the root code system, has no dependencies and will return an empty array.

```http
GET /codesystems/SNOMEDCT-LOINC/dependencies HTTP/1.1
Host: localhost:8080
Accept: application/json
```

--------------------------------

### Get Concept Preview

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a preview of a concept, including classification changes applied to it on a specific branch. Language preferences are supported.

```APIDOC
## GET /{branch}/classifications/{classificationId}/concept-preview/{conceptId}

### Description
Retrieve a preview of a concept with classification changes applied.

### Method
GET

### Endpoint
/{branch}/classifications/{classificationId}/concept-preview/{conceptId}

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch path.
- **classificationId** (string) - Required - The classification identifier.
- **conceptId** (string) - Required - The concept identifier.

#### Query Parameters
- **Accept-Language** (string) - Optional - The preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- The response contains the concept preview, conforming to ConceptView_Component schema.
```

--------------------------------

### Get New Descriptions

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of new descriptions added on a given branch. Supports filtering for unpromoted changes only and language preferences.

```APIDOC
## GET /{branch}/authoring-stats/new-descriptions

### Description
Retrieve new descriptions from a branch.

### Method
GET

### Endpoint
/{branch}/authoring-stats/new-descriptions

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch path.

#### Query Parameters
- **unpromotedChangesOnly** (boolean) - Optional - Filter for only unpromoted changes. Defaults to false.
- **Accept-Language** (string) - Optional - The preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- The response is an array of DescriptionMicro objects.
```

--------------------------------

### Get Equivalent Concepts

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves equivalent concepts identified during a classification run on a specified branch. Supports pagination and language preferences.

```APIDOC
## GET /{branch}/classifications/{classificationId}/equivalent-concepts

### Description
Retrieve equivalent concepts from a classification run on a branch.

### Method
GET

### Endpoint
/{branch}/classifications/{classificationId}/equivalent-concepts

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch path.
- **classificationId** (string) - Required - The classification identifier.

#### Query Parameters
- **offset** (integer) - Optional - The offset for pagination. Defaults to 0.
- **limit** (integer) - Optional - The limit for pagination. Defaults to 1000.
- **Accept-Language** (string) - Optional - The preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- The response contains a page of equivalent concepts, conforming to ItemsPageEquivalentConceptsResponse schema.
```

--------------------------------

### Get New Synonyms on Existing Concepts

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of new synonyms added to existing concepts on a given branch.

```APIDOC
## GET /{branch}/authoring-stats/new-synonyms-on-existing-concepts

### Description
Retrieve new synonyms on existing concepts from a branch.

### Method
GET

### Endpoint
/{branch}/authoring-stats/new-synonyms-on-existing-concepts

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch path.

### Response
#### Success Response (200)
- The response is an array of ConceptMicro objects.
```

--------------------------------

### Get Authoring Statistics

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Calculates statistics for unreleased/unversioned content on a branch, intended for use in the daily build browser. This endpoint does not work on versioned content.

```APIDOC
## GET /{branch}/authoring-stats

### Description
Calculate statistics for unreleased/unversioned content to be used in daily build browser. Does not work on versioned content.

### Method
GET

### Endpoint
/{branch}/authoring-stats

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch path.

### Response
#### Success Response (200)
- The response contains authoring statistics, conforming to AuthoringStatsSummary schema.
```

--------------------------------

### Get Export Job

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves details of an export job.

```APIDOC
## GET /exports/{exportId}

### Description
Retrieves details of an export job.

### Method
GET

### Endpoint
/exports/{exportId}

### Parameters
#### Path Parameters
- **exportId** (string) - Required - The ID of the export job to retrieve.

### Response
#### Success Response (200)
- **ExportConfiguration** - An object representing the export job configuration.
```

--------------------------------

### Get Import Job

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves the latest state of an import job, including its configuration and status.

```APIDOC
## GET /imports/{importId}

### Description
Retrieves the latest state of an import job. Used to view the import configuration and check its status.

### Method
GET

### Endpoint
/imports/{importId}

### Parameters
#### Path Parameters
- **importId** (string) - Required - The ID of the import job to retrieve.

### Response
#### Success Response (200)
- **ImportJob** - An object representing the import job.
```

--------------------------------

### Get Inactivated Synonyms

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of concepts that have inactivated synonyms within a specified branch.

```APIDOC
## GET /{branch}/authoring-stats/inactivated-synonyms

### Description
Retrieves a list of concepts that have inactivated synonyms within a specified branch.

### Method
GET

### Endpoint
/{branch}/authoring-stats/inactivated-synonyms

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to query for inactivated synonyms.

### Response
#### Success Response (200)
- Returns an array of ConceptMicro objects.

#### Response Example
{
  "example": "[\n  {\n    \"conceptId\": \"6789012\",\n    \"fsn\": \"Another Example Concept (Synonym)\"\n  }\n]"
}
```

--------------------------------

### GET /{branch}/members

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Searches for reference set members based on various criteria.

```APIDOC
## GET /{branch}/members

### Description
Searches for reference set members based on various criteria.

### Method
GET

### Endpoint
`/{branch}/members`

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to search within.

#### Query Parameters
- **referenceSet** (string) - Optional - A reference set identifier or ECL expression to limit the search. Example: `<723564002`.
- **module** (string) - Optional - A concept identifier or ECL expression to limit the modules searched. Example: `<900000000000445007`.
- **referencedComponentId** (array of strings) - Optional - Set of referencedComponentId ids to limit search.
- **active** (boolean) - Optional - Filters by active members.
- **isNullEffectiveTime** (boolean) - Optional - Filters by members with null effective time.
- **targetComponent** (array of strings) - Optional - Set of target component ids to limit search.
- **mapTarget** (string) - Optional - Filters by map target.
- **owlExpression.conceptId** (string) - Optional - Search by concept identifiers within an owlExpression.
- **owlExpression.gci** (string) - Optional - Return axiom members with a GCI.

### Response
#### Success Response (200)
- **(ItemsPageRefsetMember_Component)** - OK
```

--------------------------------

### Get Concept Authoring Form

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves the authoring form for a given concept in a specified branch, which represents the concept's structure and attributes for authoring purposes.

```APIDOC
## GET /{branch}/concepts/{conceptId}/authoring-form

### Description
Retrieves the authoring form for a given concept in a specified branch, which represents the concept's structure and attributes for authoring purposes.

### Method
GET

### Endpoint
/{branch}/concepts/{conceptId}/authoring-form

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch containing the concept.
- **conceptId** (string) - Required - The ID of the concept.

#### Headers
- **Accept-Language** (string) - Optional - Specifies the preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- The response will contain an Expression object.
```

--------------------------------

### GET /{branch}/relationships/{relationshipId}

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Fetches a specific relationship by its ID.

```APIDOC
## GET /{branch}/relationships/{relationshipId}

### Description
Fetches a specific relationship by its ID.

### Method
GET

### Endpoint
`/{branch}/relationships/{relationshipId}`

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to search within.
- **relationshipId** (string) - Required - The ID of the relationship to fetch.

#### Header Parameters
- **Accept-Language** (string) - Optional - Specifies the preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- **(Relationship_Component)** - OK
```

--------------------------------

### Get Compatible Dependent Versions

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of compatible version dates for a given code system, considering its dependencies. Important restrictions apply to the use of SNOMEDCT in parameters.

```APIDOC
## GET /codesystems/{shortName}/compatible-versions

### Description
Retrieves a list of compatible version dates for a given code system, considering its dependencies. Important restrictions apply to the use of SNOMEDCT in parameters.

### Method
GET

### Endpoint
/codesystems/{shortName}/compatible-versions

### Parameters
#### Path Parameters
- **shortName** (string) - Required - The short name of the code system.

#### Query Parameters
- **with** (string) - Optional - Additional code system short names to include in compatibility checking. Restrictions: The main code system (`shortName`) must NOT be SNOMEDCT. Any additional code systems in the `with` parameter must NOT be SNOMEDCT. SNOMEDCT is automatically included as a dependency and cannot be specified manually.

### Response
#### Success Response (200)
- **compatibleVersions** (array[string]) - A list of compatible version dates.

### Response Example
```json
{
  "compatibleVersions": ["20250801", "20250901", "20251001"]
}
```

### Error Cases
- Returns empty list if no dependent version is configured for the code system.
- Returns HTTP 400 if SNOMEDCT is specified in parameters.
- Returns HTTP 404 if the specified code system doesn't exist.
```

--------------------------------

### Get Compatible Dependent Versions

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves compatible versions for a given code system, excluding SNOMEDCT. Useful for checking version compatibility in a project.

```http
GET /codesystems/http%3A%2F%2Fsnomed.info%2Fsct/compatible-versions?with=http%3A%2F%2Fsnomed.info%2Ficd10cm&with=http%3A%2F%2Fsnomed.info%2Ficd10
GET /codesystems/http%3A%2F%2Fsnomed.info%2Fsct/compatible-versions?with=http%3A%2F%2Fsnomed.info%2Ficd10cm
```

--------------------------------

### Get Reactivated Concepts

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of reactivated concepts for a given branch. Supports language preferences.

```APIDOC
## GET /{branch}/authoring-stats/reactivated-concepts

### Description
Retrieve reactivated concepts from a branch.

### Method
GET

### Endpoint
/{branch}/authoring-stats/reactivated-concepts

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch path.

#### Query Parameters
- **Accept-Language** (string) - Optional - The preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- The response is an array of ConceptMicro objects.
```

--------------------------------

### Get New Concepts

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of new concepts within a specified branch. It can optionally filter for unpromoted changes only.

```APIDOC
## GET /{branch}/authoring-stats/new-concepts

### Description
Retrieves a list of new concepts within a specified branch. It can optionally filter for unpromoted changes only.

### Method
GET

### Endpoint
/{branch}/authoring-stats/new-concepts

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to query for new concepts.

#### Query Parameters
- **unpromotedChangesOnly** (boolean) - Optional - Defaults to false. If true, only unpromoted changes are returned.
- **Accept-Language** (string) - Optional - Defaults to "en-X-900000000000509007,en-X-900000000000508004,en". Specifies the preferred language for the response.

### Response
#### Success Response (200)
- Returns an array of ConceptMicro objects.

#### Response Example
{
  "example": "[\n  {\n    \"conceptId\": \"1234567\",\n    \"fsn\": \"Example Concept (Core Metadata Concept)\"\n  }\n]"
}
```

--------------------------------

### GET /{branch}/relationships

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of relationships based on specified filters.

```APIDOC
## GET /{branch}/relationships

### Description
Retrieves a list of relationships based on specified filters.

### Method
GET

### Endpoint
`/{branch}/relationships`

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to search within.

#### Query Parameters
- **active** (boolean) - Optional - Filters by active relationships.
- **module** (string) - Optional - Filters by module.
- **effectiveTime** (string) - Optional - Filters by effective time.
- **source** (string) - Optional - Filters by source concept.
- **type** (string) - Optional - Filters by relationship type.
- **destination** (string) - Optional - Filters by destination concept.
- **characteristicType** (string) - Optional - Filters by characteristic type (STATED_RELATIONSHIP, INFERRED_RELATIONSHIP, ADDITIONAL_RELATIONSHIP).
- **group** (integer) - Optional - Filters by relationship group.
- **offset** (integer) - Optional - The offset for pagination. Defaults to 0.
- **limit** (integer) - Optional - The limit for pagination. Defaults to 50.
- **Accept-Language** (string) - Optional - Specifies the preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- **(ItemsPageRelationship_Component)** - OK
```

--------------------------------

### Get Inactivated Concepts

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of inactivated concepts within a specified branch. Language preferences can be set via the Accept-Language header.

```APIDOC
## GET /{branch}/authoring-stats/inactivated-concepts

### Description
Retrieves a list of inactivated concepts within a specified branch. Language preferences can be set via the Accept-Language header.

### Method
GET

### Endpoint
/{branch}/authoring-stats/inactivated-concepts

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to query for inactivated concepts.

#### Query Parameters
- **Accept-Language** (string) - Optional - Defaults to "en-X-900000000000509007,en-X-900000000000508004,en". Specifies the preferred language for the response.

### Response
#### Success Response (200)
- Returns an array of ConceptMicro objects.

#### Response Example
{
  "example": "[\n  {\n    \"conceptId\": \"3456789\",\n    \"fsn\": \"Inactivated Example Concept\"\n  }\n]"
}
```

--------------------------------

### Get Compatible International Versions for Dependencies

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Finds compatible International (SNOMEDCT) versions for a given code system and any additional specified code systems. This is crucial for determining safe versions for upgrades and managing dependencies.

```http
GET /codesystems/SNOMEDCT-LOINC/dependencies/compatible-versions?with=SNOMEDCT-ICD10 HTTP/1.1
Host: localhost:8080
Accept: application/json
```

--------------------------------

### Get ECL Cache Statistics

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves statistics for the ECL (Expression Constraint Language) cache. This endpoint provides insights into the performance and usage of the ECL cache.

```APIDOC
## GET /admin/cache/ecl/stats

### Description
Retrieves statistics for the ECL cache.

### Method
GET

### Endpoint
/admin/cache/ecl/stats

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **object** (object) - An object where keys are cache names and values are objects containing integer statistics.

#### Response Example
```json
{
  "eclCache": {
    "loadCount": 100,
    "hitCount": 50,
    "missCount": 50
  }
}
```
```

--------------------------------

### Get Counts of Various Component Types Per Module ID

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves counts for different component types, categorized by module ID within a specified branch.

```APIDOC
## GET /{branch}/authoring-stats/module-counts

### Description
Retrieves counts for different component types, categorized by module ID within a specified branch.

### Method
GET

### Endpoint
/{branch}/authoring-stats/module-counts

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to retrieve module counts from.

### Response
#### Success Response (200)
- Returns an object where keys are module IDs and values are objects containing component type counts (integer).

#### Response Example
{
  "example": "{\n  \"900000000000207008\": {\n    \"concepts\": 100,\n    \"descriptions\": 500\n  }\n}"
}
```

--------------------------------

### Get Compatible International Versions

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Finds compatible International (SNOMEDCT) versions for a code system and any additional specified code systems. Essential for determining safe versions during upgrades.

```APIDOC
## GET /codesystems/{shortName}/dependencies/compatible-versions

### Description
Finds all International (SNOMEDCT code system) versions that are compatible with the specified code system and any additional code systems provided. This endpoint is essential for determining which International versions can be safely used when upgrading or managing additional code system dependencies.

### Method
GET

### Endpoint
/codesystems/{shortName}/dependencies/compatible-versions

#### Path Parameters
- **shortName** (string) - Required - The code system to check dependencies for (must be an extension, not SNOMEDCT).

#### Query Parameters
- **with** (string) - Optional - Comma-separated list of additional code systems to check compatibility against.
```

--------------------------------

### Get Concept Normal Form

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves the normal form expression for a given concept in a specified branch. This can be viewed in its stated form or as inferred by the reasoner, and can optionally include terms.

```APIDOC
## GET /{branch}/concepts/{conceptId}/normal-form

### Description
Retrieves the normal form expression for a given concept in a specified branch. This can be viewed in its stated form or as inferred by the reasoner, and can optionally include terms.

### Method
GET

### Endpoint
/{branch}/concepts/{conceptId}/normal-form

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch containing the concept.
- **conceptId** (string) - Required - The ID of the concept.

#### Query Parameters
- **statedView** (boolean) - Optional - If true, returns the stated form. Defaults to false.
- **includeTerms** (boolean) - Optional - If true, includes concept terms in the response. Defaults to false.

#### Headers
- **Accept-Language** (string) - Optional - Specifies the preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- The response will contain an ExpressionStringPojo object.
```

--------------------------------

### Get Merge Review

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a specific merge review by its ID.

```APIDOC
## GET /merge-reviews/{id}

### Description
Retrieves a specific merge review by its ID.

### Method
GET

### Endpoint
/merge-reviews/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the merge review to retrieve.

### Response
#### Success Response (200)
- **MergeReview** - An object representing the merge review.
```

--------------------------------

### Retrieve Versions of a Code System

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Fetches all versions for a given code system. Options are available to include future versions and internal releases.

```http
GET /codesystems/SNOMEDCT/versions?showFutureVersions=true&showInternalReleases=true HTTP/1.1
Host: localhost:8080
Accept: application/json
```

--------------------------------

### Get Branch Review

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves details of a specific branch review by its ID.

```APIDOC
## GET /reviews/{id}

### Description
Retrieves details of a specific branch review by its ID.

### Method
GET

### Endpoint
/reviews/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the branch review to retrieve.

### Response
#### Success Response (200)
- Returns a BranchReview object.

#### Response Example
{
  "example": "{\n  \"id\": \"review-123\",\n  \"status\": \"completed\"\n}"
}
```

--------------------------------

### Check Daily Build Match

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Verifies if the latest daily build import for a code system matches the current date. Returns a boolean indicating the match status.

```http
GET /codesystems/http%3A%2F%2Fsnomed.info%2Fsct/daily-build/check
```

--------------------------------

### List Code Systems

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Lists all available code systems. The 'forBranch' parameter can be used to find the code system associated with a specified branch.

```APIDOC
## GET /codesystems

### Description
List all code systems.
'forBranch' is an optional parameter to find the code system which the specified branch is associated with.

### Method
GET

### Endpoint
/codesystems

### Parameters
#### Query Parameters
- **forBranch** (string) - Optional - The branch to find the associated code system for.
```

--------------------------------

### Find All Versions

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves all versions for a given code system. Allows filtering to include future versions and internal releases.

```APIDOC
## GET /codesystems/{shortName}/versions

### Description
Retrieves all versions for a given code system. You can optionally show versions with future effective times and internal releases.

### Method
GET

### Endpoint
/codesystems/{shortName}/versions

#### Path Parameters
- **shortName** (string) - Required - The short name of the code system.

#### Query Parameters
- **showFutureVersions** (boolean) - Optional - Should versions with a future effective-time be shown.
- **showInternalReleases** (boolean) - Optional - Should versions marked as 'internalRelease' be shown.

### Response
#### Success Response (200)
- **ItemsPageCodeSystemVersion** - A pageable collection of code system versions.
```

--------------------------------

### Check Latest Daily Build

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Checks if the daily build import for a given code system matches today's date.

```APIDOC
## GET /codesystems/{shortName}/daily-build/check

### Description
Checks if the daily build import for a given code system matches today's date.

### Method
GET

### Endpoint
/codesystems/{shortName}/daily-build/check

### Parameters
#### Path Parameters
- **shortName** (string) - Required - The short name of the code system.

### Response
#### Success Response (200)
- (boolean) - True if the daily build matches today's date, false otherwise.
```

--------------------------------

### Retrieve a Code System

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Fetches details for a specific code system identified by its short name.

```http
GET /codesystems/SNOMEDCT HTTP/1.1
Host: localhost:8080
Accept: application/json
```

--------------------------------

### Retrieve All Permissions

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of all permissions, including global roles and user groups, as well as those set on specific branches.

```APIDOC
## GET /admin/permissions

### Description
Retrieves all permissions, including global and branch-specific roles and user groups.

### Method
GET

### Endpoint
/admin/permissions

### Response
#### Success Response (200)
- An array of PermissionRecord_Component objects detailing all permissions.
```

--------------------------------

### Load Concepts

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Loads concepts from the browser format, supporting pagination and searching after a specific point. This is useful for retrieving lists of concepts or paginating through large sets.

```APIDOC
## GET /browser/{branch}/concepts

### Description
Loads concepts from the browser format, supporting pagination and searching after a specific point. This is useful for retrieving lists of concepts or paginating through large sets.

### Method
GET

### Endpoint
/browser/{branch}/concepts

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to load concepts from.

#### Query Parameters
- **conceptIds** (array[integer]) - Optional - A list of concept IDs to load.
- **number** (integer) - Optional - The page number to retrieve (default is 0).
- **size** (integer) - Optional - The number of concepts per page (default is 100).
- **searchAfter** (string) - Optional - A token for fetching the next page of results, used for unlimited pagination.

#### Headers
- **Accept-Language** (string) - Optional - The preferred language for the response.

### Response
#### Success Response (200)
- **items** (array) - A list of concepts.
- **searchAfter** (string) - A token for fetching the next page of results.

#### Response Example
{
  "items": [
    {
      "conceptId": "138875005",
      "fsn": "Disorder of gallbladder (disorder)",
      "pt": {
        "term": "Gallbladder disorder",
        "descriptionId": "907700007"
      }
    }
  ],
  "searchAfter": "some-opaque-string"
}
```

--------------------------------

### Get Merge Review Conflicting Concepts

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves conflicting concepts for a merge review, with language preference.

```APIDOC
## GET /merge-reviews/{id}/details

### Description
Retrieves conflicting concepts for a merge review.

### Method
GET

### Endpoint
/merge-reviews/{id}/details

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the merge review.

#### Query Parameters
- **Accept-Language** (string) - Optional - The preferred language for the response. Defaults to en-X-900000000000509007,en-X-900000000000508004,en.

### Response
#### Success Response (200)
- **array[MergeReviewConceptVersions]** - An array of objects representing conflicting concept versions.
```

--------------------------------

### GET /{branch}/report/inactive-concepts-without-association

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Finds inactive concepts that lack a historical association, grouped by their inactivation type.

```APIDOC
## GET /{branch}/report/inactive-concepts-without-association

### Description
Finds inactive concepts that lack a historical association, grouped by their inactivation type.

### Method
GET

### Endpoint
`/{branch}/report/inactive-concepts-without-association`

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to search within.

#### Query Parameters
- **conceptEffectiveTime** (string) - Optional - Filters concepts by their effective time.

### Response
#### Success Response (200)
- **(array of InactivationTypeAndConceptIdList_Component)** - OK
```

--------------------------------

### Get Branch Review Concept Changes

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves the concept changes associated with a specific branch review by its ID.

```APIDOC
## GET /reviews/{id}/concept-changes

### Description
Retrieves the concept changes associated with a specific branch review by its ID.

### Method
GET

### Endpoint
/reviews/{id}/concept-changes

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the branch review.

### Response
#### Success Response (200)
- Returns a BranchReviewConceptChanges object.

#### Response Example
{
  "example": "{\n  \"added\": [\"concept-1\"],\n  \"modified\": [\"concept-2\"],\n  \"removed\": [\"concept-3\"]\n}"
}
```

--------------------------------

### List Code Systems

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a paginated list of all code systems available in the system. The `includeContentInfo` parameter controls whether detailed branch-derived fields and user permission information are populated. Setting it to `false` can reduce Elasticsearch load when this information is not needed.

```http
GET /codesystems?forBranch=MAIN&includeContentInfo=true HTTP/1.1
Host: localhost:8080
Accept: application/json
```

--------------------------------

### Fetch Description

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a specific description for a concept within a given branch, identified by its unique description ID.

```APIDOC
## GET /{branch}/descriptions/{descriptionId}

### Description
Retrieves a specific description for a concept within a given branch.

### Method
GET

### Endpoint
`/{branch}/descriptions/{descriptionId}`

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to search within.
- **descriptionId** (string) - Required - The ID of the description to fetch.

### Response
#### Success Response (200)
- **Description_Component** - OK
```

--------------------------------

### Import Job Configuration

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Defines the configuration for an import job, specifying the type of import, branch path, and other relevant settings.

```APIDOC
## Import Job Configuration

### Description
Defines the configuration for an import job.

### Type
`object`

### Properties
- **status** (string) - Enum: "WAITING_FOR_FILE", "RUNNING", "COMPLETED", "FAILED" - The current status of the import job.
- **errorMessage** (string) - Details about any error that occurred during the import.
- **type** (string) - Enum: "DELTA", "SNAPSHOT", "FULL" - The type of import to perform.
- **branchPath** (string) - The path of the branch to import into.
- **internalRelease** (boolean) - Whether this is an internal release.
- **moduleIds** (array) - Unique list of module IDs to include in the import.
  - items: (string)
- **createCodeSystemVersion** (boolean) - Whether to create a new code system version.
- **patchReleaseVersion** (integer) - The version number for a patch release.
```

--------------------------------

### Get Relationship Changes

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves relationship changes made by a classification run on a specific branch. Supports pagination and language preferences.

```APIDOC
## GET /{branch}/classifications/{classificationId}/relationship-changes

### Description
Retrieves relationship changes made by a classification run on a branch.

### Method
GET

### Endpoint
/{branch}/classifications/{classificationId}/relationship-changes

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch path.
- **classificationId** (string) - Required - The classification identifier.

#### Query Parameters
- **offset** (integer) - Optional - The offset for pagination. Defaults to 0.
- **limit** (integer) - Optional - The limit for pagination. Defaults to 1000.
- **Accept-Language** (string) - Optional - The preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- The response contains a page of relationship changes, conforming to ItemsPageRelationshipChange schema.
```

--------------------------------

### Retrieve Upgrade Job

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves the state of a code system upgrade job, including its configuration and status.

```APIDOC
## GET /codesystems/upgrade/{jobId}

### Description
Retrieves the state of a code system upgrade job. Used to view the upgrade configuration and check its status.

### Method
GET

### Endpoint
/codesystems/upgrade/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The ID of the upgrade job.

### Response
#### Success Response (200)
- (CodeSystemUpgradeJob) - The state of the upgrade job.
```

--------------------------------

### List Code Systems

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a paginated list of all code systems available in the terminology server. Supports filtering by branch and controlling the inclusion of content information.

```APIDOC
## GET /codesystems

### Description
Retrieves a paginated list of all code systems. The `includeContentInfo` parameter controls whether branch-derived fields and user permission information are populated. Defaults to true for backwards compatibility; set to false to reduce Elasticsearch load when these fields are not needed.

### Method
GET

### Endpoint
/codesystems

#### Query Parameters
- **forBranch** (string) - Optional - Specifies a branch to filter code systems by.
- **includeContentInfo** (boolean) - Optional - Defaults to true. If false, the response returns lean code system objects without content information and permissions.

### Response
#### Success Response (200)
- **ItemsPageCodeSystem** - A pageable collection of code system objects.
```

--------------------------------

### Retrieve All Branches

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves a list of all available branches within the Snowstorm system. This endpoint is useful for understanding the branching structure.

```APIDOC
## GET /branches

### Description
Retrieves all branches within the Snowstorm system.

### Method
GET

### Endpoint
/branches

### Response
#### Success Response (200)
- An array of Branch objects representing all available branches.
```

--------------------------------

### Find Descriptions

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves descriptions based on provided filters.

```APIDOC
## GET /{branch}/descriptions

### Description
Retrieves descriptions based on provided filters.

### Method
GET

### Endpoint
/{branch}/descriptions

### Parameters
#### Query Parameters
- **descriptionIds** (array of strings) - Optional - Set of description ids to match
- **conceptId** (string) - Optional - The concept id to match
- **conceptIds** (array of strings) - Optional - Set of concept ids to match
```

--------------------------------

### Find Browser Descriptions

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Searches for concept descriptions within a specified branch. Allows filtering by term, active status, module, language, and description type. The Accept-Language header influences result language.

```http
GET /browser/MAIN/descriptions?term=diabetes&active=true&module=900000000000445007&language=en&type=900000000000447001
GET /browser/MAIN/descriptions?term=diabetes&active=true&module=900000000000445007&language=en&type=900000000000447001&searchAfter=some-opaque-cursor
```

--------------------------------

### Find Concept Descriptions

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves descriptions for a specific concept within a given branch, respecting the preferred language.

```APIDOC
## GET /{branch}/concepts/{conceptId}/descriptions

### Description
Retrieves descriptions for a specific concept within a given branch, respecting the preferred language.

### Method
GET

### Endpoint
/{branch}/concepts/{conceptId}/descriptions

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch containing the concept.
- **conceptId** (string) - Required - The ID of the concept.

#### Headers
- **Accept-Language** (string) - Optional - Specifies the preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- The response will contain a ConceptDescriptionsResult_Component object.
```

--------------------------------

### Retrieve Semantic Tags

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves all available semantic tags. A default language of 'en' is used if not specified.

```APIDOC
## GET /validation-maintenance/semantic-tags

### Description
Retrieves all available semantic tags. A default language of 'en' is used if not specified.

### Method
GET

### Endpoint
/validation-maintenance/semantic-tags

### Parameters
#### Query Parameters
- **language** (string) - Optional - Defaults to "en". The language code for the semantic tags.

### Response
#### Success Response (200)
- Returns an array of strings, where each string is a semantic tag.

#### Response Example
{
  "example": "[\n  \"core\",\n  \"clinical\",\n  \"terminology\"\n]"
}
```

--------------------------------

### Find Browser Descriptions

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Searches for concept descriptions within a specified branch. Allows filtering by term, activity status, module, language, and description type. The Accept-Language header influences language selection for FSN and PT values.

```APIDOC
## GET /browser/{branch}/descriptions

### Description
Searches for concept descriptions within a specified branch. Allows filtering by term, activity status, module, language, and description type. The Accept-Language header influences language selection for FSN and PT values.

### Method
GET

### Endpoint
/browser/{branch}/descriptions

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to search within.

#### Query Parameters
- **term** (string) - Optional - The search term for descriptions.
- **active** (boolean) - Optional - Filter by active status.
- **module** (array[string]) - Optional - Set of module identifiers to limit search.
- **language** (array[string]) - Optional - Set of two-character language codes to match. The English language code 'en' will not be added automatically. Accept-Language header still controls result FSN and PT language selection.
- **type** (array[string]) - Optional - Set of description type IDs to include. Defaults to any. Pick descendants of '900000000000446008 | Description type (core metadata concept) |'.

#### Headers
- **Accept-Language** (string) - Optional - Specifies the user's preferred language for results. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- (object) - A collection of concept descriptions matching the search criteria.
```

--------------------------------

### Get Changed Fully Specified Names

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves concepts with changed fully specified names (FSNs) within a specified branch. Language preferences can be set via the Accept-Language header.

```APIDOC
## GET /{branch}/authoring-stats/changed-fully-specified-names

### Description
Retrieves concepts with changed fully specified names (FSNs) within a specified branch. Language preferences can be set via the Accept-Language header.

### Method
GET

### Endpoint
/{branch}/authoring-stats/changed-fully-specified-names

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to query for changed FSNs.

#### Query Parameters
- **Accept-Language** (string) - Optional - Defaults to "en-X-900000000000509007,en-X-900000000000508004,en". Specifies the preferred language for the response.

### Response
#### Success Response (200)
- Returns an array of ConceptMicro objects.

#### Response Example
{
  "example": "[\n  {\n    \"conceptId\": \"9876543\",\n    \"fsn\": \"Changed FSN Example Concept\"\n  }\n]"
}
```

--------------------------------

### Find Concept References

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Retrieves references to a specific concept within a given branch. This can include stated or inferred relationships and allows for pagination.

```APIDOC
## GET /{branch}/concepts/{conceptId}/references

### Description
Retrieves references to a specific concept within a given branch. This can include stated or inferred relationships and allows for pagination.

### Method
GET

### Endpoint
/{branch}/concepts/{conceptId}/references

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to search within.
- **conceptId** (integer) - Required - The ID of the concept to find references for.

#### Query Parameters
- **stated** (boolean) - Optional - If true, only consider stated relationships. Defaults to false.
- **offset** (integer) - Optional - The offset for pagination. Defaults to 0.
- **limit** (integer) - Optional - The maximum number of results to return. Defaults to 1000.

#### Headers
- **Accept-Language** (string) - Optional - Specifies the preferred language for the response. Defaults to 'en-X-900000000000509007,en-X-900000000000508004,en'.

### Response
#### Success Response (200)
- The response will contain a ConceptReferencesResult object.
```

--------------------------------

### Retrieve Upgrade Job Status

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Fetches the status and configuration details of a code system upgrade job using its unique ID. Useful for monitoring upgrade processes.

```http
GET /codesystems/upgrade/a1b2c3d4-e5f6-7890-1234-567890abcdef
```

--------------------------------

### Load Concept

Source: https://snomedbrowser.org/snowstorm/snomed-ct/v3/api-docs/snowstorm

Loads a specific concept in the browser format. Supports loading historical versions of a concept using branch versioning.

```APIDOC
## GET /browser/{branch}/concepts/{conceptId}

### Description
Loads a specific concept in the browser format. Supports loading historical versions of a concept using branch versioning.

### Method
GET

### Endpoint
/browser/{branch}/concepts/{conceptId}

### Parameters
#### Path Parameters
- **branch** (string) - Required - The branch to load the concept from. Can include versioning information (e.g., `branch@yyyy-MM-ddTHH:mm:ss.SSSZ` or `branch@-` for the version at branch creation).
- **conceptId** (string) - Required - The ID of the concept to load.

#### Query Parameters
- **descendantCountForm** (string) - Optional - Specifies the form for descendant count (stated/inferred).

#### Headers
- **Accept-Language** (string) - Optional - The preferred language for the response.

### Response
#### Success Response (200)
- **conceptId** (string) - The ID of the concept.
- **fsn** (string) - The Fully Specified Name of the concept.
- **pt** (object) - The preferred term for the concept.
  - **term** (string) - The preferred term.
  - **descriptionId** (string) - The description ID of the preferred term.

#### Response Example
{
  "conceptId": "138875005",
  "fsn": "Disorder of gallbladder (disorder)",
  "pt": {
    "term": "Gallbladder disorder",
    "descriptionId": "907700007"
  }
}
```
Tokens:
Raw