Hinzufügen von benutzerdefinierten HTTP-Headern zu Überwachungsprotokollen im FHIR-Dienst
Wichtig
Azure API for FHIR wird am 30. September 2026 eingestellt. Folgen Sie den Migrationsstrategien, um bis zu diesem Datum zum Azure Health Data Services-FHIR®-Dienst zu wechseln. Aufgrund der Einstellung von Azure API for FHIR werden neue Bereitstellungen ab dem 1. April 2025 nicht zugelassen. Der Azure Health Data Services-FHIR-Dienst ist die weiterentwickelte Version der Azure-API für FHIR, mit der Kundschaft FHIR-, DICOM- und Medizintechnikdienste mit Integrationen in andere Azure-Dienste verwalten kann.
Ein Benutzer sollte in der Azure FHIR®-API (Fast Healthcare Interoperability Resources) zusätzliche Informationen in die Protokolle aufnehmen, die aus dem aufrufenden System stammen.
Wenn der Benutzer der API beispielsweise von einem externen System authentifiziert wird, leitet dieses System den Aufruf an die FHIR-API weiter. Auf Ebene der FHIR-API gehen die Informationen zum ursprünglichen Benutzer verloren, da der Aufruf weitergeleitet wurde. Möglicherweise müssen diese Benutzerinformationen zu Überwachungs- oder Verwaltungszwecken protokolliert und aufbewahrt werden. Das aufrufende System kann die Benutzeridentität, den Standort des Aufrufers oder andere erforderliche Informationen in den HTTP-Headern bereitstellen, die bei der Weiterleitung des Aufrufs übernommen werden.
Mit benutzerdefinierten Headern können Sie verschiedene Arten von Informationen erfassen. Zum Beispiel:
- Identitäts- und Autorisierungsinformationen
- Ursprung des Aufrufers
- Ursprungsorganisation
- Details zum Clientsystem (elektronische Patientenakte, Patientenportal)
Wichtig
Beachten Sie, dass die in benutzerdefinierten Headern gesendeten Informationen nach der Bereitstellung in der Azure-Protokollüberwachung 30 Tage lang in einem internen Microsoft-Protokollierungssystem gespeichert werden. Es wird empfohlen, alle Informationen zu verschlüsseln, bevor diese benutzerdefinierten Headern hinzugefügt werden. Sie sollten keine Patienteninformationen über benutzerdefinierte Header übergeben.
Sie müssen die folgende Benennungskonvention für Ihre HTTP-Header verwenden: X-MS-AZUREFHIR-AUDIT-<Name>.
Diese HTTP-Header sind in einer Eigenschaftensammlung enthalten, die dem Protokoll hinzugefügt wird. Zum Beispiel:
- X-MS-AZUREFHIR-AUDIT-USERID: 1234
- X-MS-AZUREFHIR-AUDIT-USERLOCATION: XXXX
- X-MS-AZUREFHIR-AUDIT-XYZ: 1234
Diese Informationen werden dann beim Hinzufügen der Eigenschaftenspalte im Protokoll in JSON serialisiert. Zum Beispiel:
{ "X-MS-AZUREFHIR-AUDIT-USERID" : "1234",
"X-MS-AZUREFHIR-AUDIT-USERLOCATION" : "XXXX",
"X-MS-AZUREFHIR-AUDIT-XYZ" : "1234" }
Wie bei jedem HTTP-Header kann derselbe Headername mit unterschiedlichen Werten wiederholt werden. Zum Beispiel:
- X-MS-AZUREFHIR-AUDIT-USERLOCATION: HospitalA
- X-MS-AZUREFHIR-AUDIT-USERLOCATION: Emergency
Beim Hinzufügen zum Protokoll werden die Werte mit einer durch Trennzeichen getrennten Liste kombiniert. Zum Beispiel:
{ "X-MS-AZUREFHIR-AUDIT-USERLOCATION" : "HospitalA, Emergency" }
Sie können maximal zehn eindeutige Header hinzufügen (Wiederholungen desselben Headers mit unterschiedlichen Werten werden nur als einer gezählt). Die maximale Gesamtlänge des Werts für einen einzigen Header beträgt 2048 Zeichen.
Wenn Sie die Firefly C#-Client-API-Bibliothek verwenden, sieht der Code in etwa wie folgt aus:
FhirClient client;
client = new FhirClient(serverUrl);
client.OnBeforeRequest += (object sender, BeforeRequestEventArgs e) =>
{
// Add custom headers to be added to the logs
e.RawRequest.Headers.Add("X-MS-AZUREFHIR-AUDIT-UserLocation", "HospitalA");
};
client.Get("Patient");
Nächste Schritte
In diesem Artikel haben Sie erfahren, wie Sie mithilfe von benutzerdefinierten Headern in Azure API for FHIR Daten zu Überwachungsprotokollen hinzufügen können. Informationen zur Azure-API für FHIR-Konfigurationseinstellungen finden Sie unter
FHIR® ist eine eingetragene Marke von HL7 und wird mit Genehmigung von HL7 verwendet.