Referência para as configurações de mensagens X12 em contratos dos Aplicativos Lógicos do Azure

Aplica-se a: Aplicativos Lógicos do Azure (Consumo + Padrão)

Esta referência descreve as propriedades que você pode definir em um contrato X12 para especificar como lidar com as mensagens entre parceiros comerciais. Configure essas propriedades baseadas em seu contrato com o parceiro que troca mensagens com você.

Configurações de recebimento X12

Identificadores

Propriedade	Descrição
ISA1 (Qualificador de Autorização)	O valor do Qualificador de Autorização que você deseja usar. O valor padrão é 00 - Nenhuma informação de autorização presente. Observação: Se você selecionar outros valores, especifique um valor para a propriedade ISA2.
ISA2	O valor de Informação de Autorização a ser usado quando a propriedade ISA1 não for 00 - Nenhuma informação de autorização presente. Esse valor da propriedade deve ter no mínimo um caractere alfanumérico e no máximo 10.
ISA3 (Qualificador de Segurança)	O valor do Qualificador de Segurança que você deseja usar. O valor padrão é 00 - Nenhuma informação de segurança presente. Observação: Se você selecionar outros valores, especifique um valor para a propriedade ISA4.
ISA4	O valor de Informação de Segurança a ser usado quando a propriedade ISA3 não for 00 - Nenhuma informação de segurança presente. Esse valor da propriedade deve ter no mínimo um caractere alfanumérico e no máximo 10.

Confirmação

Propriedade	Descrição
TA1 esperado	Retorna uma confirmação técnica (TA1) ao emissor de intercâmbio.
FA esperado	Retorna uma confirmação funcional (FA) ao emissor de intercâmbio. Para a propriedade Versão de FA, com base na versão do esquema, selecione as confirmações 997 ou 999. Para habilitar a geração de loops AK2 em confirmações funcionais para conjuntos de transações aceitas, selecione Incluir Loop AK2/IK2.

Esquemas

Para esta seção, selecione um esquema da sua conta de integração para cada tipo de transação (ST01) e Aplicativo Remetente (GS02). O Pipeline de Recebimento EDI desmonta a mensagem recebida, combinando os valores e o esquema que você define nesta seção com os valores de ST01 e GS02 na mensagem recebida e com o esquema da mensagem recebida. Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Propriedade	Descrição
Versão	A versão X12 para o esquema
Tipo de Transação (ST01)	O tipo de transação
Aplicativo do Remetente (GS02)	O aplicativo do remetente
Esquema	O arquivo de esquema que você deseja usar

Envelopes

Propriedade

Descrição

Uso de ISA11

O separador a ser usado em um conjunto de transações: - Identificador padrão: usa um ponto (.) em notação decimal, em vez de uma notação decimal no documento de entrada do Pipeline de Recebimento EDI. - Separador de repetição: especifica o separador para as ocorrências repetidas de um elemento de dados simples ou uma estrutura de dados repetidos. Por exemplo, geralmente o circunflexo (^) é usado como o separador de repetição. Para esquemas HIPAA, só é possível usar circunflexo (^).

Números de Controle

Propriedade	Descrição
Não permitir duplicatas do número de controle de intercâmbio	Bloqueia o intercâmbio de duplicatas. Verifica o número de controle de intercâmbio (ISA13) para o número de controle de intercâmbio recebido. Se uma correspondência for detectada, o Pipeline de Recebimento EDI não processará o intercâmbio. Para especificar o número de dias para executar a verificação, insira um valor para a propriedade Verificação de ISA13 duplicados a cada (dias) .
Não permitir duplicatas do número de controle de grupo	Bloqueia intercâmbios que tenham números de controle de grupo em duplicata.
Não permitir duplicatas do número de controle do conjunto de transações	Bloqueia intercâmbios que tenham números de controle de conjunto de transações em duplicata.

Validações

