SQL on FHIR
2.1.0-pre - release International flag

SQL on FHIR, published by SQL on FHIR Working Group. This guide is not an authorized publication; it is the continuous build for version 2.1.0-pre built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/sql-on-fhir-v2/ and changes regularly. See the Directory of published versions

Operations Capability

CapabilityStatement for SQL-on-FHIR API

The server SHALL support the CapabilityStatement resource to allow clients to discover supported operations.

The CapabilityStatement.rest.resource array SHALL contain an entry for the ViewDefinition resource type with:

  • An operation element with:
    • name = “$export”
    • definition = “http://sql-on-fhir.org/OperationDefinition/$export”
  • An operation element with:
    • name = “$run”
    • definition = “http://sql-on-fhir.org/OperationDefinition/$run”

If the server supports CRUD and search interactions for the ViewDefinition resource type, the interaction array SHALL include the appropriate codes:

  • read
  • search-type
  • write
  • patch
  • delete
  • create

Example

GET /metadata HTTP/1.1
Accept: application/fhir+json

HTTP/1.1 200 OK
Content-Type: application/fhir+json

{
  "resourceType": "CapabilityStatement",
  "status": "active",
  "date": "2023-07-13T10:00:00Z",
  "publisher": "SQL on FHIR",
  "kind": "instance",
  "fhirVersion": "4.0.1",
  "format": ["application/fhir+json"],
  "rest": [{
    "mode": "server",
    "resource": [{
      "type": "ViewDefinition",
      "interaction": [
        { "code": "read" },
        { "code": "search-type" },
        { "code": "write" },
        { "code": "patch" },
        { "code": "delete" },
        { "code": "create" }
      ],
      "operation": [
        {
          "name": "$export",
          "definition": "http://sql-on-fhir.org/OperationDefinition/$export"
        },
        {
          "name": "$validate",
          "definition": "http://sql-on-fhir.org/OperationDefinition/$validate"
        },
        {
          "name": "$run",
          "definition": "http://sql-on-fhir.org/OperationDefinition/$run"
        }
      ]
    }]
  }]
}