> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/connectors/tools/hl7-message-transformer.md).

# HL7 Message Transformer

O **HL7 Message Transformer** converte mensagens HL7 para e a partir do formato JSON, facilitando transformações de dados eficientes em integrações de sistemas de saúde.

## **Parâmetros**

A tabela abaixo lista todos os parâmetros de configuração do conector. Parâmetros que suportam [expressões Double Braces](/documentation/connectors-and-triggers/pt-br/double-braces/overview.md) estão marcados com ✅ na coluna **Suporta DB**.

{% tabs %}
{% tab title="General" %}

<table><thead><tr><th width="112">Parâmetro</th><th width="231">Descrição</th><th width="83">Tipo de dado</th><th width="81">Suporta DB</th><th width="100">Valor padrão</th><th width="128">Visível quando</th></tr></thead><tbody><tr><td><strong>Output Format</strong></td><td>O formato para o qual a mensagem ou objeto deve ser convertido. Opções: <strong>JSON</strong> e <strong>HL7</strong>.</td><td>String</td><td>❌</td><td><code>JSON</code></td><td>—</td></tr><tr><td><strong>Message</strong> <code>(DB)</code></td><td>A mensagem HL7 ou o objeto JSON que será convertido.</td><td>String</td><td>✅</td><td>N/A</td><td>—</td></tr><tr><td><strong>Fail On Error</strong></td><td>Se a opção for ativada, a execução do pipeline com erro será interrompida. Caso contrário, a execução do pipeline continua, mas o resultado mostrará um valor falso para a propriedade <code>"success"</code>.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td>—</td></tr><tr><td><strong>Raw Pass Through</strong></td><td>Quando ativado, retorna a mensagem HL7 original sem alterações em <code>"data"</code>, ignorando completamente o ciclo de parse e encode: sem normalização de escape, sem remoção de campos/componentes vazios no final e sem regeneração do MSH-2. Use essa opção quando a mensagem precisa chegar ao destino byte a byte (por exemplo, quando o sistema de destino faz seu próprio parse). Deixe desativado para o comportamento padrão, que faz o parse e reconstrói a mensagem, um processo normalizador que não garante fidelidade byte a byte.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td><strong>Output Format</strong> é <strong>JSON</strong></td></tr></tbody></table>
{% endtab %}

{% tab title="Documentation" %}

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Parâmetro</th><th>Description</th><th>Tipo de dado</th><th>Suporta DB</th><th>Valor padrão</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Campo opcional para descrever a configuração do conector e quaisquer regras de negócio relevantes.</td><td>String</td><td>❌</td><td>N/A</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

## **Informações adicionais**

### **Versões suportadas**

As versões de mensagem HL7 suportadas são:

* 2.1
* 2.2
* 2.3
* 2.3.1
* 2.4
* 2.5
* 2.5.1
* 2.6
* 2.7
* 2.8
* 2.8.1

### **Alterações de formato em conversões HL7-JSON**

Ao converter uma mensagem HL7 para JSON e depois de volta para HL7, a mensagem final pode diferir da original.

Por exemplo, um segmento que termina em `|ABC||||` será exibido como `|ABC`. Da mesma forma, campos com valores como `|^^|` ou `|ABCˆˆ` serão representados como `||` e `|ABC`, respectivamente.

Isso ocorre porque esses caracteres funcionam como separadores de campo (`|`) ou caracteres de codificação (`^^`), e não como valores reais. Esse comportamento segue os padrões HL7 e não afeta a integridade da mensagem. A estrutura JSON utilizada na conversão também está em conformidade com os padrões HL7.

## **Exemplos de uso**

<details>

<summary><strong>HL7 para JSON</strong></summary>

**Configuração do conector:**

* **Output Format:** JSON
* **Data:**

{% code overflow="wrap" %}

```
MSH|^~\&#|NIST EHR|NIST EHR Facility|NIST Test Lab APP|NIST Lab Facility|20130211184101-0500||OML^O21^OML_O21|NIST-LOI_5.0_1.1-NG|T|2.5.1|||AL|AL|||||
PID|1||PATID5421^^^NIST MPI^MR||Wilson^Patrice^Natasha^^^^L||19820304|F||2106-3^White^HL70005|144 East 12th Street^^Los Angeles^CA^90012^^H||^PRN^PH^^^203^2290210|||||||||N^Not Hispanic or Latino^HL70189
NK1|1|Wilson^Phillip^Arthur^^^^L|SPO^Spouse^HL70063|144 East 12th Street^^Los Angeles^CA^90012^^H|||||||||
ORC|NW|ORD448811^NIST EHR|||||||20120628070100|||5742200012^Radon^Nicholas^^^^^^NPI^L^^^NPI
OBR|1|ORD448811^NIST EHR||1000^Hepatitis A  B  C Panel^99USL|||20120628070100|||||||||5742200012^Radon^Nicholas^^^^^^NPI^L^^^NPI
DG1|1||F11.129^Opioid abuse with intoxication,unspecified^I10C|||W|||||||||1
```

{% endcode %}

**Saída do conector:**

