Softwarehersteller Fachanwendung Behörden
Softwarehersteller Fachanwendung Behörden
Als Softwarehersteller für Fachanwendungen von Gesundheitsämtern greifen Sie abhängig vom jeweils abzubildenden Prozess bzw. der auszuführenden Aktion über die REST- oder über die GraphQL-API auf SHAPTH zu. Zur Unterstützung der technischen Anbindung von Fachanwendungen von Behörden werden im Folgenden die relevantesten Use Cases beschrieben. Dadurch erhalten Sie einen strukturierten Überblick über die wichtigsten Funktionen und Konfigurationsschritte zur Anbindung einer Fachanwendung etwa eines Gesundheitsamts an SHAPTH.
Hinweis zur Dokumentation
Diese Seite bietet Ihnen eine Übersicht mit detaillierten Erklärungen über für Sie relevante Use Cases. Die GraphiQL Playgrounds der jeweiligen Endpunkte zeigen darüber hinaus alle verfügbaren Queries, Mutations und Subscriptions. Ob jedoch eine konkrete Anfrage ausgeführt werden kann, hängt von erteilten Rollen bzw. Berechtigungen ab.
UseCases
Prüfbericht
Gesundheitsämter können Prüfberichte herunterladen und weiterleiten. Die Detailseiten beschreiben die jeweils benötigten Endpunkte und fachlichen Voraussetzungen.
Wählen Sie den jeweiligen Anwendungsfall aus, um eine Einführung in den zugehörigen REST-Aufruf und den XML-Hintergrund zu erhalten.
Untersuchungsplan
Untersuchungspläne können durch Gesundheitsämter erstellt, verbessert, abgelehnt, hochgeladen beziehungsweise versendet, bestätigt und heruntergeladen werden.
Wählen Sie den jeweiligen Anwendungsfall aus, um eine Einführung in den zugehörigen REST-Aufruf und den XML-Hintergrund zu erhalten.
Jahresbericht
Jahresberichte können durch Gesundheitsämter hochgeladen sowie durch Gesundheitsämter und Obere Landesbehörden heruntergeladen werden.
SHAPTH-Register - Geografische Entitäten
Abrufen
Die rechts zu sehenden Use Cases zeigen die GraphQL-Abfragen, die im Rahmen eines Abrufs über eine Behörden-Fachanwendung relevant sein können. Dazu gehören unter anderem der Abruf von Anlagen nach TrinkwV, Objekten, Probennahmestellen und Wasserversorgungsgebieten.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
Erstellen
Die rechts zu sehenden Use Cases zeigen die GraphQL-Mutationen, die im Rahmen einer Behörden-Fachanwendung für das Erstellen neuer Registereinträge relevant sein können. Dazu gehören die Erstellung von Anlagen nach TrinkwV, Objekten, Probennahmestellen und Wasserversorgungsgebieten.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
Aktivieren/deaktivieren
Die rechts zu sehenden Use Cases zeigen die GraphQL-Mutationen, die im Rahmen einer Behörden-Fachanwendung für das Aktivieren und Deaktivieren vorhandener Registereinträge relevant sein können. Beide Aktionen nutzen dieselbe GraphQL-Update-Mutation mit unterschiedlichem active-Wert.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
Leserecht erteilen
Die rechts zu sehenden Use Cases zeigen die GraphQL-Mutationen, die im Rahmen einer Behörden-Fachanwendung für das Erteilen von Leserechten relevant sein können. Dabei werden anderen Akteuren Leserechte auf Registereinträge erteilt.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
Leserecht entziehen
Die rechts zu sehenden Use Cases zeigen die GraphQL-Mutationen, die im Rahmen einer Behörden-Fachanwendung für das Entziehen von Leserechten relevant sein können. Dabei werden bereits erteilte Leserechte auf Registereinträge entzogen.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
Pflegeverantwortung ändern
Die rechts zu sehenden Use Cases zeigen die GraphQL-Mutationen, die im Rahmen einer Behörden-Fachanwendung für die Änderung der Pflegeverantwortung relevant sein können. Dazu gehören die Übergabe und Übernahme der Pflegeverantwortung für Registereinträge über dieselbe Writer-Update-Mutation.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
Bearbeiten
Die rechts zu sehenden Use Cases zeigen die GraphQL-Mutationen, die im Rahmen einer Behörden-Fachanwendung für das Bearbeiten von Registereinträgen relevant sein können. Dazu gehören die Bearbeitung von Anlagen nach TrinkwV, Objekten, Probennahmestellen und Wasserversorgungsgebieten.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
SHAPTH-Register - Akteure
Abrufen
Die rechts zu sehenden Use Cases zeigen die GraphQL-Abfragen, die im Rahmen eines Abrufs über eine Behörden-Fachanwendung relevant sein können. Dazu gehören unter anderem der Abruf von Zuständigen Behörden, Zugelassenen Untersuchungsstellen und Betreibern.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
Erstellen
Die rechts zu sehenden Use Cases zeigen die GraphQL-Mutationen, die im Rahmen einer Erstellung über eine Behörden-Fachanwendung für das Erstellen neuer Registereinträge von SHAPTH-Akteuren relevant sein können. Dazu gehören die Erstellung von Zuständigen Behörden und Zugelassenen Untersuchungsstellen.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
Bearbeiten
Die rechts zu sehenden Use Cases zeigen die GraphQL-Mutationen, die im Rahmen einer Behörden-Fachanwendung für das Bearbeiten von Registereinträgen von SHAPTH-Akteuren relevant sein können. Dazu gehören die Bearbeitung von Zuständigen Behörden und Zugelassenen Untersuchungsstellen.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
Aktivieren/deaktivieren
Die rechts zu sehenden Use Cases zeigen die GraphQL-Mutationen, die im Rahmen einer Behörden-Fachanwendung für das Aktivieren und Deaktivieren von Registereinträgen von SHAPTH-Akteuren relevant sein können. Technisch erfolgt dies jeweils über die passende Update-Mutation mit active.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.
Niederlassung erstellen
Die rechts zu sehenden Use Cases zeigen die GraphQL-Mutationen, die im Rahmen einer Behörden-Fachanwendung für das Anlegen von Niederlassungen relevant sein können. Dazu gehört das Erstellen einer Niederlassung zu einer Zugelassenen Untersuchungsstelle.
Wählen Sie den jeweiligen Anwendungsfall aus, um die zugehörige Query, Beispiel-Variablen sowie eine fachliche Erläuterung der Code-Bestandteile und Rückgabefelder einzusehen.