Configuração de Saída HL7v2

Enviar resultados para um EMR ou outro sistema externo requer uma licença EMR válida. Para ajuda na configuração da saída HL7v2, entre em contato com Suporte Técnico.

Abrir configurações

Para configurar a saída HL7v2, abra o aplicativo AGNES Connect e pressione o ícone Configurações no canto inferior esquerdo.

Seção Selecionar dispositivos

Encontre e selecione a entrada denominada Dispositivos.

Selecione HL7v2

Encontre e selecione a entrada rotulada HL7v2.

Editar configuração

Clique na configuração para editar.

Aplicar ou cancelar

Clique em Aplicar para salvar as alterações.

Pressione ESC para cancelar sem salvar.

Configurações HL7

Configuração	Descrição
`enabled`	Defina como `true` para habilitar a saída HL7. Defina como `false` para desabilitar a saída HL7.
`allowQuery`	Defina como `true` para habilitar consultas do paciente.
`allowVitals`	Defina como ‘verdadeiro’ para permitir o envio de instantâneos vitais. Defina como `false` para bloquear o envio de instantâneos vitais.
`allowDocuments`	Defina como ‘verdadeiro’ para permitir o envio de documentos, como relatórios PDF e vídeos instantâneos.
`allowedExternalExtensions`	Lista de extensões de arquivo para permitir a exportação.
`destination`	Destino das mensagens vitais da HL7. Aceita um `mllp://`, `mllps://`, `http://`, `https://`, or `file://` URI.
`fileDestination`	Destino das mensagens de arquivo de HL7. Aceita um `mllp://`, `mllps://`, `http://`, `https://`, or `file://` URI.
`queryEndpoint`	Destino dos inquéritos sobre a informação do paciente. Aceita um `mllp://`, `mllps://`, `http://`, ou `https://` URI. Habilita a aba Pesquisa dos Pacientes em AGNES quando definida.
`receivingApplication`	Preenche o campo “Recebendo Aplicação” de todas as mensagens HL7 realizadas.
`receivingFacility`	Preenche o campo “Instalação de Recebimento” de todas as mensagens de saída HL7.
`rawFileUpload`	Defina como `true` para enviar arquivos sem um wrapper HL7.
`requiredPatientFields`	Lista de campos que AGNES deve exigir antes de enviar mensagens HL7, como `pacientId`, `firstName`, `lastName`, `middleInitial`, `birthDate`, e/ou `sexo`.
`timestampFormat`	Formato do timestamp. O padrão é o padrão HL7v2.
`hl7_vitals_msg`	Configurar segmentos de mensagem vitais individuais. Pode substituir valores nos segmentos `MSH`, `PID`, `OBR`, e `OBX`.
`hl7_document_msg`	Configurar segmentos de mensagem de documento individual. Pode substituir valores nos segmentos `MSH`, `PID`, `OBR`, e `OBX`.
`queryPatientMessage`	Configure os segmentos das consultas efetuadas HL7. Pode substituir valores nos segmentos `MSH` e `QPD`.

Consulta do Paciente

Os usuários podem consultar uma lista de pacientes de um EMR sobre HL7 se o sistema EMR for compatível. O usuário pode fornecer uma string de pesquisa parcial para restringir os resultados.

Ponto de extremidade de consulta HL7

Uma vez definido queryEndpoint , a aba Patient Search no AGNES será habilitada. Para ativar a Aba de Pesquisa do Paciente, defina o endereço do servidor para se conectar na Configuração HL7 como queryEndpoint. Uma seção de QPD precisa ser definida na configuração HL7 com base nas configurações do EMR conectado.

Permitir consulta do paciente

A funcionalidade de pesquisa no AGNES é habilitada quando queryEndpoint é definido. Isso pode ser desabilitado configurando allowQuery para false.


        allowQuery: false

Copy to clipboard

Personalizando Segmentos HL7

AGNES produz sinais HL7v2 válidos e abrangentes por padrão, mas alguns usuários podem desejar dados adicionais ou alterações na saída. Os valores de cada segmento e de cada campo lá podem ser substituídos usando as configurações hl7_vitals_msg (para observações vitais discretas), hl7_documents_msg (para documentos) e queryPatientMessage (para consultas de censo).

Para personalizar um segmento, adicione o código do segmento como uma chave na configuração associada à mensagem. A partir de lá, os campos individuais podem ser personalizados usando seu número prefixado por um sublinhado. Por exemplo, _1 irá substituir o primeiro campo do segmento. Campos aninhados também são modificados seguindo o mesmo esquema. Os campos só serão substituídos se especificado.

Como exemplo, as seguintes configurações irão capitalizar apenas no sobrenome do paciente ao salvar observações:

Copy to clipboard


          hl7_vitals_msg:
  PID:
    _5:
      _0:
        _1: {{ patient.lastName.value.toUpperCase() }}

