Production documentation for service discovery, SMART configuration, and runtime health metadata. Use these endpoints to validate capabilities, configure authorization, and monitor API availability.
| Item | Value |
|---|---|
| FHIR metadata path | /fhir/metadata |
| SMART discovery path | /fhir/.well-known/smart-configuration |
| Health probe path | /health/check |
| Primary content types | application/fhir+json, application/json |
| Methods | GET only |
| Method | Path | Access | Success Response |
|---|---|---|---|
| GET | /fhir/metadata | Public or tokenized by deployment policy | 200 CapabilityStatement |
| GET | /fhir/metadata?_format=json | Public or tokenized by deployment policy | 200 CapabilityStatement (JSON) |
| GET | /fhir/.well-known/smart-configuration | Public | 200 SMART discovery JSON |
| GET | /health/check | Environment dependent | 200 Health payload |
| Field | How to use it |
|---|---|
fhirVersion | Validate client compatibility against server version. |
rest.resource.type | Determine supported resource types. |
rest.resource.interaction | Confirm allowed operations (read/search). |
rest.resource.searchParam | Generate valid query interfaces in clients. |
security.service | Confirm SMART/OAuth security expectations. |
| Status | Meaning |
|---|---|
| 200 | Endpoint returned valid metadata payload. |
| 304 | Metadata unchanged when ETag caching is used. |
| 400 | Invalid query or format parameter. |
| 401/403 | Authentication or authorization policy blocked access. |
| 404 | Discovery route unavailable in deployment. |
| 503 | Service unavailable or dependency health failure. |
Use ETag and If-None-Match for metadata polling clients to reduce traffic and latency.