Production documentation for patient-facing read APIs. This reference covers endpoint paths, required scopes, common query parameters, response behavior, and implementation examples.
| Item | Value |
|---|---|
| FHIR URL | Configured at runtime |
| Base path | /fhir |
| Authentication | OAuth2 Authorization Code + PKCE |
| Token audience | FHIR proxy API resource |
| Primary scope set | patient/*.read plus user_impersonation |
| Content type | application/fhir+json |
| Pagination | Bundle link navigation (next) |
| Method | Path | Required Scope | Success Response |
|---|---|---|---|
| GET | /fhir/Patient/{id} | patient/Patient.read | 200 Patient |
| GET | /fhir/Patient?identifier={system}|{value} | patient/Patient.read | 200 Bundle(Patient) |
| GET | /fhir/Observation?patient={id} | patient/Observation.read | 200 Bundle(Observation) |
| GET | /fhir/Condition?patient={id} | patient/Condition.read | 200 Bundle(Condition) |
| GET | /fhir/AllergyIntolerance?patient={id} | patient/AllergyIntolerance.read | 200 Bundle(AllergyIntolerance) |
| GET | /fhir/MedicationRequest?patient={id} | patient/MedicationRequest.read | 200 Bundle(MedicationRequest) |
| GET | /fhir/MedicationDispense?patient={id} | patient/MedicationDispense.read | 200 Bundle(MedicationDispense) |
| GET | /fhir/DiagnosticReport?patient={id} | patient/DiagnosticReport.read | 200 Bundle(DiagnosticReport) |
| GET | /fhir/Immunization?patient={id} | patient/Immunization.read | 200 Bundle(Immunization) |
| GET | /fhir/Procedure?patient={id} | patient/Procedure.read | 200 Bundle(Procedure) |
| GET | /fhir/Encounter?patient={id} | patient/Encounter.read | 200 Bundle(Encounter) |
| GET | /fhir/CarePlan?patient={id} | patient/CarePlan.read | 200 Bundle(CarePlan) |
| Parameter | Description |
|---|---|
patient | Patient reference id for resource searches. |
_count | Page size request (server maximum enforced). |
_sort | Sort by supported search parameter. |
_since | Return records updated after timestamp. |
_lastUpdated | FHIR date filter by update timestamp. |
category, status | Resource-specific filters where supported. |
| Status | Meaning |
|---|---|
| 200 | Resource or Bundle returned successfully. |
| 400 | Invalid parameter combination or malformed query. |
| 401 | Missing, expired, or invalid access token. |
| 403 | Token valid, but missing required scope. |
| 404 | Resource id not found. |
| 429 | Rate limited; retry using server guidance. |
| 5xx | Server-side error; retry per client policy. |
Error bodies are returned as FHIR OperationOutcome resources.