---
title: "Get the CapabilityStatement for the v2 FHIR read surface"
method: GET
path: "/api/v2/patients/{particle_patient_id}/fhir/metadata"
tags: ["Patients"]
---

# Get the CapabilityStatement for the v2 FHIR read surface

`GET /api/v2/patients/{particle_patient_id}/fhir/metadata`

## Request

- Base URL: `https://sandbox.particlehealth.com`
- URL: `https://sandbox.particlehealth.com/api/v2/patients/{particle_patient_id}/fhir/metadata`
- Auth: API key in header `Authorization`

## Path parameters

- `particle_patient_id` string, required

## Response `200`

OK

- FhirCapabilityStatement
  - `date` string
  - `description` string
  - `fhirVersion` string
  - `format` string[]
  - `implementation` FhirCapabilityImplementation
    - `description` string
    - `url` string
  - `kind` string
  - `name` string
  - `publisher` string
  - `resourceType` string
  - `rest` FhirCapabilityRest[]
    - `documentation` string
    - `mode` string
    - `resource` FhirCapabilityResource[]
      - `documentation` string
      - `interaction` FhirCapabilityInteraction[]
        - `code` string
        - `documentation` string
      - `operation` FhirCapabilityOperation[]
        - `definition` string
        - `documentation` string
        - `name` string
      - `searchParam` FhirCapabilitySearchParam[]
        - `definition` string
        - `documentation` string
        - `extension` FhirCapabilityExtension[]
          - `url` string
          - `valueCode` string
        - `name` string
        - `type` string
      - `type` string
    - `searchParam` FhirCapabilitySearchParam[]
      - `definition` string
      - `documentation` string
      - `extension` FhirCapabilityExtension[]
        - `url` string
        - `valueCode` string
      - `name` string
      - `type` string
    - `security` FhirCapabilitySecurity
      - `description` string
  - `status` string
  - `title` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Internal Server Error

## Changes

- **2026-11-03** `b59a5413a488`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/particlehealth/apis/particle-health-api/changes/api/v2/patients/:particle_patient_id/fhir/metadata/get.md)

---

[API](https://skmtc.dev/particlehealth/apis/particle-health-api.md) - [All operations](https://skmtc.dev/particlehealth/apis/particle-health-api/llms.txt) - [OpenAPI document](https://skmtc.dev/particlehealth/apis/particle-health-api/revisions/b59a5413a488?raw)
