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

CapabilityStatement: MHD Document Responder (server)

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

CapabilityStatement for Actor MHD Document Responder (server).

Raw OpenAPI-Swagger Definition file | Download

Language: en

MHD Document Responder (server)

  • 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: server

MHD server returns DocumentReference Resources that match the search criteria provided by the Document Consumer [ITI-67]. MHD supports update of DocumentReference Resources by the Document Source [CZ:MHD-1]. MHD server serves the document to the Document Consumer [ITI-68].

Security
Enable CORS: no
Security services supported: OAuth, Certificates

mTLS (TLS 1.3, min. TLS 1.2) with mutual node authentication according to ATNA [ITI-19] using certificates issued by the MZCR certification authority SHALL be used together with an IUA access token (JWT) issued by the central eHealth authorization server [ITI-71] and conveyed according to [ITI-72].

Summary of System-wide Interactions
  • Supports the search-systeminteraction.

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 TypeProfileRSUCSearches_include_revincludeOperations
DocumentReferencehttps://hl7.cz/fhir/hie/StructureDefinition/cz-mhd-documentreference-comprehensiveyyy_id, _lastUpdated, author, category, event, facility, format, creation, date, identifier, patient, patient.identifier, period, related, security-label, setting, status, type, hcid
Listhttps://hl7.cz/fhir/hie/StructureDefinition/cz-mhd-submissionset-comprehensiveyy_id, code, date, identifier, patient, patient.identifier, status
Binary y
Base System Profile
CZ MHD DocumentReference Comprehensive
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

SHALLauthorreference

Who and/or what authored the document

SHALLcategorytoken

Categorization of document

SHALLeventtoken

Main clinical acts documented

SHALLfacilitytoken

Kind of facility where patient was seen

SHALLformattoken

Format/content rules for the document

SHALLcreationdate

When this document was created

SHALLdatedate

When this document reference was created

SHALLidentifiertoken

The identifier for this DocumentReference

SHALLpatientreference

Who/what is the subject of the document

SHALLpatient.identifiertoken

Identifikátor pacienta (RID nebo DRID v systému https://ncez.mzcr.cz/fhir/sid/rid). Povinný parametr transakcí ITI-66 a ITI-67.

SHALLperioddate

Time of service that is being documented

SHALLrelatedreference

Related Resource

SHALLsecurity-labeltoken

Document security-tags

SHALLsettingtoken

Additional details about where the content was created (e.g. clinical specialty)

SHALLstatustoken

current | superseded | entered-in-error

SHALLtypetoken

Kind of document (LOINC if possible)

SHALLhcidtoken

Home community id which authored the document

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

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLcodetoken

Typ seznamu (SubmissionSet nebo Folder)

SHALLdatedate

Datum vytvoření seznamu

SHALLidentifiertoken

Identifikátor seznamu (List.masterIdentifier nebo List.identifier)

SHALLpatientreference

Pacient, kterého se seznam týká

SHALLpatient.identifiertoken

Identifikátor pacienta (RID nebo DRID v systému https://ncez.mzcr.cz/fhir/sid/rid). Povinný parametr transakcí ITI-66 a ITI-67.

SHALLstatustoken

current | retired | entered-in-error

 
Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • Supports read.