openEHR Options API

openapi: 3.2.0
info:
  title: System Options API
  version: latest
  x-status: STABLE
  x-spec: system
  contact:
    name: Specifications Editorial Committee openEHR
    url: https://specifications.openehr.org/
    email: info@openehr.org
  license:
    name: Creative Commons Attribution-NoDerivs 3.0 Unported
    url: https://creativecommons.org/licenses/by-nd/3.0/
  description: '## Description


    ### Purpose


    This specification describes service endpoints, resources and operations as well as details of requests and responses that interact with the openEHR System API in a RESTful manner.'
servers:
- url: https://{baseUrl}/v1
  description: An example openEHR server URL.
  variables:
    baseUrl:
      default: openEHRSys.example.com
      description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
security: []
tags:
- name: Options
paths:
  /:
    options:
      operationId: options
      summary: Options and Conformance
      description: 'The `OPTIONS` HTTP method allows a client to determine the options and/or requirements associated with a resource, service or with the system, without implying a resource action.


        Services SHOULD respond to this method with the appropriate HTTP codes, headers and potentially with a payload revealing more details about themselves.


        Another use-case for this method is related to exposing service capabilities for a conformance manifest.'
      tags:
      - Options
      parameters:
      - $ref: '#/components/parameters/Accept_JSON'
      responses:
        '200':
          $ref: '#/components/responses/200_options'
components:
  schemas:
    Options:
      title: Options
      type: object
      properties:
        solution:
          type: string
        solution_version:
          type: string
        vendor:
          type: string
        restapi_specs_version:
          type: string
        conformance_profile:
          type: string
        endpoints:
          type: array
          items:
            type: string
      example:
        solution: openEHRSys
        solution_version: v1.0
        vendor: My-openEHR
        restapi_specs_version: 1.1.0
        conformance_profile: STANDARD
        endpoints:
        - /ehr
        - /demographic
        - /definition
        - /query
        - /admin
  responses:
    200_options:
      description: '`200 OK` is returned when options and conformance statement was retrieved successfully.

        '
      headers:
        Allow:
          $ref: '#/components/headers/Allow'
        Content-Type:
          $ref: '#/components/headers/ContentType_JSON'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Options'
  parameters:
    Accept_JSON:
      name: Accept
      in: header
      style: simple
      schema:
        type: string
        enum:
        - application/json
  headers:
    Allow:
      description: 'The `Allow` header lists the set of methods supported.

        '
      schema:
        type: string
        example: GET, POST, PUT, DELETE, OPTIONS
    ContentType_JSON:
      schema:
        type: string
        enum:
        - application/json
x-tagGroups:
- name: Resource endpoints
  tags:
  - Options