```json
{
  "OML_O21": {
    "MSH": {
      "MSH.1": "|",
      "MSH.2": "^~\\&#",
      "MSH.3": {
        "HD.1": "NIST EHR"
      },
      "MSH.4": {
        "HD.1": "NIST EHR Facility"
      },
      "MSH.5": {
        "HD.1": "NIST Test Lab APP"
      },
      "MSH.6": {
        "HD.1": "NIST Lab Facility"
      },
      "MSH.7": {
        "TS.1": "20130211184101-0500"
      },
      "MSH.9": {
        "MSG.1": "OML",
        "MSG.2": "O21",
        "MSG.3": "OML_O21"
      },
      "MSH.10": "NIST-LOI_5.0_1.1-NG",
      "MSH.11": {
        "PT.1": "T"
      },
      "MSH.12": {
        "VID.1": "2.5.1"
      },
      "MSH.15": "AL",
      "MSH.16": "AL"
    },
    "OML_O21.PATIENT": {
      "PID": {
        "PID.1": "1",
        "PID.3": {
          "CX.1": "PATID5421",
          "CX.4": {
            "HD.1": "NIST MPI"
          },
          "CX.5": "MR"
        },
        "PID.5": {
          "XPN.1": {
            "FN.1": "Wilson"
          },
          "XPN.2": "Patrice",
          "XPN.3": "Natasha",
          "XPN.7": "L"
        },
        "PID.7": {
          "TS.1": "19820304"
        },
        "PID.8": "F",
        "PID.10": {
          "CE.1": "2106-3",
          "CE.2": "White",
          "CE.3": "HL70005"
        },
        "PID.11": {
          "XAD.1": {
            "SAD.1": "144 East 12th Street"
          },
          "XAD.3": "Los Angeles",
          "XAD.4": "CA",
          "XAD.5": "90012",
          "XAD.7": "H"
        },
        "PID.13": {
          "XTN.2": "PRN",
          "XTN.3": "PH",
          "XTN.6": "203",
          "XTN.7": "2290210"
        },
        "PID.22": {
          "CE.1": "N",
          "CE.2": "Not Hispanic or Latino",
          "CE.3": "HL70189"
        }
      },
      "NK1": {
        "NK1.1": "1",
        "NK1.2": {
          "XPN.1": {
            "FN.1": "Wilson"
          },
          "XPN.2": "Phillip",
          "XPN.3": "Arthur",
          "XPN.7": "L"
        },
        "NK1.3": {
          "CE.1": "SPO",
          "CE.2": "Spouse",
          "CE.3": "HL70063"
        },
        "NK1.4": {
          "XAD.1": {
            "SAD.1": "144 East 12th Street"
          },
          "XAD.3": "Los Angeles",
          "XAD.4": "CA",
          "XAD.5": "90012",
          "XAD.7": "H"
        }
      }
    },
    "OML_O21.ORDER": {
      "ORC": {
        "ORC.1": "NW",
        "ORC.2": {
          "EI.1": "ORD448811",
          "EI.2": "NIST EHR"
        },
        "ORC.9": {
          "TS.1": "20120628070100"
        },
        "ORC.12": {
          "XCN.1": "5742200012",
          "XCN.2": {
            "FN.1": "Radon"
          },
          "XCN.3": "Nicholas",
          "XCN.9": {
            "HD.1": "NPI"
          },
          "XCN.10": "L",
          "XCN.13": "NPI"
        }
      },
      "OML_O21.OBSERVATION_REQUEST": {
        "OBR": {
          "OBR.1": "1",
          "OBR.2": {
            "EI.1": "ORD448811",
            "EI.2": "NIST EHR"
          },
          "OBR.4": {
            "CE.1": "1000",
            "CE.2": "Hepatitis A  B  C Panel",
            "CE.3": "99USL"
          },
          "OBR.7": {
            "TS.1": "20120628070100"
          },
          "OBR.16": {
            "XCN.1": "5742200012",
            "XCN.2": {
              "FN.1": "Radon"
            },
            "XCN.3": "Nicholas",
            "XCN.9": {
              "HD.1": "NPI"
            },
            "XCN.10": "L",
            "XCN.13": "NPI"
          }
        },
        "DG1": {
          "DG1.1": "1",
          "DG1.3": {
            "CE.1": "F11.129",
            "CE.2": "Opioid abuse with intoxication,unspecified",
            "CE.3": "I10C"
          },
          "DG1.6": "W",
          "DG1.15": "1"
        }
      }
    }
  }
}
```

</details>

<details>

<summary><strong>JSON para HL7</strong></summary>

**Configuração do conector:**

* **Output Format:** HL7
* **Data:**

