MII IG Dokument
2027.0.0-ballot.2 - Germany flag

This page is part of the MII IG Dokument (v2027.0.0-ballot.2: 2027 Ballot 3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Capability Statements

To enable decentralized data analysis via the German Portal for Medical Research Data (FDPG) of the Medical Informatics Initiative, the capabilities interaction MUST be supported, so that the FHIR server exposes a CapabilityStatement under [BASE_URL]/metadata. Within this CapabilityStatement it MUST be stated which profiles, including their version, as well as which search parameters are supported.

The following lists which content MUST be stated in the CapabilityStatement. In addition, conformance to the following CapabilityStatement MUST be declared in the respective CapabilityStatement instance under CapabilityStatement.instantiates.

Canonical: https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/CapabilityStatement/mii-cps-dokument-capabilitystatement

Artifact page: MII CPS Dokument CapabilityStatement

Language: en

MII CPS Dokument CapabilityStatement

  • Implementation Guide Version: 2027.0.0-ballot.2
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Published on: 2025-06-23
  • Published by: NUM-DIZ

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

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
DocumentReferenceSupported Profiles
  MII PR Dokument Dokument
YY_id, _profile, identifier, status, doc-status, type, category, patient, relation, relatesto, relationship, description, security-label, contenttype, language, location, creation, format, encounter, event, period, facility, setting, nlp-processing-status

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

MII PR Dokument Dokument

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_profileuri
SHALLidentifiertoken
SHALLstatustoken
SHALLdoc-statustoken
SHALLtypetoken
SHALLcategorytoken
SHALLpatientreference
SHALLrelationtoken
SHALLrelatestoreference
SHALLrelationshipcomposite
SHALLdescriptionstring
SHALLsecurity-labeltoken
SHALLcontenttypetoken
SHALLlanguagetoken
SHALLlocationuri
SHALLcreationdate
SHALLformattoken
SHALLencounterreference
SHALLeventtoken
SHALLperioddate
SHALLfacilitytoken
SHALLsettingtoken
SHALLnlp-processing-statustoken
 

Example calls for the search parameters and the links to the Meta module's SearchParameter definitions are on the Search Parameters page.