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) - JSON Representation

Active as of 2025-09-23

Raw json | Download

    {
      "resourceType" : "CapabilityStatement",
      "id" : "CZ-MHD-DocumentResponder",
      "text" : {
        "status" : "extensions",
        "div" : "<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>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>TLS SHALL be used together with IUA extended access token</p>\n</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>\u00a0</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>"
      },
      "url" : "https://hl7.cz/fhir/hie/CapabilityStatement/CZ-MHD-DocumentResponder",
      "version" : "0.0.1",
      "name" : "CZ_MHD_DocumentResponder",
      "title" : "MHD Document Responder (server)",
      "status" : "active",
      "date" : "2025-09-23",
      "publisher" : "HL7 Czech Republic",
      "contact" : [
        {
          "name" : "HL7 Czech Republic",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://www.hl7.cz/"
            }
          ]
        }
      ],
      "description" : "CapabilityStatement for Actor MHD Document Responder (server).",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "CZ",
              "display" : "Czechia"
            }
          ]
        }
      ],
      "kind" : "requirements",
      "fhirVersion" : "4.0.1",
      "format" : [
        "application/fhir+xml",
        "application/fhir+json"
      ],
      "rest" : [
        {
          "mode" : "server",
          "documentation" : "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" : false,
            "description" : "TLS SHALL be used together with IUA extended access token"
          },
          "resource" : [
            {
              "type" : "DocumentReference",
              "profile" : "https://hl7.cz/fhir/hie/StructureDefinition/cz-mhd-documentreference-comprehensive",
              "interaction" : [
                {
                  "code" : "read"
                },
                {
                  "code" : "search-type"
                },
                {
                  "code" : "update"
                }
              ],
              "searchParam" : [
                {
                  "name" : "_id",
                  "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
                  "type" : "token",
                  "documentation" : "Logical id of this artifact"
                },
                {
                  "name" : "_lastUpdated",
                  "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
                  "type" : "date",
                  "documentation" : "When the resource version last changed"
                },
                {
                  "name" : "author",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-author",
                  "type" : "reference",
                  "documentation" : "Who and/or what authored the document"
                },
                {
                  "name" : "category",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
                  "type" : "token",
                  "documentation" : "Categorization of document"
                },
                {
                  "name" : "event",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
                  "type" : "token",
                  "documentation" : "Main clinical acts documented"
                },
                {
                  "name" : "facility",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
                  "type" : "token",
                  "documentation" : "Kind of facility where patient was seen"
                },
                {
                  "name" : "format",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
                  "type" : "token",
                  "documentation" : "Format/content rules for the document"
                },
                {
                  "name" : "creation",
                  "definition" : "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation",
                  "type" : "date",
                  "documentation" : "When this document was created"
                },
                {
                  "name" : "date",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
                  "type" : "date",
                  "documentation" : "When this document reference was created"
                },
                {
                  "name" : "identifier",
                  "definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
                  "type" : "token",
                  "documentation" : "The identifier for this DocumentReference"
                },
                {
                  "name" : "patient",
                  "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
                  "type" : "reference",
                  "documentation" : "Who/what is the subject of the document"
                },
                {
                  "name" : "period",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
                  "type" : "date",
                  "documentation" : "Time of service that is being documented"
                },
                {
                  "name" : "related",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
                  "type" : "reference",
                  "documentation" : "Related Resource"
                },
                {
                  "name" : "security-label",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
                  "type" : "token",
                  "documentation" : "Document security-tags"
                },
                {
                  "name" : "setting",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
                  "type" : "token",
                  "documentation" : "Additional details about where the content was created (e.g. clinical specialty)"
                },
                {
                  "name" : "status",
                  "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
                  "type" : "token",
                  "documentation" : "current | superseded | entered-in-error"
                },
                {
                  "name" : "type",
                  "definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
                  "type" : "token",
                  "documentation" : "Kind of document (LOINC if possible)"
                }
              ]
            },
            {
              "type" : "Binary",
              "interaction" : [
                {
                  "code" : "read"
                }
              ]
            }
          ],
          "interaction" : [
            {
              "code" : "search-system"
            }
          ]
        }
      ]
    }