German Practice Management Shared Semantics (R4)
0.102.3 - release Germany

German Practice Management Shared Semantics (R4) - Downloaded Version null See the Directory of published versions

Missing Data

Missing data

This page states how a FHIR R4 producer records a value that is missing or withheld. This IG has one way to do it. It is the missing-data pattern of HL7 Europe Base and Core, applied without change:

Artifact Value
Package hl7.fhir.eu.base
Version 2.0.1 (STU 2, FHIR R4)
Canonical http://hl7.eu/fhir/base/ImplementationGuide/hl7.fhir.eu.base
Rule Handling Missing Data

The rule uses only artifacts that this IG already depends on: the core extension http://hl7.org/fhir/StructureDefinition/data-absent-reason and the code http://terminology.hl7.org/CodeSystem/data-absent-reason#masked from hl7.terminology.r4. This IG does not add a dependency on hl7.fhir.eu.base and defines no profile, extension, CodeSystem or ValueSet for missing data.

The de-identification IG (io.cognovis.de-identification.de) uses the same path for the values a de-identified export withholds; see its masking export path. The path applies until the German FHIR community standardises another one.

The path

  1. Optional element (0..1, 0..*): omit it. The resource does not contain the element. It does not contain an empty value, a placeholder such as [REDACTED], or a data-absent-reason.
  2. Required coded element (1..1, 1..*): use an exceptional code as the value. A CodeableConcept with an example, preferred or extensible binding takes the exceptional code of its binding value set that states why the value is missing, when the value set has one. Otherwise its only Coding is http://terminology.hl7.org/CodeSystem/data-absent-reason#masked (or the data-absent-reason code that applies, for example unknown), and it has no text. A required Coding element takes the same Coding. A code or CodeableConcept with a required binding takes the exceptional code of its binding value set that states why the value is missing. When that value set has no such code, the element is not masked or left without a value. The producer never substitutes a code with another meaning: Observation.status is not masked as unknown, because unknown states that the source does not know the status.
  3. Required non-coded element (1..1, 1..*, any other datatype): put the data-absent-reason extension on the element. The element has no value and no other content. Its extension http://hl7.org/fhir/StructureDefinition/data-absent-reason has valueCode masked, or the code that states why the value is missing, for example unknown. A primitive such as a dateTime carries the extension on its _element sibling in JSON. A complex datatype such as a Reference or a Period carries it in its own extension list.

The path does not distinguish data that was never collected from data that was collected and withheld. A withheld value uses masked. Data the source did not have follows the same three rules with the code that states why, for example unknown.

TI transmission Task

Task.code and Task.businessStatus of the ti-transmission-task profile are required and have required bindings. Their value sets have no exceptional code, so rule 2 never masks them, and a TI transmission Task always carries its TI application and its transmission stage.

Rejected shapes

These shapes are not part of the path. A producer does not write them.

An emptied Coding with the extension on Coding.system, Coding.code or Coding.display:

"code": {
  "coding": [{
    "_system": { "extension": [{ "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "masked" }] },
    "_code": { "extension": [{ "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "masked" }] }
  }]
}

The required code is "code": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", "code": "masked" }] } instead.

A placeholder or an emptied value, alone or together with a masked code or extension:

"name": [{ "text": "[REDACTED]" }],
"_birthDate": { "extension": [{ "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "masked" }] }

Patient.name and Patient.birthDate are optional, so the producer omits both.

Two paths, one for data that was never collected and one for data that was withheld, are also rejected.