eHealth Infrastructure
3.3.0 - release Denmark flag

This page is part of the FUT Infrastructure (v3.3.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

CapabilityStatement: document-query

Official URL: http://ehealth.sundhed.dk/fhir/CapabilityStatement/document-query Version: 3.3.0
Active as of 2024-10-28 Computable Name: document-query

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement document-query

  • Implementation Guide Version: 3.3.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
  • Supported Patch Formats:
  • Published on: 2024-10-28 02:12:33+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.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • Supports the history-systeminteraction.

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 TypeProfileRSUCSearches_include_revincludeOperations
Binaryhttp://hl7.org/fhir/StructureDefinition/Binary*DocumentReference:patient$retrieve-document
Bundlehttp://hl7.org/fhir/StructureDefinition/Bundle*DocumentReference:patient$retrieve-and-transform-QRD, $retrieve-and-transform-PHMR, $retrieve-and-transform-APD
DocumentReferencehttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreferenceystatus, category, consentOverride, date, event, facility, format, patient, patient-identifier, period, reason, setting, type*, DocumentReference:patientDocumentReference:patient
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*DocumentReference:patient

Resource Conformance: supported Binary

Base System Profile
Binary
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Extended Operations
    ConformanceOperationDocumentation
    SHALL$retrieve-document

    Input (url) is the element DocumentReference.content.attachment.url for metadata about the QRD/APD/PHMR document as returned from the DocumentReference search operation performing a query to national document sharing infrastructure. The url, which shall be used as-is in this operation, is an encoding of the XDS DocumentEntry.uniqueId, XDS DocumentEntry.repositoryUniqueId and XDS DocumentEntry.homeCommunityId metadata attributes needed to retrieve the document. Input (consentOverride) signifies, when set to true, that the retrieve of a document shall be performed with override of any withholding of information possibly performed by the national document sharing service in accordance with patient's consents. Override of consents constitutes a form of break-the-glass invocation, known in Danish as værdispring.The preferred method is to call this operation without consent override and to only call with consent override when necessary. Input (reason) is mandatory when input element consentOverride is set to true. The string input is intended as a placeholder for the user's rationale for choosing to override consents.The value is logged in the Infrastructure.

    Resource Conformance: supported Bundle

    Base System Profile
    Bundle
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary

      Extended Operations
      ConformanceOperationDocumentation
      SHALL$retrieve-and-transform-QRD

      Retrieves a DK-HL7 Questionnaire Response Document (QRD) XML document from national document sharing infrastructure and transforms the QRD XML document to a FHIR QuestionnaireResponse (ehealth-questionnaireresponse profile) resource.Input (url) is the element DocumentReference.content.attachment.url for metadata about the QRD document as returned from the DocumentReference search operation performing a query to national document sharing infrastructure. The url, which shall be used as-is in this operation, is an encoding of the XDS DocumentEntry.uniqueId, XDS DocumentEntry.repositoryUniqueId and XDS DocumentEntry.homeCommunityId metadata attributes needed to retrieve the document. Input (bundle) must contain a Questionnaire FHIR resource corresponding to the questionnaire definition (QFDD) that the QRD references and is a response to.Input (consentOverride) signifies, when set to true, that the retrieve of a document shall be performed with override of any withholding of information possibly performed by the national document sharing service in accordance with patient's consents. Override of consents constitutes a form of break-the-glass invocation, known in Danish as værdispring. The preferred method is to call this operation without consent override and to only call with consent override when necessary. Input (reason) is mandatory when input element consentOverride is set to true. The string input is intended as a placeholder for the user's rationale for choosing to override consents. The value is logged in the Infrastructure.The returned FHIR Bundle contains a FHIR Composition (ehealth-composition profile) resource referencing a FHIR QuestionnaireResponse (ehealth-documentreference profile) resource, if the Questionnaire FHIR resource was provided as an input, and if the transformation was successful.If the Questionnaire FHIR resource was not provided as an input, or if the transformation was not successful, the returned FHIR Bundle contains the QRD XML document that was retrieved from the national document sharing infrastructure.

      SHALL$retrieve-and-transform-PHMR

      Retrieves a DK-HL7 Personal Health Monitoring Report (PHMR) XML document from national document sharing infrastructure and transforms the PHMR XML document to FHIR Observation (ehealth-observation profile) resources.Input (url) is the element DocumentReference.content.attachment.url for metadata about the PHMR document as returned from the DocumentReference search operation performing a query to national document sharing infrastructure. The url, which shall be used as-is in this operation, is an encoding of the XDS DocumentEntry.uniqueId, XDS DocumentEntry.repositoryUniqueId and XDS DocumentEntry.homeCommunityId metadata attributes needed to retrieve the document. Input (consentOverride) signifies, when set to true, that the retrieve of a document shall be performed with override of any withholding of information possibly performed by the national document sharing service in accordance with patient's consents. Override of consents constitutes a form of break-the-glass invocation, known in Danish as værdispring. The preferred method is to call this operation without consent override and to only call with consent override when necessary. Input (reason) is mandatory when input element consentOverride is set to true. The string input is intended as a placeholder for the user's rationale for choosing to override consents. The value is logged in the Infrastructure.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$retrieve-and-transform-APD

      Retrieves a DK-HL7 Appointment (APD) XML document from national document sharing infrastructure and transforms the APD XML document to a FHIR Appointment (ehealth-appointment profile) resource.Input (url) is the element DocumentReference.content.attachment.url for metadata about the APD document as returned from the DocumentReference search operation performing a query to national document sharing infrastructure. The url, which shall be used as-is in this operation, is an encoding of the XDS DocumentEntry.uniqueId, XDS DocumentEntry.repositoryUniqueId and XDS DocumentEntry.homeCommunityId metadata attributes needed to retrieve the document. Input (consentOverride) signifies, when set to true, that the retrieve of a document shall be performed with override of any withholding of information possibly performed by the national document sharing service in accordance with patient's consents. Override of consents constitutes a form of break-the-glass invocation, known in Danish as værdispring. The preferred method is to call this operation without consent override and to only call with consent override when necessary.Input (reason) is mandatory when input element consentOverride is set to true. The string input is intended as a placeholder for the user's rationale for choosing to override consents. The value is logged in the Infrastructure.The returned FHIR Bundle contains a FHIR Appointment (ehealth-appointment profile) resource.

      Resource Conformance: supported DocumentReference

      Base System Profile
      ehealth-documentreference
      Profile Conformance
      SHALL
      Reference Policy

      Interaction summary
      • Supports search-type.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLstatustoken

      current | superseded

      SHALLcategorytoken

      Categorization of document

      SHALLconsentOverridetoken

      ConsentOverride signifies, when set to true, that the retrieve of a document shall be performed with override of any withholding of information possibly performed by the national document sharing service in accordance with patient's consents. Override of consents constitutes a form of break-the-glass invocation, known in Danish as værdispring. The preferred method is to call this operation without consent override and to only call with consent override when necessary.

      SHALLdatedate

      Document creation time

      SHALLeventtoken

      Main clinical acts documented

      SHALLfacilitytoken

      Kind of facility where patient was seen

      SHALLformattoken

      Format/content rules for the document

      SHALLpatientreference

      Who/what is the subject of the document

      SHALLpatient-identifiertoken

      Who/what is the subject of the document (identifier)

      SHALLperioddate

      Time of service that is being documented

      SHALLreasonstring

      Reason is mandatory when parameter consentOverride is set to true. The string input is intended as a placeholder for the user's rationale for choosing to override consents. The value is logged in the Infrastructure.

      SHALLsettingtoken

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

      SHALLtypetoken

      Kind of document (LOINC if possible)

       

      Resource Conformance: supported OperationDefinition

      Base System Profile
      OperationDefinition
      Profile Conformance
      SHALL
      Reference Policy

      Interaction summary
      • Supports read.

      Operations

      Use