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

## CapabilityStatement: MHD Document Consumer (client)

Official URL: https://hl7.cz/fhir/hie/CapabilityStatement/CZ-MHD-DocumentConsumer | Version: 0.0.1
Active as of 2025-09-23 | Computable Name: CZ_MHD_DocumentConsumer

CapabilityStatement for Actor MHD Document Consumer (client).

Raw OpenAPI-Swagger Definition file | Download

## MHD Document Consumer (client)

- Implementation Guide Version: 0.0.1
- FHIR Version: 4.0.1
- Supported Formats: `application/fhir+xml`, `application/fhir+json`
- Published on: 2025-09-23
- Published by: HL7 Czech Republic

> Note to Implementers: FHIR Capabilities

> Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

## FHIR RESTful Capabilities

### Mode: `client`

MHD client requests a list of DocumentReference Resources, matching the supplied set of criteria, from the Document Responder [ITI-67]. MHD client requests a document from the Document Responder [ITI-68].

Security

> TLS SHALL be used together with IUA extended access token

Summary of System-wide Interactions

- Supports the `search-system`interaction.

### Capabilities by Resource/Profile

#### Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

- The relevant profiles (if any)
- The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
- The required, recommended, and some optional search parameters (if any).
- The linked resources enabled for `_include`
- The other resources enabled for `_revinclude`
- The operations on the resource (if any)

Resource Type | Profile | R | S | U | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
DocumentReference | https://hl7.cz/fhir/hie/StructureDefinition/cz-mhd-documentreference-comprehensive | y | y |  |  | _id, _lastUpdated, author, category, date, event, facility, format, identifier, patient, period, related, security-label, setting, status, type |  |  |
List | https://hl7.cz/fhir/hie/StructureDefinition/cz-mhd-submissionset-comprehensive | y | y |  |  | _id, _lastupdated, code, creation, date, identifier, subject |  |  |
Binary |  | y |  |  |  |  |  |  |

#### Resource Conformance: supported DocumentReference

Base System Profile
CZ MHD DocumentReference Comprehensive
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `read`, `search-type`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Logical id of this artifact
SHALL | _lastUpdated | `date` | When the resource version last changed
SHALL | author | `reference` | Who and/or what authored the document
SHALL | category | `token` | Categorization of document
SHALL | date | `date` | When this document reference was created
SHALL | event | `token` | Main clinical acts documented
SHALL | facility | `token` | Kind of facility where patient was seen
SHALL | format | `token` | Format/content rules for the document
SHALL | identifier | `token` | The identifier for this DocumentReference
SHALL | patient | `reference` | Who/what is the subject of the document
SHALL | period | `date` | Time of service that is being documented
SHALL | related | `reference` | Related Resource
SHALL | security-label | `token` | Document security-tags
SHALL | setting | `token` | Additional details about where the content was created (e.g. clinical specialty)
SHALL | status | `token` | current | superseded | entered-in-error
SHALL | type | `token` | Kind of document (LOINC if possible)

#### Resource Conformance: supported List

Base System Profile
CZ MHD SubmissionSet Comprehensive
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `read`, `search-type`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Logical id of this artifact
SHALL | _lastupdated | `date` | When the resource version last changed
SHALL | code | `token` | This parameter, of type token, specifies the code.coding value supplied in the List Resource. The value of the code element indicates the List of type SubmissionSet or Folder as indicated.
SHALL | creation | `date` | When this document was created
SHALL | date | `date` | This parameter, of type date, specifies the time when the List was created.
SHALL | identifier | `token` | This parameter, of type token, specifies an identifier for this List. The search results represent the results of a search on List.masterIdentifier and List.identifier. See ITI TF-2: Appendix Z.2 for additional constraints on the use of the token search parameter type.
SHALL | subject | `reference` | This parameter is of type Reference(Patient). The Document Consumer may get this reference through the use of the PDQm or PIXm Profiles, or by some other method. When the patient parameter is used, the Patient reference would need to be accessible to both the Document Consumer and the Document Responder.

#### Resource Conformance: supported Binary

Core FHIR Resource
Binary
Reference Policy
Interaction summary

- Supports `read`.