{
  "openapi": "3.1.1",
  "info": {
    "title": "System 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/"
    }
  },
  "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": "Conformance",
      "description": "Retrieving system options and conformance information."
    }
  ],
  "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.\n\nServices SHOULD respond to this method with the appropriate HTTP codes, headers and potentially with a payload revealing more details about themselves.\n\nAnother use-case for this method is related to exposing service capabilities for a conformance manifest.\n",
        "tags": [
          "Options"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/200_options"
          }
        }
      }
    }
  },
  "components": {
    "headers": {
      "Allow": {
        "description": "The `Allow` header lists the set of methods supported.\n",
        "schema": {
          "type": "string",
          "examples": [
            "GET, POST, PUT, DELETE, OPTIONS"
          ]
        }
      }
    },
    "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"
            }
          }
        },
        "examples": [
          {
            "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.\n",
        "headers": {
          "Allow": {
            "$ref": "#/components/headers/Allow"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Options"
            }
          }
        }
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "Resource endpoints",
      "tags": [
        "Options"
      ]
    }
  ],
  "x-ext-urls": {}
}