Generated Narrative: CapabilityStatement device Implementation Guide Version: 10.0.1 FHIR Version: 4.0.1 Supported Formats: application/fhir+xml, xml, application/fhir+json, json, application/x-turtle, ttl, html/json, html/xml, html/turtle Published on: 2026-08-03 02:07:12+0000 Published by: Den telemedicinske infrastruktur (eHealth Infrastructure) 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. This CapabilityStatement instantiates the CapabilityStatement http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data FHIR RESTful Capabilities Mode: server Summary of System-wide Operations Conformance Operation Documentation SHALL $reindex SHALL $hapi.fhir.reindex-status SHALL $migrate Data migration SHALL $export-poll-status 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 SHALL $export 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. 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). _until: Optional parameter to specify a time. Only resources that have been created or modified before this time will be included in the export (i.e., if Resource.meta.lastUpdated is earlier than the supplied _until time). _typeFilter: Optional parameter to apply search filter 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 when searching resources. _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. _includeHistory: Optional parameter to specify whether historical versions of resources should be included in the export. Default is false. _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. SHALL $meta SHALL $get-resource-counts Provides the number of resources currently stored on the server, broken down by resource type SHALL $expunge 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 Type Profile R V-R S U C Searches _include _revinclude Operations Binary http://hl7.org/fhir/StructureDefinition/Binary y y * Device:location, Device:organization, Device:patient, DeviceMetric:parent, DeviceMetric:source, DeviceUseStatement:context, DeviceUseStatement:device, DeviceUseStatement:patient, DeviceUseStatement:subject $expunge Device http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device y y y y y _content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, device-name, identifier, location, manufacturer, model, organization, patient, status, type, udi-carrier, udi-di, url Device:location, Device:organization, Device:patient, DeviceMetric:parent, DeviceMetric:source, DeviceUseStatement:context, DeviceUseStatement:device, DeviceUseStatement:patient, DeviceUseStatement:subject $validate DeviceMetric http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric y y y y y _content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, category, identifier, parent, qualityCategory, source, type DeviceMetric:source Device:location, Device:organization, Device:patient, DeviceMetric:parent, DeviceMetric:source, DeviceUseStatement:context, DeviceUseStatement:device, DeviceUseStatement:patient, DeviceUseStatement:subject DeviceUseStatement http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-deviceusestatement y y y y y _content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, context, device, identifier, patient, status, subject, timing DeviceUseStatement:device Device:location, Device:organization, Device:patient, DeviceMetric:parent, DeviceMetric:source, DeviceUseStatement:context, DeviceUseStatement:device, DeviceUseStatement:patient, DeviceUseStatement:subject $validate OperationDefinition http://hl7.org/fhir/StructureDefinition/OperationDefinition y * Device:location, Device:organization, Device:patient, DeviceMetric:parent, DeviceMetric:source, DeviceUseStatement:context, DeviceUseStatement:device, DeviceUseStatement:patient, DeviceUseStatement:subject Resource Conformance: unspecified Binary Base System Profile Binary Profile Conformance SHALL Reference Policy Interaction summary Supports vread, read. Extended Operations Conformance Operation Documentation SHALL $expunge Resource Conformance: unspecified Device Base System Profile ehealth-device Profile Conformance SHALL Reference Policy Interaction summary Supports update, search-type, vread, read, create. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _has string Return resources linked to by the given target SHALL _id token The ID of the resource SHALL _language string The language of the resource SHALL _lastUpdated date Only return resources which were last updated as specified by the given range SHALL _profile uri Search for resources which have the given profile SHALL _security token Search for resources which have the given security labels SHALL _tag token Search for resources which have the given tag SHALL _text string Search the contents of the resource's narrative using a fulltext search SHALL device-name string A server defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text SHALL identifier token Instance id from manufacturer, owner, and others SHALL location reference A location, where the resource is found SHALL manufacturer string The manufacturer of the device SHALL model string The model of the device SHALL organization reference The organization responsible for the device SHALL patient reference Patient information, if the resource is affixed to a person SHALL status token active | inactive | entered-in-error | unknown SHALL type token The type of the device SHALL udi-carrier string UDI Barcode (RFID or other technology) string either in HRF format or AIDC format converted to base64 string. SHALL udi-di string The udi Device Identifier (DI) SHALL url uri Network address to contact device Extended Operations Conformance Operation Documentation SHALL $validate Resource Conformance: unspecified DeviceMetric Base System Profile ehealth-devicemetric Profile Conformance SHALL Reference Policy Interaction summary Supports update, search-type, vread, read, create. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _has string Return resources linked to by the given target SHALL _id token The ID of the resource SHALL _language string The language of the resource SHALL _lastUpdated date Only return resources which were last updated as specified by the given range SHALL _profile uri Search for resources which have the given profile SHALL _security token Search for resources which have the given security labels SHALL _tag token Search for resources which have the given tag SHALL _text string Search the contents of the resource's narrative using a fulltext search SHALL category token The category of the metric SHALL identifier token The identifier of the metric SHALL parent reference The parent DeviceMetric resource SHALL qualityCategory token The device metric quality SHALL source reference The device resource SHALL type token The component type Resource Conformance: unspecified DeviceUseStatement Base System Profile ehealth-deviceusestatement Profile Conformance SHALL Reference Policy Interaction summary Supports update, search-type, vread, read, create. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _has string Return resources linked to by the given target SHALL _id token The ID of the resource SHALL _language string The language of the resource SHALL _lastUpdated date Only return resources which were last updated as specified by the given range SHALL _profile uri Search for resources which have the given profile SHALL _security token Search for resources which have the given security labels SHALL _tag token Search for resources which have the given tag SHALL _text string Search the contents of the resource's narrative using a fulltext search SHALL context reference Search by context SHALL device reference Search by device SHALL identifier token Search by identifier SHALL patient reference Search by subject - a patient SHALL status token active | completed | entered-in-error + SHALL subject reference Search by subject SHALL timing date Period device was used Extended Operations Conformance Operation Documentation SHALL $validate Resource Conformance: unspecified OperationDefinition Base System Profile OperationDefinition Profile Conformance SHALL Reference Policy Interaction summary Supports read.
Den telemedicinske infrastruktur (eHealth Infrastructure)
Search the contents of the resource's data using a fulltext search
Return resources linked to by the given target
Only return resources which were last updated as specified by the given range
Search for resources which have the given profile
Search for resources which have the given security labels
Search for resources which have the given tag
Search the contents of the resource's narrative using a fulltext search
A server defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text
Instance id from manufacturer, owner, and others
The organization responsible for the device
Patient information, if the resource is affixed to a person
active | inactive | entered-in-error | unknown
UDI Barcode (RFID or other technology) string either in HRF format or AIDC format converted to base64 string.
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
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). - _until: Optional parameter to specify a time. Only resources that have been created or modified before this time will be included in the export (i.e., if Resource.meta.lastUpdated is earlier than the supplied _until time). - _typeFilter: Optional parameter to apply search filter 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 when searching resources. - _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. - _includeHistory: Optional parameter to specify whether historical versions of resources should be included in the export. Default is false. - _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.
Provides the number of resources currently stored on the server, broken down by resource type