HL7 Czech Health information exchange Implementation Guide
0.0.1 - ci-build
HL7 Czech Health information exchange Implementation Guide, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/HIE/ and changes regularly. See the Directory of published versions
The Retrieve ATNA Audit Event [ITI-81] transaction is defined in IHE ITI TF-2 and the IHE ITI Supplement Add RESTful Query to ATNA. The following rules apply in the Czech national extension.
The Retrieve ATNA Audit Event message shall be a HTTP GET request sent to the Audit Record Repository. This message is a FHIR search (see http://hl7.org/fhir/R4/search.html) on AuditEvent Resources (see http://hl7.org/fhir/R4/auditevent.html). This "search" target is formatted as:
<scheme>://<authority>/<path>/AuditEvent?date=ge[start-time]&date=le[stop-time]&<query>
where:
<scheme> shall be https.
<query> shall include at least one parameter identifying the data subject as defined in Additional ATNA Search Parameters and may include additional ATNA Search parameters. If no parameter identifying the data subject is included, an HTTP response code 400 - Bad Request shall be returned.
The Activity Journal (Žurnál činností) retrieves audit records for a data subject – a patient, a healthcare professional or a healthcare provider. The subject is identified by one of these parameters:
| Subject | Parameter | Matched against | Example value |
|---|---|---|---|
| Patient | entity.identifier |
AuditEvent.entity.what.identifier (ParticipantObjectID in DICOM) |
https://ncez.mzcr.cz/fhir/sid/rid\|2066425387 (RID, or DRID) |
| Healthcare professional | altid |
AuditEvent.agent.altId (KRZP identifier) |
2000000090092 |
| Healthcare provider | agent:identifier |
AuditEvent.agent.who.identifier (provider company ID from the access token) |
https://ncez.mzcr.cz/fhir/sid/ico\|12345678 |
Token parameters SHALL contain both the system and the value. The Audit Consumer may use other parameters as listed in Retrieve Audit Event [ITI-81].
Example query for the audit records of a patient:
https://example.com/ARRservice/AuditEvent?date=ge2020-03-22&date=le2025-03-22&entity.identifier=https://ncez.mzcr.cz/fhir/sid/rid|2066425387
Example query for the audit records of a healthcare professional:
https://example.com/ARRservice/AuditEvent?date=ge2025-01-01&date=le2025-03-31&altid=2000000090092
The returned AuditEvent FHIR resources in the Bundle shall conform to the audit event content profiles, see Volume 3 – Audit Event Content Profiles.
Security of the transaction is based on the Czech Standard for Accredited Affinity Domains (AAfD). The transport layer (mTLS) and the application layer (IUA access token) are always used together; they are not alternatives.
The transaction SHALL be secured by TLS 1.3 (at least TLS 1.2 with strong cipher suites) with mutual node authentication (mTLS) as defined in the ATNA Authenticate Node [ITI-19] transaction. Both client and server authenticate with an X.509 certificate issued by the certification authority of the Czech Ministry of Health (MZČR), and each side validates the certificate of its peer. mTLS is used for all communication: between the healthcare provider's system (IS PZS) and the AAfD, between AAfDs, and between an AAfD and the central eHealth services.
The client SHALL convey an IHE IUA access token in JSON Web Token (JWT) format in every request:
Authorization: Bearer header as defined in Incorporate Access Token [ITI-72].When the home AAfD forwards a request to another AAfD, it obtains a new access token for the target AAfD using OAuth 2.0 Token Exchange as defined in RFC 8693: the subject_token is the access token of the healthcare provider and the actor_token is the system token of the calling AAfD. The target AAfD verifies in the eHealth Service Catalogue that the calling AAfD is accredited and issues a token containing the identity of the healthcare provider (sub) and of the intermediary AAfD (act). Forwarding the healthcare provider's token to another AAfD without validation is not allowed.
Actors SHALL support the traceparent header as defined in W3C Trace Context.
The Audit Consumer is the central eHealth component Activity Journal (Žurnál činností). It authenticates with its certificate in mTLS and with its system access token. The Audit Record Repository SHALL verify that the caller is authorized to read audit records and SHALL return only records related to the queried subject.
The Audit Record Repository SHALL record every query for audit records as an audit event according to the Access Audit Trail Content Profile, including the identity of the caller from mTLS and from the access token (see Recording the communication security).