---
title: "Create HL7 System"
method: POST
path: "/v1/hl7-systems"
tags: ["HL7 Systems"]
---

# Create HL7 System

`POST /v1/hl7-systems`

## Request

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

Manually create a new HL7 system registration.

## Request body

- object
  - `name` string, required
  - `sendingApplication` string, required
  - `sendingFacility` string
  - `receivingApplication` string
  - `receivingFacility` string
  - `status` 'unmapped' | 'active' | 'disabled'
  - `notes` unknown
  - `interfaces` object[]
    - `name` string, required
    - `messageTypes` string[], required
    - `url` string, required
    - `method` 'POST' | 'PUT'
    - `headers` object
    - `username` string
    - `password` string
    - `interfaceName` string
    - `enabled` boolean

## Response `201`

Default Response

- object
  - `_id` string, required
  - `sendingApplication` string, required
  - `sendingFacility` string, required
  - `receivingApplication` string, required
  - `receivingFacility` string, required
  - `systemKey` string, required
  - `name` string, required
  - `status` 'unmapped' | 'active' | 'disabled', required
  - `interfaces` object[]
    - `id` string, required
    - `name` string, required
    - `messageTypes` string[], required
    - `url` string, required
    - `method` 'POST' | 'PUT'
    - `headers` object
    - `username` string
    - `password` string
    - `interfaceName` string
    - `enabled` boolean, required
  - `brandId` string
  - `autoRegistered` boolean
  - `firstSeenAt` string, date-time
  - `lastSeenAt` string, date-time
  - `messageCount` integer
  - `lastMessageType` string
  - `notes` string
  - `createdAt` string, date-time
  - `updatedAt` string, date-time

## Other responses

- `401`: Default Response
- `403`: Default Response
- `409`: Default Response
- `500`: Default Response

## Changes

- **2026-02-18** `efcb45ec0e67`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bluehive-health/apis/bluehive-api/changes/v1/hl7-systems/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)