```json
{
  "ORU_R01": {
    "MSH": {
      "MSH.1": "|",
      "MSH.2": "^~\\&",
      "MSH.3": {
        "HD.1": "NIST Test Lab APP"
      },
      "MSH.4": {
        "HD.1": "NIST Lab Facility"
      },
      "MSH.6": {
        "HD.1": "NIST EHR Facility"
      },
      "MSH.7": {
        "TS.1": "20150926140551"
      },
      "MSH.9": {
        "MSG.1": "ORU",
        "MSG.2": "R01",
        "MSG.3": "ORU_R01"
      },
      "MSH.10": "NIST-LOI_5.0_1.1-NG",
      "MSH.11": {
        "PT.1": "T"
      },
      "MSH.12": {
        "VID.1": "2.5.1"
      },
      "MSH.15": "AL",
      "MSH.16": "AL"
    },
    "ORU_R01.PATIENT_RESULT": {
      "ORU_R01.PATIENT": {
        "PID": {
          "PID.1": "1",
          "PID.3": {
            "CX.1": "PATID5421",
            "CX.4": {
              "HD.1": "NIST MPI"
            },
            "CX.5": "MR"
          },
          "PID.5": {
            "XPN.1": {
              "FN.1": "Wilson"
            },
            "XPN.2": "Patrice",
            "XPN.3": "Natasha",
            "XPN.7": "L"
          },
          "PID.7": {
            "TS.1": "19820304"
          },
          "PID.8": "F",
          "PID.10": {
            "CE.1": "2106-3",
            "CE.2": "White",
            "CE.3": "HL70005"
          },
          "PID.11": {
            "XAD.1": {
              "SAD.1": "144 East 12th Street"
            },
            "XAD.3": "Los Angeles",
            "XAD.4": "CA",
            "XAD.5": "90012",
            "XAD.7": "H"
          },
          "PID.13": {
            "XTN.2": "PRN",
            "XTN.3": "PH",
            "XTN.6": "203",
            "XTN.7": "2290210"
          },
          "PID.22": {
            "CE.1": "N",
            "CE.2": "Not Hispanic or Latino",
            "CE.3": "HL70189"
          }
        }
      },
      "ORU_R01.ORDER_OBSERVATION": {
        "ORC": {
          "ORC.1": "NW",
          "ORC.2": {
            "EI.1": "ORD448811",
            "EI.2": "NIST EHR"
          },
          "ORC.3": {
            "EI.1": "R-511",
            "EI.2": "NIST Lab Filler"
          },
          "ORC.9": {
            "TS.1": "20120628070100"
          },
          "ORC.12": {
            "XCN.1": "5742200012",
            "XCN.2": {
              "FN.1": "Radon"
            },
            "XCN.3": "Nicholas",
            "XCN.9": {
              "HD.1": "NPI"
            },
            "XCN.10": "L",
            "XCN.13": "NPI"
          }
        },
        "OBR": {
          "OBR.1": "1",
          "OBR.2": {
            "EI.1": "ORD448811",
            "EI.2": "NIST EHR"
          },
          "OBR.3": {
            "EI.1": "R-511",
            "EI.2": "NIST Lab Filler"
          },
          "OBR.4": {
            "CE.1": "1000",
            "CE.2": "Hepatitis A B C Panel",
            "CE.3": "99USL"
          },
          "OBR.7": {
            "TS.1": "20120628070100"
          },
          "OBR.16": {
            "XCN.1": "5742200012",
            "XCN.2": {
              "FN.1": "Radon"
            },
            "XCN.3": "Nicholas",
            "XCN.9": {
              "HD.1": "NPI"
            },
            "XCN.10": "L",
            "XCN.13": "NPI"
          }
        },
        "ORU_R01.OBSERVATION": [
          {
            "OBX": {
              "OBX.1": "1",
              "OBX.2": "CWE",
              "OBX.3": {
                "CE.1": "22314-9",
                "CE.2": "Hepatitis A virus IgM Ab [Presence] in Serum",
                "CE.3": "LN",
                "CE.4": "HAVM",
                "CE.5": "Hepatitis A IgM antibodies (IgM anti-HAV)",
                "CE.6": "L"
              },
              "OBX.5": {
                "CWE.1": "260385009",
                "CWE.2": "Negative (qualifier value)",
                "CWE.3": "SCT",
                "CWE.4": "NEG",
                "CWE.5": "NEGATIVE",
                "CWE.6": "L",
                "CWE.7": "201509USEd",
                "CWE.9": "Negative (qualifier value)"
              },
              "OBX.7": "Negative",
              "OBX.8": "N",
              "OBX.11": "F",
              "OBX.14": {
                "TS.1": "20150925"
              },
              "OBX.19": {
                "TS.1": "201509261400"
              }
            }
          },
          {
            "OBX": {
              "OBX.1": "2",
              "OBX.2": "CWE",
              "OBX.3": {
                "CE.1": "20575-7",
                "CE.2": "Hepatitis A virus Ab [Presence] in Serum",
                "CE.3": "LN",
                "CE.4": "HAVAB",
                "CE.5": "Hepatitis A antibodies (anti-HAV)",
                "CE.6": "L"
              },
              "OBX.5": {
                "CWE.1": "260385009",
                "CWE.2": "Negative (qualifier value)",
                "CWE.3": "SCT",
                "CWE.4": "NEG",
                "CWE.5": "NEGATIVE",
                "CWE.6": "L",
                "CWE.7": "201509USEd",
                "CWE.9": "Negative (qualifier value)"
              },
              "OBX.7": "Negative",
              "OBX.8": "N",
              "OBX.11": "F",
              "OBX.14": {
                "TS.1": "20150925"
              },
              "OBX.19": {
                "TS.1": "201509261400"
              }
            }
          },
          {
            "OBX": {
              "OBX.1": "3",
              "OBX.2": "NM",
              "OBX.3": {
                "CE.1": "22316-4",
                "CE.2": "Hepatitis B virus core Ab [Units/volume] in Serum",
                "CE.3": "LN",
                "CE.4": "HBcAbQ",
                "CE.5": "Hepatitis B core antibodies (anti-HBVc) Quant",
                "CE.6": "L"
              },
              "OBX.5": "0.70",
              "OBX.6": {
                "CE.1": "[IU]/mL",
                "CE.2": "international unit per milliliter",
                "CE.3": "UCUM",
                "CE.4": "IU/ml",
                "CE.6": "L"
              },
              "OBX.7": "<0.50 IU/mL",
              "OBX.8": "H",
              "OBX.11": "F",
              "OBX.14": {
                "TS.1": "20150925"
              },
              "OBX.19": {
                "TS.1": "201509261400"
              }
            }
          }
        ]
      }
    }
  }
}
```

**Saída do conector:**

{% code overflow="wrap" %}

```
{
  "data": "MSH|^~\\&|NIST Test Lab APP|NIST Lab Facility||NIST EHR Facility|20150926140551||ORU^R01^ORU_R01|NIST-LOI_5.0_1.1-NG|T|2.5.1|||AL|AL\rPID|1||PATID5421^^^NIST MPI^MR||Wilson^Patrice^Natasha^^^^L||19820304|F||2106-3^White^HL70005|144 East 12th Street^^Los Angeles^CA^90012^^H||^PRN^PH^^^203^2290210|||||||||N^Not Hispanic or Latino^HL70189\rORC|NW|ORD448811^NIST EHR|R-511^NIST Lab Filler||||||20120628070100|||5742200012^Radon^Nicholas^^^^^^NPI^L^^^NPI\rOBR|1|ORD448811^NIST EHR|R-511^NIST Lab Filler|1000^Hepatitis A B C Panel^99USL|||20120628070100|||||||||5742200012^Radon^Nicholas^^^^^^NPI^L^^^NPI\rOBX|1|CWE|22314-9^Hepatitis A virus IgM Ab [Presence] in Serum^LN^HAVM^Hepatitis A IgM antibodies (IgM anti-HAV)^L||260385009^Negative (qualifier value)^SCT^NEG^NEGATIVE^L^201509USEd^^Negative (qualifier value)||Negative|N|||F|||20150925|||||201509261400\rOBX|2|CWE|20575-7^Hepatitis A virus Ab [Presence] in Serum^LN^HAVAB^Hepatitis A antibodies (anti-HAV)^L||260385009^Negative (qualifier value)^SCT^NEG^NEGATIVE^L^201509USEd^^Negative (qualifier value)||Negative|N|||F|||20150925|||||201509261400\rOBX|3|NM|22316-4^Hepatitis B virus core Ab [Units/volume] in Serum^LN^HBcAbQ^Hepatitis B core antibodies (anti-HBVc) Quant^L||0.70|[IU]/mL^international unit per milliliter^UCUM^IU/ml^^L|<0.50 IU/mL|H|||F|||20150925|||||201509261400\r"
}
```

