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: document-transformation

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

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:17:53+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$upload-QFDD

Uploads an DK-HL7 Questionnaire Form Definition Document (QFDD). The input FHIR DocumentReference must be of type QFDD (74468-0) and the status set to current. Include an attachment which contains the base64 encoded QFDD XML document with contentType application/xml. The QFDD XML document must contain a unique id which is used as the the masterIdentifier in the DocumentReference. The returned FHIR DocumentReference contains a masterIdentifier, a type and the description all pulled from the attachment.

SHALL$transform-to-QRD

Transforms a FHIR QuestionnaireResponse (ehealth-questionnaireresponse profile) resource to a DK-HL7 Questionnaire Response Document (QRD) XML document. The input FHIR Bundle contains FHIR Composition (ehealth-composition profile) resource referencing a FHIR QuestionnaireResponse resource. a FHIR Questionnaire resource. The bundle must also contain a FHIR DocumentReference containing a QFDD xml file (base64 encoded)The returned FHIR DocumentReference contains the QRD XML document adhering to the DK-HL7 Questionnaire Response Document profile.

SHALL$transform-to-QFDD

Transforms an eHealth Questionnaire resource to the DK-HL7 Questionnaire Form Definition Document (QFDD). The input Bundle contains an eHealth Questionnaire and Composition resource which reference the returned eHealth Questionnaire. The returned Bundle in case of no validation errors contains the FHIR DocumentReference containing the QFDD XML for the DK-HL7 Questionnaire Form Definition Document and an OperationOutcome will possible warnings. In case of validation errors the Bundle will only contain an OperationOutcome with the validation errors/warnings.

SHALL$transform-to-PHMR

Transforms a FHIR Observation (ehealth-observation profile) resource to a DK-HL7 Personal Health Monitoring Report (PHMR) XML document. The input FHIR Bundle contains a FHIR Composition (ehealth-composition profile) resource referencing one or more FHIR Observation (ehealth-observation profile) resources and referenced resources such as FHIR Organization. The returned FHIR DocumentReference contains the PHMR XML document adhering to the DK-HL7 Personal Health Monitoring Report profile.

SHALL$transform-to-APD

Transforms a FHIR Appointment (ehealth-appointment profile) resource to a DK-HL7 Appointment Document (APD) XML document. The input FHIR Bundle contains a FHIR Composition (ehealth-composition profile) resource referencing a FHIR Appointment (ehealth-appointment profile) resource and referenced resources such as FHIR Organization. The returned FHIR DocumentReference contains the APD XML document adhering to the DK-HL7 Appointment Document profile.

SHALL$transform-from-QRD-based-on-questionnaire

Transforms a DK-HL7 Questionnaire Response Document (QRD) XML document to a FHIR QuestionnaireResponse (ehealth-questionnaireresponse profile) resource. The input bundle must contain the QRD XML document adhering to the DK-HL7 Questionnaire Response Document profile. And a FHIR Questionnaire resource. The returned FHIR Bundle contains FHIR Composition (ehealth-composition profile) resource referencing a FHIR QuestionnaireResponse (ehealth-documentreference profile) resource.

SHALL$transform-from-QRD

Transforms a DK-HL7 Questionnaire Response Document (QRD) XML document to a FHIR QuestionnaireResponse (ehealth-questionnaireresponse profile) resource. The input FHIR DocumentReference contains the QRD XML document adhering to the DK-HL7 Questionnaire Response Document profile. The returned FHIR Bundle contains FHIR Composition (ehealth-composition profile) resource referencing a FHIR QuestionnaireResponse (ehealth-documentreference profile) resource.

SHALL$transform-from-QFDD

Transforms the DK-HL7 Questionnaire Form Definition Document (QFDD) to an eHealth Questionnaire resource. The input FHIR DocumentReference contains QFDD XML for the DK-HL7 Questionnaire Form Definition Document. The returned Bundle contains the eHealth Questionnaire and Composition resource which reference the returned eHealth Questionnaire.

SHALL$transform-from-PHMR

Transforms a DK-HL7 Personal Health Monitoring Report (PHMR) XML document to FHIR Observation (ehealth-observation profile) resource. The input FHIR DocumentReference contains the PHMR XML document adhering to the DK-HL7 Personal Health Monitoring Report profile The returned FHIR Bundle contains a FHIR Composition (ehealth-composition profile) resource referencing.one or more FHIR Observation (ehealth-observation profile) resources and referenced resources such as FHIR Organization.

SHALL$transform-from-APD

