---
title: "Process HL7 Message"
method: POST
path: "/v1/hl7"
tags: ["HL7"]
---

# Process HL7 Message

`POST /v1/hl7`

## Request

- Base URL: `https://api.bluehive.com`
- URL: `https://api.bluehive.com/v1/hl7`
- Auth: none declared
- TypeScript: <https://skmtc.dev/bluehive-health/apis/bluehive-api/docs/v1/hl7/post.ts> (a function with typed inputs; its response is checked against the schema)

Process incoming HL7 messages from EHR systems. Accepts JSON with "message" field, raw text/plain HL7 content, or form-encoded data.

## Request body

- object: HL7 message data. For JSON: use "message" field. For text/plain: send raw HL7. For form-encoded: include message field.
  - `message` union: HL7 message content - the primary way to send HL7 data
    - string
    - object
  - `f` string: Form field (legacy support)
  - `interface` string: Interface identifier (legacy support)
  - `login_user` string: Login user (legacy support)
  - `login_passwd` string: Login password (legacy support)
  - `message_b64` string: Base64 encoded HL7 message (legacy support)

## Response `200`

HL7 ACK message

- string: HL7 ACK message

## Other responses

- `400`: Default Response
- `500`: Default Response

## Changes

- **2026-10-16** `a8bcbdf02e33`: 1 info
  - removed the non-success response with the status `503`
- **2026-07-21** `e6e553c2594a`: 1 info
  - added the non-success response with the status `503`
- **2025-10-13** `c5da7f3b01ee`: 3 info
  - request property `message` list-of-types was widened by adding types `object` to media type `application/json`
  - request property `message` list-of-types was widened by adding types `object` to media type `application/x-www-form-urlencoded`
  - request property `message` list-of-types was widened by adding types `object` to media type `text/plain`
- **2025-10-06** `8f04fdb630d8`: 1 info
  - the endpoint scheme security `ApiKeyAuth` was removed from the API
- **2025-10-05** `28d439490b5e`: 1 breaking, 1 info
  - api path removed without deprecation
  - endpoint added

[Operation history](https://skmtc.dev/bluehive-health/apis/bluehive-api/changes/v1/hl7/post.md)

---

[API](https://skmtc.dev/bluehive-health/apis/bluehive-api.md) - [All operations](https://skmtc.dev/bluehive-health/apis/bluehive-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluehive-health/apis/bluehive-api/revisions/a8bcbdf02e33?raw)