HL7 Czech Health information exchange Implementation Guide
0.0.1 - ci-build Czechia flag

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

Find Document References [ITI-67]

This section describes the additional requirements for the Czech HIE of the Find Document References [ITI-67] transaction defined in the MHD Profile published in the IHE ITI Trial Implementation “Mobile Access to Health Documents”.

Scope

The Find Document References transaction is used to find DocumentReference Resources that satisfy a set of parameters. It is equivalent to the FindDocuments and FindDocumentsByReferenceId queries from the Registry Stored Query [ITI-18] transaction. The result of the query is a FHIR Bundle containing DocumentReference Resources that match the query parameters.

Actor Roles

Table 1: Actor Roles

Actor Role
[Document Consumer] Requests a list of DocumentReference Resources, matching the supplied set of criteria, from the Document Responder
[Document Responder] Returns DocumentReference Resources that match the search criteria provided by the Document Consumer

Referenced Standards

FHIR-R4 HL7 FHIR Release 4.0

Messages

Find Document References [ITI-67]Find Document References [ITI-67]Document ConsumerDocument ResponderDocument ConsumerDocument ResponderDocument ConsumerDocument ResponderDocument ConsumerDocument Responder1. Find Document References [ITI-67]

Find Document References Request Message

The Document Consumer SHALL include the search parameter patient.identifier with the RID. The search parameters of type token SHALL contain both the system and the code.

Find Document Reference example request:

GET [base]/DocumentReference?patient.identifier=urn:oid:2.16.756.5.30.1.127.3.10.3|761337610411353650&status=current HTTP/1.1
Accept: application/fhir+json
traceparent: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-00

Expected Actions

The Document Responder SHALL process the query to discover the DocumentReference entries that match the search parameters given.

The Document Responder SHALL support search page count requests from the Document Consumer of up to 100 resources.

The Document Responder SHALL set the DocumentReference.content.attachment.url value to the URL used in ITI-68 transactions to retrieve that document's content.

Find Document References Response Message

The response Bundle SHALL follow the CZ MHD Find Document References Comprehensive Response message.

Federated Cross Community Access Option

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.

CapabilityStatement Resource

The CapabilityStatement resource for the Document Consumer is MHD Document Consumer.

The CapabilityStatement resource for the Document Responder is MHD Document Responder.

Security Consideration

The transaction SHALL be secured by Transport Layer Security (TLS) encryption and server authentication with server certificates. Transactions across communities SHALL use mTLS.

The transaction SHALL use client authentication and authorization using one of the following strategies:

  1. Use an extended access token defined in IUA conveyed as defined in the Incorporate Access Token [ITI-72] transaction.
  2. or, use mutual authentication (mTLS) on the transport layer in combination with a XUA token for authorization from the Get X-User Assertion transaction (Annex 5.1 1.6.4.2). The XUA token SHALL be conveyed as defined in the Incorporate Access Token [ITI-72] transaction.

Security Audit Considerations

Will be added in future (ATNA)

Document Consumer Audit
Document Responder Audit