---
title: "List HL7 Systems"
method: GET
path: "/v1/hl7-systems"
tags: ["HL7 Systems"]
---

# List HL7 Systems

`GET /v1/hl7-systems`

List and search registered HL7 systems with pagination. Results sorted by most recently seen.

## Query parameters

- `page` integer
- `pageSize` integer
- `status` 'unmapped' | 'active' | 'disabled'
- `search` string

## Response `200`

Default Response

- object
  - `meta` object, required
    - `page` integer, required
    - `pageSize` integer, required
    - `total` integer, required
    - `returned` integer, required
  - `systems` object[], required
    - `_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
- `500` — Default Response

---

[API](https://skmtc.net/bluehive-health/apis/bluehive-api.md) · [All operations](https://skmtc.net/bluehive-health/apis/bluehive-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bluehive-health/bluehive-api/versions/e6e553c2594a/schema)