Em alguns casos, um campo em um segmento HL7 pode ter um tipo de variável, como no terceiro campo do segmento QPD (“Parâmetros do usuário”). Nestes casos, AGNES permite definir a estrutura da mensagem usando as chaves _def para definir estruturas personalizadas, para que a mensagem possa atender às necessidades do pedido de recebimento. Por exemplo, passar parâmetros de pesquisa de consulta definindo o campo “Parâmetros do Usuário” do segmento QPD:

Copy to clipboard


          queryPatientMessage:
  QPD:
    _3:
      _0:
        _1:
          _def:
            dt: ST
            desc: Status
            opt: R
            rep: 0
          _0: Status
        _2:
          _def:
            dt: ST
            desc: Active
            opt: R
            rep: true
          _0: Active

Chaves _def devem conter as seguintes propriedades:

Propriedade	Descrição
`dt`	Tipo de dados HL7v2. Consulte o padrão HL7 para valores válidos.
`desc`	Descrição do campo. Não transmitido.
`optar`	Opcionalidade. `R` para obrigatório, `O` para opcional.
`rep`	Repetição. Repetição. `0` ou `false` sem repetição.

Variáveis de Template Disponíveis

Ao substituir segmentos de HL7 ou calcular o ponto de extremidade para a solicitação, as seguintes variáveis de template estão disponíveis.

Variável	Devoluções
`{{document.source}}`	Módulo AGNES que adicionou o documento
`{{document.data}}`	Dados do documento
`{{document.timestamp}}`	Timestamp do documento com formatação
`{{document.key}}`	Chave única atribuída ao documento
`{{document.ext}}`	Extensão do document
`{{document.filename}}`	Nome de arquivo do documento
`{{document.isValid}}`	Boleano
`{{document.mime}}`	Tipo de arquivo MIME
`{{document.thumbnail}}`	Caminho do arquivo de miniatura usado
`{{document.editable}}`	Boleano
`{{patient.sex.value}}`	Sexo Paciente
`{{patient.patientId.value}}`	ID do paciente (não visível no portal)
`{{patient.middleInitial.value}}`	Paciente inicial do meio
`{{patient.extra.value}}`	Campo Extra do Paciente (não visível no portal) usado para passar valores arbitrários
`{{patient.birthDate.value}}`	Data de Nascimento do Paciente
`{{patient.patientExternalId.value}}`	ID externa do paciente (visível para o usuário)
`{{patient.firstName.value}}`	Nome do Paciente
`{{patient.lastName.value}}`	Sobrenome do paciente
`{{user.firstName}}`	Nome do remetente
`{{user.lastName}}`	Sobrenome do remetente
`{{user.username}}`	Nome de usuário do remetente
`{{user.org}}`	ID da organização do remetente
`{{user.sub}}`	ID de usuário do remetente
`{{user.npi}}`	ID EMR do contribuidor
`{{user.fullName}}`	Nome completo do remetente
`{{timestamp}}`	Carimbo de tempo de salvamento da operação na formatação HL7v2
`{{docTimestamp}}`	timestamp da criação do documento na formatação HL7v2

Configurações de Exemplo

Configuração básica

Copy to clipboard


          enabled: true

keepOpen: true
destination: file:///hl7/message-{{document.timestamp}}.hl7
fileDestination: file:///hl7/message-{{document.timestamp}}.hl7

allowExternalDocuments: true
allowVideoSnapshots: true
allowPDFReport: true

# This option will disable the HL7 wrapper for file destinations
#rawFileUpload: true

allowVitals: true
combinedVitalsField: 'OBX'

# If you require certain patient fields to be present, specify them here
#requiredPatientFields:
#        - 'patientId'

allowedExternalExtensions:
    - jpg
    - txt
    - pdf
    - tif

timestampFormat: YYYYMMDDHHmmss

hl7_vitals_msg:
    MSH:
    PID:
    OBR:
    OBX:

hl7_document_msg:
    MSH:
    PID:
    OBR:
    OBX:

Exemplo com variáveis

Copy to clipboard


          enabled: true

keepOpen: true
destination: file:///hl7/vitals-{{docTimestamp}}.hl7
fileDestination: file:///hl7/file-{{docTimestamp}}.hl7

allowExternalDocuments: true
allowVideoSnapshots: true
allowPDFReport: true

# This option will disable the HL7 wrapper for file destinations
#rawFileUpload: true

allowVitals: true
combinedVitalsField: 'OBX'

# If you require certain patient fields to be present, specify them here
#requiredPatientFields:
#        - 'patientId'

allowedExternalExtensions:
    - jpg
    - txt
    - pdf
    - tif

timestampFormat: YYYYMMDDHHmmss

