﻿{
  "openapi": "3.0.2",
  "info": {
    "title": "IE Core Client CapabilityStatement",
    "description": "This CapabilityStatement describes the expected capabilities of a system that conforms to the IE Core Implementation Guide as a Client. It lists the RESTful interactions and supported profiles for each resource type that a client application can use to query an IE Core Server.",
    "license": {
      "name": "Creative Commons Attribution 4.0 International",
      "url": "http://spdx.org/licenses/CC-BY-4.0.html"
    },
    "version": "0.3.0",
    "contact": {
      "name": "Nithin Mohan T K (Proof of Concept)",
      "email": "nithinmohantk1@gmail.com",
      "url": "https://github.com/hl7-ie"
    }
  },
  "servers": [
    {
      "url": "https://hl7-ie.github.io/ie-core/fhir/ie/core",
      "description": "IE Core FHIR Client"
    }
  ],
  "externalDocs": {
    "url": "https://hl7-ie.github.io/ie-core/fhir/ie/core/CapabilityStatement/ie-core-client",
    "description": "FHIR CapabilityStatement"
  },
  "components": {
    "parameters": {
      "rid": {
        "name": "rid",
        "in": "path",
        "description": "id of the resource (\u003dResource.id)",
        "required": true,
        "allowEmptyValue": false,
        "style": "simple",
        "schema": {
          "type": "string"
        }
      },
      "hid": {
        "name": "hid",
        "in": "path",
        "description": "id of the history entry (\u003dResource.meta.versionId)",
        "required": true,
        "allowEmptyValue": false,
        "style": "simple",
        "schema": {
          "type": "string"
        }
      },
      "summary": {
        "name": "_summary",
        "in": "query",
        "description": "Requests the server to return a designated subset of the resource",
        "allowEmptyValue": true,
        "style": "form",
        "schema": {
          "type": "string",
          "enum": [
            "true",
            "text",
            "data",
            "count",
            "false"
          ]
        }
      },
      "format": {
        "name": "_format",
        "in": "query",
        "description": "Specify alternative response formats by their MIME-types (when a client is unable acccess accept: header)",
        "allowEmptyValue": true,
        "style": "form",
        "schema": {
          "type": "string",
          "format": "mime-type"
        }
      },
      "pretty": {
        "name": "_pretty",
        "in": "query",
        "description": "Ask for a pretty printed response for human convenience",
        "allowEmptyValue": true,
        "style": "form",
        "schema": {
          "type": "boolean"
        }
      },
      "elements": {
        "name": "_elements",
        "in": "query",
        "description": "Requests the server to return a collection of elements from the resource",
        "allowEmptyValue": true,
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "format": "string",
          "items": {
            "format": "string"
          }
        }
      },
      "count": {
        "name": "_count",
        "in": "query",
        "description": "The maximum number of search results on a page. The server is not bound to return the number requested, but cannot return more",
        "schema": {
          "type": "number"
        }
      }
    }
  }
}