FALCON FHIR R4 Server API

Comprehensive FHIR-compliant RESTful API for Healthcare Resource Management

FHIR Version

4.0.1 (R4)

Server Software

FALCON FHIR Server 8.2.0

Supported Profiles

US Core, Bulk Data, SMART App Launch

907
Provenance Records
453
Observations
423
Binary Resources
74
Diagnostic Reports
71
Encounters
71
Conditions
47
Medication Dispenses
45
Patients
API Documentation
FHIR API Documentation
EHR Certification Guide
CCDA API Documentation

🏥 EHR Certification Testing Guide

📋 Certification Overview

FALCON FHIR R4 Server (v8.2.0) compliant with:

  • 🏅 FHIR R4 (4.0.1) - HL7 FHIR Release 4
  • 🇺🇸 US Core Implementation Guide v6.1.0
  • 🔒 SMART App Launch Framework
  • 📊 Bulk Data Access (FHIR Bulk Data Export)

🔗 Base URL & Endpoints

Base FHIR URL: https://fhir.imperiumsoft.biz:8443/fhir
Capability Statement: https://fhir.imperiumsoft.biz:8443/fhir/metadata
Well-Known Configuration: https://fhir.imperiumsoft.biz:8443/fhir/.well-known/smart_configuration

🧪 Certification Test Categories

🔍 § 170.315(g)(10) - Standardized API

Patient Access API Requirements:

  • ✅ Patient demographics (US Core Patient)
  • ✅ Problems list (US Core Condition)
  • ✅ Medication list (US Core MedicationRequest)
  • ✅ Medication allergy list (US Core AllergyIntolerance)
  • ✅ Laboratory test results (US Core Observation)
  • ✅ Vital signs (US Core Vital Signs)
  • ✅ Smoking status (US Core Smoking Status)
  • ✅ Clinical notes (US Core DocumentReference)

🔐 § 170.315(d)(13) - SMART on FHIR

Authorization & Authentication:

  • ✅ OAuth 2.0 Authorization Code Flow
  • ✅ SMART App Launch Framework
  • ✅ Standalone app launch
  • ✅ EHR launch sequence
  • ✅ Patient-level scopes
  • ✅ Provider-level scopes
  • ✅ JWT-based access tokens
  • ✅ Refresh token support

📦 § 170.315(b)(10) - Data Export

Bulk Data API (FHIR $export):

  • ✅ System-level export ($export)
  • ✅ Patient-level export (Patient/$export)
  • ✅ Group-level export (Group/{id}/$export)
  • ✅ NDJSON format support
  • ✅ Asynchronous processing
  • ✅ Status polling endpoint
  • ✅ Secure file download
  • ✅ Since parameter support

🎯 § 170.315(b)(1) - CDS

Clinical Decision Support:

  • ⚡ Patient-view hook
  • ⚡ Medication-prescribe hook
  • ⚡ Order-review hook
  • ⚡ Card response format
  • ⚡ SMART App suggestions
  • ⚡ FHIR resource prefetch
  • ⚡ Authentication support

