Skip to main content

General Purpose FHIR R4 API

Overview​

The Netsmart General Purpose FHIR R4 API provides comprehensive healthcare data integration capabilities based on the HL7 FHIR R4 specification. This API supports various integration scenarios including:

  • ProviderConnect Enterprise - FHIR integration between contracted providers and health plans
  • Pharmacy Integrations - Medication requests, allergies, and intolerances lookup
  • Referral Management - Service request submission to referral management teams
  • Bed Registry and Management - Bridging inpatient/residential EHR with bed management solutions

Important: Always start by retrieving the CapabilityStatement to understand current API capabilities before implementing integrations.

Getting Started​

Step 1: Retrieve CapabilityStatement​

Before using any API resources, retrieve the current CapabilityStatement to understand supported capabilities:

# Production Environment
curl -X GET https://fhir.netsmartcloud.com/v4/metadata \
    -H "Accept: application/fhir+json"

# Preview Environment
curl -X GET https://fhirtest.netsmartcloud.com/v4/metadata \
    -H "Accept: application/fhir+json"

Step 2: Validate Resource Support​

Check the CapabilityStatement rest.resource array to confirm which resources and operations are available for your tenant configuration.

Step 3: Review Authentication Requirements​

Most operations require proper authentication. See the Authorization documentation for details on obtaining and using access tokens.

Base URL​

https://fhir.netsmartcloud.com/v4

Resources​

ResourceReadSearchCreateUpdateExtended Operations
CapabilityStatement
AllergyIntolerance✅✅✅✅
Basic✅✅✅✅
Binary✅
CarePlan✅✅✅✅
Condition✅✅✅✅
Coverage✅✅✅✅
CoverageEligibilityRequest✅✅✅✅
CoverageEligibilityResponse✅✅✅✅
Device✅✅✅✅
DocumentReference✅✅✅✅
Encounter✅✅✅✅
EpisodeOfCare✅✅✅✅
Goal✅✅✅✅
Immunization✅✅✅✅
Location✅✅✅✅$read-relay
$search-relay
$create-relay
$update-relay
MedicationRequest✅✅✅✅
MessageHeader✅✅✅✅
Observation✅✅✅✅
Organization✅✅✅✅$read-relay
$search-relay
$create-relay
$update-relay
Patient✅✅✅✅$assign-mrn
$match
$merge
$unmerge
Practitioner✅✅✅✅
PractitionerRole✅✅✅✅
Procedure✅✅✅✅
QuestionaireResponse✅✅✅✅
RelatedPerson✅✅✅✅
Schedule✅
ServiceRequest✅✅✅✅

Messaging​

This API also includes limited support for FHIR Messaging using a $process-message operation.

Supported Formats​

The API supports multiple content formats. Check the CapabilityStatement format array for the complete list:

  • application/fhir+json (recommended)
  • application/json
  • application/fhir+xml
  • application/xml

Error Handling​

For comprehensive error handling information, see Common Errors. This includes:

  • HTTP status codes and their meanings
  • Common error scenarios and solutions
  • Troubleshooting guidelines
  • Rate limiting information

Additional Resources​

  • Extensions - Supported FHIR extensions for enhanced data capture
  • Operations - Custom operations beyond standard CRUD
  • Messaging - FHIR messaging capabilities
  • Care Records - Care record management workflows

Support​

For technical support and integration assistance, contact Netsmart support through your designated support channels. When reporting issues, include:

  • API endpoint and HTTP method
  • Request headers and body (sanitized)
  • Response status code and body
  • Tenant configuration details