hl7_vitals_msg:
    MSH:
        '_3': '3)Doc_Timestamp={{document.timestamp}}'
        '_4': '4)Timestamp={{timestamp}}'
        '_5': '5)Patient_Birthdate={{patient.birthDate.value}}'
    PID:
        '_1': '1)Patient_ID={{patient.patientId.value}}'
        '_8': '8)Patient_First_Name={{patient.firstName.value}}'
        '_9': '9)Patient_Middle_Initial={{patient.middleInitial.value}}'
        '_10': '10)Patient_Last_Name={{patient.lastName.value}}'
    OBR:
        '_2': '2)Document_Timestamp={{document.timestamp}}'
        '_3': '3)Document_Filename={{document.filename}}'
        '_4': '4)Patient_Sex={{patient.sex.value}}'
    OBX:
        '_1': '1)User_Full_Name={{user.fullname}}'
        '_4': '4)User_Username={{user.username}}'
        '_7': '7)User_First_Name={{user.firstname}}'
        '_8': '8)User_Last_Name={{user.lastname}}'
        '_10': '10)User_Org={{user.org}}'
        '_11': '11)User_Sub={{user.sub}}'
        '_13': '13)User_Meta={{user.meta}}'
        '_15': '15)User_NPI={{user.npi}}'

hl7_document_msg:
    MSH:
        '_3': '3)Doc_Timestamp={{document.timestamp}}'
        '_4': '4)Timestamp={{timestamp}}'
        '_5': '5)Patient_Birthdate={{patient.birthDate.value}}'
        '_6': '6)User_NPI={{user.npi}}'
    PID:
        '_1': '1)Patient_ID={{patient.patientId.value}}'
        '_8': '8)Patient_First_Name={{patient.firstName.value}}'
        '_9': '9)Patient_Middle_Initial={{patient.middleInitial.value}}'
        '_10': '10)Patient_Last_Name={{patient.lastName.value}}'
    OBR:
        '_2': '2)Document_Timestamp={{document.timestamp}}'
        '_3': '3)Document_Filename={{document.filename}}'
        '_4': '4)Patient_Sex={{patient.sex.value}}'
        '_14': '14)User_First_Name={{user.firstname}}'
        '_15': '15)User_Last_Name={{user.lastname}}'
        '_10': '10)User_Org={{user.org}}'
        '_11': '11)User_Sub={{user.sub}}'
        '_13': '13)User_Meta={{user.meta}}'
    OBX:
        '_1': '1)User_Full_Name={{user.fullname}}'
        '_4': '4)User_Username={{user.username}}'

Exemplo de consulta do paciente

Copy to clipboard


          enabled: true

keepOpen: true
destination: mllps://192.168.1.238:6007
fileDestination: mllps://192.168.1.238:6007
queryEndpoint: mllps://192.168.1.238:6007

allowExternalDocuments: true
allowVideoSnapshots: true
allowPDFReport: true

# This option will disable the HL7 wrapper for file destinations
#rawFileUpload: true

allowVitals: true
combinedVitalsField: 'OBX'

# If you require certain patient fields to be present, specify them here
#requiredPatientFields:
#        - 'patientId'

allowedExternalExtensions:
    - jpg
    - txt
    - pdf
    - tif

timestampFormat: YYYYMMDDHHmmss

queryPatientMessage:
    MSH:
        '_2': 'TeleHealth'
        '_5': 'ApplicationName'
        '_6': 'Facility'
    QPD:
        '_3':
            '_0':
                '_1':
                    '_def':
                        'dt': 'ST'
                        'desc': 'Family Name Segment'
                        'opt': 'R'
                        'rep': 0
                    '_0': 'PID-5-0'
                '_2':
                    '_def':
                        'dt': 'ST'
                        'desc': 'Family Name'
                        'opt': 'O'
                        'rep': 0
                    '_0': '{{patient.lastName}}*'
            '_1':
                '_1':
                    '_def':
                        'dt': 'ST'
                        'desc': 'Given Name Segment'
                        'opt': 'R'
                        'rep': 0
                    '_0': 'PID-5-1'
                '_2':
                    '_def':
                        'dt': 'ST'
                        'desc': 'Given Name'
                        'opt': 'O'
                        'rep': 0
                    '_0': '{{patient.firstName}}*'
            '_2':
                '_1':
                    '_def':
                        'dt': 'ST'
                        'desc': 'Segment'
                        'opt': 'R'
                        'rep': 0
                    '_0': 'PID-2-1'
                '_2':
                    '_def':
                        'dt': 'ST'
                        'desc': 'Patient ID'
                        'opt': 'O'
                        'rep': 0
                    '_0': '{{patient.patientExternalId}}*'

hl7_vitals_msg:
    MSH:
        'ReceivingApplication': 'ApplicationName'
        'ReceivingFacility': 'Facility'
    PID:
    OBR:
    OBX:

hl7_document_msg:
    MSH:
        'ReceivingApplication': 'ApplicationName'
        'ReceivingFacility': 'Facility'
    PID:
    OBR:
    OBX: