eHealth Infrastructure
8.0.0 - release Denmark flag

eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 8.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

CapabilityStatement: questionnaire

Official URL: http://ehealth.sundhed.dk/fhir/CapabilityStatement/questionnaire Version: 8.0.0
Active as of 2025-12-09 Computable Name: questionnaire

Raw OpenAPI-Swagger Definition file | Download

  • Implementation Guide Version: 8.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: 2025-12-09 02:47:42+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
ConformanceOperationDocumentation
SHALL$reindex
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).
  • _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.

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 TypeProfileRV-RSUCDSearches_include_revincludeOperations
Basichttp://hl7.org/fhir/StructureDefinition/Basicyyyyy_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
Binaryhttp://hl7.org/fhir/StructureDefinition/Binaryyy*Basic:actionGuidanceForReference, Basic:intendedAudience, Basic:reference, Basic:viewForReference, Questionnaire:reference, StructureDefinition:valueset
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*Basic:actionGuidanceForReference, Basic:intendedAudience, Basic:reference, Basic:viewForReference, Questionnaire:reference, StructureDefinition:valueset
Questionnairehttp://hl7.org/fhir/StructureDefinition/Questionnaireyyyyyy_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
StructureDefinitionhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-definedquestionyyyyyy_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:valuesetBasic:actionGuidanceForReference, Basic:intendedAudience, Basic:reference, Basic:viewForReference, Questionnaire:reference, StructureDefinition:valueset$validate
Base System Profile
Basic
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID of the resource

SHALL_languagestring

The language of the resource

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Search for resources which have the given profile

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLactionGuidanceForReferencereference

Action guidance for reference

SHALLactionGuidanceForTypetoken

The action guidance for type

SHALLactionGuidanceTypetoken

The action guidance type

SHALLcodetoken

The code

SHALLcontexttoken

A use context assigned to the action guidance

SHALLcontext-typetoken

A type of use context assigned to the action guidance

SHALLcontext-type-valuecomposite

A use context type and value assigned to the action guidance

SHALLidentifiertoken

The identifier

SHALLintendedAudiencereference

The intended audience

SHALLrecommendationtoken

The recommendation

SHALLreferencereference

The modifier reference

SHALLroletoken

The modifier role

SHALLstatustoken

The current status

SHALLviewForReferencereference

View for reference

SHALLviewForTypetoken

The view for type

SHALLviewTypetoken

The view type

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
Base System Profile
Binary
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports vread, read.

Base System Profile
OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Base System Profile
Questionnaire
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, delete, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID of the resource

SHALL_languagestring

The language of the resource

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Search for resources which have the given profile

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLbasetoken

Base of resource

SHALLbaseEnvironmenttoken

Base Environment of resource

SHALLcodetoken

A code that corresponds to one of its items in the questionnaire

SHALLcontexttoken

A use context assigned to the questionnaire

SHALLcontext-typetoken

A type of use context assigned to the questionnaire

SHALLcontext-type-valuecomposite

A use context type and value assigned to the questionnaire

SHALLdatedate

The questionnaire publication date

SHALLdescriptionstring

The description of the questionnaire

SHALLeffectivedate

The time during which the questionnaire is intended to be in use

SHALLehealthPredecessortoken

Predecessor of resource

SHALLemployeeTitlestring

Title intended for clinicians

SHALLidentifiertoken

External identifier for the questionnaire

SHALLjurisdictiontoken

Intended jurisdiction for the questionnaire

SHALLnamestring

Computationally friendly name of the questionnaire

SHALLpublisherstring

Name of the publisher of the questionnaire

SHALLreferencereference

Modifier reference

SHALLroletoken

Modifier role

SHALLstatustoken

The current status of the questionnaire

SHALLtitlestring

The human-friendly name of the questionnaire

SHALLtypetoken

Questionnaire type

SHALLurluri

The uri that identifies the questionnaire

SHALLversiontoken

The business version of the questionnaire

 
Extended Operations
ConformanceOperationDocumentation
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
Base System Profile
ehealth-definedquestion
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, delete, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID of the resource

SHALL_languagestring

The language of the resource

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Search for resources which have the given profile

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_sourceuri

Search for resources which have the given source value (Resource.meta.source)

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLabstracttoken

Whether the structure is abstract

SHALLbaseuri

Definition that this type is constrained/specialized from

SHALLbase-pathtoken

Path that identifies the base element

SHALLcontext-typetoken

resource | datatype | extension

SHALLdatedate

The structure definition publication date

SHALLderivationtoken

specialization | constraint - How relates to base definition

SHALLdescriptionstring

The description of the structure definition

SHALLexperimentaltoken

For testing purposes, not real usage

SHALLext-contextstring

Where the extension can be used in instances

SHALLidentifiertoken

External identifier for the structure definition

SHALLjurisdictiontoken

Intended jurisdiction for the structure definition

SHALLkeywordtoken

A code for the profile

SHALLkindtoken

primitive-type | complex-type | resource | logical

SHALLnamestring

Computationally friendly name of the structure definition

SHALLpathtoken

A path that is constrained in the profile

SHALLpublisherstring

Name of the publisher of the structure definition

SHALLstatustoken

The current status of the structure definition

SHALLtitlestring

The human-friendly name of the structure definition

SHALLtypetoken

Type defined or constrained by this structure

SHALLurluri

The uri that identifies the structure definition

SHALLvaluesetreference

A vocabulary binding reference

SHALLversiontoken

The business version of the structure definition

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate