FHIR®
Für eine grundlegende Dokumentation zu FHIR® wird auf die offizielle Dokumentation von HL7® verwiesen. Diese wird hier als bekannt vorausgesetzt.
Basis-URL
- Aktuelle Version:
https://dipa.bfarm.de/api/fhir/v2.0/ - Testsystem:
https://dipa.bfarm.de/api/fhir/test/
Hinweise
Interne IDs
Die internen IDs des FHIR®-Servers sind nicht zur externen Speicherung gedacht und werden sich bei neuen Versionen der API ändern.
Meta-Informationen
id, versionId und lastUpdated haben keine fachliche Aussagekraft. Diese rein technischen Eigenschaften der Datensätze auf dem FHIR-Server können sich jederzeit ändern und dürfen nicht extern gespeichert werden. Die Meta-Informationen sind nicht Bestandteil der DiPA-Daten und können nicht manuell geändert werden.
Als eindeutiger Identifier einer DiPA gilt allein die DiPA-ID welche im identifier-Feld ausgelesen werden kann. Fachliche Datums- und Zeitangaben sind allein in den profilierten Feldern zu finden. Beispielweise sind die Gültigkeitsdaten eines Verzeichniseintrages in CatalogEntry.validityPeriod gespeichert, für die Verordnungseinheiten in ChargeItemDefinition.effectivePeriod.
Kardinalität und Must-Support
Das Must-Support-Flag (S) gibt an welche Elemente prinzipiell über die Schnittstelle bereitgestellt werden können. Allerdings bedeutet dies nicht, dass diese Elemente in jedem Datensatz befüllt sind; dafür ist allein die Kardinalität entscheidend.
Ale Elemente deren Kardinalität mit 0 beginnen, sind immer optional. Datensätze müssen diese Angaben nicht enthalten um korrekt zu sein.
Das bedeutet:
- Ein Feld mit Must-Support und Kardinalität
0…ist optional und kann befüllt sein. - Ein Feld ohne Must-Support und Kardinalität
0…ist aus den Basisprofilen übernommen wurden, wird aber nie befüllt.
Hintergrund dieser Vorgehensweise ist, dass somit keine Felder aus den Basisprofilen gestrichen werden müssen um bei einer potentiellen Erweiterung der Profilierung keine Inkompatibilitäten zu erzeugen.