>_ Healix Developer Portal
API REFERENCE

FHIR methods and endpoint behavior

Use this page as a practical reference for common methods available through our SMART on FHIR APIs. Resource support may vary by partner program.

Patient Access examples

  • GET /fhir/Patient/{id}
  • GET /fhir/Observation?patient={id}
  • GET /fhir/Condition?patient={id}

Provider Directory examples

  • GET /fhir/Organization?name={name}
  • GET /fhir/Practitioner?name={name}
  • GET /fhir/PractitionerRole?organization={id}

HTTP response guidance

  • 200: Request accepted and resource(s) returned.
  • 401: Access token missing, invalid, or expired.
  • 403: Token valid but missing required scope for endpoint.
  • 404: Resource not found or unavailable in current context.
Use FHIR search conventions for query parameters and paging. Behavior aligns with R4 search patterns.

Reference endpoints

  • GET /fhir/metadata
  • GET /metadata
  • GET /health/check
  • GET /fhir/{resourceType}