Particle Health · Capability

Particle Health API — Batches

Particle Health API — Batch query orchestration. Run CCDA, FHIR_R4, FLAT, or DELTAS query types over patient cohorts and track progress.

Particle Health API — Batches is a Naftiko capability published by Particle Health, one of 12 capabilities the APIs.io network indexes for this provider. It bundles 3 operations across the GET and POST methods rooted at /v1/batches.

The capability includes 2 read-only operations and 1 state-changing operation. Lead operation: List Batches. Can be deployed as a REST endpoint, MCP tool, or Agent Skill via Naftiko.

Tagged areas include Particle Health and Batches.

Run with Naftiko Particle HealthBatches

What You Can Do

GET
Listbatches — List Batches
/v1/batches
POST
Createbatch — Create Batch
/v1/batches/{batch_type}
GET
Getbatch — Get Batch
/v1/batches/{batch_id}

MCP Tools

list-batches

List Batches

read-only idempotent
create-batch

Create Batch (CCDA, FHIR_R4, FLAT, or DELTAS)

get-batch

Get Batch

read-only idempotent

Capability Spec

particle-health-batches.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: Particle Health API — Batches
  description: 'Particle Health API — Batch query orchestration. Run CCDA, FHIR_R4, FLAT, or DELTAS
    query types over patient cohorts and track progress.'
  tags:
  - Particle Health
  - Batches
  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: batches
    baseUri: https://api.particlehealth.com
    description: Particle Health Batches business capability.
    resources:
    - name: Batches
      path: /api/v1/batches
      operations:
      - name: listbatches
        method: GET
        description: List Batches
        outputRawFormat: json
        outputParameters: [{ name: result, type: object, value: $. }]
    - name: BatchByType
      path: /api/v1/batches/{batch_type}
      operations:
      - name: createbatch
        method: POST
        description: Create Batch
        outputRawFormat: json
        outputParameters: [{ name: result, type: object, value: $. }]
    - name: Batch
      path: /api/v1/batches/{batch_id}
      operations:
      - name: getbatch
        method: GET
        description: Get Batch
        outputRawFormat: json
        outputParameters: [{ name: result, type: object, value: $. }]
    authentication:
      type: bearer
      token: '{{env.PARTICLE_HEALTH_API_TOKEN}}'
  exposes:
  - type: rest
    namespace: batches-rest
    port: 8080
    description: REST adapter for Particle Health Batches.
    resources:
    - path: /v1/batches
      name: batches
      operations:
      - method: GET
        name: listbatches
        description: List Batches
        call: batches.listbatches
        outputParameters: [{ type: object, mapping: $. }]
    - path: /v1/batches/{batch_type}
      name: batch-by-type
      operations:
      - method: POST
        name: createbatch
        description: Create Batch
        call: batches.createbatch
        outputParameters: [{ type: object, mapping: $. }]
    - path: /v1/batches/{batch_id}
      name: batch
      operations:
      - method: GET
        name: getbatch
        description: Get Batch
        call: batches.getbatch
        outputParameters: [{ type: object, mapping: $. }]
  - type: mcp
    namespace: batches-mcp
    port: 9090
    transport: http
    description: MCP adapter for Particle Health Batches.
    tools:
    - name: list-batches
      description: List Batches
      hints: { readOnly: true, destructive: false, idempotent: true }
      call: batches.listbatches
      outputParameters: [{ type: object, mapping: $. }]
    - name: create-batch
      description: Create Batch (CCDA, FHIR_R4, FLAT, or DELTAS)
      hints: { readOnly: false, destructive: false, idempotent: false }
      call: batches.createbatch
      outputParameters: [{ type: object, mapping: $. }]
    - name: get-batch
      description: Get Batch
      hints: { readOnly: true, destructive: false, idempotent: true }
      call: batches.getbatch
      outputParameters: [{ type: object, mapping: $. }]