MII IG Dokument
2027.0.0-ballot.2 - Germany flag

MII IG Dokument - Downloaded Version 2027.0.0-ballot.2 See the Directory of published versions

Extension: MII EX Dokument NLP Processing Status

Official URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/StructureDefinition/mii-ex-dokument-nlp-processing-status Version: 2027.0.0-ballot.2
Active as of 2026-09-14 Computable Name: MII_EX_Dokument_NLP_Processing_Status

Status der NLP-Verarbeitung des referenzierten Dokuments

Context of Use

    This extension may be used on the following element(s)

Description

This extension is used for the structured description of the processing status of a document within an NLP project. Processing documents that carry unstructured information typically happens in a series of consecutive processing steps. In the course of these process chains, different transformations of the original document arise, as well as relations between the source document and the intermediate products derived from it.

For this purpose the NLP extension provides a code system with which the various processing states and intermediate products of an NLP workflow can be described and archived consistently.

The code system of the NLP extension is hierarchical and comprises two levels: level 1 (Lvl 1) and level 2 (Lvl 2). Lvl 1 describes a superordinate process status, for example annotated. Lvl 2 serves to specify that status. One example is the combination Lvl 1: annotated, Lvl 2: deid, which indicates that a document has been furnished with de-identifying annotations.

Using both hierarchy levels is not mandatory. Depending on the respective application scenario, it can be decided freely whether only the superordinate status (Lvl 1) or additionally a specific differentiation via Lvl 2 is used. Please note: if a Lvl 2 specification such as deid is used, the corresponding Lvl 1 annotated must also be used. Otherwise deid could be misunderstood as a fully de-identified document.

An exemplary use case is a document within an annotation project that has already been extracted from a source system and anonymised. Several processing steps may have taken place up to the current processing state, for example:

  • transformation of the file format from .pdf to .txt (preprocessed – format-change)
  • removal of document headers (preprocessed – content-change)
  • machine pre-annotation of identifying structures (annotated – preanno deid)
  • subsequent manual annotation of those structures (annotated – deid)
  • irreversible replacement of all identifying annotations by surrogates (surrogated)

The NLP extension deliberately leaves degrees of freedom in documenting such process chains. It is possible to represent every processing step of a document. Alternatively, the description may be limited to selected processing states that are essential for the respective use case, for example exclusively to the final status surrogated.

Content

The technical structure of this extension — differential, key elements, snapshot and the XML and JSON serialisations — is rendered by the IG Publisher directly below this section on this artifact page. The Must Support elements with their short descriptions and comments are shown there as well; canonical URL, status, version and base definition are carried by the page header.

The codes of the NLP processing status are defined by the code system MII CS Dokument NLP Processing Status with its two-level hierarchy; the extension is bound via the value set MII VS Dokument NLP Processing Status.

Examples

The NLP pipeline example scenario — flow diagram, the processing steps with their NLP processing status and the associated DocumentReference, Patient and Encounter resources — is on the Examples page.

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension MII EX Dokument NLP Processing Status
... extension 0..0 Extension
... url 1..1 uri "https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/StructureDefinition/mii-ex-dokument-nlp-processing-status"
... value[x] S 1..1 CodeableConcept NLP Processing Status
.... coding S 1..* Coding Code defined by a terminology system
Binding: MII VS Dokument NLP Processing Status (required)
..... system S 1..1 uri Identity of the terminology system
Fixed Value: https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/CodeSystem/mii-cs-dokument-nlp-processing-status
..... code S 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.value[x].coding Base required MII VS Dokument NLP Processing Status 📦2027.0.0-ballot.2 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension MII EX Dokument NLP Processing Status
... id 0..1 string Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/StructureDefinition/mii-ex-dokument-nlp-processing-status"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
Binding: MII VS Dokument NLP Processing Status (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/CodeSystem/mii-cs-dokument-nlp-processing-status
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.value[x].coding Base required MII VS Dokument NLP Processing Status 📦2027.0.0-ballot.2 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Simple Extension with the type CodeableConcept: Status der NLP-Verarbeitung des referenzierten Dokuments

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension MII EX Dokument NLP Processing Status
... extension 0..0 Extension
... url 1..1 uri "https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/StructureDefinition/mii-ex-dokument-nlp-processing-status"
... value[x] S 1..1 CodeableConcept NLP Processing Status
.... coding S 1..* Coding Code defined by a terminology system
Binding: MII VS Dokument NLP Processing Status (required)
..... system S 1..1 uri Identity of the terminology system
Fixed Value: https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/CodeSystem/mii-cs-dokument-nlp-processing-status
..... code S 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.value[x].coding Base required MII VS Dokument NLP Processing Status 📦2027.0.0-ballot.2 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension MII EX Dokument NLP Processing Status
... id 0..1 string Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/StructureDefinition/mii-ex-dokument-nlp-processing-status"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
Binding: MII VS Dokument NLP Processing Status (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/CodeSystem/mii-cs-dokument-nlp-processing-status
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.value[x].coding Base required MII VS Dokument NLP Processing Status 📦2027.0.0-ballot.2 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Simple Extension with the type CodeableConcept: Status der NLP-Verarbeitung des referenzierten Dokuments

 

Other representations of profile: CSV, Excel, Schematron