{% endcode %}

</details>

## Exemplos de mensagem HL7

<details>

<summary><strong>ADT_A01</strong></summary>

**Mensagem HL7:**

{% code overflow="wrap" %}

```
MSH|^~\&|ADT1|GOOD HEALTH HOSPITAL|GHH LAB, INC.|GOOD HEALTH HOSPITAL|198808181126|SECURITY|ADT^A01^ADT_A01|MSG00001|P|2.8||
EVN|A01|200708181123||
PID|1||PATID1234^5^M11^ADT1^MR^GOOD HEALTH HOSPITAL~123456789^^^USSSA^SS||EVERYMAN^ADAM^A^III||19610615|M||C|2222 HOME STREET^^GREENSBORO^NC^27401-1020|GL|(555) 555-2004|(555)555-2004||S||PATID12345001^2^M10^ADT1^AN^A|444333333|987654^NC|
NK1|1|NUCLEAR^NELDA^W|SPO^SPOUSE||||NK^NEXT OF KIN
PV1|1|I|2000^2012^01||||004777^ATTEND^AARON^A|||SUR||||ADM|A0|
```

{% endcode %}

**Representação em JSON:**

```json
{
  "ADT_A01": {
    "MSH": {
      "MSH.1": "|",
      "MSH.2": "^~\\&",
      "MSH.3": {
        "HD.1": "ADT1"
      },
      "MSH.4": {
        "HD.1": "GOOD HEALTH HOSPITAL"
      },
      "MSH.5": {
        "HD.1": "GHH LAB, INC."
      },
      "MSH.6": {
        "HD.1": "GOOD HEALTH HOSPITAL"
      },
      "MSH.7": "198808181126",
      "MSH.8": "SECURITY",
      "MSH.9": {
        "MSG.1": "ADT",
        "MSG.2": "A01",
        "MSG.3": "ADT_A01"
      },
      "MSH.10": "MSG00001",
      "MSH.11": {
        "PT.1": "P"
      },
      "MSH.12": {
        "VID.1": "2.8"
      }
    },
    "EVN": {
      "EVN.1": "A01",
      "EVN.2": "200708181123"
    },
    "PID": {
      "PID.1": "1",
      "PID.3": [
        {
          "CX.1": "PATID1234",
          "CX.2": "5",
          "CX.3": "M11",
          "CX.4": {
            "HD.1": "ADT1"
          },
          "CX.5": "MR",
          "CX.6": {
            "HD.1": "GOOD HEALTH HOSPITAL"
          }
        },
        {
          "CX.1": "123456789",
          "CX.4": {
            "HD.1": "USSSA"
          },
          "CX.5": "SS"
        }
      ],
      "PID.5": {
        "XPN.1": {
          "FN.1": "EVERYMAN"
        },
        "XPN.2": "ADAM",
        "XPN.3": "A",
        "XPN.4": "III"
      },
      "PID.7": "19610615",
      "PID.8": {
        "CWE.1": "M"
      },
      "PID.10": {
        "CWE.1": "C"
      },
      "PID.11": {
        "XAD.1": {
          "SAD.1": "2222 HOME STREET"
        },
        "XAD.3": "GREENSBORO",
        "XAD.4": "NC",
        "XAD.5": "27401-1020"
      },
      "PID.12": "GL",
      "PID.13": {
        "XTN.1": "(555) 555-2004"
      },
      "PID.14": {
        "XTN.1": "(555)555-2004"
      },
      "PID.16": {
        "CWE.1": "S"
      },
      "PID.18": {
        "CX.1": "PATID12345001",
        "CX.2": "2",
        "CX.3": "M10",
        "CX.4": {
          "HD.1": "ADT1"
        },
        "CX.5": "AN",
        "CX.6": {
          "HD.1": "A"
        }
      },
      "PID.19": "444333333",
      "PID.20": "987654"
    },
    "NK1": {
      "NK1.1": "1",
      "NK1.2": {
        "XPN.1": {
          "FN.1": "NUCLEAR"
        },
        "XPN.2": "NELDA",
        "XPN.3": "W"
      },
      "NK1.3": {
        "CWE.1": "SPO",
        "CWE.2": "SPOUSE"
      },
      "NK1.7": {
        "CWE.1": "NK",
        "CWE.2": "NEXT OF KIN"
      }
    },
    "PV1": {
      "PV1.1": "1",
      "PV1.2": {
        "CWE.1": "I"
      },
      "PV1.3": {
        "PL.1": {
          "HD.1": "2000"
        },
        "PL.2": {
          "HD.1": "2012"
        },
        "PL.3": {
          "HD.1": "01"
        }
      },
      "PV1.7": {
        "XCN.1": "004777",
        "XCN.2": {
          "FN.1": "ATTEND"
        },
        "XCN.3": "AARON",
        "XCN.4": "A"
      },
      "PV1.10": {
        "CWE.1": "SUR"
      },
      "PV1.14": {
        "CWE.1": "ADM"
      },
      "PV1.15": {
        "CWE.1": "A0"
      }
    }
  }
}
```

</details>

<details>

<summary><strong>RDE_O01</strong></summary>

**Mensagem HL7:**

{% code overflow="wrap" %}

