Configurar um esquema para analisar mensagens HL7v2
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Esta página oferece uma visão geral de como e quando configurar um esquema em
um armazenamento HL7v2 para analisar mensagens HL7v2.
Esquema padrão
A API Cloud Healthcare usa um esquema padrão para analisar mensagens HL7v2 que estão em conformidade
com o padrão HL7v2. Se as mensagens HL7v2 estiverem em conformidade com o padrão e
não contiverem segmentos, campos ou outros dados personalizados que se desviem
do padrão, consulte Ativar a análise esquematizada para mensagens HL7v2.
É possível especificar opções para o analisador no objeto ParserConfig, independentemente de você estar usando o
esquema padrão ou um esquema personalizado. O ParserConfig contém um objeto
ParserVersion
que permite especificar uma versão para o analisador. Consulte a documentação de referência para saber mais detalhes sobre cada versão.
Recomendamos que, para todos os casos de uso, você especifique a versão
V3
do analisador. A versão V3 tem as seguintes vantagens:
Ele contém a funcionalidade existente na versão V2.
Quando usado com o analisador padrão, ele remove a codificação dos seguintes caracteres de controle
HL7v2 com codificação por escape padrão:
Separador de campo: |
Separador de componentes: ^
Separador de subcomponentes: &
Separador de repetição: ~
Caractere de escape: \
Caractere de truncamento: #
Quando usado com um analisador personalizado, o analisador V3 usa técnicas de correspondência
melhores em relação às outras versões do analisador.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-18 UTC."],[[["\u003cp\u003eThis page guides users on configuring schemas for HL7v2 stores to parse HL7v2 messages effectively.\u003c/p\u003e\n"],["\u003cp\u003eThe Cloud Healthcare API uses a default schema for parsing standard HL7v2 messages, with a specific guide available for this use case.\u003c/p\u003e\n"],["\u003cp\u003eCustom schemas are necessary for HL7v2 messages that do not adhere to the standard, and a separate guide is available for these.\u003c/p\u003e\n"],["\u003cp\u003eRegardless of the schema used, the \u003ccode\u003eParserConfig\u003c/code\u003e object allows specifying a \u003ccode\u003eParserVersion\u003c/code\u003e, with \u003ccode\u003eV3\u003c/code\u003e recommended for its enhanced functionality, including unescaping default HL7v2 control characters and improved matching with custom parsers.\u003c/p\u003e\n"]]],[],null,["# Configure a schema to parse HL7v2 messages\n\nThis page provides an overview on how and when to configure a schema on\nan HL7v2 store to parse HL7v2 messages.\n\nDefault schema\n--------------\n\nThe Cloud Healthcare API uses a default schema to parse HL7v2 messages that conform\nto the HL7v2 standard. If your HL7v2 messages conform to the standard, and\ndo not contain custom segments, fields, or any other data that deviates from\nthe standard, see [Enable schematized parsing for HL7v2 messages](/healthcare-api/docs/how-tos/hl7v2-default-parser).\n\nCustom schema\n-------------\n\nIf you have HL7v2 messages that don't conform to the HL7v2 standard, see\n[Use a custom schema to parse HL7v2 messages](/healthcare-api/docs/how-tos/hl7v2-custom-parser).\n\nSelect a parser version\n-----------------------\n\nYou can specify options for the parser in the [`ParserConfig`](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.hl7V2Stores#ParserConfig) object, regardless of whether you're using the\ndefault schema or a custom schema. The `ParserConfig` contains a\n[`ParserVersion`](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.hl7V2Stores#ParserVersion)\nobject that lets you specify a version for the parser. See the [reference documentation](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.hl7V2Stores#ParserVersion.ENUM_VALUES) for details on each version.\n\nWe recommend that, for all use cases, you specify the\n[`V3`](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.hl7V2Stores#ParserVersion.ENUM_VALUES.V3)\nversion of the parser. The `V3` version has the following advantages:\n\n- It contains the existing functionality in the `V2` version.\n- When used with the default parser, it unescapes the following default escaped\n HL7v2 control characters:\n\n - Field separator: `|`\n - Component separator: `^`\n - Sub-component separator: `&`\n - Repetition separator: `~`\n - Escape character: `\\`\n - Truncation character: `#`\n- When used with a custom parser, the `V3` parser uses improved matching\n techniques over the other parser versions."]]
