Ontoserver Management API

Admin

/api/addBundle

POST

Add a bundle of FHIR Resources to the server

The Bundle supplied in the multipart/form-data must be in either of FHIR's JSON or XML formats.

Request

**Content-Type: ** multipart/form-data

Parameters
Name Located in Required Description Default Schema
file query yes A FHIR Bundle object containing a set of resources - ref (application/json+fhir, application/xml+fhir, application/json, application/xml)

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[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. 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 yes The atom entry ID 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 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

Definitions

AtomArtifact

name type required description example
codeSystem CodeSystemReference optional -
type string optional -
baseModule string optional -
baseEffectiveTime string optional -
indexVersion string optional -

Chronology

name type required description example
zone DateTimeZone optional -

CodeSystem

name type required description example
get_id integer (int64) optional -
id string optional -
lastUpdated string (date-time) optional -
metaVersion string optional -
jsonBlob string optional -
tags array[Tag] optional -
url string optional -
version string optional -
name string optional -
description string optional -
identifierSystem string optional -
identifierValue string optional -
valueSetUri string optional -
indexStatus string optional -
syndicate boolean optional -
sha256 string optional -
indexVersion string optional -

CodeSystemInfo

name type required description example
codeSystem CodeSystemReference optional -
name string optional -
sourceAvailable boolean optional -
binaryAvailable boolean optional -
inDatabase boolean optional -
status string optional -
syndicated boolean optional -

CodeSystemReference

name type required description example
id string optional -
url string optional -
version string optional -

DateTimeField

name type required description example
name string optional -
type DateTimeFieldType optional -
supported boolean optional -
lenient boolean optional -
minimumValue integer (int32) optional -
maximumValue integer (int32) optional -
rangeDurationField DurationField optional -
leapDurationField DurationField optional -
durationField DurationField optional -

DateTimeFieldType

name type required description example
name string optional -
rangeDurationType DurationFieldType optional -
durationType DurationFieldType optional -

DateTimeZone

name type required description example
id string optional -
fixed boolean optional -

DurationField

name type required description example
name string optional -
type DurationFieldType optional -
supported boolean optional -
precise boolean optional -
unitMillis integer (int64) optional -

DurationFieldType

name type required description example
name string optional -

LocalDateTime

name type required description example
era integer (int32) optional -
dayOfYear integer (int32) optional -
dayOfWeek integer (int32) optional -
dayOfMonth integer (int32) optional -
year integer (int32) optional -
chronology Chronology optional -
centuryOfEra integer (int32) optional -
yearOfEra integer (int32) optional -
yearOfCentury integer (int32) optional -
weekyear integer (int32) optional -
monthOfYear integer (int32) optional -
weekOfWeekyear integer (int32) optional -
hourOfDay integer (int32) optional -
minuteOfHour integer (int32) optional -
secondOfMinute integer (int32) optional -
millisOfSecond integer (int32) optional -
millisOfDay integer (int32) optional -
fields array[DateTimeField] optional -
values array[integer] optional -
fieldTypes array[DateTimeFieldType] optional -

Module

name type required description example
moduleId string optional -
name string optional -
effectiveTime LocalDateTime optional -
dependencies array[Module] optional -

Resource

name type required description example
get_id integer (int64) optional -
id string optional -
lastUpdated string (date-time) optional -
metaVersion string optional -
jsonBlob string optional -
tags array[Tag] optional -

ResourceObject

name type required description example
get_id integer (int64) optional -
id string optional -
lastUpdated string (date-time) optional -
metaVersion string optional -
jsonBlob string optional -
tags array[Tag] optional -

Tag

name type required description example
code string optional -
system string optional -
resource ResourceObject optional -