A linha Padrão mostra as regras de validação usadas para um tipo de mensagem EDI. Se você deseja definir regras diferentes, selecione cada caixa em que deseja que a regra seja definida como true. Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Propriedade	Descrição
Tipo de mensagem	O tipo de mensagem EDI
Validação de EDI	Executa a validação de EDI nos tipos de dados conforme a definição das propriedades de EDI do esquema, restrições de comprimento, elementos de dados vazios e separadores à direita.
Validação Estendida	Se o tipo de dados não for EDI, a validação será realizada nos requisitos de elementos de dados e na permissão de repetições, enumerações e validação de tamanho de elementos de dados (mín. ou máx.).
Permitir Zeros à Esquerda/Direita	Mantém zeros à esquerda ou à direita adicionais e caracteres de espaço. Não remova esses caracteres.
Cortar Zeros à Esquerda/Direita	Remove zeros à esquerda ou à direita e caracteres de espaço.
Política de Separador à Direita	Gera separadores à direita. - Não permitido: proíbe delimitadores e separadores à direita no intercâmbio de entrada. Se o intercâmbio tiver delimitadores e separadores à direita, o intercâmbio é declarado não válido. - Opcional: aceita intercâmbios com ou sem delimitadores e separadores à direita. - Obrigatório: o intercâmbio de entrada deve ter delimitadores e separadores à direita.

Configurações Internas

Propriedade	Descrição
Converter o formato decimal implícito Nn para o valor numérico de base 10	Converte um número de EDI especificado no formato "Nn" em um valor numérico de base 10.
Criar marcas XML vazias se forem permitidos separadores à direita	Faz com que o remetente do intercâmbio inclua marcas XML vazias para separadores à direita.
Dividir intercâmbio como conjuntos de transação – suspender conjuntos de transação com erro	Analisa cada conjunto de transações em um intercâmbio dentro de um documento XML separado ao aplicar o envelope apropriado ao conjunto de transações. Suspende somente as transações em que a validação falha.
Dividir intercâmbio como conjuntos de transação – suspender intercâmbio com erro	Analisa cada conjunto de transações em um intercâmbio dentro de um documento XML separado ao aplicar o envelope apropriado. Suspende o intercâmbio inteiro se um ou mais conjuntos de transações no intercâmbio falharem na validação.
Preservar intercâmbio – suspender conjuntos de transações com erro	Mantém o intercâmbio intacto e cria um documento XML para o intercâmbio em lote inteiro. Suspende somente os conjuntos de transações com falha na validação, mas continua a processar todos os outros conjuntos de transações.
Preservar intercâmbio – suspender intercâmbio com erro	Mantém o intercâmbio intacto, cria um documento XML para o intercâmbio em lote inteiro. Suspende o intercâmbio inteiro se um ou mais conjuntos de transações no intercâmbio falharem na validação.

Configurações do Envio X12

Identificadores

Propriedade	Descrição
ISA1 (Qualificador de Autorização)	O valor do Qualificador de Autorização que você deseja usar. O valor padrão é 00 - Nenhuma informação de autorização presente. Observação: Se você selecionar outros valores, especifique um valor para a propriedade ISA2.
ISA2	O valor de Informação de Autorização a ser usado quando a propriedade ISA1 não for 00 - Nenhuma informação de autorização presente. Esse valor da propriedade deve ter no mínimo um caractere alfanumérico e no máximo 10.
ISA3 (Qualificador de Segurança)	O valor do Qualificador de Segurança que você deseja usar. O valor padrão é 00 - Nenhuma informação de segurança presente. Observação: Se você selecionar outros valores, especifique um valor para a propriedade ISA4.
ISA4	O valor de Informação de Segurança a ser usado quando a propriedade ISA3 não for 00 - Nenhuma informação de segurança presente. Esse valor da propriedade deve ter no mínimo um caractere alfanumérico e no máximo 10.

Confirmação

Propriedade	Descrição
TA1 esperado	Retorna uma confirmação técnica (TA1) ao emissor de intercâmbio. Essa configuração especifica que o parceiro host que está enviando a mensagem solicitou uma confirmação do parceiro convidado no contrato. Essas confirmações são esperadas pelo parceiro host com base nas Configurações de Recebimento do contrato.
FA esperado	Retorna uma confirmação funcional (FA) ao emissor de intercâmbio. Para a propriedade Versão de FA, com base na versão do esquema, selecione as confirmações 997 ou 999. Essa configuração especifica que o parceiro host que está enviando a mensagem solicitou uma confirmação do parceiro convidado no contrato. Essas confirmações são esperadas pelo parceiro host com base nas Configurações de Recebimento do contrato.

Esquemas

