Validar recursos FHIR em relação a perfis nos Serviços de Dados de Integridade do Azure
Nos perfis da loja no artigo de serviço FHIR®, você percorreu os conceitos básicos dos perfis FHIR e os armazenou. O serviço FHIR nos Serviços de Dados de Integridade do Azure permite validar recursos em perfis para ver se os recursos estão em conformidade com os perfis. Este artigo orienta você sobre como usar $validate a validação de recursos em perfis.
$validate é uma operação em Recursos de Interoperabilidade Médica Rápida (FHIR) que permite garantir que um recurso FHIR esteja em conformidade com os requisitos de recurso base ou um perfil especificado. Essa operação garante que os dados em um serviço FHIR tenham os atributos e valores esperados. Para obter informações sobre a operação de validação, visite Especificação HL7 FHIR.
De acordo com a especificação, o modo pode ser especificado com $validate, como create e update:
create: O serviço FHIR verifica se o conteúdo do perfil é exclusivo dos recursos existentes e se é aceitável ser criado como um novo recurso.update: Verifica se o perfil é uma atualização em relação ao recurso existente nomeado (ou seja, se nenhuma alteração é feita nos campos imutáveis).
Existem diferentes maneiras fornecidas para você validar o recurso:
- Opção 1: validar um recurso existente com a operação de validação.
- Opção 2: validar um novo recurso com a operação de validação.
- Opção 3: validar no recurso CREATE ou UPDATE usando um cabeçalho.
Na validação bem-sucedida de um recurso existente ou novo com a operação de validação, o recurso não é persistido no serviço FHIR. Use a Opção 3 para persistir com êxito os recursos validados no serviço FHIR.
O serviço FHIR sempre retorna um OperationOutcome como os resultados da validação para uma operação $validate. Depois que um recurso é passado para $validate ponto de extremidade, o serviço FHIR faz a validação em duas etapas. A primeira etapa é uma validação básica para garantir que o recurso possa ser analisado. Durante a análise de recursos, erros individuais precisam ser corrigidos antes de prosseguir para a próxima etapa. Depois que um recurso é analisado com êxito, a validação completa é conduzida como a segunda etapa.
Observação
Todos os conjuntos de valores que devem ser usados para validação devem ser carregados no servidor FHIR. Isso inclui todos os Valuesets que fazem parte da especificação FHIR, bem como todos os ValueSets definidos nos guias de implementação. Somente conjuntos de valores totalmente expandidos que contêm uma lista completa de todos os códigos são suportados. Não há suporte para definições de ValueSet que fazem referência a fontes externas.
Opção 1: Validando um recurso existente
Para validar um recurso existente, use $validate em uma GET solicitação.
GET http://<your FHIR service base URL>/{resource}/{resource ID}/$validate
Por exemplo:
GET https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/Patient/a6e11662-def8-4dde-9ebc-4429e68d130e/$validate
Neste exemplo, você está validando o recurso a6e11662-def8-4dde-9ebc-4429e68d130e Paciente existente em relação ao recurso Paciente base. Se for válido, você obterá um exemplo de OperationOutcome código como o exemplo de código a seguir.
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "information",
"code": "informational",
"diagnostics": "All OK"
}
]
}
Se o recurso não for válido, você receberá um código de erro e uma mensagem de erro com detalhes sobre o motivo pelo qual o recurso é inválido. Um exemplo OperationOutcome é retornado com mensagens de erro e pode ser semelhante ao exemplo de código a seguir.
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "error",
"code": "invalid",
"details": {
"coding": [
{
"system": "http://hl7.org/fhir/dotnet-api-operation-outcome",
"code": "1028"
}
],
"text": "Instance count for 'Patient.identifier.value' is 0, which is not within the specified cardinality of 1..1"
},
"location": [
"Patient.identifier[1]"
]
},
{
"severity": "error",
"code": "invalid",
"details": {
"coding": [
{
"system": "http://hl7.org/fhir/dotnet-api-operation-outcome",
"code": "1028"
}
],
"text": "Instance count for 'Patient.gender' is 0, which is not within the specified cardinality of 1..1"
},
"location": [
"Patient"
]
}
]
}
Neste exemplo, o recurso não estava em conformidade com o perfil do paciente fornecido, que exigia um valor de identificador de paciente e sexo.
Se você quiser especificar um perfil como um parâmetro, poderá especificar a URL canônica para o perfil a ser validado, como o exemplo a seguir para o perfil base HL7 para heartrate.
GET https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/Observation/12345678/$validate?profile=http://hl7.org/fhir/StructureDefinition/heartrate
Opção 2: Validando um novo recurso
Se você quiser validar um novo recurso que está carregando no servidor, poderá fazer uma POST solicitação.
POST http://<your FHIR service base URL>/{Resource}/$validate
Por exemplo:
POST https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/Patient/$validate
Essa solicitação valida o recurso. O novo recurso que você está especificando na solicitação será criado após a validação.
O servidor sempre retorna um OperationOutcome como resultado.
Opção 3: validar no recurso CREATE ou UPDATE usando um cabeçalho
Você pode escolher quando deseja validar seu recurso, como no recurso CREATE ou UPDATE. Por padrão, o serviço FHIR é configurado para recusar a validação no recurso Create/Update. Esse recurso permite a validação no Create/Update uso do x-ms-profile-validation cabeçalho. Defina x-ms-profile-validation como true para validação.
Observação
No serviço FHIR de software livre, você pode alterar a definição de configuração do servidor, em CoreFeatures.
{
"FhirServer": {
"CoreFeatures": {
"ProfileValidationOnCreate": true,
"ProfileValidationOnUpdate": false
}
}
Para habilitar a validação estrita, use um cabeçalho 'Prefer: handling' com valor estrito. Ao definir esse cabeçalho, um aviso de validação é relatado como um erro.
Próximas etapas
Neste artigo, você aprendeu a validar recursos em perfis usando $validateo . Para saber mais sobre os outros recursos compatíveis com o serviço FHIR, consulte
Observação
FHIR® é uma marca registrada da HL7 e é usado com a permissão da HL7.