```
MSH|^~\&|EPIC|NMHPL|ES|ES|20210708113648|JHILAO|RDE^O01|5619|D|2.3
PID|||111011393329^^^MR^MR||IDSTEST^ONE||19850718|M||W|711 E 63RD ST^^CHICAGO^IL^60651^USA^^^COOK|COOK|(773)785-9879^P^PH||ENGLISH|S||200014156735||||H
PV1||I|616E^1611^01^NMHH^R^^NMHH^^^^NMHCDEP||||35671^TEST MD2^TESTMD2^^||||||||||92438^DOCTOR^TEST^FIVE^~35671^TEST MD2^TESTMD2^^||200014156735|||||||||||||||||||||||||20180718105700
ORC|DC|1164023444^EPC|||||^DAILY^^20210709090000^20210708113647^^^||20210708113550|JHILAO^HILAO^JAMES^J^|231871^HILAO^JAMES^^|90189^TEST ONE^KEITH^BELL^|||||||||NORTHWESTERN MEMORIAL HOSPITAL IP|251 E HURON ST^^CHICAGO^IL^60611-2908^|(312)926-2000|P1 TESTING ONLY^^^^^|||||I
RXE|^DAILY^^20210709090000^20210708113647^^^|STD006663^STUDY: NBI-98854-HD3006 VALBENAZINE 80 MG CAPSULE^ADS^^^^^^Study: NBI-98854-HD3006 Valbenazine 80 mg capsule 80 mg|80||3^mg||Study ID: 123456. Take 1capsule(s) (80mg) at the same time each morning. Swallow the capsule with about 4 ounces of water or other liquid, with or without food.~*FOR INVESTIGATIONAL USE ONLY*|||1|Each^each||^TEST ONE^KEITH^BELL^|||||||||||||||||STANDARD||||||||||^NMH GALTER 17 INVESTIGATIONAL PHARMACY||||UD w/ bc
RXR|Oral^Oral
RXC||STD006663^STUDY: NBI-98854-HD3006 VALBENAZINE 80 MG CAPSULE^ADS|80|mg^mg|80|mg^mg
```

{% endcode %}

**Representação em JSON:**

```json
{
  "RDE_O01": {
    "MSH": {
      "MSH.1": "|",
      "MSH.2": "^~\\&",
      "MSH.3": {
        "HD.1": "EPIC"
      },
      "MSH.4": {
        "HD.1": "NMHPL"
      },
      "MSH.5": {
        "HD.1": "ES"
      },
      "MSH.6": {
        "HD.1": "ES"
      },
      "MSH.7": {
        "TS.1": "20210708113648"
      },
      "MSH.8": "JHILAO",
      "MSH.9": {
        "CM_MSG.1": "RDE",
        "CM_MSG.2": "O01"
      },
      "MSH.10": "5619",
      "MSH.11": {
        "PT.1": "D"
      },
      "MSH.12": "2.3"
    },
    "RDE_O01.PATIENT": {
      "PID": {
        "PID.3": {
          "CX.1": "111011393329",
          "CX.4": {
            "HD.1": "MR"
          },
          "CX.5": "MR"
        },
        "PID.5": {
          "XPN.1": "IDSTEST",
          "XPN.2": "ONE"
        },
        "PID.7": {
          "TS.1": "19850718"
        },
        "PID.8": "M",
        "PID.10": "W",
        "PID.11": {
          "XAD.1": "711 E 63RD ST",
          "XAD.3": "CHICAGO",
          "XAD.4": "IL",
          "XAD.5": "60651",
          "XAD.6": "USA",
          "XAD.9": "COOK"
        },
        "PID.12": "COOK",
        "PID.13": {
          "XTN.1": "(773)785-9879",
          "XTN.2": "P",
          "XTN.3": "PH"
        },
        "PID.15": {
          "CE.1": "ENGLISH"
        },
        "PID.16": "S",
        "PID.18": {
          "CX.1": "200014156735"
        },
        "PID.22": "H"
      },
      "RDE_O01.PATIENT_VISIT": {
        "PV1": {
          "PV1.2": "I",
          "PV1.3": {
            "PL.1": "616E",
            "PL.2": "1611",
            "PL.3": "01",
            "PL.4": {
              "HD.1": "NMHH"
            },
            "PL.5": "R",
            "PL.7": "NMHH"
          },
          "PV1.7": {
            "XCN.1": "35671",
            "XCN.2": "TEST MD2",
            "XCN.3": "TESTMD2"
          },
          "PV1.17": [
            {
              "XCN.1": "92438",
              "XCN.2": "DOCTOR",
              "XCN.3": "TEST",
              "XCN.4": "FIVE"
            },
            {
              "XCN.1": "35671",
              "XCN.2": "TEST MD2",
              "XCN.3": "TESTMD2"
            }
          ],
          "PV1.19": {
            "CX.1": "200014156735"
          },
          "PV1.44": {
            "TS.1": "20180718105700"
          }
        }
      }
    },
    "RDE_O01.ORDER": {
      "ORC": {
        "ORC.1": "DC",
        "ORC.2": {
          "EI.1": "1164023444",
          "EI.2": "EPC"
        },
        "ORC.7": {
          "TQ.2": {
            "CM_RI.1": "DAILY"
          },
          "TQ.4": {
            "TS.1": "20210709090000"
          },
          "TQ.5": {
            "TS.1": "20210708113647"
          }
        },
        "ORC.9": {
          "TS.1": "20210708113550"
        },
        "ORC.10": {
          "XCN.1": "JHILAO",
          "XCN.2": "HILAO",
          "XCN.3": "JAMES",
          "XCN.4": "J"
        },
        "ORC.11": {
          "XCN.1": "231871",
          "XCN.2": "HILAO",
          "XCN.3": "JAMES"
        },
        "ORC.12": {
          "XCN.1": "90189",
          "XCN.2": "TEST ONE",
          "XCN.3": "KEITH",
          "XCN.4": "BELL"
        },
        "ORC.21": "NORTHWESTERN MEMORIAL HOSPITAL IP",
        "ORC.22": {
          "UNKNOWN.1": "251 E HURON ST",
          "UNKNOWN.3": "CHICAGO",
          "UNKNOWN.4": "IL",
          "UNKNOWN.5": "60611-2908"
        },
        "ORC.23": "(312)926-2000",
        "ORC.24": "P1 TESTING ONLY",
        "ORC.29": "I"
      },
      "RXE": {
        "RXE.1": {
          "TQ.2": {
            "CM_RI.1": "DAILY"
          },
          "TQ.4": {
            "TS.1": "20210709090000"
          },
          "TQ.5": {
            "TS.1": "20210708113647"
          }
        },
        "RXE.2": {
          "CE.1": "STD006663",
          "CE.2": "STUDY: NBI-98854-HD3006 VALBENAZINE 80 MG CAPSULE",
          "CE.3": "ADS"
        },
        "RXE.3": "80",
        "RXE.5": {
          "CE.1": "3",
          "CE.2": "mg"
        },
        "RXE.7": [
          {
            "CE.1": "Study ID: 123456. Take 1capsule(s) (80mg) at the same time each morning. Swallow the capsule with about 4 ounces of water or other liquid, with or without food."
          },
          {
            "CE.1": "*FOR INVESTIGATIONAL USE ONLY*"
          }
        ],
        "RXE.10": "1",
        "RXE.11": {
          "CE.1": "Each",
          "CE.2": "each"
        },
        "RXE.13": {
          "CN.2": "TEST ONE",
          "CN.3": "KEITH",
          "CN.4": "BELL"
        },
        "RXE.30": "STANDARD",
        "RXE.40": {
          "UNKNOWN.2": "NMH GALTER 17 INVESTIGATIONAL PHARMACY"
        },
        "RXE.44": "UD w/ bc"
      },
      "RXR": {
        "RXR.1": {
          "CE.1": "Oral",
          "CE.2": "Oral"
        }
      },
      "RXC": {
        "RXC.2": {
          "CE.1": "STD006663",
          "CE.2": "STUDY: NBI-98854-HD3006 VALBENAZINE 80 MG CAPSULE",
          "CE.3": "ADS"
        },
        "RXC.3": "80",
        "RXC.4": {
          "CE.1": "mg",
          "CE.2": "mg"
        },
        "RXC.5": "80",
        "RXC.6": {
          "CE.1": "mg",
          "CE.2": "mg"
        }
      }
    }
  }
}
```

