Adicionar cabeçalhos HTTP personalizados aos logs de auditoria no serviço FHIR
Importante
A API do Azure para FHIR será desativada em 30 de setembro de 2026. Siga as estratégias de migração para fazer a transição para o serviço FHIR® dos Serviços de Dados de Saúde do Azure até essa data. Devido à desativação da API do Azure para FHIR, novas implantações não serão permitidas a partir de 1 de abril de 2025. O serviço FHIR dos Serviços de Dados de Saúde do Azure é a versão evoluída da API do Azure para FHIR que permite aos clientes gerir serviços FHIR, DICOM e MedTech com integrações noutros serviços do Azure.
Na API do Azure Fast Healthcare Interoperability Resources (FHIR),® um usuário pode querer incluir informações adicionais nos logs, que vêm do sistema de chamada.
Por exemplo, quando o usuário da API é autenticado por um sistema externo, esse sistema encaminha a chamada para a API FHIR. Na camada de API FHIR, as informações sobre o usuário original são perdidas, porque a chamada foi encaminhada. Pode ser necessário registrar e reter essas informações do usuário para fins de auditoria ou gerenciamento. O sistema de chamada pode fornecer a identidade do usuário, a localização do chamador ou outras informações necessárias nos cabeçalhos HTTP, que são transportadas à medida que a chamada é encaminhada.
Você pode usar cabeçalhos personalizados para capturar vários tipos de informações. Por exemplo:
- Informações de identidade ou autorização
- Origem do chamador
- Organização de origem
- Dados do sistema do cliente (registo de saúde eletrónico, portal do doente)
Importante
Lembre-se de que as informações enviadas em cabeçalhos personalizados são armazenadas em um sistema de log interno da Microsoft por 30 dias após estarem disponíveis no Monitoramento de Log do Azure. Recomendamos criptografar qualquer informação antes de adicioná-la a cabeçalhos personalizados. Você não deve passar nenhuma informação PHI através de cabeçalhos de clientes.
Você deve usar a seguinte convenção de nomenclatura para seus cabeçalhos HTTP: X-MS-AZUREFHIR-AUDIT-name<>.
Esses cabeçalhos HTTP são incluídos em um pacote de propriedades que é adicionado ao log. Por exemplo:
- X-MS-AZUREFHIR-AUDIT-USERID: 1234
- X-MS-AZUREFHIR-AUDIT-USERLOCATION: XXXX
- X-MS-AZUREFHIR-AUDIT-XYZ: 1234
Essas informações são serializadas para JSON quando são adicionadas à coluna de propriedades no log. Por exemplo:
{ "X-MS-AZUREFHIR-AUDIT-USERID" : "1234",
"X-MS-AZUREFHIR-AUDIT-USERLOCATION" : "XXXX",
"X-MS-AZUREFHIR-AUDIT-XYZ" : "1234" }
Como com qualquer cabeçalho HTTP, o mesmo nome de cabeçalho pode ser repetido com valores diferentes. Por exemplo:
- X-MS-AZUREFHIR-AUDIT-USERLOCATION: HospitalA
- X-MS-AZUREFHIR-AUDIT-USERLOCATION: Emergência
Quando adicionados ao log, os valores são combinados com uma lista delimitada por vírgula. Por exemplo:
{ "X-MS-AZUREFHIR-AUDIT-USERLOCATION" : "HospitalA, Emergência" }
Você pode adicionar um máximo de 10 cabeçalhos exclusivos (repetições do mesmo cabeçalho com valores diferentes são contadas apenas como um). O comprimento máximo total do valor para qualquer cabeçalho é de 2048 caracteres.
Se você estiver usando a biblioteca de API do cliente Firefly C#, o código terá esta aparência:
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");
Próximos passos
Neste artigo, você aprendeu como adicionar dados aos logs de auditoria usando cabeçalhos personalizados na API do Azure para FHIR. Para obter informações sobre as definições de configuração da API do Azure para FHIR, consulte
FHIR® é uma marca registada da HL7 e é utilizada com a permissão da HL7.