Para esta seção, selecione um esquema da sua conta de integração para cada tipo de transação (ST01). Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Propriedade	Descrição
Versão	A versão X12 para o esquema
Tipo de Transação (ST01)	O tipo de transação para o esquema
Esquema	O arquivo de esquema que você deseja usar. Se você selecionar o esquema primeiro, a versão e o tipo de transação serão definidos automaticamente.

Envelopes

Propriedade

Descrição

Uso de ISA11

O separador a ser usado em um conjunto de transações: - Identificador padrão: usa um ponto (.) em notação decimal, em vez de uma notação decimal no documento de saída do Pipeline de Envio EDI. - Separador de repetição: especifica o separador para as ocorrências repetidas de um elemento de dados simples ou uma estrutura de dados repetidos. Por exemplo, geralmente o circunflexo (^) é usado como o separador de repetição. Para esquemas HIPAA, só é possível usar circunflexo (^).

Número da Versão de Controle

Para esta seção, selecione um esquema da sua conta de integração para cada intercâmbio. Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Propriedade	Descrição
Número de Versão de Controle (ISA12)	A versão do padrão X12
Indicador de Uso (ISA15)	O contexto de um intercâmbio, que consiste em dados de Teste, dados de Informações ou dados de Produção
Esquema	O esquema a ser usado para gerar os segmentos GS e ST para um intercâmbio de codificação X12 que ele envia para o Pipeline de Envio EDI.
GS1	Opcional, seleciona o código funcional.
GS2	Opcional, especifica o remetente do aplicativo.
GS3	Opcional, especifica o receptor do aplicativo.
GS4	Opcional, selecionar CCYYMMDD ou YYMMDD.
GS5	Opcional, selecionar HHMM, HHMMSS ou HHMMSSdd.
GS7	Opcional, selecionar um valor para a agência responsável.
GS8	Opcional, especifica a versão do documento de esquema.

Números de Controle

Propriedade	Descrição
Número de Controle de Intercâmbio (ISA13)	O intervalo de valores para o número de controle de intercâmbio, que pode ter um valor mínimo de 1 e um valor máximo de 999999999
Número de Controle de Grupo (GS06)	O intervalo de valores para o número de controle de grupo, que pode ter um valor mínimo de 1 e um valor máximo de 999999999
Número de Controle de Conjunto de Transações (ST02)	O intervalo de valores para o número de controle do conjunto de transações, que pode ter um valor mínimo de 1 e um valor máximo de 999999999 - Prefixo: opcional, um valor alfanumérico - Sufixo: Opcional, um valor alfanumérico

Conjuntos de Caracteres e Separadores

A linha Padrão mostra o conjunto de caracteres usado como delimitadores para um esquema de mensagens. Se não quiser usar o conjunto de caracteres Padrão, você pode inserir um conjunto diferente de delimitadores para cada tipo de mensagem. Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Dica

Para fornecer valores de caractere especial, edite o contrato como JSON e forneça o valor ASCII para o caractere especial.

Propriedade	Descrição
Conjunto de Caracteres a ser usado	O conjunto de caracteres X12, que é Básico, Estendido ou UTF8.
Esquema	O esquema que você deseja usar. Depois de selecionar o esquema, selecione o conjunto de caracteres que deseja usar, com base nas descrições do separador abaixo.
Tipo de Entrada	O tipo de entrada para o conjunto de caracteres.
Separador de Componente	Um único caractere que separa elementos de dados compostos.
Separador de Elemento de Dados	Um único caractere que separa elementos de dados simples nos dados compostos.
Separador de Caracteres de Substituição	Um caractere de substituição que substitui todos os caracteres separadores dos dados de conteúdo ao gerar a mensagem X12 de saída.
Terminador de Segmento	Um único caractere que indica o final de um segmento EDI.
Suffix	O caractere a ser usado com o identificador de segmento. Se especificar um sufixo, o elemento de dados de terminador de segmento poderá ser esvaziado. Se o terminador de segmento for deixado vazio, será necessário designar um sufixo.

Validação

