fhir-api

Implement FHIR RESTful API servers and clients per HL7 FHIR specifications.

133|23|Updated Mar 23, 2020
One-click install
npx skills add https://github.com/aehrc/pathling --skill fhir-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fhir-api
Source: https://github.com/aehrc/pathling/tree/main/.claude/skills/fhir-api
Command: npx skills add https://github.com/aehrc/pathling --skill fhir-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides expert guidance for implementing robust FHIR RESTful API servers and clients, ensuring compliance with HL7 FHIR specifications.

Core Features & Use Cases

  • API Design: Design FHIR API routes, handlers, and operations (read, create, update, delete, search, history).
  • Client Implementation: Build FHIR clients that interact with REST endpoints.
  • Advanced Features: Handle content negotiation, headers, versioning, and conditional operations.
  • Use Case: You are building a new healthcare analytics platform and need to expose FHIR R4 data via a REST API. This Skill will guide you through setting up the server, defining endpoints, and implementing search functionality according to the FHIR standard.

Quick Start

Use the fhir-api skill to understand how to implement the FHIR search operation for the Patient resource.

Frequently Asked Questions about fhir-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I implement a FHIR RESTful API server for healthcare data?

To implement a FHIR RESTful API server, you need to define API routes and handlers for core operations like read, create, update, delete, search, and history according to HL7 FHIR specifications. This ensures your healthcare data is exposed compliantly.

How does content negotiation work in a FHIR REST API?

Content negotiation in a FHIR REST API involves handling HTTP headers to manage data formats exchanged between clients and servers. Proper implementation ensures clients receive healthcare data payloads in their requested formats, maintaining strict HL7 FHIR compliance.

What is the best way to handle FHIR API versioning and error handling?

The best way to handle FHIR API versioning and error handling is by following HL7 FHIR specifications for resource version tracking and structured error responses. This guarantees robust API behavior during concurrent updates and invalid client requests.

Can I use this for building a FHIR client to interact with REST endpoints?

Yes, you can use this guidance to build FHIR clients that interact with REST endpoints. It covers client implementation details required to successfully query, retrieve, and submit healthcare data to any FHIR-compliant server.

How do I implement batch and transaction processing in a FHIR API?

Implementing batch and transaction processing in a FHIR API requires grouping multiple operations into a single HTTP request. Following HL7 FHIR specifications ensures these complex operations are processed atomically and return appropriate response bundles.

Does this FHIR API guidance cover conditional operations and search functionality?

Yes, this FHIR API guidance covers conditional operations and search functionality. It provides comprehensive instructions for implementing FHIR search operations and conditional updates or creates, ensuring compliant healthcare data retrieval.