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

## : MHD Document Responder (server) - XML Representation

Active as of 2025-09-23

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="CZ-MHD-DocumentResponder"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement CZ-MHD-DocumentResponder</b></p><a name="CZ-MHD-DocumentResponder"> </a><a name="hcCZ-MHD-DocumentResponder"> </a><h2 id="title">MHD Document Responder (server)</h2><ul><li>Implementation Guide Version: 0.0.1 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Published on: 2025-09-23 </li><li>Published by: HL7 Czech Republic </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div><p>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].</p>
    </div><div class="lead"><em>Security</em></div><blockquote><div><p>TLS SHALL be used together with IUA extended access token</p>
    </div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code>interaction.</li></ul></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#DocumentReference1-1">DocumentReference</a></td><td><a href="StructureDefinition-cz-mhd-documentreference-comprehensive.html">https://hl7.cz/fhir/hie/StructureDefinition/cz-mhd-documentreference-comprehensive</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td>_id, _lastUpdated, author, category, event, facility, format, creation, date, identifier, patient, period, related, security-label, setting, status, type</td><td/><td/><td/></tr><tr><td><a href="#Binary1-2">Binary</a></td><td> </td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="DocumentReference1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>DocumentReference</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-cz-mhd-documentreference-comprehensive.html">CZ MHD DocumentReference Comprehensive</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>, <code>update</code>.</li></ul></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_lastUpdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">author</a></td><td><code>reference</code></td><td><div><p>Who and/or what authored the document</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">category</a></td><td><code>token</code></td><td><div><p>Categorization of document</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">event</a></td><td><code>token</code></td><td><div><p>Main clinical acts documented</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">facility</a></td><td><code>token</code></td><td><div><p>Kind of facility where patient was seen</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">format</a></td><td><code>token</code></td><td><div><p>Format/content rules for the document</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="https://profiles.ihe.net/ITI/MHD/4.2.2/SearchParameter-DocumentReference-Creation.html">creation</a></td><td><code>date</code></td><td><div><p>When this document was created</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">date</a></td><td><code>date</code></td><td><div><p>When this document reference was created</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">identifier</a></td><td><code>token</code></td><td><div><p>The identifier for this DocumentReference</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">patient</a></td><td><code>reference</code></td><td><div><p>Who/what is the subject of the document</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">period</a></td><td><code>date</code></td><td><div><p>Time of service that is being documented</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">related</a></td><td><code>reference</code></td><td><div><p>Related Resource</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">security-label</a></td><td><code>token</code></td><td><div><p>Document security-tags</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">setting</a></td><td><code>token</code></td><td><div><p>Additional details about where the content was created (e.g. clinical specialty)</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">status</a></td><td><code>token</code></td><td><div><p>current | superseded | entered-in-error</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">type</a></td><td><code>token</code></td><td><div><p>Kind of document (LOINC if possible)</p>
    </div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Binary1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Binary</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/binary.html">Binary</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><p/></div></div></div></div>
      </text>
      <url
           value="https://hl7.cz/fhir/hie/CapabilityStatement/CZ-MHD-DocumentResponder"/>
      <version value="0.0.1"/>
      <name value="CZ_MHD_DocumentResponder"/>
      <title value="MHD Document Responder (server)"/>
      <status value="active"/>
      <date value="2025-09-23"/>
      <publisher value="HL7 Czech Republic"/>
      <contact>
        <name value="HL7 Czech Republic"/>
        <telecom>
          <system value="url"/>
          <value value="https://www.hl7.cz/"/>
        </telecom>
      </contact>
      <description
                   value="CapabilityStatement for Actor MHD Document Responder (server)."/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="CZ"/>
          <display value="Czechia"/>
        </coding>
      </jurisdiction>
      <kind value="requirements"/>
      <fhirVersion value="4.0.1"/>
      <format value="application/fhir+xml"/>
      <format value="application/fhir+json"/>
      <rest>
        <mode value="server"/>
        <documentation
                       value="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>
          <cors value="false"/>
          <description
                       value="TLS SHALL be used together with IUA extended access token"/>
        </security>
        <resource>
          <type value="DocumentReference"/>
          <profile
                   value="https://hl7.cz/fhir/hie/StructureDefinition/cz-mhd-documentreference-comprehensive"/>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <code value="update"/>
          </interaction>
          <searchParam>
            <name value="_id"/>
            <definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
            <type value="token"/>
            <documentation value="Logical id of this artifact"/>
          </searchParam>
          <searchParam>
            <name value="_lastUpdated"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
            <type value="date"/>
            <documentation value="When the resource version last changed"/>
          </searchParam>
          <searchParam>
            <name value="author"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-author"/>
            <type value="reference"/>
            <documentation value="Who and/or what authored the document"/>
          </searchParam>
          <searchParam>
            <name value="category"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-category"/>
            <type value="token"/>
            <documentation value="Categorization of document"/>
          </searchParam>
          <searchParam>
            <name value="event"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-event"/>
            <type value="token"/>
            <documentation value="Main clinical acts documented"/>
          </searchParam>
          <searchParam>
            <name value="facility"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-facility"/>
            <type value="token"/>
            <documentation value="Kind of facility where patient was seen"/>
          </searchParam>
          <searchParam>
            <name value="format"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-format"/>
            <type value="token"/>
            <documentation value="Format/content rules for the document"/>
          </searchParam>
          <searchParam>
            <name value="creation"/>
            <definition
                        value="https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation"/>
            <type value="date"/>
            <documentation value="When this document was created"/>
          </searchParam>
          <searchParam>
            <name value="date"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-date"/>
            <type value="date"/>
            <documentation value="When this document reference was created"/>
          </searchParam>
          <searchParam>
            <name value="identifier"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
            <type value="token"/>
            <documentation value="The identifier for this DocumentReference"/>
          </searchParam>
          <searchParam>
            <name value="patient"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
            <type value="reference"/>
            <documentation value="Who/what is the subject of the document"/>
          </searchParam>
          <searchParam>
            <name value="period"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-period"/>
            <type value="date"/>
            <documentation value="Time of service that is being documented"/>
          </searchParam>
          <searchParam>
            <name value="related"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-related"/>
            <type value="reference"/>
            <documentation value="Related Resource"/>
          </searchParam>
          <searchParam>
            <name value="security-label"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-security-label"/>
            <type value="token"/>
            <documentation value="Document security-tags"/>
          </searchParam>
          <searchParam>
            <name value="setting"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-setting"/>
            <type value="token"/>
            <documentation
                           value="Additional details about where the content was created (e.g. clinical specialty)"/>
          </searchParam>
          <searchParam>
            <name value="status"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/DocumentReference-status"/>
            <type value="token"/>
            <documentation value="current | superseded | entered-in-error"/>
          </searchParam>
          <searchParam>
            <name value="type"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/clinical-type"/>
            <type value="token"/>
            <documentation value="Kind of document (LOINC if possible)"/>
          </searchParam>
        </resource>
        <resource>
          <type value="Binary"/>
          <interaction>
            <code value="read"/>
          </interaction>
        </resource>
        <interaction>
          <code value="search-system"/>
        </interaction>
      </rest>
    </CapabilityStatement>