For AI agents: the complete documentation index is available at https://docs.dataplatform.ovh.net/llms.txt, the full documentation bundle is available at https://docs.dataplatform.ovh.net/llms-full.txt, and this page is available as Markdown at https://docs.dataplatform.ovh.net/connectors-sources-fhir.md.
  • 🇬🇧 English
  • Collect healthcare data from a FHIR R4 server

    HL7 FHIR Release 4 (FHIR R4) is a standard for exchanging healthcare data. The FHIR connector connects the Platform to your FHIR server

    Objective

    HL7 FHIR Release 4 (FHIR R4) is a standard for exchanging healthcare data. The FHIR connector connects the Platform to your FHIR server. It ingests selected data into relational tables that you can use in Lakehouse Manager and processing jobs.

    FHIR connector selection
    Info

    The FHIR connector is an initial release: supported tables and behaviour will grow over time and may not yet match every integration or FHIR workflow you have in mind. Check the release notes and this page periodically for updates.

    Info

    Before you begin, collect your FHIR base URL (for example https://example.com/fhir). If your server requires authentication, prepare a bearer token or basic credentials.

    Add a FHIR source on the Platform

    Configure the connection

    1. Open the Platform store and select the FHIR connector.
    2. Enter the endpoint URL of your FHIR API. This is the server base URL the connector calls.
    3. Choose an authentication mode:
      • None if the server allows unauthenticated access.
      • Bearer if the server expects an Authorization: Bearer token. Paste the token when prompted.
      • Basic if the server uses HTTP basic authentication. Enter the username and password.
    4. Complete the connection step using Connect.
    FHIR connector configuration

    Select tables to ingest

    After the connection step, you add data by choosing tables in the Add tables dialog. Each row is a relational table name (for example patient, encounter) with a short description and a category tag.

    Add tables dialog with category filter, search, presets, and table list

    Filter by category

    The category list on the left is fixed in the Platform. It does not come from your FHIR server.

    You can filter tables using:

    • All
    • Administrative
    • Encounters
    • Clinical
    • Medication
    • Diagnostics
    • Referentials
    • Transverse

    Categories help you browse long lists. They do not change what your FHIR server exposes.

    The search field filters rows by table name. It does not run ad hoc queries against the FHIR server.

    Presets

    Presets are shortcuts that pre-select a bundle of tables for a common scenario. Examples include PATIENT PROFILE, CARE PATHWAY, CLINICAL OBSERVATIONS, MEDICATIONS, and FULL EXPORT.

    FHIR presets

    Presets are starting points only. They help you select tables faster. They are not driven by server configuration and do not limit what you can add manually.

    Batch

    Each time you add tables, you assign a batch value. The batch is a suffix appended to table names so you can group related tables inside the Platform.

    You can edit the batch name before you confirm. You can also add tables to an existing batch when you need the same grouping suffix.

    Population filters

    For patient-centric tables, you can narrow who is included using population filters.

    • Simple mode offers controls such as gender and date of birth through dropdowns. FHIR population filters simple mode
    • Advanced mode does not add extra controls; it is for typing the filter manually as text, for example gender=female&birthdate=... with parameters separated by &. Use the syntax your FHIR server expects. FHIR population filters advanced mode

    Linked tables

    Some tables depend on others. When you select a table, the UI may auto-select related tables that are required for a consistent dataset.

    For example, selecting patient_name can also select patient and human_name. The exact rules follow the product implementation.

    Info

    Review the full selection (including any tables added automatically) before you click Add. Dependencies can widen the scope of the data you ingest.

    When your selection is ready, click Add. Use Cancel to close without adding tables.

    Name the source

    Before you finish creating the source, enter a name in the field provided by the UI.

    Warning

    The technical name cannot be changed after you create the source. It is used when you open the source with the Data Platform SDK.

    FHIR name the source

    Use ingested data

    After you ingest data, you can work with it like other Platform sources. Load it into Lakehouse Manager tables using Data Processing Engine load actions.

    Go further

    If you need training or technical assistance to implement our solutions, contact your sales representative or click on this link to get a quote and ask our Professional Services experts for a custom analysis of your project.

    Ask questions, give your feedback and interact directly with the team building the Data Platform on the dedicated Discord channel.

    If you need support with your OVHcloud services, create a request in our Help Centre.

    Join our community of users.