Capabilities

Capabilities returns what operations and resources are supported by the server. This is returned to the client as a CapabilityStatment resource.

API

R4

CLI

iguhealth api capabilities r4

Curl

 curl --request GET --header "Authorization: Header" --header "Content-Type: application/fhir+json" ${domain}/w/${tenant}/api/v1/fhir/r4/metadata

Typescript

await client.capabilities({}, R4);

R4B

CLI

iguhealth api capabilities r4b

Curl

 curl --request GET --header "Authorization: Header" --header "Content-Type: application/fhir+json" ${domain}/w/${tenant}/api/v1/fhir/r4b/metadata

Typescript

await client.capabilities({}, R4B);

Example

Response

{
  "resourceType": "CapabilityStatement",
  "status": "active",
  "fhirVersion": "4.0.1",
  "date": "2024-06-23T22:57:09.826Z",
  "kind": "capability",
  "format": [
    "json"
  ],
  "rest": [
    {
      "mode": "server",
      "security": {
        "cors": true
      },
      "interaction": [
        {
          "code": "search-system"
        }
      ],
      "searchParam": [
        {
          "name": "_text",
          "definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
          "type": "string",
          "documentation": "Search on the narrative of the resource"
        },
        {
... capabilities