Ontoserver Management API

Admin

/api/addBundle

POST

Add a bundle of FHIR Resources to the server

Request

Parameters
Name Located in Required Description Default Schema
file query yes A FHIR Bundle object containing a set of resources - ref

Response

**Content-Type: ** application/json

Status Code Reason Response Model
200 successful operation

/api/auditReports

GET

Get all current audit reports

Request

Parameters

Response

**Content-Type: ** application/json, application/fhir+json

Status Code Reason Response Model
200 successful operation

/api/availableCodeSystemIndexes

GET

Get a list of the code system indexes that are available to this server

Request

Parameters

Response

**Content-Type: ** application/json

Status Code Reason Response Model
200 successful operation Array[AtomArtifact]

/api/availableCodeSystemSources

GET

Get a list of the code system sources that are available to this server

Request

Parameters

Response

**Content-Type: ** application/json

Status Code Reason Response Model
200 successful operation Array[AtomArtifact]

/api/deleteCodeSystem

POST

Remove a SNOMED/LOINC code system

Request

Parameters
Name Located in Required Description Default Schema
codeSystemId query yes A code system identifier, e.g. http://snomed.info/sct - string
codeSystemVersion query yes The version of the specified code system - string

Response

Status Code Reason Response Model

| default | successful operation | - |

/api/indexCodeSystem

POST

Index a SNOMED/LOINC code system, using a syndication server if available

Request

Parameters
Name Located in Required Description Default Schema
codeSystemId query yes A code system identifier, e.g. http://snomed.info/sct - string
codeSystemVersion query yes The version of the specified code system - string
validate query yes Indicates whether the server should validate the index if it already exists - boolean
buildLocal query no Do not use BINARY indexes from syndication feed, but build them locally - boolean

Response

Status Code Reason Response Model
200 successful operation

/api/indexedCodeSystems

GET

Get a list of the code systems that are indexed on this server

Request

Parameters

Response

**Content-Type: ** application/json

Status Code Reason Response Model
200 successful operation Array[CodeSystem]

/api/sct/addRf2

POST

Loads RF2 content into the underlying database. Does not build an index - see /api/indexCodeSystem

Note: under consideration for deprecation

Request

Parameters
Name Located in Required Description Default Schema
file query yes The ZIP file containing RF2 packaged according to IHTSDO conventions - ref
type query yes The release type. One of SCT_RF2_FULL, SCT_RF2_ALL, or SCT_RF2_SNAPSHOT. - string

Response

**Content-Type: ** application/json

Status Code Reason Response Model
200 successful operation

Syndication

/synd/fetchSyndicatedContentEntry

POST

Fetch an artifact from the upstream syndication feed into the server

Request

Parameters
Name Located in Required Description Default Schema
entryId query yes The atom entry ID to fetch - string

Response

Status Code Reason Response Model

| default | successful operation | - |

/synd/getBinaryIndexZip

GET

Retrieve the binary index for a code system from the server (if available)

Request

Parameters
Name Located in Required Description Default Schema
codeSystemId query yes A code system identifier, e.g. http://snomed.info/sct - string
codeSystemVersion query yes The version of the specified code system - string
indexVersion query yes The internal version of the binary index format - string

Response

**Content-Type: ** application/zip

Status Code Reason Response Model
200 successful operation Array[]

/synd/setIndexSyndicationStatus

POST

Change the downstream syndication status for a SNOMED/LOINC code system on the server

Request

Parameters
Name Located in Required Description Default Schema
codeSystemId query yes A code system identifier, e.g. http://snomed.info/sct - string
codeSystemVersion query yes The version of the specified code system - string
syndicate query yes Whether to publish a binary index for the code system - boolean

Response

Status Code Reason Response Model

| default | successful operation | - |

/synd/syndication.xml

GET

Retrieve the server's downstream syndication feed (if available)

Request

Parameters

Response

Status Code Reason Response Model
200 successful operation