Skip to main content

CapabilityStatement

Overview​

The CapabilityStatement documents "a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation". This resource serves as the definitive source of truth for API capabilities.

Resource Schema​

The CapabilityStatement resource includes key metadata about the FHIR server:

{
  "resourceType": "CapabilityStatement",
  "id": "us-core-server",
  "status": "active",
  "date": "2024-01-15",
  "publisher": "Netsmart Technologies, Inc.",
  "software": {
    "name": "Netsmart FHIR Server",
    "version": "1.1.15"
  },
  "fhirVersion": "4.0.1",
  "format": ["application/fhir+json", "application/fhir+xml"],
  "rest": [{
    "mode": "server",
    "resource": [
      // Supported resources with operations and search parameters
    ]
  }]
}

Operations​

Read​

Retrieves the CapabilityStatement for this FHIR server. No authorization is required for this operation.

HTTP Method: GET
URL: /metadata

Examples​

curl -X GET https://fhir.netsmartcloud.com/uscore/v1/metadata \
    -H "Accept: application/fhir+json"

Integration Patterns​

Discovering API Capabilities​

  1. Retrieve CapabilityStatement - Always start by fetching /metadata
  2. Extract Supported Resources - Check rest.resource array for available resources
  3. Validate Operations - Verify supported operations for each resource type
  4. Check Search Parameters - Review searchParam arrays for supported search criteria

The CapabilityStatement references all supported resources in this API. See the Resources page for detailed documentation of each resource type.

Supported Profiles​

Profiles supported by this API are defined in the CapabilityStatement supportedProfile arrays. Common profiles include:

Error Handling​

For common errors and troubleshooting guidance, see Common Errors.

Supported Formats​

This API supports the following response formats:

  • application/fhir+json (default)
  • application/fhir+xml
  • application/json
  • application/xml