Questionnaire eEKP-FHIR UseCase

Short Description

Within the scope of the track, participants are enabled to implement and test both the authorization process and the Questionnaire-based interactions with a test environment. This includes, in particular, the structured capture and exchange of examination data related to birth using the defined FHIR-based artifacts from the eEKP-FHIR project. Furthermore, the end-to-end process and the required technical interactions for obtaining the necessary access prerequisites, i.e. obtaining and exchanging SAML-based Assertions for access tokens, and related authorization artifacts, can be tested and validated as part of the track.

Long Description

The track provides a comprehensive testing scenario that mirrors the core integration principles of the eEKP-FHIR architecture. Participants are not only able to connect to a dedicated test environment, but can also walk through the complete security and access workflow required to access FHIR-based interaction endpoints for eEKP-FHIR. This includes simulating the identity and authorization chain starting with the acquisition of a valid Assertion (SAML), performing the necessary token exchange procedures, and obtaining OAuth2-based access tokens required to invoke the protected FHIR endpoints.

Beyond the security layer, the track focuses on the functional interoperability aspects defined in the eEKP-FHIR specifications. Participants can retrieve and process the officially defined FHIR Questionnaire resources that model the structured documentation of examinations related to pregnancy and birth. These Questionnaires serve as canonical definitions for standardized data capture and are intended to be completed and submitted as FHIR QuestionnaireResponse resources. The scenario enables implementers to test both read and write use cases, ensuring correct implementation of resource structures as defined in eEKP-FHIR.

Type

Experimental use of FHIR interactions, including authorization logic, for eEKP FHIR.

Submitting Work Group/
Project/
Accelerator/
Affiliate/
Implementer Group  

ELGA GmbH

Track Lead(s)

Schuler, Andreas & Anna Lin

Track Lead Email(s)

tc-fhir@hl7.at

Related Tracks

https://hl7at.atlassian.net/wiki/x/AYCKOw (in case the basics are required)

FHIR Version

All related Questionnaires and IHE-Profiles:

• FHIR R4

Specification(s) this track uses

In course of the eEKP-FHIR Track, we focus on 4 distinct Questionnaire definitions that are intendet to record the examinations related to pregnancy and birth. For reference, you can find the Questionnaire-definitions and a prebuild form rendering via

• https://developer.elga.gv.at/apis/eekp-fhir-anbindung/v0.1.0/reference/questionnaires/#zustand-des-kindes-bei-entlassung-transfer

Artifacts of focus

• FHIR resource in focus

  • Questionnaire

  • QuestionnaireReponse

• eEKP Access in eEKP-FHIR is modeled after IHE Mobile Access to Health Documents, in particular the following transactions are in focus

  • ITI-67

  • ITI-68

• Obtaining required Tokens and OAuth2 access

  • RFC 7522

  • RFC 6749

Date / Time

Monday March 2nd, 09:00am-17:00pm CET

Test Servers

A dedicated test server will be provided as part of the event. Access details and further information will be shared separately.

Expected participants

In general this track is open for all participants. However, the track focusses on the following participants in particular:

• Software developers and system integrators who develop FHIR-compatible applications or modules for the eEKP FHIR integration,

• Healthcare service providers who wish to capture or retrieve birth-related data via HL7® FHIR Questionnaires, and

• Manufacturers of medical software who intend to integrate eEKP-FHIR into existing systems.

Track Details

System Roles

FHIR Client

• This actor initiates the processing requests that enable the creation, deletion, manipulation and retrieval of QuestinnaireResponse resources conforming to the aformentioned Questionnaire derfinitions above. The required, supported interactions are:

  • TBD

• All access to the provided eEKP-FHIR interactions will require authentication and authorization against a provided instance of the ELGA/e-Health access control system.

eEKP FHIR Test System

• In the course of the event a test instance for eEKP FHIR will be provided composed of

  • An instance of the ELGA/eHealth Access Control System

  • A FHIR Server that provides the FHIR interactions as defined above

Pre-Requisites (depending on use case)

• REST-Client (Postman, Insomnia, and/or Bruno)

• Browser

Example Instances

Access to eEKP FHIR Test System will be provided in the course of the event.

Level 1

Browser-based Questionnaire Interaction

For this level, participants are provided with a preconfigured browser client that already includes all required setup:

• access tokens and configuration and are handled automatically in the background

• FHIR Questionnaires are automatically loaded and rendered in the UI

• completed QuestionnaireResponses can be submitted directly through the interface

Participants interact solely through the UI and do not need to perform REST calls or manually work with JSON resources.

Participants will learn:

• how a FHIR Questionnaire is structured conceptually

• how Questionnaires are retrieved and rendered by a FHIR client

• how user input is transformed into a QuestionnaireResponse

• how structured healthcare data can be collected without manual JSON handling

• how a typical FHIR workflow works from a client perspective

This level intentionally hides technical complexity in order to focus on concepts:

• no manual JSON editing

• no token handling or authentication setup required

• emphasis on understanding workflow and data structure

This allows participants to concentrate on the functional aspects of questionnaires and their role in healthcare documentation.

Success Criteria

Participants successfully complete Level 1 when they can:

• open and interact with a provided Questionnaire in the browser

• complete and submit a QuestionnaireResponse

• understand the relationship between Questionnaire and QuestionnaireResponse

Step 1: Load a Questionnaire

Step 2: Fill out answers and explore the dynamic form (enableWhen fields) in the UI and submit the QuestionnaireResposne

Step 3: Load a previously submitted QuestionnaireResponse and edit it

Level 2

API-Level Interactions (OAuth2 + FHIR)

• Participants shall be able to test the following interactions against a provided test instance of the ELGA Access Control System:

  • Request an Access Token using provided Authentication Statements

  • Renewing the Access Token token using provided Authentication Statements

• Participants shall be able to test the following interactions and scenarios via the FHIR-SF:

  • Search for eEKP using provided access token

  • Retrieve the complete eEKP using provided access token

  • Store eEKP examinations using provided access token

  • Search for examinations using provided access token

  • Update examinations using provided access token

Level 3

Service and API-Level Interactions (SAML + OAuth2 + FHIR)

• TBD

Helpful Links

Security and Privacy considerations

Do not submit personal data (in particular, social insurance numbers and the like). Development and Test clusters require authentication, but are not encrypted and hardened like a production instance would be - use only the provided pseudo certificates.