eHealth Infrastructure
3.6.0 - release
eHealth Infrastructure
3.6.0 - release
eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.6.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
| Official URL: http://ehealth.sundhed.dk/fhir/CapabilityStatement/document-transformation | Version: 3.6.0 | |||
| Active as of 2025-02-06 | Computable Name: document-transformation | |||
Raw OpenAPI-Swagger Definition file | Download
application/fhir+xml, xml, application/fhir+json, json, application/x-turtle, ttl, html/json, html/xml, html/turtleNote 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.
server| Conformance | Operation | Documentation |
|---|---|---|
| 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 | $reindex-terminology | |
| SHALL | $meta | |
| SHALL | $get-resource-counts | Provides the number of resources currently stored on the server, broken down by resource type |
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | V-R | S | U | P | C | D | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Composition | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-composition | y | y | y | y | y | _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, type | Composition:related-ref | 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 | $validate | ||
| DocumentReference | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-transformation-documentreference | y | y | y | y | y | y | _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, type | DocumentReference:relatesto | 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 | $validate, $deprecate-document | |
| OperationDefinition | http://hl7.org/fhir/StructureDefinition/OperationDefinition | y | * | 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 |
search-type, vread, read, delete, create.| 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 | attester | reference | Who attested the composition |
| SHALL | author | reference | Who and/or what authored the composition |
| SHALL | class | token | Categorization of Composition |
| SHALL | confidentiality | token | As defined by affinity domain |
| SHALL | context | token | Code(s) that apply to the event being documented |
| SHALL | date | date | Composition editing time |
| SHALL | encounter | reference | Context of the Composition |
| SHALL | entry | reference | A reference to data that supports this section |
| SHALL | identifier | token | Logical identifier of composition (version-independent) |
| SHALL | patient | reference | Who and/or what the composition is about |
| SHALL | period | date | The period covered by the documentation |
| SHALL | related-id | token | Target of the relationship |
| SHALL | related-ref | reference | Target of the relationship |
| SHALL | section | token | Classification of section (recommended) |
| SHALL | status | token | preliminary | final | amended | entered-in-error |
| SHALL | subject | reference | Who and/or what the composition is about |
| SHALL | title | string | Human Readable name/title |
| SHALL | type | token | Kind of composition (LOINC if possible) |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $validate |
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-transformation-documentreferencesearch-type, vread, read, patch, delete, create.| 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 | authenticator | reference | Who/what authenticated the document |
| SHALL | author | reference | Who and/or what authored the document |
| SHALL | class | token | Categorization of document |
| SHALL | custodian | reference | Organization which maintains the document |
| SHALL | date | date | Document creation time |
| SHALL | description | string | Human-readable description (title) |
| SHALL | documentSharingState | token | Sharing State of the Document |
| SHALL | encounter | reference | Context of the document content |
| SHALL | event | token | Main clinical acts documented |
| SHALL | facility | token | Kind of facility where patient was seen |
| SHALL | format | token | Format/content rules for the document |
| SHALL | identifier | token | Master Version Specific Identifier |
| SHALL | indexed | date | When this document reference was created |
| SHALL | language | token | Human language of the content (BCP-47) |
| SHALL | location | uri | Uri where the data can be found |
| SHALL | masterIdentifier | token | Master identifier |
| SHALL | patient | reference | Who/what is the subject of the document |
| SHALL | period | date | Time of service that is being documented |
| SHALL | related | reference | Related identifiers or resources |
| SHALL | related-id | token | Identifier of related objects or events |
| SHALL | related-ref | reference | Related Resource |
| SHALL | relatesto | reference | Target of the relationship |
| SHALL | relation | token | replaces | transforms | signs | appends |
| SHALL | relationship | composite | Combination of relation and relatesTo |
| SHALL | securitylabel | token | Document security-tags |
| SHALL | setting | token | Additional details about where the content was created (e.g. clinical specialty) |
| SHALL | status | token | current | superseded | entered-in-error |
| SHALL | subject | reference | Who/what is the subject of the document |
| SHALL | type | token | Kind of document (LOINC if possible) |
| Conformance | Operation | Documentation |
|---|---|---|
| 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. |
read.
IG © 2021+ Den telemedicinske infrastruktur (eHealth Infrastructure). Package dk.ehealth.sundhed.fhir.ig.core#3.6.0 based on FHIR 4.0.1. Generated 2025-09-11
