eHealth Infrastructure
3.3.0 - ci-build 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 3.3.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: 3.3.0
Active as of 2024-08-06 Computable Name: document-transformation

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement document-transformation

  • 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-08-06 02:18:15+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 TypeProfileRV-RSUPCDSearches_include_revincludeOperations
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-documentreferenceyyyyyy_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, authenticator, author, class, custodian, date, description, 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
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
Base System Profile
ehealth-documentreference
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)

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.

Operations

Use