Skip to main content

CapabilityStatement

Overview​

The CapabilityStatement resource documents the capabilities (behaviors) of the Netsmart General Purpose R4 FHIR API. It serves as the authoritative source for understanding what resources, operations, search parameters, and extensions are supported by this API implementation.

Important: Always retrieve the current CapabilityStatement before implementing API integrations to ensure you're working with the most up-to-date capabilities.

Resource Schema​

The CapabilityStatement follows the HL7 FHIR R4 CapabilityStatement specification.

Key elements include:

  • software - Information about the Netsmart software implementation
  • rest.resource - Supported FHIR resources and their operations
  • rest.resource.searchParam - Supported search parameters for each resource
  • rest.resource.supportedProfile - FHIR profiles supported for each resource
  • format - Supported content formats (JSON, XML, etc.)

Supported Profiles​

This API supports the following FHIR profiles:

Operations​

The CapabilityStatement resource supports the following operations:

Read​

This operation retrieves the behaviors of the specified FHIR server. For this operation, there is no authorization requirement. The capability statement for each server is available to view by sending a GET to /metadata

Read Examples​

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

Examples​

Response Structure​

The CapabilityStatement response includes detailed information about API capabilities:

{
  "resourceType": "CapabilityStatement",
  "status": "active",
  "date": "2024-01-15T10:30:00Z",
  "publisher": "Netsmart Technologies, Inc.",
  "software": {
    "name": "Netsmart FHIR Server",
    "version": "4.0.1"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+json",
    "json",
    "application/fhir+xml",
    "xml"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "type": "Patient",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ],
          "interaction": [
            {"code": "read"},
            {"code": "search-type"}
          ],
          "searchParam": [
            {
              "name": "_id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            }
          ]
        }
      ]
    }
  ]
}

Integration Patterns​

Capability Discovery Workflow​

  1. Retrieve CapabilityStatement - Start every integration by fetching /metadata
  2. Parse Supported Resources - Extract available resource types from rest.resource
  3. Identify Operations - Check interaction arrays for supported operations
  4. Validate Search Parameters - Use searchParam arrays to build valid queries
  5. Check Profile Support - Verify required profiles in supportedProfile arrays

Format Negotiation​

Use the format array to determine supported content types:

# Request JSON format
curl -X GET https://fhir.netsmartcloud.com/v4/metadata \
    -H "Accept: application/fhir+json"

# Request XML format  
curl -X GET https://fhir.netsmartcloud.com/v4/metadata \
    -H "Accept: application/fhir+xml"

Error Handling​

For information about error responses when retrieving the CapabilityStatement, see Common Errors.

Relationships to Other Resources​

The CapabilityStatement provides essential information for working with all other API resources:

  • Extensions - Extension support is documented in resource profiles
  • Resources - All resource capabilities are defined in the CapabilityStatement
  • Operations - Custom operations are listed in the CapabilityStatement

Support​

For questions about API capabilities or CapabilityStatement interpretation, contact Netsmart support through your designated support channels.