Generated Narrative: CapabilityStatement task Implementation Guide Version: 10.0.0 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 03:12:22+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 P C Searches _include _revinclude Operations Binary http://hl7.org/fhir/StructureDefinition/Binary y y * ClinicalImpression:action, ClinicalImpression:assessor, ClinicalImpression:carePlan, ClinicalImpression:episodeOfCare, ClinicalImpression:finding-ref, ClinicalImpression:investigation, ClinicalImpression:patient, ClinicalImpression:previous, ClinicalImpression:problem, ClinicalImpression:subject, Task:based-on, Task:carePlan, Task:episodeOfCare, Task:focus, Task:owner, Task:part-of, Task:patient, Task:requester, Task:responsible, Task:subject $expunge ClinicalImpression http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-clinicalimpression y y y y y _content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, action, assessor, carePlan, date, decision, episodeOfCare, finding-code, finding-ref, identifier, investigation, patient, previous, problem, status, subject ClinicalImpression:previous ClinicalImpression:action, ClinicalImpression:assessor, ClinicalImpression:carePlan, ClinicalImpression:episodeOfCare, ClinicalImpression:finding-ref, ClinicalImpression:investigation, ClinicalImpression:patient, ClinicalImpression:previous, ClinicalImpression:problem, ClinicalImpression:subject, Task:based-on, Task:carePlan, Task:episodeOfCare, Task:focus, Task:owner, Task:part-of, Task:patient, Task:requester, Task:responsible, Task:subject $validate, $set-measurement-validity OperationDefinition http://hl7.org/fhir/StructureDefinition/OperationDefinition y * ClinicalImpression:action, ClinicalImpression:assessor, ClinicalImpression:carePlan, ClinicalImpression:episodeOfCare, ClinicalImpression:finding-ref, ClinicalImpression:investigation, ClinicalImpression:patient, ClinicalImpression:previous, ClinicalImpression:problem, ClinicalImpression:subject, Task:based-on, Task:carePlan, Task:episodeOfCare, Task:focus, Task:owner, Task:part-of, Task:patient, Task:requester, Task:responsible, Task:subject Task http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-task y y y y y _content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, authored-on, based-on, business-status, carePlan, category, code, episodeOfCare, focus, group-identifier, identifier, intent, modified, owner, part-of, patient, performer, period, priority, requester, resolvedTimingEnd, resolvedTimingServiceRequestVersionId, resolvedTimingStart, resolvedTimingType, responsible, restriction-category, status, subject Task:based-on, Task:focus, Task:part-of ClinicalImpression:action, ClinicalImpression:assessor, ClinicalImpression:carePlan, ClinicalImpression:episodeOfCare, ClinicalImpression:finding-ref, ClinicalImpression:investigation, ClinicalImpression:patient, ClinicalImpression:previous, ClinicalImpression:problem, ClinicalImpression:subject, Task:based-on, Task:carePlan, Task:episodeOfCare, Task:focus, Task:owner, Task:part-of, Task:patient, Task:requester, Task:responsible, Task:subject $validate 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 ClinicalImpression Base System Profile ehealth-clinicalimpression Profile Conformance SHALL Reference Policy Interaction summary Supports search-type, vread, read, patch, 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 action reference Action taken as part of assessment procedure SHALL assessor reference The clinician performing the assessment SHALL carePlan reference CarePlan SHALL date date When the assessment was documented SHALL decision token Decision SHALL episodeOfCare reference Encounter or Episode created from SHALL finding-code token What was found SHALL finding-ref reference What was found SHALL identifier token Business identifier SHALL investigation reference Record of a specific investigation SHALL patient reference Patient or group assessed SHALL previous reference Reference to last assessment SHALL problem reference Relevant impressions of patient state SHALL status token draft | completed | entered-in-error SHALL subject reference Patient or group assessed Extended Operations Conformance Operation Documentation SHALL $validate SHALL $set-measurement-validity This operation is used to invalidate or retract an invalidation of a Measurement. Input The input parameter is a ClinicalImpression resource with the following values: status - The status of the ClinicalImpression must be completed. investigation.item - Versioned reference to the Measurement that is to be invalidated or retracted. investigation.item - Unversioned reference to the Measurement that is to be invalidated or retracted. subject - Reference to the Patient . episodeOfCare - Reference to the EpisodeOfCare that the Measurement is part of. code - Should use MeasurementAssessment from http://ehealth.sundhed.dk/cs/clinicalimpression-codes. finding.code - The finding code must be measurement-invalidated or measurement-invalidation-retracted. decision - The decision code is required if finding.code is measurement-invalidated. The decision code must be invalidated-fulfills or invalidated-is-not-fulfillment. Output The operation returns the persisted ClinicalImpression: clinicalImpression - The persisted ClinicalImpression resource with updated assessor values. Operation side effects The operation will update the status of the Measurement that is being invalidated or has the invalidation retracted to entered-in-error or completed respectively. The operation will update the status to entered-in-error for any previous invalidation or invalidation retraction ClinicalImpression for the referenced Measurement, indicating that the previous ClinicalImpression is no longer used to represent the validity of the Measurement. The operation performs a search for any existing ClinicalImpression in the measurement validity cycle, and does not rely on/update the previous field on the input ClinicalImpression. If the input ClinicalImpression is for invalidation retraction, there must exist a ClinicalImpression invalidating the Measurement. The operation will add an additional investigation with the code item-modified, referencing the Measurement version after the patch has been applied. The operation will set assessor values (assessor, assessorOrganization and assessorOther). If the user is of type PRACTITIONER, assessor and assessorOrganization will be set. If the user is of type PATIENT, assessorOther will be set`. Resource Conformance: unspecified OperationDefinition Base System Profile OperationDefinition Profile Conformance SHALL Reference Policy Interaction summary Supports read. Resource Conformance: unspecified Task Base System Profile ehealth-task Profile Conformance SHALL Reference Policy Interaction summary Supports search-type, vread, read, patch, 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 authored-on date Search by creation date SHALL based-on reference Search by requests this task is based on SHALL business-status token Search by business status SHALL carePlan reference Search by CarePlan SHALL category token Search by category SHALL code token Search by task code SHALL episodeOfCare reference Search by encounter or episode SHALL focus reference Search by task focus SHALL group-identifier token Search by group identifier SHALL identifier token Search for a task instance by its business identifier SHALL intent token Search by task intent SHALL modified date Search by last modification date SHALL owner reference Search by task owner SHALL part-of reference Search by task this task is part of SHALL patient reference Search by patient SHALL performer token Search by recommended type of performer (e.g., Requester, Performer, Scheduler). SHALL period date Search by period Task is/was underway SHALL priority token Search by task priority SHALL requester reference Search by task requester SHALL resolvedTimingEnd date Resolved Timing end SHALL resolvedTimingServiceRequestVersionId token Resolved Timing serviceRequestVersionID SHALL resolvedTimingStart date Resolved Timing start SHALL resolvedTimingType token Resolved Timing type SHALL responsible reference Search by responsible SHALL restriction-category token Search by restriction category SHALL status token Search by task status SHALL subject reference Search by subject Extended Operations Conformance Operation Documentation SHALL $validate
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
Action taken as part of assessment procedure
This operation is used to invalidate or retract an invalidation of a Measurement. ## Input The input parameter is a ClinicalImpression resource with the following values: - `status` - The status of the ClinicalImpression must be `completed`. - `investigation.item` - Versioned reference to the Measurement that is to be invalidated or retracted. - `investigation.item` - Unversioned reference to the Measurement that is to be invalidated or retracted. - `subject` - Reference to the Patient . - `episodeOfCare` - Reference to the EpisodeOfCare that the Measurement is part of. - `code` - Should use `MeasurementAssessment` from `http://ehealth.sundhed.dk/cs/clinicalimpression-codes`. - `finding.code` - The finding code must be `measurement-invalidated` or `measurement-invalidation-retracted`. - `decision` - The decision code is required if `finding.code` is `measurement-invalidated`. The decision code must be `invalidated-fulfills` or `invalidated-is-not-fulfillment`. ## Output The operation returns the persisted ClinicalImpression: - `clinicalImpression` - The persisted ClinicalImpression resource with updated assessor values. ## Operation side effects - The operation will update the status of the Measurement that is being invalidated or has the invalidation retracted to `entered-in-error` or `completed` respectively. - The operation will update the status to `entered-in-error` for any previous invalidation or invalidation retraction ClinicalImpression for the referenced Measurement, indicating that the previous ClinicalImpression is no longer used to represent the validity of the Measurement. The operation performs a search for any existing ClinicalImpression in the measurement validity cycle, and does not rely on/update the `previous` field on the input ClinicalImpression. If the input ClinicalImpression is for invalidation retraction, there must exist a ClinicalImpression invalidating the Measurement. - The operation will add an additional investigation with the code `item-modified`, referencing the Measurement version after the patch has been applied. - The operation will set assessor values (assessor, assessorOrganization and assessorOther). If the user is of type PRACTITIONER, assessor and assessorOrganization will be set. If the user is of type PATIENT, assessorOther will be set`.
Search by requests this task is based on
Search for a task instance by its business identifier
Search by recommended type of performer (e.g., Requester, Performer, Scheduler).
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