Particle Health · Capability

Particle Health API — HL7v2

Particle Health API — HL7v2 ADT message retrieval. Returns admission, discharge, and transfer messages tied to a patient.

Particle Health API — HL7v2 is a Naftiko capability published by Particle Health, one of 12 capabilities the APIs.io network indexes for this provider. It bundles 2 operations across the GET method rooted at /v1/hl7v2.

The capability includes 2 read-only operations. Lead operation: Get HL7v2 Message. Can be deployed as a REST endpoint, MCP tool, or Agent Skill via Naftiko.

Tagged areas include Particle Health, HL7v2, and ADT.

Run with Naftiko Particle HealthHL7v2ADT

What You Can Do

GET
Gethl7v2message — Get HL7v2 Message
/v1/hl7v2/message/{id}
GET
Gethl7v2messages — Get HL7v2 Messages by Patient
/v1/hl7v2/patient/{particle_patient_id}

MCP Tools

get-hl7v2-message

Get HL7v2 Message

read-only idempotent
get-hl7v2-messages-by-patient

Get HL7v2 Messages by Patient

read-only idempotent

Capability Spec

particle-health-hl7v2.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: Particle Health API — HL7v2
  description: 'Particle Health API — HL7v2 ADT message retrieval. Returns admission, discharge, and
    transfer messages tied to a patient.'
  tags:
  - Particle Health
  - HL7v2
  - ADT
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
- namespace: env
  keys:
    PARTICLE_HEALTH_API_TOKEN: PARTICLE_HEALTH_API_TOKEN
capability:
  consumes:
  - type: http
    namespace: hl7v2
    baseUri: https://api.particlehealth.com
    description: Particle Health HL7v2 business capability.
    resources:
    - name: Hl7v2Message
      path: /hl7v2/message/{id}
      operations:
      - name: gethl7v2message
        method: GET
        description: Get HL7v2 Message
        outputRawFormat: json
        outputParameters: [{ name: result, type: object, value: $. }]
    - name: Hl7v2PatientMessages
      path: /hl7v2/patient/{particle_patient_id}
      operations:
      - name: gethl7v2messages
        method: GET
        description: Get HL7v2 Messages by Patient
        outputRawFormat: json
        outputParameters: [{ name: result, type: object, value: $. }]
    authentication:
      type: bearer
      token: '{{env.PARTICLE_HEALTH_API_TOKEN}}'
  exposes:
  - type: rest
    namespace: hl7v2-rest
    port: 8080
    description: REST adapter for Particle Health HL7v2.
    resources:
    - path: /v1/hl7v2/message/{id}
      name: hl7v2-message
      operations:
      - method: GET
        name: gethl7v2message
        description: Get HL7v2 Message
        call: hl7v2.gethl7v2message
        outputParameters: [{ type: object, mapping: $. }]
    - path: /v1/hl7v2/patient/{particle_patient_id}
      name: hl7v2-patient
      operations:
      - method: GET
        name: gethl7v2messages
        description: Get HL7v2 Messages by Patient
        call: hl7v2.gethl7v2messages
        outputParameters: [{ type: object, mapping: $. }]
  - type: mcp
    namespace: hl7v2-mcp
    port: 9090
    transport: http
    description: MCP adapter for Particle Health HL7v2.
    tools:
    - name: get-hl7v2-message
      description: Get HL7v2 Message
      hints: { readOnly: true, destructive: false, idempotent: true }
      call: hl7v2.gethl7v2message
      outputParameters: [{ type: object, mapping: $. }]
    - name: get-hl7v2-messages-by-patient
      description: Get HL7v2 Messages by Patient
      hints: { readOnly: true, destructive: false, idempotent: true }
      call: hl7v2.gethl7v2messages
      outputParameters: [{ type: object, mapping: $. }]