Generated Narrative: CapabilityStatement questionnaire Implementation Guide Version: 9.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-04-16 13:05:57+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 D Searches _include _revinclude Operations Basic http://hl7.org/fhir/StructureDefinition/Basic y y y y y _content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, actionGuidanceForReference, actionGuidanceForType, actionGuidanceType, code, context, context-type, context-type-value, identifier, intendedAudience, recommendation, reference, role, status, viewForReference, viewForType, viewType * Basic:actionGuidanceForReference, Basic:intendedAudience, Basic:reference, Basic:viewForReference, Questionnaire:reference, StructureDefinition:valueset $validate Binary http://hl7.org/fhir/StructureDefinition/Binary y y * Basic:actionGuidanceForReference, Basic:intendedAudience, Basic:reference, Basic:viewForReference, Questionnaire:reference, StructureDefinition:valueset $expunge OperationDefinition http://hl7.org/fhir/StructureDefinition/OperationDefinition y * Basic:actionGuidanceForReference, Basic:intendedAudience, Basic:reference, Basic:viewForReference, Questionnaire:reference, StructureDefinition:valueset Questionnaire http://hl7.org/fhir/StructureDefinition/Questionnaire y y y y y y _content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, base, baseEnvironment, code, context, context-type, context-type-value, date, description, effective, ehealthPredecessor, employeeTitle, identifier, jurisdiction, name, publisher, reference, role, status, title, type, url, version * Basic:actionGuidanceForReference, Basic:intendedAudience, Basic:reference, Basic:viewForReference, Questionnaire:reference, StructureDefinition:valueset $validate, $create-clone StructureDefinition http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-definedquestion y y y y y y _content, _filter, _has, _id, _language, _lastUpdated, _profile, _security, _source, _tag, _text, abstract, base, base-path, context-type, date, derivation, description, experimental, ext-context, identifier, jurisdiction, keyword, kind, name, path, publisher, status, title, type, url, valueset, version *, StructureDefinition:valueset Basic:actionGuidanceForReference, Basic:intendedAudience, Basic:reference, Basic:viewForReference, Questionnaire:reference, StructureDefinition:valueset $validate Resource Conformance: supported Basic Base System Profile Basic 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 actionGuidanceForReference reference Action guidance for reference SHALL actionGuidanceForType token The action guidance for type SHALL actionGuidanceType token The action guidance type SHALL code token The code SHALL context token A use context assigned to the action guidance SHALL context-type token A type of use context assigned to the action guidance SHALL context-type-value composite A use context type and value assigned to the action guidance SHALL identifier token The identifier SHALL intendedAudience reference The intended audience SHALL recommendation token The recommendation SHALL reference reference The modifier reference SHALL role token The modifier role SHALL status token The current status SHALL viewForReference reference View for reference SHALL viewForType token The view for type SHALL viewType token The view type Extended Operations Conformance Operation Documentation SHALL $validate Resource Conformance: supported Binary Base System Profile Binary Profile Conformance SHALL Reference Policy Interaction summary Supports vread, read. Extended Operations Conformance Operation Documentation SHALL $expunge Resource Conformance: supported OperationDefinition Base System Profile OperationDefinition Profile Conformance SHALL Reference Policy Interaction summary Supports read. Resource Conformance: supported Questionnaire Base System Profile Questionnaire Profile Conformance SHALL Reference Policy Interaction summary Supports update, search-type, vread, read, delete, 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 base token Base of resource SHALL baseEnvironment token Base Environment of resource SHALL code token A code that corresponds to one of its items in the questionnaire SHALL context token A use context assigned to the questionnaire SHALL context-type token A type of use context assigned to the questionnaire SHALL context-type-value composite A use context type and value assigned to the questionnaire SHALL date date The questionnaire publication date SHALL description string The description of the questionnaire SHALL effective date The time during which the questionnaire is intended to be in use SHALL ehealthPredecessor token Predecessor of resource SHALL employeeTitle string Title intended for clinicians SHALL identifier token External identifier for the questionnaire SHALL jurisdiction token Intended jurisdiction for the questionnaire SHALL name string Computationally friendly name of the questionnaire SHALL publisher string Name of the publisher of the questionnaire SHALL reference reference Modifier reference SHALL role token Modifier role SHALL status token The current status of the questionnaire SHALL title string The human-friendly name of the questionnaire SHALL type token Questionnaire type SHALL url uri The uri that identifies the questionnaire SHALL version token The business version of the questionnaire Extended Operations Conformance Operation Documentation SHALL $validate SHALL $create-clone Input resourceId: reference to the Questionnaire resource that should be cloned clone-operation: minor-version/major-version/copy Coding from codesystem: http://ehealth.sundhed.dk/cs/ehealth-clone-operation Output Bundle containing all resources that were created during the operation. Validation New business versions require that the user has modifier-role: owner or co-author for the resource New copy does not require that the user has a modifier-role. New business version can be made only when no draft resource exists (having identical base identifier). Read/search/create privileges are required for the resource types affected by $create-clone Resource Conformance: supported StructureDefinition Base System Profile ehealth-definedquestion Profile Conformance SHALL Reference Policy Interaction summary Supports update, search-type, vread, read, delete, create. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _filter string Search the contents of the resource's data using a filter 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 _source uri Search for resources which have the given source value (Resource.meta.source) 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 abstract token Whether the structure is abstract SHALL base uri Definition that this type is constrained/specialized from SHALL base-path token Path that identifies the base element SHALL context-type token resource | datatype | extension SHALL date date The structure definition publication date SHALL derivation token specialization | constraint - How relates to base definition SHALL description string The description of the structure definition SHALL experimental token For testing purposes, not real usage SHALL ext-context string Where the extension can be used in instances SHALL identifier token External identifier for the structure definition SHALL jurisdiction token Intended jurisdiction for the structure definition SHALL keyword token A code for the profile SHALL kind token primitive-type | complex-type | resource | logical SHALL name string Computationally friendly name of the structure definition SHALL path token A path that is constrained in the profile SHALL publisher string Name of the publisher of the structure definition SHALL status token The current status of the structure definition SHALL title string The human-friendly name of the structure definition SHALL type token Type defined or constrained by this structure SHALL url uri The uri that identifies the structure definition SHALL valueset reference A vocabulary binding reference SHALL version token The business version of the structure definition 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
A use context assigned to the action guidance
A type of use context assigned to the action guidance
A use context type and value assigned to the action guidance
A code that corresponds to one of its items in the questionnaire
A use context assigned to the questionnaire
A type of use context assigned to the questionnaire
A use context type and value assigned to the questionnaire
The time during which the questionnaire is intended to be in use
External identifier for the questionnaire
Intended jurisdiction for the questionnaire
Computationally friendly name of the questionnaire
Name of the publisher of the questionnaire
The human-friendly name of the questionnaire
The uri that identifies the questionnaire
The business version of the questionnaire
### Input - resourceId: reference to the Questionnaire resource that should be cloned - clone-operation: minor-version/major-version/copy Coding from codesystem: http://ehealth.sundhed.dk/cs/ehealth-clone-operation ### Output Bundle containing all resources that were created during the operation. ### Validation - New business versions require that the user has modifier-role: owner or co-author for the resource - New copy does not require that the user has a modifier-role. - New business version can be made only when no draft resource exists (having identical base identifier). - Read/search/create privileges are required for the resource types affected by $create-clone
Search the contents of the resource's data using a filter
Search for resources which have the given source value (Resource.meta.source)
Definition that this type is constrained/specialized from
The structure definition publication date
specialization | constraint - How relates to base definition
The description of the structure definition
Where the extension can be used in instances
External identifier for the structure definition
Intended jurisdiction for the structure definition
primitive-type | complex-type | resource | logical
Computationally friendly name of the structure definition
A path that is constrained in the profile
Name of the publisher of the structure definition
The current status of the structure definition
The human-friendly name of the structure definition
Type defined or constrained by this structure
The uri that identifies the structure definition
The business version of the structure definition
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