Capability Statement

​

Capability Statement

​

Endpoint

GET /fhir/metadata

​

Example Request

curl -H "Accept: application/fhir+json" \
     https://your-server.com/fhir/metadata

GET /fhir/metadata HTTP/1.1
Host: your-server.com
Accept: application/fhir+json

​

Response

​

Success (200 OK)

{
  "resourceType": "CapabilityStatement",
  "status": "active",
  "date": "2024-01-01T12:00:00Z",
  "kind": "instance",
  "software": {
    "name": "Ferrum",
    "version": "1.0.0"
  },
  "implementation": {
    "url": "https://your-server.com/fhir",
    "description": "Ferrum Implementation"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+json",
    "application/fhir+xml"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "type": "Patient",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "vread"
            },
            {
              "code": "update"
            },
            {
              "code": "patch"
            },
            {
              "code": "delete"
            },
            {
              "code": "history-instance"
            },
            {
              "code": "history-type"
            },
            {
              "code": "create"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "name",
              "type": "string",
              "documentation": "A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text"
            },
            {
              "name": "identifier",
              "type": "token",
              "documentation": "A patient identifier"
            }
          ]
        }
      ]
    }
  ]
}

​

Capability Statement Structure

​

Software Information

• software.name - Server name
• software.version - Server version
• software.releaseDate - Release date

​

Implementation Details

• implementation.url - Base URL
• implementation.description - Implementation description

​

Supported Formats

• format - List of supported content types (JSON, XML, etc.)

​

REST Capabilities

• rest.mode - Server mode (server or client)
• rest.resource - List of supported resources

​

Resource Capabilities

• type - Resource type name
• interaction - Supported interactions (read, create, update, delete, search, etc.)
• searchParam - Supported search parameters
• operation - Supported operations
• versioning - Versioning support (versioned, versioned-update, no-version, versioned)
• readHistory - Whether history is supported
• updateCreate - Whether updates can create resources
• conditionalCreate - Whether conditional create is supported
• conditionalUpdate - Whether conditional update is supported
• conditionalDelete - Whether conditional delete is supported

​

Operations

• rest.operation - System-level operations
• rest.resource[].operation - Resource-specific operations

​

Use Cases

• Discover which resources are supported
• Learn which search parameters are available
• Check which operations are supported
• Determine versioning behavior
• Understand server capabilities before making requests

​

Notes

• The capability statement is always available at /fhir/metadata
• It reflects the current server configuration
• Use it to build dynamic clients that adapt to server capabilities
• The statement may change as the server is updated or configured