A linha Padrão mostra as regras de validação usadas para um tipo de mensagem EDI. Se você deseja definir regras diferentes, selecione cada caixa em que deseja que a regra seja definida como true. Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Propriedade	Descrição
Tipo de mensagem	O tipo de mensagem EDI
Validação de EDI	Executa a validação de EDI nos tipos de dados conforme a definição das propriedades de EDI do esquema, restrições de comprimento, elementos de dados vazios e separadores à direita.
Validação Estendida	Se o tipo de dados não for EDI, a validação será realizada nos requisitos de elementos de dados e na permissão de repetições, enumerações e validação de tamanho de elementos de dados (mín. ou máx.).
Permitir Zeros à Esquerda/Direita	Mantém zeros à esquerda ou à direita adicionais e caracteres de espaço. Não remova esses caracteres.
Cortar Zeros à Esquerda/Direita	Remove zeros à esquerda ou à direita e caracteres de espaço.
Política de Separador à Direita	Gera separadores à direita. - Não permitido: proíbe delimitadores e separadores à direita no intercâmbio de saída. Se o intercâmbio tiver delimitadores e separadores à direita, o intercâmbio é declarado não válido. - Opcional: envia intercâmbios com ou sem delimitadores e separadores à direita. - Obrigatório: o intercâmbio de saída deve ter delimitadores e separadores à direita.

Tipos de mensagens e esquemas HIPAA

Ao trabalhar com esquemas HIPAA e os tipos de mensagem 277 ou 837, é necessário executar algumas etapas adicionais. Os números de versão do documento (GS8) para esses tipos de mensagens têm mais de nove caracteres, por exemplo, "005010X222A1". Além disso, alguns números de versão do documento são mapeados para tipos de mensagens variantes. Se você não fizer referência ao tipo de mensagem correto no seu esquema e no seu contrato, receberá esta mensagem de erro:

"The message has an unknown document type and did not resolve to any of the existing schemas configured in the agreement."

Esta tabela lista os tipos de mensagens afetados, quaisquer variantes e os números de versão do documento que são mapeados para esses tipos de mensagens:

Tipo ou variante de mensagem	Descrição	Número da versão do documento (GS8)
277	Notificação de status de informações de assistência médica	005010X212
837_I	Declaração de assistência médica institucional	004010X096A1 005010X223A1 005010X223A2
837_D	Declaração de assistência médica dental	004010X097A1 005010X224A1 005010X224A2
837_P	Declaração de assistência médica profissional	004010X098A1 005010X222 005010X222A1

Também é preciso desativar a validação EDI ao usar esses números de versão do documento, pois eles resultam em um erro que indica que o comprimento do caractere é inválido.

Para especificar esses números de versão de documento e tipos de mensagens, siga estas etapas:

Observação

Cada mensagem com 837_P, 837_I ou tipo de 837_D requer um contrato separado.

1. No esquema HIPAA, substitua o tipo de mensagem atual pelo tipo de mensagem variante do número da versão do documento que você deseja usar.

   Por exemplo, suponha que você queira usar o número de versão do documento 005010X222A1 com o tipo de mensagem 837. No seu esquema, substitua cada valor "X12_00501_837" pelo valor "X12_00501_837_P".

   Para atualizar o esquema, siga estas etapas:

   1. No portal do Azure, vá para sua conta de integração. Localize e faça download do seu esquema. Substitua o tipo de mensagem e renomeie o arquivo de esquema e faça upload do esquema revisado para sua conta de integração. Para obter mais informações, confira Editar um esquema.

   2. Nas configurações de mensagem do contrato, selecione o esquema revisado.

2. No objeto schemaReferences do seu contrato, adicione outra entrada que especifique o tipo de mensagem variante que corresponde ao número da versão do documento.

   Por exemplo, suponha que você queira usar o número de versão do documento 005010X222A1 com o tipo de mensagem 837. Seu contrato tem uma seção schemaReferences com essas propriedades e valores:

   "schemaReferences": [
      {
         "messageId": "837",
         "schemaVersion": "00501",
         "schemaName": "X12_00501_837"
      }
   ]
   

   Edite sua seção schemaReferences para se parecer com o seguinte exemplo:

   "schemaReferences": [
      {
         "messageId": "837",
         "schemaVersion": "00501",
         "schemaName": "X12_00501_837_P"
      }
   ]
   

3. Nas configurações de mensagem do seu contrato, desative a validação EDI desmarcando a caixa de seleção Validação EDI para cada tipo de mensagem ou para todos os tipos de mensagem, se você estiver usando os valores Padrão.

   

Próximas etapas

Trocar mensagens X12