MII IG Modul Patho
2027.0.0-ballot - Germany

MII IG Modul Patho - Local Development build (v2027.0.0-ballot) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: MII CPS Patho Capability Statement

Official URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-patho/CapabilityStatement/mii-cps-patho-capability-statement Version: 2027.0.0-ballot
Active as of 2024-11-08 Computable Name: MII_CPS_Patho_Capability_Statement

The CapabilityStatement describes all mandatory interactions for a system to be conformant to the Pathology Module of the Medical Informatics Initiative

In order to enable decentralized data analysis by means of the German Research Data Portal for Health of the Medical Informatics Initiative, the capabilities interaction MUST be supported, so that the FHIR server exposes a CapabilityStatement at [BASE_URL]/metadata. Within this CapabilityStatement it MUST be stated which profiles including version, and which search parameters, are supported.

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

Canonical: https://www.medizininformatik-initiative.de/fhir/ext/modul-patho/CapabilityStatement/metadata

Raw OpenAPI-Swagger Definition file | Download

Language: en

MII CPS Patho Capability Statement

  • Implementation Guide Version: 2027.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Published on: 2024-11-08
  • Published by: Medizininformatik-Initiative

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
SpecimenSupported Profiles
  MII PR Patho Specimenversion: 2027.0.0-ballot)
YY_id, _lastUpdated, _profile, identifier, accession, status, type, subject, parent, collected, collector, bodysite, container, patient, request, collection-method, collection-body-site, processing-procedure, processing-additive, processing-date, container-additive
ObservationSupported Profiles
  MII PR Patho Intraoperative Grouperversion: 2027.0.0-ballot)
  MII PR Patho Macroscopic Grouperversion: 2027.0.0-ballot)
  MII PR Patho Microscopic Grouperversion: 2027.0.0-ballot)
  MII PR Patho Findingversion: 2027.0.0-ballot)
  MII PR Patho Diagnostic Conclusion Grouperversion: 2027.0.0-ballot)
  MII PR Patho Additional Specified Grouperversion: 2027.0.0-ballot)
YY_id, _lastUpdated, _profile, based-on, category, code, code-value-concept, code-value-date, code-value-quantity, code-value-string, combo-code, combo-code-value-concept, combo-code-value-quantity, combo-data-absent-reason, combo-value-concept, combo-value-quantity, component-code, component-code-value-concept, component-code-value-quantity, component-data-absent-reason, component-value-concept, component-value-quantity, data-absent-reason, date, derived-from, encounter, has-member, identifier, method, patient, performer, specimen, status, subject, value-concept, value-date, value-quantity, value-string, body-site, value-ratio, value-ratio-numerator, value-ratio-denominator
ServiceRequestSupported Profiles
  MII PR Patho Service Requestversion: 2027.0.0-ballot)
YY_id, _lastUpdated, _profile, authored, category, code, encounter, identifier, intent, patient, performer, requester, requisition, specimen, status, subject, reason-code, supporting-info
DiagnosticReportSupported Profiles
  MII PR Patho Reportversion: 2027.0.0-ballot)
YY_id, _lastUpdated, _profile, based-on, category, code, conclusion, date, encounter, identifier, issued, media, patient, performer, result, specimen, status, subject, imaging-study
CompositionSupported Profiles
  MII PR Patho Compositionversion: 2027.0.0-ballot)
YY_id, _lastUpdated, _profile, attester, author, category, context, date, encounter, entry, identifier, patient, period, related-ref, section, status, subject, title, type, attester-mode, custodian, relates-to-code
MediaSupported Profiles
  MII PR Patho Attached Imageversion: 2027.0.0-ballot)
YY_id, _lastUpdated, _profile, created, status, subject, type, part-of

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

SHALL_profileuri

Profiles this resource claims to conform to

SHALLidentifiertoken

The unique identifier associated with the specimen

SHALLaccessiontoken

The accession number associated with the specimen

SHALLstatustoken

available | unavailable | unsatisfactory | entered-in-error

SHALLtypetoken

The specimen type

SHALLsubjectreference

The subject of the specimen

SHALLparentreference

The parent of the specimen

SHALLcollecteddate

The date the specimen was collected

SHALLcollectorreference

Who collected the specimen

SHALLbodysitetoken

The code for the body site from where the specimen originated

SHALLcontainertoken

The kind of specimen container

SHALLpatientreference

The patient the specimen comes from

SHALLrequestreference

SearchParameter for Specimen.request

SHALLcollection-methodtoken

SearchParameter for Specimen.collection.method

SHALLcollection-body-sitetoken

SearchParameter for Specimen.collection.bodySite

SHALLprocessing-proceduretoken

SearchParameter for Specimen.processing.procedure

SHALLprocessing-additivereference

SearchParameter for Specimen.processing.additive

SHALLprocessing-datedate

SearchParameter for Specimen.processing.time

SHALLcontainer-additivereference

SearchParameter for Specimen.container.additive

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

SHALL_profileuri

Profiles this resource claims to conform to

SHALLbased-onreference

Reference to the service request

SHALLcategorytoken

The classification of the type of observation

SHALLcodetoken

The code of the observation type

SHALLcode-value-conceptcomposite

Code and coded value parameter pair

SHALLcode-value-datecomposite

