Skip to content

Commit 0695765

Browse files
AlexanderGrossgematikAlexanderGrossgematik
authored
Merge pull request #99 from gematik/feature/doc-validator-messages
Beschreibung der Validator-Meldungen
2 parents a2d870f + 76bab21 commit 0695765

1 file changed

Lines changed: 127 additions & 0 deletions

File tree

‎ValidationMessages.md‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Erläuterung Validator-Meldungen
2+
3+
Bei der Validierung der Struktur- und Beispielressourcen dieses Projekts werden eine ganze Reihe von Meldungen ausgegeben.
4+
Dieses Dokument erläutert den Hintergrund der jeweiligen Meldung und begründet, warum bestimmte Meldungen aktuell nicht behoben und/oder ignoriert werden können.
5+
In den zitierten Meldungstexten werden Pfade und Positionen zum Teil gekürzt, um Meldungen zusammenzufassen.
6+
Die Meldungen stammen aus dem HAPI Validator [Release 6.7.11](https://github.com/hapifhir/org.hl7.fhir.core/releases/tag/6.7.11).
7+
8+
## Meldungen zu den Struktur-Ressourcen
9+
10+
### Warning: A resource should have narrative for robust management
11+
12+
Wortlaut der Meldung:
13+
```
14+
StructureDefinition: Warning - Constraint failed: dom-6: 'A resource should have narrative for robust management' (defined in http://hl7.org/fhir/StructureDefinition/DomainResource) (Best Practice Recommendation) {http://hl7.org/fhir/StructureDefinition/DomainResource#dom-6}
15+
```
16+
17+
Auf die Generierung von *narrative content* für die Struktur-Ressourcen wird bewusst verzichtet, da sie durch die enthaltenen Struktur-Elemente des FHIR-Standards bereits beschrieben werden.
18+
19+
### Warning: Element names should be simple alphanumerics with a max of 64 characters...
20+
21+
Betrifft nur die Dateien `StructureDefinition-VSDDatensatzGKV.json` und `StructureDefinition-VSDDatensatzPKV.json`. Wortlaut der Meldung:
22+
```
23+
StructureDefinition.differential.element[*]: Warning - Constraint failed: eld-20: 'Element names should be simple alphanumerics with a max of 64 characters, or code generation tools may be broken' {http://hl7.org/fhir/StructureDefinition/ElementDefinition#eld-20}
24+
```
25+
26+
Bei diesen Dateien handelt es sich um Repräsentationen des logischen Modells, die für die praktische Nutzung und insbesondere die Code-Generierung keine Rolle spielen.
27+
28+
### Information: The discriminator type 'pattern' is deprecated in R5+
29+
30+
Wortlaut der Meldung:
31+
```
32+
StructureDefinition.differential.element[*].slicing.discriminator[0]: Information - The discriminator type 'pattern' is deprecated in R5+. For future compatibility, you could consider using type=value with a pattern[x] instead (if this is not an inherited slicing) {SD_PATH_SLICING_DEPRECATED}
33+
```
34+
35+
Zur Bearbeitung dieser Warnung ist bereits [Issue 97](https://github.com/gematik/spec-VSDM2/issues/97) eingeplant.
36+
37+
### Warning: The code '...' is not a valid code in this code system
38+
39+
Betrifft nur die Datei `CodeSystem-VSDMTDSCodeCS.json`. Wortlaut der Meldungen:
40+
```
41+
CodeSystem.concept[0].property[0]: Warning - The code 'client' is not a valid code in this code system {CODESYSTEM_PROPERTY_BAD_INTERNAL_REFERENCE}
42+
CodeSystem.concept[9].property[0]: Warning - The code 'proxy' is not a valid code in this code system {CODESYSTEM_PROPERTY_BAD_INTERNAL_REFERENCE}
43+
```
44+
45+
Da die hier betroffene Property nur zur lokalen Dokumentation verwendet wird, wurde kein eigenes CodeSystem eingerichtet.
46+
Das scheint in der Folge diese Fehlermeldung des Validators auszulösen (siehe auch Info-Meldung `CODESYSTEM_PROPERTY_CODE_DEFAULT_WARNING` weiter unten).
47+
48+
### Warning: Target Code System urn:iso:std:iso:3166 doesn't have all content (content = not-present)...
49+
50+
Betrifft nur die Datei `ConceptMap-VSDMDEUEVAnlage8ISO3166.json`. Wortlaut der Meldung:
51+
```
52+
ConceptMap.group[0].target: Warning - Target Code System urn:iso:std:iso:3166 doesn't have all content (content = not-present), so the target codes cannot be checked {CONCEPTMAP_GROUP_TARGET_INCOMPLETE}
53+
```
54+
55+
Diese Meldung warnt lediglich vor einer Lücke in der Abdeckung durch den Validator.
56+
57+
### Warning: No Target Code System, so the target codes cannot be checked
58+
59+
Betrifft nur die Datei `ConceptMap-VSDMTDSCodeHTTPStatus.json`. Wortlaut der Meldung:
60+
```
61+
ConceptMap.group[0]: Warning - No Target Code System, so the target codes cannot be checked {CONCEPTMAP_GROUP_TARGET_MISSING}
62+
```
63+
64+
Für das Zielsystem (HTTP Status Codes) gibt es kein kanonisches CodeSysteme, aus dem die Codes bezogen werden könnten.
65+
Damit ist auch keine Validierung möglich.
66+
67+
### Information: The type of property 'code' is 'code', but no ValueSet information was found...
68+
69+
Betrifft nur die Datei `CodeSystem-VSDMTDSCodeCS.json`. Wortlaut der Meldungen:
70+
```
71+
CodeSystem.property[0]: Information - The type of property 'code' is 'code', but no ValueSet information was found, so the codes will be validated as internal codes {CODESYSTEM_PROPERTY_CODE_DEFAULT_WARNING}
72+
```
73+
74+
Da die hier betroffene Property nur zur lokalen Dokumentation verwendet wird, wurde kein eigenes CodeSystem eingerichtet.
75+
76+
## Meldungen zu den Beispiel-Ressourcen
77+
78+
### Information: The value provided (...) was not found in the value set 'Iso 3166 Part 1: 2 Letter Codes'...
79+
80+
Wortlaut der Meldung:
81+
```
82+
Bundle.entry[*].resource/.../.address[0].country: Information - The value provided ('LAND') was not found in the value set 'Iso 3166 Part 1: 2 Letter Codes' (http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1), and a code is recommended to come from this value set (error message = The System URI could not be determined for the code 'LAND' in the ValueSet 'http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1'; The provided code '#LAND' was not found in the value set 'http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1') {Terminology_TX_NoValid_18}
83+
```
84+
für `LAND` = Deutschland, Schweiz, Österreich, Luxemburg, Kosovo
85+
86+
In der hier verwendeten Version der Basisprofile existiert noch eine Festlegung der Kodierung der Landesangabe nach ISO 3166-1.
87+
Diese Festlegung [wurde im Basisprofil in der Zwischenzeit geändert](https://github.com/hl7germany/basisprofil-de-r4/pull/665) und [dokumentiert (Abschnitt "Staat (Land)")](https://simplifier.net/guide/leitfaden-de-basis-r4/ig-markdown-Ressourcen-Patient-Addresse?version=current).
88+
Diese Änderung wird allerdings erst in Version 1.6.0 der Basisprofile zur Verfügung stehen.
89+
90+
### Information: The value provided ('Graf') was not found in the value set 'Namenszusatz'...
91+
92+
Wortlaut der Meldung:
93+
```
94+
Bundle.entry[0].resource/*Patient/...*/.name[0].family.extension[0].value.ofType(string): Information - The value provided ('Graf') was not found in the value set 'Namenszusatz' (https://gematik.de/fhir/vsdm2/ValueSet/VSDMNamenszusatzVS|1.0.0), and a code is recommended to come from this value set (error message = The System URI could not be determined for the code 'Graf' in the ValueSet 'https://gematik.de/fhir/vsdm2/ValueSet/VSDMNamenszusatzVS|1.0.0'; The provided code '#Graf' was not found in the value set 'https://gematik.de/fhir/vsdm2/ValueSet/VSDMNamenszusatzVS|1.0.0') {Terminology_TX_NoValid_18}
95+
```
96+
97+
Im zugrundeliegenden CodeSystem ist ein [Übertragungsfehler](https://github.com/hl7germany/basisprofil-de-r4/issues/649) aufgetreten.
98+
Der Fehler wurde mittlerweile behoben.
99+
Diese Änderung wird allerdings erst in Version 1.6.0 der Basisprofile zur Verfügung stehen.
100+
101+
### Information: Binding for path ... in profile StructureDefinition[http://hl7.org/fhir/StructureDefinition/iso21090-codedString|...] has no source, so can't be checked
102+
103+
Wortlaut der Meldung:
104+
```
105+
Bundle.entry[*].resource/*...*/.address[*].country.extension[*].value.ofType(Coding): Information - Binding for path Bundle.entry[*].resource/*...*/.address[*].country.extension[*].value.ofType(Coding) in profile StructureDefinition[http://hl7.org/fhir/StructureDefinition/iso21090-codedString|...] has no source, so can't be checked {Terminology_TX_Binding_NoSource}
106+
```
107+
108+
Die Herkunft dieser Meldung wird derzeit noch untersucht.
109+
110+
### Information: None of the codings provided are in the value set 'Coverage Type and Self-Pay Codes'
111+
112+
Wortlaut der Meldungen:
113+
```
114+
Bundle.entry[*].resource/*Coverage/...*/.type: Information - None of the codings provided are in the value set 'Coverage Type and Self-Pay Codes' (http://hl7.org/fhir/ValueSet/coverage-type|4.0.1), and a coding is recommended to come from this value set (codes = http://fhir.de/CodeSystem/versicherungsart-de-basis#GKV) {Terminology_TX_NoValid_3_CC}
115+
Bundle.entry[*].resource/*Coverage/...*/.type: Information - None of the codings provided are in the value set 'Coverage Type and Self-Pay Codes' (http://hl7.org/fhir/ValueSet/coverage-type|4.0.1), and a coding is recommended to come from this value set (codes = http://fhir.de/CodeSystem/versicherungsart-de-basis#PKV) {Terminology_TX_NoValid_3_CC}
116+
```
117+
118+
Die Herkunft dieser Meldung wird derzeit noch untersucht.
119+
120+
### Information: This element does not match any known slice defined in the profile https://gematik.de/fhir/vsdm2/StructureDefinition/VSDMKrankenhausleistungenPKV|1.0.0
121+
122+
Wortlaut der Meldungen:
123+
```
124+
[157, 38] Bundle.entry[1].resource/*Coverage/...*/.extension[2].extension[*].value.ofType(boolean): Information - This element does not match any known slice defined in the profile https://gematik.de/fhir/vsdm2/StructureDefinition/VSDMKrankenhausleistungenPKV|1.0.0 (this may not be a problem, but you should check that it's not intended to match a slice) {Details_for__matching_against_Profile_}
125+
```
126+
127+
Die Herkunft dieser Meldung wird derzeit noch untersucht.

0 commit comments

Comments
 (0)
⚡