Ontoserver Management API

Admin

/api/addBundle

POST

Add a bundle of FHIR Resources to the server

Request

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

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

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 no The version (or optionally, for SNOMED, the Edition) 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[CodeSystemDetails]

/api/jobs

GET

Retrieve a list of the background Jobs the server has run/is running along with their status

Request

Parameters
Name Located in Required Description Default Schema
jobId query no A job identifier - string

Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation

/api/upstream.xml

GET

Retrieve merged form of the server's upstream syndication feeds (if available)

Request

Parameters

Response

Content-Type: application/atom+xml

Status Code Reason Response Model
200 successful operation

/api/vacuum

POST

Checks for, and optionally cleans up, extraneous indexing content in the filesystem.

Request

Parameters
Name Located in Required Description Default Schema
cleanup query no If 'true', then actually delete the extraneous content - boolean

Response

Status Code Reason Response Model
200 Success
500 Failure -

Syndication

/synd/fetchSyndicatedContentEntry

POST

Fetch an artifact from the upstream syndication feed into the server. For entries of type Bundle: only 'batch' and 'collection' are supported. Future versions may support 'transaction', and unsupported contained Resource types will be ignored.

Request

Parameters
Name Located in Required Description Default Schema
entryId query no The atom entry ID to fetch - string
resourceType query no The type of resource to fetch - string
url query no The URL of the resource (CodeSystem, ValueSet, ConceptMap or StructureDefinition) to fetch - string
version query no The version of the resource to fetch - string
bundleInterpretation query no If the entry is a Bundle, how to process the Bundle. Valid values are: 'batch' and 'collection' - string

Response

Status Code Reason Response Model
200 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 InputStreamResource

/synd/getSyndicationStatus

GET

Get the downstream syndication status for a Resource on the server

Request

Parameters
Name Located in Required Description Default Schema
resourceType query yes The type of the resource, e.g. ValueSet, CodeSystem, NamingSystem - string
id query yes The id of the resource - string

Response

Status Code Reason Response Model
200 successful operation

/synd/redoPreload

POST

Re-executes the data load performed at start in the preload feed without having to restart the server.<p>Execution will be asynchronous or synchronous depending upon the configuration of atom.preload.async, which is true by default.

Request

Parameters

Response

Status Code Reason Response Model
200 Preload execution has been started -
500 Preload could not be re-executed -

/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/setSyndicationStatus

POST

Change the downstream syndication status for a Resource on the server

Request

Parameters
Name Located in Required Description Default Schema
resourceType query yes The type of the resource, e.g. ValueSet, CodeSystem, NamingSystem - string
id query yes The id of the resource - string
syndicate query yes Whether to publish the resource in the downstream syndication feed - 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

Content-Type: application/atom+xml

Status Code Reason Response Model
200 successful operation