Supported Scopes

  • ⚡ openid,profile,launch/patient, fhirUser,launch
  • ⚡ patient/Patient.rs
  • ⚡ patient/Patient.write
  • ⚡ patient/Observation.rs
  • ⚡ patient/Observation.write
  • ⚡ patient/Condition.rs
  • ⚡ patient/ServiceRequest.rs
  • ⚡ patient/MedicationRequest.rs
  • ⚡ patient/Coverage.rs
  • ⚡ patient/Specimen.rs
  • ⚡ patient/Medication.rs
  • ⚡ patient/Encounter.rs
  • ⚡ patient/Procedure.rs
  • ⚡ patient/AllergyIntolerance.rs
  • ⚡ patient/DiagnosticReport.rs
  • ⚡patient/Immunization.rs
  • ⚡ patient/DocumentReference.rs
  • ⚡ patient/Location.rs
  • ⚡ patient/CareTeam.rs
  • ⚡ patient/Provenance.rs
  • ⚡ patient/RelatedPerson.rs
  • ⚡patient/QuestionnaireResponse.rs
  • ⚡ user/Medication.rs
  • ⚡ user/AllergyIntolerance.rs
  • ⚡ user/CarePlan.rs
  • ⚡ user/CareTeam.rs
  • ⚡ user/Condition.rs
  • ⚡ user/Device.rs
  • ⚡ user/DiagnosticReport.rs
  • ⚡ user/DocumentReference.rs
  • ⚡ user/Encounter.rs
  • ⚡ user/Goal.rs
  • ⚡ user/Immunization.rs
  • ⚡ user/Location.rs
  • ⚡ user/MedicationRequest.rs
  • ⚡ user/Observation.rs
  • ⚡ user/Organization.rs
  • ⚡ user/Patient.rs
  • ⚡ user/Practitioner.rs
  • ⚡ user/Procedure.rs
  • ⚡ user/Provenance.rs
  • ⚡ user/PractitionerRole.rs
  • ⚡ user/Specimen.rs
  • ⚡ user/Coverage.rs
  • ⚡ user/MedicationDispense.rs
  • ⚡ user/ServiceRequest.rs
  • ⚡ user/RelatedPerson.rs
  • ⚡ user/QuestionnaireResponse.rs
  • ⚡ patient/Condition.rs?category=http://terminology.hl7.org/CodeSystem/condition-category|encounter-diagnosis
  • ⚡ patient/Condition.rs?category=http://hl7.org/fhir/us/core/CodeSystem/condition-category|health-concern
  • ⚡ patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory
  • ⚡ patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|social-history
  • ⚡ patient/Condition.rs?category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item
  • ⚡ patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs
  • ⚡ patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|survey
  • ⚡ patient/Observation.rs?category=http://hl7.org/fhir/us/core/CodeSystem/us-core-category|sdoh

🔐 TLS

TLS 1.2+ Enforcement View TLS Report

“All API endpoints and OAuth 2.0 authorization endpoints support and enforce TLS 1.2 or higher for all connections in accordance with ONC API Conditions and Maintenance of Certification requirements.” TLS Security Enforcement The ImperiumSoft FHIR API and authorization server enforce TLS version 1.2 or higher for all connections. This satisfies the ONC certification requirement under 45 CFR 170.315(g)(10)(viii) and 170.404(a)(2). Attempts to use earlier TLS versions (e.g., TLS 1.0 or 1.1) will be rejected.

📊 Test Data Summary

👥 Patient Demographics

  • 45 Patient records
  • Diverse demographics
  • Multiple identifier systems
  • Address & contact information
  • Emergency contacts

🔬 Clinical Data

  • 453 Observations (labs, vitals)
  • 71 Conditions (problems)
  • 74 Diagnostic Reports
  • 40 Allergy Intolerances
  • 15 Procedures

💊 Medications

  • 42 Medication Requests
  • 47 Medication Dispenses
  • 11 Immunizations
  • RxNorm coded medications
  • NDC identifiers

🏥 Care & Administration

  • 71 Encounters
  • 12 Organizations
  • 10 Practitioners
  • 9 Locations
  • 907 Provenance records

🔍 Key Search Examples for Testing

Patient Access API - Core Searches

# Patient Demographics
GET /Patient?family=Johnson&given=John
GET /Patient?birthdate=1990-01-01&gender=male

# Clinical Data
GET /Condition?patient=Patient/123&clinical-status=active
GET /Observation?patient=Patient/123&category=vital-signs
GET /AllergyIntolerance?patient=Patient/123&clinical-status=active
GET /MedicationRequest?patient=Patient/123&status=active

# US Core Required Searches
GET /Observation?patient=Patient/123&code=72166-2  # Tobacco smoking status
GET /Observation?patient=Patient/123&category=laboratory
GET /DiagnosticReport?patient=Patient/123&category=LAB

Bulk Data Export Testing

# System-level export
POST /$export
Accept: application/fhir+json
Prefer: respond-async

# Patient-level export  
POST /Patient/$export
Accept: application/fhir+json
Prefer: respond-async

# Group-level export
POST /Group/123/$export
Accept: application/fhir+json
Prefer: respond-async

📈 Compliance & Standards

✅ Standards Compliance

  • ✅ HL7 FHIR R4 (4.0.1)
  • ✅ US Core v6.1.0
  • ✅ SMART App Launch v2.0
  • ✅ OAuth 2.0 / OpenID Connect
  • ✅ FHIR Bulk Data v1.0
  • ✅ IHE PIXm/PDQm
  • ✅ 21st Century Cures Act

🛠️ Testing Tools & Resources

🔧 Recommended Tools

📚 Documentation

US Core Profiles Supported

Implementation Guides