E-Rezept App (iOS)

About The Project
- Release Notes
Getting Started
Functional Requirements
Usage
Contributing
Security And Privacy
License
Contact
Additional Links And Sourcecode

About The Project

Prescriptions for medicines that are only available in pharmacies can be issued as electronic prescriptions (e-prescriptions resp. E-Rezepte) for people with public health insurance from 1 July 2021. The official gematik E-Rezept App (electronic prescription app) is available to receive and redeem prescriptions digitally. Anyone can download the app for free:

Login is possible with the health card or the app of the users public health insurance company. In July 2021, the e-prescription started with a test phase, initially in the focus region Berlin-Brandenburg. The nationwide rollout started three month later in September 2022.

The e-prescriptions are stored in the telematics infrastructure, for which gematik is responsible.

Visit our FAQ page for more information about the e-prescription.

Release Notes

See ReleaseNotes.md for all information regarding the (newest) releases.

Getting Started

This section provides instructions on how to get started with the project, including setting up the development environment and building the application.

Prerequisites

Before you can build and run the application, ensure you have the following prerequisites installed on your system:

Xcode: The official IDE for iOS app development.
Swift: The primary programming language used in this project. Xcode comes bundled with Swift support.
Git: A distributed version control system used to manage the project’s source code.
Homebrew: For installing dependencies like sourcery.

Getting the Project Code

To begin, clone the project’s repository from GitHub using the following command in your terminal:

git clone https://github.com/gematik/E-Rezept-App-iOS.git

Structure

The following is an overview of the more important parts of the iOS project:

|-- App
|   |-- Package.swift
|   |-- Sources
|   |   |-- AppDelegate.swift
|   |   |-- Resources
|   |   |-- UITestScenarios
|   |-- Tests
|-- Sources
|   |-- eRpApp
|   |-- eRpKit
|   |-- eRpLocalStorage
|   |-- eRpRemoteStorage
|   |-- eRpStyleKit
|   |-- FHIRClient
|   |-- HTTPClient
|   |-- IDP
|   |-- Pharmacy
|   |-- TrustStore
|   |-- ...
|-- Tests
|   |-- eRpAppTests
|   |-- eRpAppUITests
|   |-- eRpKitTests
|   |-- ...
|-- fastlane
|-- scripts
|-- Templates
|-- doc

App/Sources: Main app entry point and resources.
Sources/eRpApp: iOS front-end (consumer facing) eRezept App.
Sources/eRpKit: Non platform specific business logic.
Sources/eRpLocalStorage & eRpRemoteStorage: FHIR communication modules.
Sources/Pharmacy: Handles communication with the Pharmacy API.
Sources/FHIRClient: Provides a generic FHIR interface.
Sources/HTTPClient: HTTP communication.
Sources/IDP: Authentication against the eHealth network.
Sources/VAUClient: Encrypted communication channel.
Sources/TrustStore: Trust validation and OCSP handling.

You can find more documentation about each module here.

Installation

To set up the project and install dependencies, run:

make setup

This will ensure all dependencies are in place and the Xcode project is generated.

You’ll need a running implementation of IDP and FD. Reference implementations are available for IDP and FD.

To build the app for release, run:

make build

Note: Make sure you have run make setup before and have code-signing set up for your local or CI build.

Functional Requirements

The underlying requirements can be found within the Gematik Fachportal. Search for “E-Rezept Frontend des Versicherten”.

A mapping of these requirements can be found within the documentation. To generate the mapping from requirements to implementation run bundle exec fastlane list_requirements.

Usage

The installed debug build is for local testing only. To show some data, you can use demo/test modes if available. For a live version, please download from the sources mentioned in the About The Project section.

Contributing

See Contributing.md for all information regarding the contributing process in this project.

Security And Privacy

See Security.md for all information regarding the used security and privacy guidelines in this project.

You can find the privacy policy for the app at: https://www.das-e-rezept-fuer-deutschland.de/app/datenschutz

License

EUROPEAN UNION PUBLIC LICENCE v. 1.2

See the LICENSE for the specific language governing permissions and limitations under the License

Additional Notes and Disclaimer from gematik GmbH

Copyright notice: Each published work result is accompanied by an explicit statement of the license conditions for use. These are regularly typical conditions in connection with open source or free software. Programs described/provided/linked here are free software, unless otherwise stated.

Permission notice: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
1. The copyright notice (Item 1) and the permission notice (Item 2) shall be included in all copies or substantial portions of the Software.
2. The software is provided “as is” without warranty of any kind, either express or implied, including, but not limited to, the warranties of fitness for a particular purpose, merchantability, and/or non-infringement. The authors or copyright holders shall not be liable in any manner whatsoever for any damages or other claims arising from, out of or in connection with the software or the use or other dealings with the software, whether in an action of contract, tort, or otherwise.
3. We take open source license compliance very seriously. We are always striving to achieve compliance at all times and to improve our processes. If you find any issues or have any suggestions or comments, or if you see any other ways in which we can improve, please reach out to: ospo@gematik.de
Please note: Parts of this code may have been generated using AI-supported technology. Please take this into account, especially when troubleshooting, for security analyses and possible adjustments.