Transforms a DK-HL7 Appointment Document (APD) XML document to a FHIR Appointment (ehealth-appointment profile) resource. The input FHIR DocumentReference (ehealth-documentreference profile) contains the APD XML document. The caller must ensure that the APD XML document is valid and adheres to the DK-HL7 Appointment Document profile. The returned FHIR Bundle contains a FHIR Composition (ehealth-composition profile) resource referencing a FHIR Appointment (ehealth-appointment profile) resource.

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-RSUPCDSearches_include_revincludeOperations
Binaryhttp://hl7.org/fhir/StructureDefinition/Binaryyy*Composition:attester, Composition:author, Composition:encounter, Composition:entry, Composition:patient, Composition:related-ref, Composition:subject, DocumentReference:authenticator, DocumentReference:author, DocumentReference:custodian, DocumentReference:encounter, DocumentReference:patient, DocumentReference:related, DocumentReference:related-ref, DocumentReference:relatesto, DocumentReference:subject
Compositionhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-compositionyyyyy_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, attester, author, class, confidentiality, context, date, encounter, entry, identifier, patient, period, related-id, related-ref, section, status, subject, title, typeComposition:related-refComposition:attester, Composition:author, Composition:encounter, Composition:entry, Composition:patient, Composition:related-ref, Composition:subject, DocumentReference:authenticator, DocumentReference:author, DocumentReference:custodian, DocumentReference:encounter, DocumentReference:patient, DocumentReference:related, DocumentReference:related-ref, DocumentReference:relatesto, DocumentReference:subject$validate
DocumentReferencehttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-transformation-documentreferenceyyyyyy_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, authenticator, author, class, custodian, date, description, documentSharingState, encounter, event, facility, format, identifier, indexed, language, location, masterIdentifier, patient, period, related, related-id, related-ref, relatesto, relation, relationship, securitylabel, setting, status, subject, typeDocumentReference:relatestoComposition:attester, Composition:author, Composition:encounter, Composition:entry, Composition:patient, Composition:related-ref, Composition:subject, DocumentReference:authenticator, DocumentReference:author, DocumentReference:custodian, DocumentReference:encounter, DocumentReference:patient, DocumentReference:related, DocumentReference:related-ref, DocumentReference:relatesto, DocumentReference:subject$validate, $deprecate-document
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*Composition:attester, Composition:author, Composition:encounter, Composition:entry, Composition:patient, Composition:related-ref, Composition:subject, DocumentReference:authenticator, DocumentReference:author, DocumentReference:custodian, DocumentReference:encounter, DocumentReference:patient, DocumentReference:related, DocumentReference:related-ref, DocumentReference:relatesto, DocumentReference:subject

Base System Profile
Binary
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports vread, read.

Base System Profile
ehealth-composition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports 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

SHALLattesterreference

Who attested the composition

SHALLauthorreference

Who and/or what authored the composition

SHALLclasstoken

Categorization of Composition

SHALLconfidentialitytoken

As defined by affinity domain

SHALLcontexttoken

Code(s) that apply to the event being documented

SHALLdatedate

Composition editing time

SHALLencounterreference

Context of the Composition

SHALLentryreference

A reference to data that supports this section

SHALLidentifiertoken

Logical identifier of composition (version-independent)

SHALLpatientreference

Who and/or what the composition is about

SHALLperioddate

The period covered by the documentation

SHALLrelated-idtoken

Target of the relationship

SHALLrelated-refreference

Target of the relationship

SHALLsectiontoken

Classification of section (recommended)

SHALLstatustoken

preliminary | final | amended | entered-in-error

SHALLsubjectreference

Who and/or what the composition is about

SHALLtitlestring

Human Readable name/title

SHALLtypetoken

Kind of composition (LOINC if possible)

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, vread, read, patch, 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

SHALLauthenticatorreference

Who/what authenticated the document

SHALLauthorreference

Who and/or what authored the document

SHALLclasstoken

Categorization of document

SHALLcustodianreference

Organization which maintains the document

SHALLdatedate

Document creation time

SHALLdescriptionstring

Human-readable description (title)

SHALLdocumentSharingStatetoken

Sharing State of the Document

SHALLencounterreference

Context of the document content

SHALLeventtoken

Main clinical acts documented

SHALLfacilitytoken

Kind of facility where patient was seen

SHALLformattoken

Format/content rules for the document

SHALLidentifiertoken

Master Version Specific Identifier

SHALLindexeddate

When this document reference was created

SHALLlanguagetoken

Human language of the content (BCP-47)

SHALLlocationuri

Uri where the data can be found

SHALLmasterIdentifiertoken

Master identifier

SHALLpatientreference

Who/what is the subject of the document

SHALLperioddate

Time of service that is being documented

SHALLrelatedreference

Related identifiers or resources

SHALLrelated-idtoken

Identifier of related objects or events

SHALLrelated-refreference

Related Resource

SHALLrelatestoreference

Target of the relationship

SHALLrelationtoken

replaces | transforms | signs | appends

SHALLrelationshipcomposite

Combination of relation and relatesTo

SHALLsecuritylabeltoken

Document security-tags

SHALLsettingtoken

Additional details about where the content was created (e.g. clinical specialty)

SHALLstatustoken

current | superseded | entered-in-error

SHALLsubjectreference

Who/what is the subject of the document

SHALLtypetoken

Kind of document (LOINC if possible)

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$deprecate-document

Deprecates a shared document. The operation takes a documentIdentifier and cpr-number as parameters and finds the DocumentReference with the corresponding masterIdentifier. masterIdentifier should be unique for DocumentReference so if less than 0 or more than 1 are found the operation throws and exception. If the found documentReference has a patient which cpr number matches the provided value the document is deprecated. iti-57 is used to deprecate the document on XDS. On successthe documentReference status is updated to superseded and updated in the database.

Base System Profile
OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.