Clinical Data APIs Overview

FHIRfly provides instant access to healthcare reference data through simple REST APIs.

Available APIs

Common Patterns

All Clinical Data APIs follow consistent patterns:

Single Lookup

GET /v1/{api}/{code}

Batch Lookup

POST /v1/{api}/_batch
Content-Type: application/json
{"codes": ["code1", "code2", "code3"]}

Response Shapes

GET /v1/{api}/{code}?shape=compact|standard|full

See Response Shapes for details on each format.

Authentication

All Clinical Data API requests require authentication via API key or OAuth token.

import { Fhirfly } from "@fhirfly-io/terminology";

// API Key
const client = new Fhirfly({ apiKey: "YOUR_API_KEY" });

// Or OAuth2
const client = new Fhirfly({
  clientId: "ffly_client_...",
  clientSecret: "ffly_secret_...",
});

const result = await client.ndc.lookup("0069-0151-01");

Response Format

All responses follow a consistent structure:

{
  "data": { /* resource data */ },
  "meta": {
    "source": { /* provenance (full shape only) */ },
    "legal": { /* licensing info */ }
  }
}

Error Responses

{
  "error": "not_found",
  "error_description": "NDC code not found: 0000-0000-00"
}