Adicionar cabeçalhos HTTP personalizados para auditar logs 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 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 dos Serviços de Dados de Saúde do Azure para serviço FHIR é a versão evoluída da API do Azure para FHIR que permite aos clientes gerenciar os serviços FHIR, DICOM e serviço de tecnologia médica com integrações a outros serviços do Azure.
Na API do Fast Healthcare Interoperability Resources (FHIR®) do Azure, um usuário pode querer incluir informações adicionais nos logs, que vêm do sistema de chamadas.
Por exemplo, quando o usuário da API é autenticado por um sistema externo, esse sistema encaminha a chamada para a API do FHIR. Na camada da API FHIR, as informações sobre o usuário original são perdidas porque a chamada foi encaminhada. Pode ser necessário registrar em log e reter essas informações de usuário para fins de auditoria ou gerenciamento. O sistema de chamadas pode fornecer a identidade do usuário, o local do chamador ou outras informações necessárias nos cabeçalhos HTTP, que são realizadas conforme 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
- Detalhes do sistema do cliente (registro de integridade eletrônico, portal do paciente)
Importante
Lembre-se de que as informações enviadas em cabeçalhos personalizados são armazenadas em um sistema de registro interno da Microsoft por 30 dias depois de estarem disponíveis no Monitoramento de Log do Azure. É recomendável criptografar todas as informações antes de adicioná-las aos cabeçalhos personalizados. Você não deve passar nenhuma informação PHI por meio de cabeçalhos de cliente.
Você deve usar a seguinte convenção de nomenclatura para seus cabeçalhos HTTP: X-MS-AZUREFHIR-AUDIT-<nome>.
Esses cabeçalhos HTTP são incluídos em um recipiente 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" }
Assim como ocorre 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 adicionado ao log, os valores são combinados a uma lista delimitada por vírgulas. Por exemplo:
{ "X-MS-AZUREFHIR-AUDIT-USERLOCATION" : "HospitalA, Emergência" }
Você pode adicionar um máximo de 10 cabeçalhos exclusivos (as repetições do mesmo cabeçalho com valores diferentes só são contadas uma vez). O comprimento máximo total do valor para qualquer cabeçalho é de 2.048 caracteres.
Se você está usando a biblioteca de APIs cliente de Firely C#, o código se parece com este:
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óximas etapas
Neste artigo, você aprendeu a adicionar dados aos logs de auditoria usando cabeçalhos personalizados na API do Azure para FHIR. Para obter informações sobre as configurações da API do Azure para FHIR, confira
FHIR® é uma marca registrada da HL7 e é usado com a permissão da HL7.