</details>

<details>

<summary><strong>VXU_V04</strong></summary>

**Mensagem HL7:**

{% code overflow="wrap" %}

```
MSH|^~\&|WIR11.3.2^^^|WIR^^^||WIRPH^^^|20200514||VXU^V04|2020051409183900|P^|2.3.1^^|||ER
PID|||3019189^^^^^||NEW^BORNGIRL^^^^^^||20180711|F||W^^^^^|800 ECLIPSE CENTER^^BELOIT^WI^53511^^^^WI105^^||(608)999-9999^PRN^PH^^^608^9999^^|||||||||NH^^^^^|||||||
PD1|||||||||||02^^^^^|Y||A
NK1|1|NEW^BORNGIRL^^^^^^|18^SELF^HL70063^^^|800 ECLIPSE CENTER^^BELOIT^WI^53511^^^^^^|(608)999-9999^PRN^PH^^^608^9999999^^
NK1|2|ZZZGIRL^MOTHER^^^^^^|G8^OTHER RELATIONSHIP^HL70063^^^|800 LEFT ST^^MILWAUKEE^WI^53212^^^^^^|(414)999-9999^PRN^PH^^^414^9999999^^
NK1|3|ZZZGIRL^MOTHER^^^^^^|32^MOTHER^HL70063^^^|800 LEFT ST^^MILWAUKEE^WI^53212^^^^^^|(414)999-9999^PRN^PH^^^414^9999999^^
RXA|0|999|20180711|20180711|08^HepB pediatric^CVX^90744^HepB pediatric^CPT|1.0|||00^^^^^~38133698^WIR immunization id^IMM_ID^^^|^Test  Doctor^^^^^^^^^^^^^|^^^WIR Physicians^^^^^^^^^^^||||GSKFlulaval||SKB^SKB^MVX^^^
RXR|IM^^^^^|LA^^^^^
RXA|0|999|20180710|20180711|20^DtaP^CVX^90700^DtaP^CPT|1.0|||01^^^^^~38150833^WIR immunization id^IMM_ID^^^||||||||
```

{% endcode %}

**Representação em JSON:**

