eHealth Infrastructure - Local Development build (v3.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: document-query - XML Representation

Active as of 2024-02-04

Raw xml | Download

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="document-query"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title"/><ul><li>Implementation Guide Version: 3.0.0</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <code>application/fhir+xml</code>, <code>xml</code>, <code>application/fhir+json</code>, <code>json</code>, <code>application/x-turtle</code>, <code>ttl</code>, <code>html/json</code>, <code>html/xml</code>, <code>html/turtle</code></li><li>Supported Patch Formats: </li><li>Published on: Sun Feb 04 02:12:24 UTC 2024</li><li>Published by: Den telemedicinske infrastruktur (eHealth Infrastructure)</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 &quot;SHALL NOT&quot;. 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 class="lead"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code> interaction.</li><li>Supports the <code>history-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="#Binary1-1">Binary</a></td><td><a href="http://hl7.org/fhir/R4/binary.html">http://hl7.org/fhir/StructureDefinition/Binary</a></td><td></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td><code>*</code></td><td><code>DocumentReference:patient</code></td><td/></tr><tr><td><a href="#DocumentReference1-2">DocumentReference</a></td><td><a href="StructureDefinition-ehealth-documentreference.html">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference</a></td><td></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td>status, category, date, event, facility, format, patient, patient-identifier, period, setting, type</td><td><code>*</code>, <code>DocumentReference:patient</code></td><td><code>DocumentReference:patient</code></td><td/></tr><tr><td><a href="#OperationDefinition1-3">OperationDefinition</a></td><td><a href="http://hl7.org/fhir/R4/operationdefinition.html">http://hl7.org/fhir/StructureDefinition/OperationDefinition</a></td><td>y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td><code>*</code></td><td><code>DocumentReference:patient</code></td><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Binary1-1" 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-6"><span class="lead">Base System Profile</span><br/><a href="http://hl7.org/fhir/R4/binary.html">http://hl7.org/fhir/StructureDefinition/Binary</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/></div></div><p/><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Binary-t-retrieve-document.html">$retrieve-document</a></td><td><div><p>Retrieve document</p>
</div></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="DocumentReference1-2" 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-ehealth-documentreference.html">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference</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>search-type</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>status</td><td><code>token</code></td><td><div><p>current | superseded</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div><p>Categorization of document</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>Document creation time</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>event</td><td><code>token</code></td><td><div><p>Main clinical acts documented</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>facility</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>format</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>patient</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>patient-identifier</td><td><code>token</code></td><td><div><p>Who/what is the subject of the document (identifier)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>period</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>setting</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>type</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="OperationDefinition1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>OperationDefinition</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="http://hl7.org/fhir/R4/operationdefinition.html">http://hl7.org/fhir/StructureDefinition/OperationDefinition</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>.</li></ul></div></div><p/></div></div></div></div>
  </text>
  <url
       value="http://ehealth.sundhed.dk/fhir/CapabilityStatement/document-query"/>
  <version value="3.0.0"/>
  <name value="document-query"/>
  <status value="active"/>
  <date value="2024-02-04T02:12:24.980+00:00"/>
  <publisher
             value="Den telemedicinske infrastruktur (eHealth Infrastructure)"/>
  <contact>
    <name value="Den telemedicinske infrastruktur (eHealth Infrastructure)"/>
    <telecom>
      <system value="url"/>
      <value value="http://ehealth.sundhed.dk"/>
    </telecom>
  </contact>
  <kind value="instance"/>
  <software>
    <name value="document-query"/>
    <version value="1.8.8"/>
  </software>
  <implementation>
    <description value="eHealth document-query service"/>
    <url value="https://document-query.devtest.systematic-ehealth.com/fhir"/>
  </implementation>
  <fhirVersion value="4.0.1"/>
  <format value="application/fhir+xml"/>
  <format value="xml"/>
  <format value="application/fhir+json"/>
  <format value="json"/>
  <format value="application/x-turtle"/>
  <format value="ttl"/>
  <format value="html/json"/>
  <format value="html/xml"/>
  <format value="html/turtle"/>
  <rest>
    <mode value="server"/>
    <resource>
      <type value="Binary"/>
      <profile value="http://hl7.org/fhir/StructureDefinition/Binary"/>
      <searchInclude value="*"/>
      <searchRevInclude value="DocumentReference:patient"/>
      <operation>
        <name value="retrieve-document"/>
        <definition
                    value="https://document-query.devtest.systematic-ehealth.com/fhir/OperationDefinition/Binary-t-retrieve-document"/>
        <documentation value="Retrieve document"/>
      </operation>
    </resource>
    <resource>
      <type value="DocumentReference"/>
      <profile
               value="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference"/>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchInclude value="*"/>
      <searchInclude value="DocumentReference:patient"/>
      <searchRevInclude value="DocumentReference:patient"/>
      <searchParam>
        <name value="status"/>
        <type value="token"/>
        <documentation value="current | superseded"/>
      </searchParam>
      <searchParam>
        <name value="category"/>
        <type value="token"/>
        <documentation value="Categorization of document"/>
      </searchParam>
      <searchParam>
        <name value="date"/>
        <type value="date"/>
        <documentation value="Document creation time"/>
      </searchParam>
      <searchParam>
        <name value="event"/>
        <type value="token"/>
        <documentation value="Main clinical acts documented"/>
      </searchParam>
      <searchParam>
        <name value="facility"/>
        <type value="token"/>
        <documentation value="Kind of facility where patient was seen"/>
      </searchParam>
      <searchParam>
        <name value="format"/>
        <type value="token"/>
        <documentation value="Format/content rules for the document"/>
      </searchParam>
      <searchParam>
        <name value="patient"/>
        <type value="reference"/>
        <documentation value="Who/what is the subject of the document"/>
      </searchParam>
      <searchParam>
        <name value="patient-identifier"/>
        <type value="token"/>
        <documentation
                       value="Who/what is the subject of the document (identifier)"/>
      </searchParam>
      <searchParam>
        <name value="period"/>
        <type value="date"/>
        <documentation value="Time of service that is being documented"/>
      </searchParam>
      <searchParam>
        <name value="setting"/>
        <type value="token"/>
        <documentation
                       value="Additional details about where the content was created (e.g. clinical specialty)"/>
      </searchParam>
      <searchParam>
        <name value="type"/>
        <type value="token"/>
        <documentation value="Kind of document (LOINC if possible)"/>
      </searchParam>
    </resource>
    <resource>
      <type value="OperationDefinition"/>
      <profile
               value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <searchInclude value="*"/>
      <searchRevInclude value="DocumentReference:patient"/>
    </resource>
    <interaction>
      <code value="transaction"/>
    </interaction>
    <interaction>
      <code value="history-system"/>
    </interaction>
    <operation>
      <name value="process-message"/>
      <definition
                  value="https://document-query.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-process-message"/>
      <documentation value="Accept a FHIR Message Bundle for processing"/>
    </operation>
    <operation>
      <name value="perform-reindexing-pass"/>
      <definition
                  value="https://document-query.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-perform-reindexing-pass"/>
      <documentation
                     value="Forces a single pass of the resource reindexing processor"/>
    </operation>
    <operation>
      <name value="meta"/>
      <definition
                  value="https://document-query.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-meta"/>
    </operation>
    <operation>
      <name value="get-resource-counts"/>
      <definition
                  value="https://document-query.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-get-resource-counts"/>
      <documentation
                     value="Provides the number of resources currently stored on the server, broken down by resource type"/>
    </operation>
    <operation>
      <name value="reindex-terminology"/>
      <definition
                  value="https://document-query.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-reindex-terminology"/>
    </operation>
  </rest>
</CapabilityStatement>