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

        <td>ref (application/json+fhir, application/xml+fhir, application/json, application/xml)</td>

Name	Located in	Required	Description	Default	Schema
file	query	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

        <td>string </td>

        <td>string </td>

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

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

        <td>string </td>

        <td>string </td>

        <td>boolean </td>

        <td>boolean </td>

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

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

        <td>ref </td>

        <td>string </td>

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

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

        <td>string </td>

        <td>string </td>

        <td>string </td>

        <td>string </td>

        <td>string </td>

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

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

        <td>string </td>

        <td>string </td>

        <td>string </td>

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

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

        <td>string </td>

        <td>string </td>

        <td>boolean </td>

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

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

Definitions

AtomArtifact

    <tr>
        <td>type</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>signatures</td>
        <td>
            
                
                object
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>codeSystem</td>
        <td>
            
                <a href="#/definitions/CodeSystemReference">CodeSystemReference</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>baseModule</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>baseEffectiveTime</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>indexVersion</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>id</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>bundleType</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

Chronology

    <tr>
        <td>zone</td>
        <td>
            
                <a href="#/definitions/DateTimeZone">DateTimeZone</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

CodeSystem

    <tr>
        <td>get_id</td>
        <td>
            
                
                integer (int64)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>id</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>lastUpdated</td>
        <td>
            
                
                string (date-time)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>metaVersion</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>jsonBlob</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>tags</td>
        <td>
            
            
                array[<a href="#/definitions/Tag">Tag</a>]
            
            
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>url</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>version</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>name</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>publisher</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>status</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>description</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>identifierSystem</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>identifierValue</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>valueSetUri</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>indexStatus</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>syndicate</td>
        <td>
            
                
                boolean
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>sha256</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>indexVersion</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

CodeSystemInfo

    <tr>
        <td>codeSystem</td>
        <td>
            
                <a href="#/definitions/CodeSystemReference">CodeSystemReference</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>name</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>sourceAvailable</td>
        <td>
            
                
                boolean
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>binaryAvailable</td>
        <td>
            
                
                boolean
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>inDatabase</td>
        <td>
            
                
                boolean
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>status</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>syndicated</td>
        <td>
            
                
                boolean
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

CodeSystemReference

    <tr>
        <td>id</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>url</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>version</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

DateTimeField

    <tr>
        <td>durationField</td>
        <td>
            
                <a href="#/definitions/DurationField">DurationField</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>minimumValue</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>maximumValue</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>rangeDurationField</td>
        <td>
            
                <a href="#/definitions/DurationField">DurationField</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>leapDurationField</td>
        <td>
            
                <a href="#/definitions/DurationField">DurationField</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>name</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>type</td>
        <td>
            
                <a href="#/definitions/DateTimeFieldType">DateTimeFieldType</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>supported</td>
        <td>
            
                
                boolean
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>lenient</td>
        <td>
            
                
                boolean
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

DateTimeFieldType

    <tr>
        <td>rangeDurationType</td>
        <td>
            
                <a href="#/definitions/DurationFieldType">DurationFieldType</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>durationType</td>
        <td>
            
                <a href="#/definitions/DurationFieldType">DurationFieldType</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>name</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

DateTimeZone

    <tr>
        <td>fixed</td>
        <td>
            
                
                boolean
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>id</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

DurationField

    <tr>
        <td>precise</td>
        <td>
            
                
                boolean
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>unitMillis</td>
        <td>
            
                
                integer (int64)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>name</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>type</td>
        <td>
            
                <a href="#/definitions/DurationFieldType">DurationFieldType</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>supported</td>
        <td>
            
                
                boolean
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

DurationFieldType

    <tr>
        <td>name</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

LocalDateTime

    <tr>
        <td>chronology</td>
        <td>
            
                <a href="#/definitions/Chronology">Chronology</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>centuryOfEra</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>yearOfEra</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>yearOfCentury</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>weekyear</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>monthOfYear</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>weekOfWeekyear</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>hourOfDay</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>minuteOfHour</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>secondOfMinute</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>millisOfSecond</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>millisOfDay</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>era</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>dayOfYear</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>dayOfWeek</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>dayOfMonth</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>year</td>
        <td>
            
                
                integer (int32)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>fieldTypes</td>
        <td>
            
            
                array[<a href="#/definitions/DateTimeFieldType">DateTimeFieldType</a>]
            
            
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>fields</td>
        <td>
            
            
                array[<a href="#/definitions/DateTimeField">DateTimeField</a>]
            
            
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>values</td>
        <td>
            
            
            array[integer]
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

Module

    <tr>
        <td>moduleId</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>name</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>effectiveTime</td>
        <td>
            
                <a href="#/definitions/LocalDateTime">LocalDateTime</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>dependencies</td>
        <td>
            
            
                array[<a href="#/definitions/Module">Module</a>]
            
            
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

Resource

    <tr>
        <td>get_id</td>
        <td>
            
                
                integer (int64)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>id</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>lastUpdated</td>
        <td>
            
                
                string (date-time)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>metaVersion</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>jsonBlob</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>tags</td>
        <td>
            
            
                array[<a href="#/definitions/Tag">Tag</a>]
            
            
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

ResourceObject

    <tr>
        <td>get_id</td>
        <td>
            
                
                integer (int64)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>id</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>lastUpdated</td>
        <td>
            
                
                string (date-time)
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>metaVersion</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>jsonBlob</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>tags</td>
        <td>
            
            
                array[<a href="#/definitions/Tag">Tag</a>]
            
            
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example

Tag

    <tr>
        <td>code</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>system</td>
        <td>
            
                
                string
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

    <tr>
        <td>resource</td>
        <td>
            
                <a href="#/definitions/ResourceObject">ResourceObject</a>
                
            
        </td>
        <td>optional</td>
        <td>-</td>
        <td></td>
    </tr>

name	type	required	description	example