```json
{
  "VXU_V04": {
    "MSH": {
      "MSH.1": "|",
      "MSH.2": "^~\\&",
      "MSH.3": {
        "HD.1": "WIR11.3.2"
      },
      "MSH.4": {
        "HD.1": "WIR"
      },
      "MSH.6": {
        "HD.1": "WIRPH"
      },
      "MSH.7": {
        "TS.1": "20200514"
      },
      "MSH.9": {
        "MSG.1": "VXU",
        "MSG.2": "V04"
      },
      "MSH.10": "2020051409183900",
      "MSH.11": {
        "PT.1": "P"
      },
      "MSH.12": {
        "VID.1": "2.3.1"
      },
      "MSH.15": "ER"
    },
    "PID": {
      "PID.3": {
        "CX.1": "3019189"
      },
      "PID.5": {
        "XPN.1": {
          "FN.1": "NEW"
        },
        "XPN.2": "BORNGIRL"
      },
      "PID.7": {
        "TS.1": "20180711"
      },
      "PID.8": "F",
      "PID.10": {
        "CE.1": "W"
      },
      "PID.11": {
        "XAD.1": "800 ECLIPSE CENTER",
        "XAD.3": "BELOIT",
        "XAD.4": "WI",
        "XAD.5": "53511",
        "XAD.9": "WI105"
      },
      "PID.13": {
        "XTN.1": "(608)999-9999",
        "XTN.2": "PRN",
        "XTN.3": "PH",
        "XTN.6": "608",
        "XTN.7": "9999"
      },
      "PID.22": {
        "CE.1": "NH"
      }
    },
    "PD1": {
      "PD1.11": {
        "CE.1": "02"
      },
      "PD1.12": "Y",
      "PD1.14": "A"
    },
    "NK1": [
      {
        "NK1.1": "1",
        "NK1.2": {
          "XPN.1": {
            "FN.1": "NEW"
          },
          "XPN.2": "BORNGIRL"
        },
        "NK1.3": {
          "CE.1": "18",
          "CE.2": "SELF",
          "CE.3": "HL70063"
        },
        "NK1.4": {
          "XAD.1": "800 ECLIPSE CENTER",
          "XAD.3": "BELOIT",
          "XAD.4": "WI",
          "XAD.5": "53511"
        },
        "NK1.5": {
          "XTN.1": "(608)999-9999",
          "XTN.2": "PRN",
          "XTN.3": "PH",
          "XTN.6": "608",
          "XTN.7": "9999999"
        }
      },
      {
        "NK1.1": "2",
        "NK1.2": {
          "XPN.1": {
            "FN.1": "ZZZGIRL"
          },
          "XPN.2": "MOTHER"
        },
        "NK1.3": {
          "CE.1": "G8",
          "CE.2": "OTHER RELATIONSHIP",
          "CE.3": "HL70063"
        },
        "NK1.4": {
          "XAD.1": "800 LEFT ST",
          "XAD.3": "MILWAUKEE",
          "XAD.4": "WI",
          "XAD.5": "53212"
        },
        "NK1.5": {
          "XTN.1": "(414)999-9999",
          "XTN.2": "PRN",
          "XTN.3": "PH",
          "XTN.6": "414",
          "XTN.7": "9999999"
        }
      },
      {
        "NK1.1": "3",
        "NK1.2": {
          "XPN.1": {
            "FN.1": "ZZZGIRL"
          },
          "XPN.2": "MOTHER"
        },
        "NK1.3": {
          "CE.1": "32",
          "CE.2": "MOTHER",
          "CE.3": "HL70063"
        },
        "NK1.4": {
          "XAD.1": "800 LEFT ST",
          "XAD.3": "MILWAUKEE",
          "XAD.4": "WI",
          "XAD.5": "53212"
        },
        "NK1.5": {
          "XTN.1": "(414)999-9999",
          "XTN.2": "PRN",
          "XTN.3": "PH",
          "XTN.6": "414",
          "XTN.7": "9999999"
        }
      }
    ],
    "VXU_V04.ORCRXARXROBXNTE": [
      {
        "RXA": {
          "RXA.1": "0",
          "RXA.2": "999",
          "RXA.3": {
            "TS.1": "20180711"
          },
          "RXA.4": {
            "TS.1": "20180711"
          },
          "RXA.5": {
            "CE.1": "08",
            "CE.2": "HepB pediatric",
            "CE.3": "CVX",
            "CE.4": "90744",
            "CE.5": "HepB pediatric",
            "CE.6": "CPT"
          },
          "RXA.6": "1.0",
          "RXA.9": [
            {
              "CE.1": "00"
            },
            {
              "CE.1": "38133698",
              "CE.2": "WIR immunization id",
              "CE.3": "IMM_ID"
            }
          ],
          "RXA.10": {
            "XCN.2": {
              "FN.1": "Test  Doctor"
            }
          },
          "RXA.11": {
            "LA2.4": {
              "HD.1": "WIR Physicians"
            }
          },
          "RXA.15": "GSKFlulaval",
          "RXA.17": {
            "CE.1": "SKB",
            "CE.2": "SKB",
            "CE.3": "MVX"
          }
        },
        "RXR": {
          "RXR.1": {
            "CE.1": "IM"
          },
          "RXR.2": {
            "CE.1": "LA"
          }
        }
      },
      {
        "RXA": {
          "RXA.1": "0",
          "RXA.2": "999",
          "RXA.3": {
            "TS.1": "20180710"
          },
          "RXA.4": {
            "TS.1": "20180711"
          },
          "RXA.5": {
            "CE.1": "20",
            "CE.2": "DtaP",
            "CE.3": "CVX",
            "CE.4": "90700",
            "CE.5": "DtaP",
            "CE.6": "CPT"
          },
          "RXA.6": "1.0",
          "RXA.9": [
            {
              "CE.1": "01"
            },
            {
              "CE.1": "38150833",
              "CE.2": "WIR immunization id",
              "CE.3": "IMM_ID"
            }
          ]
        }
      }
    ]
  }
}
```

</details>

<details>

<summary><strong>DFT_P03</strong></summary>

**Mensagem HL7:**

{% code overflow="wrap" %}

```
MSH|^~\&|Healthmatics|Healthmatics EHR|Ntierprise|Ntierprise Clinic|20190416084748||DFT^P03|1477-3|P|2.3|||NE|NE
EVN|P03|20190416084748||01
PID|1|A4EMR640|640|67359|Test^Patient1^D||19700101|F||3|1212 Dillard Drive^^Cary^NC^27511|||(222)222-2222^^^^^222^2222222||S
PV1|1|R|MainOffi||||Manning^Manning^Terry^^^^^^&7654321&UPIN|||||||||||||||||||||||||||||||||||||20190416110000||||||1203
FT1|1|E8866||20190416110000|20190416110000|CG||||1||||||^^^MainOffi|||J11.1^INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS^I10~487.1^INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS^I9~J03.90^INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS^I10~J40^BRONCHITIS, NOT SPECIFIED AS ACUTE OR CHRONIC^I10~490^BRONCHITIS, NOT SPECIFIED AS ACUTE OR CHRONIC^I9|TM^Manning^Terry^^^^^^&7654321&UPIN|Manning^Manning^Terry^^^^^^&7654321&UPIN||||99214^OFFICE OUTPATIENT VISIT 25 MINUTES
PR1|1||99214^OFFICE OUTPATIENT VISIT 25 MINUTES||20190416110000|D|||||||||J11.1^^I10
DG1|1|I|J11.1^INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS^I10|||F
DG1|2|I|487.1^INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS^I9|||F
DG1|3|I|J03.90^INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS^I10|||F
DG1|4|I|J40^BRONCHITIS, NOT SPECIFIED AS ACUTE OR CHRONIC^I10|||F
DG1|5|I|490^BRONCHITIS, NOT SPECIFIED AS ACUTE OR CHRONIC^I9|||F
```

{% endcode %}

**Representação em JSON:**

