SpecsModelExploreRequirements
SpecsModelExploreRequirements
FHIR Gateway
Overview
Guide
FHIR Gateway API
Twin streams
IDproduct.ingestion.fhir_gateway
DescriptionFHIR R4 REST endpoint with mTLS and consent enforcement.
Keyfhir_gateway
Typemicroservice:service
Statusactive
TeamClinical Ingestion
Owner
ingestion@healthcare.example
TechnologiesJava, HL7, FHIR
Tags
Table of contents
Guide
FHIR Gateway
Internal structure
Components
Request path
Authenticate
Enforce consent
API
FHIR Gateway API
Requirements

Attributes

authSMART-on-FHIR
standardFHIR R4

Guide

FHIR Gateway

The FHIR Gateway exposes a FHIR R4 REST surface for apps and partners. Every request passes SMART-on-FHIR authentication and consent checks before Clinical Data is queried.

No anonymous PHI

Unauthenticated or consent-violating requests are rejected here — Clinical Data never sees them.

Internal structure

Could not build diagram for model "example-healthcare".

Components

FHIR Router

Routes FHIR resource requests to handlers.

SMART Auth Filter

SMART-on-FHIR token validation.

Consent Check

Enforces patient consent before serving data.

Request path

Route

The FHIR Router selects the handler for the resource type and interaction.

Authenticate

The SMART Auth Filter validates OAuth tokens and scopes.

Enforce consent

The Consent Check asks the Policy Engine before reads proceed.

API

The gateway exposes Patient, Observation, Encounter and related interactions. The full OpenAPI contract is embedded on the Overview tab.

Contract

Search requests are paginated; _summary and _elements are honoured to keep portal payloads small.

FHIR Gateway API

Requirements