Code and date/time value parameter pair

SHALLcode-value-quantitycomposite

Code and quantity value parameter pair

SHALLcode-value-stringcomposite

Code and string value parameter pair

SHALLcombo-codetoken

The code of the observation type or component type

SHALLcombo-code-value-conceptcomposite

Code and coded value parameter pair, including in components

SHALLcombo-code-value-quantitycomposite

Code and quantity value parameter pair, including in components

SHALLcombo-data-absent-reasontoken

The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing

SHALLcombo-value-concepttoken

The value or component value of the observation, if the value is a CodeableConcept

SHALLcombo-value-quantityquantity

The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)

SHALLcomponent-codetoken

The component code of the observation type

SHALLcomponent-code-value-conceptcomposite

Component code and component coded value parameter pair

SHALLcomponent-code-value-quantitycomposite

Component code and component quantity value parameter pair

SHALLcomponent-data-absent-reasontoken

The reason why the expected value in the element Observation.component.value[x] is missing

SHALLcomponent-value-concepttoken

The value of the component observation, if the value is a CodeableConcept

SHALLcomponent-value-quantityquantity

The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)

SHALLdata-absent-reasontoken

The reason why the expected value in the element Observation.value[x] is missing

SHALLdatedate

Obtained datetime. If the obtained element is a period, a date that falls in the period

SHALLderived-fromreference

Related measurements the observation is made from

SHALLencounterreference

Encounter related to the observation

SHALLhas-memberreference

Related resource that belongs to the Observation group

SHALLidentifiertoken

The unique id for a particular observation

SHALLmethodtoken

The method used for the observation

SHALLpatientreference

The subject that the observation is about (if patient)

SHALLperformerreference

Who performed the observation

SHALLspecimenreference

Specimen used for this observation

SHALLstatustoken

The status of the observation

SHALLsubjectreference

The subject that the observation is about

SHALLvalue-concepttoken

The value of the observation, if the value is a CodeableConcept

SHALLvalue-datedate

The value of the observation, if the value is a date or period of time

SHALLvalue-quantityquantity

The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)

SHALLvalue-stringstring

The value of the observation, if the value is a string, and also searches in CodeableConcept.text

SHALLbody-sitetoken

SearchParameter for Observation.bodySite

SHALLvalue-ratiocomposite

SearchParameter for Observation.valueRatio

SHALLvalue-ratio-numeratorquantity

SearchParameter for Observation.valueRatio.numerator

SHALLvalue-ratio-denominatorquantity

SearchParameter for Observation.valueRatio.denominator

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

SHALL_profileuri

Profiles this resource claims to conform to

SHALLauthoreddate

Date request signed

SHALLcategorytoken

Classification of service

SHALLcodetoken

What is being requested/ordered

SHALLencounterreference

An encounter in which this request is made

SHALLidentifiertoken

Identifiers assigned to this order

SHALLintenttoken

proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option

SHALLpatientreference

Search by subject - a patient

SHALLperformerreference

Requested performer

SHALLrequesterreference

Who/what is requesting service

SHALLrequisitiontoken

Composite Request ID

SHALLspecimenreference

Specimen to be tested

SHALLstatustoken

draft | active | on-hold | revoked | completed | entered-in-error | unknown

SHALLsubjectreference

Search by subject

SHALLreason-codetoken

SearchParameter for ServiceRequest.reasonCode

SHALLsupporting-inforeference

SearchParameter for ServiceRequest.supportingInfo

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

SHALL_profileuri

Profiles this resource claims to conform to

SHALLbased-onreference

Reference to the service request

SHALLcategorytoken

Which diagnostic discipline/department created the report

SHALLcodetoken

The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result

SHALLconclusiontoken

A coded conclusion (interpretation/impression) on the report

SHALLdatedate

The clinically relevant time of the report

SHALLencounterreference

The Encounter when the order was made

SHALLidentifiertoken

An identifier for the report

SHALLissueddate

When the report was issued

SHALLmediareference

A reference to the image source

SHALLpatientreference

The subject of the report if a patient

SHALLperformerreference

Who is responsible for the report

SHALLresultreference

Link to an atomic result (observation resource)

SHALLspecimenreference

The specimen details

SHALLstatustoken

The status of the report

SHALLsubjectreference

The subject of the report

SHALLimaging-studyreference

SearchParameter for DiagnosticReport.imagingStudy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

SHALL_profileuri

Profiles this resource claims to conform to

SHALLattesterreference

Who attested the composition

SHALLauthorreference

Who and/or what authored the composition

SHALLcategorytoken

Categorization of Composition

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

Version-independent identifier for the Composition

SHALLpatientreference

Who and/or what the composition is about

SHALLperioddate

The period covered by the documentation

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)

SHALLattester-modetoken

SearchParameter for Composition.attester.mode

SHALLcustodianreference

SearchParameter for Composition.custodian

SHALLrelates-to-codetoken

SearchParameter for Composition.relatesTo.code

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

SHALL_profileuri

Profiles this resource claims to conform to

SHALLcreateddate

When Media was collected

SHALLstatustoken

preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

SHALLsubjectreference

Who/What this Media is a record of

SHALLtypetoken

Classification of media as image, video, or audio

SHALLpart-ofreference

SearchParameter for Media.partOf