Skip to content

Instantly share code, notes, and snippets.

@gjergjsheldija

gjergjsheldija/oai.yaml

Created April 8, 2021 11:55
Show Gist options
  • Save gjergjsheldija/39cc0164635610ca52642df192430d2e to your computer and use it in GitHub Desktop.
Save gjergjsheldija/39cc0164635610ca52642df192430d2e to your computer and use it in GitHub Desktop.
Download ZIP
Raw
oai.yaml
openapi: 3.0.0
info:
contact:
email: gjergj.sheldija@raylytic.com
name: FHIR Terminology API
url: raylyti.com
description: AIQNET
license:
name: proprietary
termsOfService: '-'
title: REST API for FHIR Terminology Service
version: '1.0'
servers:
- url: 'https://raylytic.com/'
paths:
/CodeSystem/$lookup:
get:
parameters:
- description: system
in: query
name: system
required: false
schema:
type: string
- description: code
in: query
name: code
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- code-system-controller
operationId: lookupUsingGET
post:
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- code-system-controller
operationId: lookupUsingPOST
requestBody:
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: serializeResource
required: true
/CodeSystem/$metadata:
get:
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- code-system-controller
operationId: getMetadataXmlUsingGET
summary: getMetadataXml
/CodeSystem/$searchConcept:
get:
parameters:
- description: text
in: query
name: text
required: true
schema:
type: string
- description: system
in: query
name: system
required: false
schema:
type: string
- description: ValueSetId
in: query
name: ValueSetId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- code-system-controller
operationId: searchConceptXmlUsingGET
summary: searchConceptXml
/CodeSystem/$subsumes:
get:
parameters:
- description: system
in: query
name: system
required: true
schema:
type: string
- description: codeA
in: query
name: codeA
required: true
schema:
type: string
- description: codeB
in: query
name: codeB
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- code-system-controller
operationId: sumbsumesCodeXmlUsingGET
summary: sumbsumesCodeXml
post:
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- code-system-controller
operationId: sumbsumesCodingXmlUsingPOST
requestBody:
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: serializeResource
required: true
summary: sumbsumesCodingXml
/ConceptMap:
post:
responses:
'200':
content:
'*/*':
schema:
$ref: '#/components/schemas/ModelAndView'
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- concept-map-controller
operationId: postConceptMapUsingPOST
summary: postConceptMap
/ConceptMap/$metadata:
get:
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- concept-map-controller
operationId: getMetadataXmlUsingGET_1
summary: getMetadataXml
/ConceptMap/$translate:
get:
parameters:
- description: system
in: query
name: system
required: true
schema:
type: string
- description: code
in: query
name: code
required: true
schema:
type: string
- description: source
in: query
name: source
required: false
schema:
type: string
- description: target
in: query
name: target
required: false
schema:
type: string
- description: targetSystem
in: query
name: targetSystem
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- concept-map-controller
operationId: translateXmlUsingGET
summary: translateXml
post:
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- concept-map-controller
operationId: translateXmlUsingPOST
requestBody:
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: serializeResource
required: true
summary: translateXml
/ValueSet:
post:
responses:
'200':
content:
'*/*':
schema:
$ref: '#/components/schemas/ModelAndView'
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- value-set-controller
operationId: postValueSetUsingPOST
summary: postValueSet
/ValueSet/$expand:
get:
parameters:
- description: url
in: query
name: url
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- value-set-controller
operationId: getExpandXmlUsingGET
summary: getExpandXml
post:
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- value-set-controller
description: 'Batch operation is allowed, so it can be posted a serialized Bundle resource with a set of ValueSets'
operationId: expandXmlUsingPOST
requestBody:
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: serializeResource
required: true
summary: 'Expand the serialized xml/json ValueSet on the post request body, responding a serialized Parameters resource with the ValueSet expanded or the outcome error'
/ValueSet/$lookupconcept:
get:
parameters:
- description: system
in: query
name: system
required: true
schema:
type: string
- description: code
in: query
name: code
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- value-set-controller
operationId: lookupconceptXmlUsingGET
summary: lookupconceptXml
/ValueSet/$metadata:
get:
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- value-set-controller
operationId: getMetadataXmlUsingGET_2
summary: getMetadataXml
/ValueSet/$validate-code:
get:
parameters:
- description: url
in: query
name: url
required: true
schema:
type: string
- description: system
in: query
name: system
required: true
schema:
type: string
- description: code
in: query
name: code
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- value-set-controller
operationId: validateXmlUsingGET
summary: validateXml
post:
responses:
'200':
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- value-set-controller
description: 'Batch operation is allowed, so it can be posted a serialized Bundle resource with a set of requests'
operationId: validateXmlUsingPOST
requestBody:
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: serializeResource
required: true
summary: Validate a concept against the ValueSet. All posted in a Parameters resource. Parameter1 name=codeableConcept/coding/code and type=CodeableConcept/Coding/CodeType Parameter2 name=valueSet and type=ValueSet Responding a serialized Parameters resource with the ValueSet expanded or the outcome error
components:
requestBodies:
lookupUsingPOSTSerializeresource:
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
description: serializeResource
required: true
schemas:
ModelAndView:
properties:
empty:
type: boolean
model:
type: object
modelMap:
additionalProperties:
type: object
type: object
reference:
type: boolean
status:
enum:
- '100'
- '101'
- '102'
- '103'
- '200'
- '201'
- '202'
- '203'
- '204'
- '205'
- '206'
- '207'
- '208'
- '226'
- '300'
- '301'
- '302'
- '303'
- '304'
- '305'
- '307'
- '308'
- '400'
- '401'
- '402'
- '403'
- '404'
- '405'
- '406'
- '407'
- '408'
- '409'
- '410'
- '411'
- '412'
- '413'
- '414'
- '415'
- '416'
- '417'
- '418'
- '419'
- '420'
- '421'
- '422'
- '423'
- '424'
- '426'
- '428'
- '429'
- '431'
- '451'
- '500'
- '501'
- '502'
- '503'
- '504'
- '505'
- '506'
- '507'
- '508'
- '509'
- '510'
- '511'
type: string
view:
$ref: '#/components/schemas/View'
viewName:
type: string
type: object
View:
properties:
contentType:
type: string
type: object
tags:
- description: Value Set Controller
name: value-set-controller
- description: Concept Map Controller
name: concept-map-controller
- description: Code System Controller
name: code-system-controller
- description: Basic Error Controller
name: basic-error-controller
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment