FHIR++ Resource Catalog
FHIR++
Introduction
Fast Healthcare Interoperability Resources (FHIR, pronounced "Fire") defines a set of "Resources" that represent granular clinical concepts. The resources can be managed in isolation, or aggregated into complex documents. FHIR is designed for the web - the resources are based on simple XML or JSON structures, with an http-based RESTful protocol where each resource has a predictable URL. Where possible, open internet standards are used for data representation. xcaliber Patient360 provides read, write, and eventing APIs to a variety of data sources used to access patient-centric data. The API is not just FHIR-conformant, but goes beyond with FHIR++ extensions for minimizing data loss from sources that have additional data.
FHIR++ Capabilities
FHIR++ provides a set of common capabilities that can be applied to any FHIR resource or bundle of resources:
- Create: Create and persist new FHIR resources by sending POST requests.
- Read: Retrieve existing resources by ID or search parameters using GET requests.
- Update: Update existing resources by sending PUT requests with modified data.
- Delete: Delete resources by sending DELETE requests by ID.
- Search/Filter: Find resources based on search criteria using query parameters. Filter results.
- Eventing: Subscribe to real-time events when resources are created, updated, or deleted.
These core CRUDSE (Create, Read, Update, Search/Filter, Eventing) capabilities are available for all resources like Patient, Observation, Encounter and more.
For example, you can:
- Create a new Patient
- Read a Patient by ID
- Update the Patient's demographics
- Search for Patients by name
- Get notified if the Patient is deleted
FHIR++ Compatibility
FHIR++ is designed to be compatible with and build upon mainstream FHIR standards. This ensures integration with other systems and leverage of FHIR tooling.
Specifically, FHIR++ supports the following FHIR versions:
- FHIR Release 4 (R4) - FHIR++ is fully compliant with FHIR R4 and passes official FHIR R4 validation testing. All FHIR++ resources can be used as standard FHIR R4 resources.
Capability Matrix
| Resources | Create | Read | Update | Delete | Search |
|---|---|---|---|---|---|
| AllergyIntolerance | ✅ | ✅ | ✅ | ✅ | ✅ |
| Appointment | ✅ | ✅ | ✅ | ✅ | ✅ |
| Basic | ❌ | ❌ | ❌ | ❌ | ✅ |
| CarePlan | ❌ | ✅ | ❌ | ❌ | ✅ |
| CareTeam | ✅ | ❌ | ❌ | ✅ | ✅ |
| Claim | ✅ | ✅ | ✅ | ✅ | ✅ |
| Communication | ❌ | ✅ | ❌ | ❌ | ✅ |
| Condition | ✅ | ✅ | ✅ | ✅ | ✅ |
| Coverage | ✅ | ✅ | ✅ | ✅ | ✅ |
| CoverageEligibilityRequest | ✅ | ❌ | ❌ | ❌ | ❌ |
| CoverageEligibilityResponse | ❌ | ❌ | ❌ | ❌ | ✅ |
| DiagnosticReport | ✅ | ✅ | ✅ | ✅ | ✅ |
| DocumentReference | ✅ | ✅ | ✅ | ✅ | ✅ |
| Encounter | ✅ | ✅ | ✅ | ✅ | ✅ |
| ExplanationOfBenefit | ✅ | ❌ | ✅ | ❌ | ✅ |
| FamilyMemberHistory | ✅ | ✅ | ✅ | ✅ | ✅ |
| Goal | ❌ | ❌ | ❌ | ❌ | ✅ |
| ImagingStudy | ❌ | ❌ | ❌ | ❌ | ✅ |
| Immunization | ✅ | ✅ | ✅ | ✅ | ✅ |
| InsurancePlan | ❌ | ❌ | ❌ | ❌ | ✅ |
| Invoice | ✅ | ✅ | ✅ | ✅ | ✅ |
| Location | ✅ | ✅ | ✅ | ✅ | ✅ |
| Measure | ❌ | ❌ | ❌ | ❌ | ✅ |
| Media | ✅ | ✅ | ✅ | ✅ | ✅ |
| MedicationRequest | ✅ | ✅ | ✅ | ✅ | ✅ |
| MedicationStatement | ✅ | ✅ | ✅ | ✅ | ✅ |
| Observation | ✅ | ✅ | ✅ | ✅ | ✅ |
| Organization | ✅ | ✅ | ✅ | ✅ | ✅ |
| Patient | ✅ | ✅ | ✅ | ✅ | ✅ |
| PaymentNotice | ✅ | ❌ | ❌ | ❌ | ✅ |
| Person | ✅ | ✅ | ✅ | ✅ | ✅ |
| Practitioner | ✅ | ✅ | ✅ | ✅ | ✅ |
| PractitionerRole | ❌ | ❌ | ❌ | ❌ | ✅ |
| Procedure | ✅ | ✅ | ✅ | ✅ | ✅ |
| Questionnaire | ✅ | ❌ | ✅ | ❌ | ✅ |
| QuestionnaireResponse | ✅ | ✅ | ✅ | ✅ | ✅ |
| ServiceRequest | ✅ | ✅ | ✅ | ✅ | ✅ |
| Slot | ✅ | ❌ | ❌ | ❌ | ❌ |
| Task | ❌ | ❌ | ❌ | ❌ | ✅ |
| ❌ | ❌ | ❌ | ❌ | ❌ |
Postman
Get started with our public postman collection and examples.