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
This section corresponds to transaction [ITI-66] of the IHE Technical Framework. Transaction [ITI-66] is used by the Document Consumer and Document Responder Actors. This transaction is used to locate and return metadata for previously stored document submission sets or folders.
The Find Document Lists [ITI-66] transaction is used to find List Resources that satisfy a set of parameters. It is equivalent to the:
The result of the query is a Bundle containing List Resources that match the query parameters.
Table 1: Actor Roles
| Actor | Role |
|---|---|
| Document Consumer | Requests List Resources, matching the supplied set of criteria, from the Document Responder |
| Document Responder | Returns List Resources that match the search criteria provided by the Document Consumer |
FHIR-R4 HL7 FHIR Release 4.0
Figure 1: Find Document Lists Interactions
The response Bundle SHALL follow the CZ MHD Find Document References Comprehensive Response message.
If a Document Responder does not respond, an OperationOutcome with a severity warning SHALL be added to the aggregated results indicating the community does not respond.
For matching DocumentReferences returned by the Document Responder, the Document Responder SHALL ensure by rewriting the id and attachment.url that follow-up reads, updates or document retrieval will be handled by same Document Responder actor. Any id, url rewrite SHALL be resolvable for at least an hour.
The CapabilityStatement resource for the Document Consumer is MHD Document Consumer.
The CapabilityStatement resource for the Document Responder is MHD Document Responder.
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 actors SHALL record an audit event and send it with Record Audit Event [ITI-20]:
The audit event SHALL record the node identities from mTLS and the details of the IUA access token as defined in Recording the communication security. The AAfD records the query and its result (healthcare provider, healthcare professional, RID or DRID, query parameters).