FHIR server
A FHIR R4 server - Medplum, HAPI, Epic or Cerner - read for orders or written with results.
Web↓ Inbound↑ OutboundFHIR_SERVERcamel-fhirFHIR - Fast Healthcare Interoperability Resources - a modern web API standard for health data
See the Glossary for every term.
The worked example points at the public HAPI test server, which needs internet. Never send real patient data there.
For example https://host/fhir/R4. If it does not, Test connection reports that the address did not answer with a FHIR CapabilityStatement.
Worked example
HAPI public FHIR (test) · Inbound · FHIR R4 · Test passes on any engine: Yes
The public HAPI test server - needs internet. Never send real patient data there.
{
"direction": "Inbound",
"format": "FHIR R4",
"settings": {
"baseUrl": "https://hapi.fhir.org/baseR4",
"auth": "NONE",
"pollSeconds": "60"
}
}
This is what the console's Fill example button enters. Secrets are never part of an example. Every setting is explained below.
Settings
Required fields are marked Yes. Fields marked 🔒 (clientSecret, password, token) are stored encrypted and never sent back to the browser - the console only shows Set / Not set. A field marked inbound only or outbound only appears just for that direction.
| Setting | Type | Required | Default | What to enter |
|---|---|---|---|---|
baseUrlFHIR base URL | text | Yes | https:// | Required: the FHIR root, e.g. https://host/fhir/R4. |
authAuthentication | select | Yes | OAUTH_CLIENT | How the engine signs in: OAuth client (usual for Medplum), Basic, Bearer or None. Only the chosen type's fields are shown. Options: NONE, OAUTH_CLIENT, BASIC, BEARER. |
tokenUrlToken URL | text | No | — | Required for OAuth: where the engine gets its token, e.g. https://host/oauth2/token. |
clientIdClient ID | text | No | — | Required for OAuth: the client id the server gave you. |
clientSecretClient secret | password | No | — | 🔒 secret. Required for OAuth: the client secret. Stored encrypted. |
usernameUsername | text | No | — | Required for Basic: the account name. |
passwordPassword | password | No | — | 🔒 secret. Required for Basic: the password. Stored encrypted. |
tokenBearer token | password | No | — | 🔒 secret. Required for Bearer: the token the server issued. |
pollSecondsPoll every (seconds) | number | No | 60 | inbound only. How often to read new resources, e.g. 60 (seconds). |
What "Test connection" checks
Signs in (OAuth client credentials, Basic or Bearer) and reads the server's CapabilityStatement.
Test connection is read-only and says how far it got: verified, reached, checked or failed. See Testing a connection, and Troubleshooting if it fails.