eHealth Infrastructure
7.0.0 - release
eHealth Infrastructure
7.0.0 - release
eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 7.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions
| Active as of 2025-12-09 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="library"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement library</b></p><a name="library"> </a><a name="hclibrary"> </a><h2 id="title"/><ul><li>Implementation Guide Version: 7.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>Published on: 2025-12-09 02:22:22+0000 </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 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><p>This CapabilityStatement instantiates the CapabilityStatement <code>http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data</code></p><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="row"><div class="col-12"><span class="lead">Summary of System-wide 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>$reindex</td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>$migrate</td><td><div><p>Data migration</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>$export-poll-status</td><td><div><p>Operation for polling the status of a previously initiated FHIR Bulk Data System Level Export. A complete URL including the '_jobId' is returned in the 'Content-Location' response header when initiating the export. A 'GET' request to the polling location will return '202 Accepted' with a response header 'X-Progress' containing a status message for the progress of the export job. When the job has finished, the polling location will return '200 OK', and the contents of the body will be a JSON object providing metadata and links to the generated bulk data files. A 'DELETE' request can be used to cancel the export. If the export has already finished, the delete will return '404 Not Found', else the export job will be cancelled and a '202 Accepted' is returned with an operation outcome response.</p>
<h3>Parameters</h3>
<ul>
<li>_jobId: the job ID for the Bulk Export job which was returned in the 'Content-Location' header when initiating the export</li>
</ul>
</div></td></tr><tr><td><b>SHALL</b></td><td>$export</td><td><div><p>FHIR Operation to initiate an export of data from a FHIR server. The type of resources returned can be restricted using the '_type' parameter, and the '_since' parameter can be used to restrict resources to be only included if changed since the supplied time. The FHIR server support invocation of this operation using the <a href="http://hl7.org/fhir/R4/async.html">FHIR Asynchronous Request Pattern</a>.</p>
<h2>Initiation of export</h2>
<p>The initiation of an export must specify the request header 'Prefer: respond-async', and will return '202 Accepted' with a polling location in the response header 'Content-Location'. The polling location is for the endpoint '$export-poll-status' and has the export job ID as parameter '_jobId'.</p>
<h3>Parameters</h3>
<ul>
<li>_outputFormat: Optional parameter to specify the output format of the exported files. Default is 'application/fhir+ndjson'</li>
<li>_type: Optional parameter to specify a comma separated list of resource types to be included in the export. If not provided, all resource types will be included.</li>
<li>_since: Optional parameter to specify a time. Only resources that have been created or modified after this time will be included in the export (i.e., if Resource.meta.lastUpdated is later than the supplied _since time).</li>
<li>_typePostFetchFilterUrl: Optional parameter to apply filtering of resources for export. It is a string of comma-delimited FHIR REST search queries in the format [resourceType]?[parameters]. The filter will be applied on resources after being fetched from the database.</li>
<li>_exportId: Optional parameter to specify a client provided identifier for the export. Resulting exported files (Binary) will be labeled with the identifer in meta extension 'https://hapifhir.org/NamingSystem/bulk-export-identifier'</li>
</ul>
<h2>Polling status of export</h2>
<p>Subsequent GET requests to the polling location will return '202 Accepted' with a response header 'X-Progress' containing a status message for the progress of the export job. When the job has finished, the polling location will return '200 OK', and the contents of the body will be a JSON object providing metadata and links to the generated bulk export data files.</p>
<h2>Retrieving exported files</h2>
<p>The JSON object returned when the export job is complete will contain a list of files (Binary resources) available for download. Each file can be retrieved using a standard HTTP GET request to the provided URL. The security context of the Binary resources resulting from the export is the user that initiated the export. The files can therefore only be retrieved by the same user.</p>
<h3>Retention of exported files</h3>
<p>The exported files are retained for a limited time after which they are deleted. The retention time is a server configuration with default 2 hours.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>$meta</td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>$get-resource-counts</td><td><div><p>Provides the number of resources currently stored on the server, broken down by resource type</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>$expunge</td><td><div/></td></tr></tbody></table></div></div></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 past versions of resources (vread interaction)">V-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 class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td><code>*</code></td><td><code>Library:composed-of</code>, <code>Library:depends-on</code>, <code>Library:derived-from</code>, <code>Library:predecessor</code>, <code>Library:successor</code></td><td/></tr><tr><td><a href="#Library1-2">Library</a></td><td><a href="StructureDefinition-ehealth-library.html">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, composed-of, date, depends-on, derived-from, description, effective, identifier, jurisdiction, name, predecessor, publisher, status, successor, title, topic, url, version</td><td><code>*</code>, <code>Library:composed-of</code>, <code>Library:depends-on</code>, <code>Library:derived-from</code>, <code>Library:predecessor</code>, <code>Library:successor</code></td><td><code>Library:composed-of</code>, <code>Library:depends-on</code>, <code>Library:derived-from</code>, <code>Library:predecessor</code>, <code>Library:successor</code></td><td><code>$validate</code>, <code>$evaluate</code></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 class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td><code>*</code></td><td><code>Library:composed-of</code>, <code>Library:depends-on</code>, <code>Library:derived-from</code>, <code>Library:predecessor</code>, <code>Library:successor</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">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><li>Supports <code>vread</code>, <code>read</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Library1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Library</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-library.html">ehealth-library</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>update</code>, <code>search-type</code>, <code>vread</code>, <code>read</code>, <code>create</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>_content</td><td><code>string</code></td><td><div><p>Search the contents of the resource's data using a fulltext search</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_has</td><td><code>string</code></td><td><div><p>Return resources linked to by the given target</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div><p>The ID of the resource</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_language</td><td><code>string</code></td><td><div><p>The language of the resource</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdated</td><td><code>date</code></td><td><div><p>Only return resources which were last updated as specified by the given range</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_profile</td><td><code>uri</code></td><td><div><p>Search for resources which have the given profile</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_security</td><td><code>token</code></td><td><div><p>Search for resources which have the given security labels</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_tag</td><td><code>token</code></td><td><div><p>Search for resources which have the given tag</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_text</td><td><code>string</code></td><td><div><p>Search the contents of the resource's narrative using a fulltext search</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>composed-of</td><td><code>reference</code></td><td><div><p>What resource is being referenced</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>The library publication date</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>depends-on</td><td><code>reference</code></td><td><div><p>What resource is being referenced</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>derived-from</td><td><code>reference</code></td><td><div><p>What resource is being referenced</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>description</td><td><code>string</code></td><td><div><p>The description of the library</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>effective</td><td><code>date</code></td><td><div><p>The time during which the library is intended to be in use</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>External identifier for the library</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>jurisdiction</td><td><code>token</code></td><td><div><p>Intended jurisdiction for the library</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>Computationally friendly name of the library</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>predecessor</td><td><code>reference</code></td><td><div><p>What resource is being referenced</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>publisher</td><td><code>string</code></td><td><div><p>Name of the publisher of the library</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>The current status of the library</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>successor</td><td><code>reference</code></td><td><div><p>What resource is being referenced</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>title</td><td><code>string</code></td><td><div><p>The human-friendly name of the library</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>topic</td><td><code>token</code></td><td><div><p>Topics associated with the module</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>url</td><td><code>uri</code></td><td><div><p>The uri that identifies the library</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>version</td><td><code>token</code></td><td><div><p>The business version of the library</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div><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>$validate</td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>$evaluate</td><td><div><p>This operation evaluates parameters passed as input against the decision support rule identified by the Library resource. It returns the computed clinical decision support result and/or errors. The Library resource identifies the clinical decision rule and define its parameters.</p>
<p>The operation is idempotent.</p>
<h3>Input</h3>
<ul>
<li>1..1 Parameters: HL7 FHIR <a href="https://www.hl7.org/fhir/stu3/parameters.html">Parameters</a> resource containing input parameters for the clinical decision support computation.This should either be a QuestionnaireResponse or an Observation for evaluation.</li>
</ul>
<h3>Output</h3>
<p>Upon success this operation returns an GuidanceResponse resource containing the decision support result.</p>
</div></td></tr></tbody></table></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">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/library"/>
<version value="7.0.0"/>
<name value="library"/>
<status value="active"/>
<date value="2025-12-09T02:22:22.493+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>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="DK"/>
<display value="Denmark"/>
</coding>
</jurisdiction>
<kind value="instance"/>
<instantiates
value="http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data"/>
<software>
<name value="library"/>
<version value="1.20.0"/>
</software>
<implementation>
<description value="eHealth library service"/>
<url value="https://library.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"/>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<searchInclude value="*"/>
<searchRevInclude value="Library:composed-of"/>
<searchRevInclude value="Library:depends-on"/>
<searchRevInclude value="Library:derived-from"/>
<searchRevInclude value="Library:predecessor"/>
<searchRevInclude value="Library:successor"/>
</resource>
<resource>
<type value="Library"/>
<profile
value="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library"/>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<conditionalCreate value="true"/>
<conditionalUpdate value="true"/>
<searchInclude value="*"/>
<searchInclude value="Library:composed-of"/>
<searchInclude value="Library:depends-on"/>
<searchInclude value="Library:derived-from"/>
<searchInclude value="Library:predecessor"/>
<searchInclude value="Library:successor"/>
<searchRevInclude value="Library:composed-of"/>
<searchRevInclude value="Library:depends-on"/>
<searchRevInclude value="Library:derived-from"/>
<searchRevInclude value="Library:predecessor"/>
<searchRevInclude value="Library:successor"/>
<searchParam>
<name value="_content"/>
<type value="string"/>
<documentation
value="Search the contents of the resource's data using a fulltext search"/>
</searchParam>
<searchParam>
<name value="_has"/>
<type value="string"/>
<documentation
value="Return resources linked to by the given target"/>
</searchParam>
<searchParam>
<name value="_id"/>
<type value="token"/>
<documentation value="The ID of the resource"/>
</searchParam>
<searchParam>
<name value="_language"/>
<type value="string"/>
<documentation value="The language of the resource"/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<type value="date"/>
<documentation
value="Only return resources which were last updated as specified by the given range"/>
</searchParam>
<searchParam>
<name value="_profile"/>
<type value="uri"/>
<documentation
value="Search for resources which have the given profile"/>
</searchParam>
<searchParam>
<name value="_security"/>
<type value="token"/>
<documentation
value="Search for resources which have the given security labels"/>
</searchParam>
<searchParam>
<name value="_tag"/>
<type value="token"/>
<documentation value="Search for resources which have the given tag"/>
</searchParam>
<searchParam>
<name value="_text"/>
<type value="string"/>
<documentation
value="Search the contents of the resource's narrative using a fulltext search"/>
</searchParam>
<searchParam>
<name value="composed-of"/>
<type value="reference"/>
<documentation value="What resource is being referenced"/>
</searchParam>
<searchParam>
<name value="date"/>
<type value="date"/>
<documentation value="The library publication date"/>
</searchParam>
<searchParam>
<name value="depends-on"/>
<type value="reference"/>
<documentation value="What resource is being referenced"/>
</searchParam>
<searchParam>
<name value="derived-from"/>
<type value="reference"/>
<documentation value="What resource is being referenced"/>
</searchParam>
<searchParam>
<name value="description"/>
<type value="string"/>
<documentation value="The description of the library"/>
</searchParam>
<searchParam>
<name value="effective"/>
<type value="date"/>
<documentation
value="The time during which the library is intended to be in use"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation value="External identifier for the library"/>
</searchParam>
<searchParam>
<name value="jurisdiction"/>
<type value="token"/>
<documentation value="Intended jurisdiction for the library"/>
</searchParam>
<searchParam>
<name value="name"/>
<type value="string"/>
<documentation value="Computationally friendly name of the library"/>
</searchParam>
<searchParam>
<name value="predecessor"/>
<type value="reference"/>
<documentation value="What resource is being referenced"/>
</searchParam>
<searchParam>
<name value="publisher"/>
<type value="string"/>
<documentation value="Name of the publisher of the library"/>
</searchParam>
<searchParam>
<name value="status"/>
<type value="token"/>
<documentation value="The current status of the library"/>
</searchParam>
<searchParam>
<name value="successor"/>
<type value="reference"/>
<documentation value="What resource is being referenced"/>
</searchParam>
<searchParam>
<name value="title"/>
<type value="string"/>
<documentation value="The human-friendly name of the library"/>
</searchParam>
<searchParam>
<name value="topic"/>
<type value="token"/>
<documentation value="Topics associated with the module"/>
</searchParam>
<searchParam>
<name value="url"/>
<type value="uri"/>
<documentation value="The uri that identifies the library"/>
</searchParam>
<searchParam>
<name value="version"/>
<type value="token"/>
<documentation value="The business version of the library"/>
</searchParam>
<operation>
<name value="validate"/>
<definition
value="https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/Library-it-validate"/>
</operation>
<operation>
<name value="evaluate"/>
<definition
value="https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/Library-it-evaluate"/>
<documentation
value="This operation evaluates parameters passed as input against the decision support rule identified by the Library resource. It returns the computed clinical decision support result and/or errors. The Library resource identifies the clinical decision rule and define its parameters.
The operation is idempotent.
### Input
- 1..1 Parameters: HL7 FHIR [Parameters](https://www.hl7.org/fhir/stu3/parameters.html) resource containing input parameters for the clinical decision support computation.This should either be a QuestionnaireResponse or an Observation for evaluation.
### Output
Upon success this operation returns an GuidanceResponse resource containing the decision support result."/>
</operation>
</resource>
<resource>
<type value="OperationDefinition"/>
<profile
value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/>
<interaction>
<code value="read"/>
</interaction>
<searchInclude value="*"/>
<searchRevInclude value="Library:composed-of"/>
<searchRevInclude value="Library:depends-on"/>
<searchRevInclude value="Library:derived-from"/>
<searchRevInclude value="Library:predecessor"/>
<searchRevInclude value="Library:successor"/>
</resource>
<operation>
<name value="reindex"/>
<definition
value="https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-reindex"/>
</operation>
<operation>
<name value="migrate"/>
<definition
value="https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-migrate"/>
<documentation value="Data migration"/>
</operation>
<operation>
<name value="export-poll-status"/>
<definition
value="https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-export-poll-status"/>
<documentation
value="Operation for polling the status of a previously initiated FHIR Bulk Data System Level Export. A complete URL including the '_jobId' is returned in the 'Content-Location' response header when initiating the export. A 'GET' request to the polling location will return '202 Accepted' with a response header 'X-Progress' containing a status message for the progress of the export job. When the job has finished, the polling location will return '200 OK', and the contents of the body will be a JSON object providing metadata and links to the generated bulk data files. A 'DELETE' request can be used to cancel the export. If the export has already finished, the delete will return '404 Not Found', else the export job will be cancelled and a '202 Accepted' is returned with an operation outcome response.
### Parameters
- _jobId: the job ID for the Bulk Export job which was returned in the 'Content-Location' header when initiating the export"/>
</operation>
<operation>
<name value="export"/>
<definition
value="https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-export"/>
<documentation
value="FHIR Operation to initiate an export of data from a FHIR server. The type of resources returned can be restricted using the '_type' parameter, and the '_since' parameter can be used to restrict resources to be only included if changed since the supplied time. The FHIR server support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html).
## Initiation of export
The initiation of an export must specify the request header 'Prefer: respond-async', and will return '202 Accepted' with a polling location in the response header 'Content-Location'. The polling location is for the endpoint '$export-poll-status' and has the export job ID as parameter '_jobId'.
### Parameters
- _outputFormat: Optional parameter to specify the output format of the exported files. Default is 'application/fhir+ndjson'
- _type: Optional parameter to specify a comma separated list of resource types to be included in the export. If not provided, all resource types will be included.
- _since: Optional parameter to specify a time. Only resources that have been created or modified after this time will be included in the export (i.e., if Resource.meta.lastUpdated is later than the supplied _since time).
- _typePostFetchFilterUrl: Optional parameter to apply filtering of resources for export. It is a string of comma-delimited FHIR REST search queries in the format [resourceType]?[parameters]. The filter will be applied on resources after being fetched from the database.
- _exportId: Optional parameter to specify a client provided identifier for the export. Resulting exported files (Binary) will be labeled with the identifer in meta extension 'https://hapifhir.org/NamingSystem/bulk-export-identifier'
## Polling status of export
Subsequent GET requests to the polling location will return '202 Accepted' with a response header 'X-Progress' containing a status message for the progress of the export job. When the job has finished, the polling location will return '200 OK', and the contents of the body will be a JSON object providing metadata and links to the generated bulk export data files.
## Retrieving exported files
The JSON object returned when the export job is complete will contain a list of files (Binary resources) available for download. Each file can be retrieved using a standard HTTP GET request to the provided URL. The security context of the Binary resources resulting from the export is the user that initiated the export. The files can therefore only be retrieved by the same user.
### Retention of exported files
The exported files are retained for a limited time after which they are deleted. The retention time is a server configuration with default 2 hours."/>
</operation>
<operation>
<name value="meta"/>
<definition
value="https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-meta"/>
</operation>
<operation>
<name value="get-resource-counts"/>
<definition
value="https://library.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="expunge"/>
<definition
value="https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-expunge"/>
</operation>
</rest>
</CapabilityStatement>
IG © 2021+ Den telemedicinske infrastruktur (eHealth Infrastructure). Package dk.ehealth.sundhed.fhir.ig.core#7.0.0 based on FHIR 4.0.1. Generated 2025-12-16