```json
{
  "DFT_P03": {
    "MSH": {
      "MSH.1": "|",
      "MSH.2": "^~\\&",
      "MSH.3": {
        "HD.1": "Healthmatics"
      },
      "MSH.4": {
        "HD.1": "Healthmatics EHR"
      },
      "MSH.5": {
        "HD.1": "Ntierprise"
      },
      "MSH.6": {
        "HD.1": "Ntierprise Clinic"
      },
      "MSH.7": {
        "TS.1": "20190416084748"
      },
      "MSH.9": {
        "CM_MSG.1": "DFT",
        "CM_MSG.2": "P03"
      },
      "MSH.10": "1477-3",
      "MSH.11": {
        "PT.1": "P"
      },
      "MSH.12": "2.3",
      "MSH.15": "NE",
      "MSH.16": "NE"
    },
    "EVN": {
      "EVN.1": "P03",
      "EVN.2": {
        "TS.1": "20190416084748"
      },
      "EVN.4": "01"
    },
    "PID": {
      "PID.1": "1",
      "PID.2": {
        "CX.1": "A4EMR640"
      },
      "PID.3": {
        "CX.1": "640"
      },
      "PID.4": {
        "CX.1": "67359"
      },
      "PID.5": {
        "XPN.1": "Test",
        "XPN.2": "Patient1",
        "XPN.3": "D"
      },
      "PID.7": {
        "TS.1": "19700101"
      },
      "PID.8": "F",
      "PID.10": "3",
      "PID.11": {
        "XAD.1": "1212 Dillard Drive",
        "XAD.3": "Cary",
        "XAD.4": "NC",
        "XAD.5": "27511"
      },
      "PID.14": {
        "XTN.1": "(222)222-2222",
        "XTN.6": "222",
        "XTN.7": "2222222"
      },
      "PID.16": "S"
    },
    "PV1": {
      "PV1.1": "1",
      "PV1.2": "R",
      "PV1.3": {
        "PL.1": "MainOffi"
      },
      "PV1.7": {
        "XCN.1": "Manning",
        "XCN.2": "Manning",
        "XCN.3": "Terry",
        "XCN.9": {
          "HD.2": "7654321",
          "HD.3": "UPIN"
        }
      },
      "PV1.44": {
        "TS.1": "20190416110000"
      },
      "PV1.50": {
        "CX.1": "1203"
      }
    },
    "DFT_P03.FINANCIAL": {
      "FT1": {
        "FT1.1": "1",
        "FT1.2": "E8866",
        "FT1.4": {
          "TS.1": "20190416110000"
        },
        "FT1.5": {
          "TS.1": "20190416110000"
        },
        "FT1.6": "CG",
        "FT1.10": "1",
        "FT1.16": {
          "PL.4": {
            "HD.1": "MainOffi"
          }
        },
        "FT1.19": [
          {
            "CE.1": "J11.1",
            "CE.2": "INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS",
            "CE.3": "I10"
          },
          {
            "CE.1": "487.1",
            "CE.2": "INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS",
            "CE.3": "I9"
          },
          {
            "CE.1": "J03.90",
            "CE.2": "INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS",
            "CE.3": "I10"
          },
          {
            "CE.1": "J40",
            "CE.2": "BRONCHITIS, NOT SPECIFIED AS ACUTE OR CHRONIC",
            "CE.3": "I10"
          },
          {
            "CE.1": "490",
            "CE.2": "BRONCHITIS, NOT SPECIFIED AS ACUTE OR CHRONIC",
            "CE.3": "I9"
          }
        ],
        "FT1.20": {
          "XCN.1": "TM",
          "XCN.2": "Manning",
          "XCN.3": "Terry",
          "XCN.9": {
            "HD.2": "7654321",
            "HD.3": "UPIN"
          }
        },
        "FT1.21": {
          "XCN.1": "Manning",
          "XCN.2": "Manning",
          "XCN.3": "Terry",
          "XCN.9": {
            "HD.2": "7654321",
            "HD.3": "UPIN"
          }
        },
        "FT1.25": {
          "CE.1": "99214",
          "CE.2": "OFFICE OUTPATIENT VISIT 25 MINUTES"
        }
      },
      "DFT_P03.FINANCIAL_PROCEDURE": {
        "PR1": {
          "PR1.1": "1",
          "PR1.3": {
            "CE.1": "99214",
            "CE.2": "OFFICE OUTPATIENT VISIT 25 MINUTES"
          },
          "PR1.5": {
            "TS.1": "20190416110000"
          },
          "PR1.6": "D",
          "PR1.15": {
            "CE.1": "J11.1",
            "CE.3": "I10"
          }
        }
      }
    },
    "DG1": [
      {
        "DG1.1": "1",
        "DG1.2": "I",
        "DG1.3": {
          "CE.1": "J11.1",
          "CE.2": "INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS",
          "CE.3": "I10"
        },
        "DG1.6": "F"
      },
      {
        "DG1.1": "2",
        "DG1.2": "I",
        "DG1.3": {
          "CE.1": "487.1",
          "CE.2": "INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS",
          "CE.3": "I9"
        },
        "DG1.6": "F"
      },
      {
        "DG1.1": "3",
        "DG1.2": "I",
        "DG1.3": {
          "CE.1": "J03.90",
          "CE.2": "INFLUENZA WITH OTHER RESPIRATORY MANIFESTATIONS",
          "CE.3": "I10"
        },
        "DG1.6": "F"
      },
      {
        "DG1.1": "4",
        "DG1.2": "I",
        "DG1.3": {
          "CE.1": "J40",
          "CE.2": "BRONCHITIS, NOT SPECIFIED AS ACUTE OR CHRONIC",
          "CE.3": "I10"
        },
        "DG1.6": "F"
      },
      {
        "DG1.1": "5",
        "DG1.2": "I",
        "DG1.3": {
          "CE.1": "490",
          "CE.2": "BRONCHITIS, NOT SPECIFIED AS ACUTE OR CHRONIC",
          "CE.3": "I9"
        },
        "DG1.6": "F"
      }
    ]
  }
}
```

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/connectors/tools/hl7-message-transformer.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
