Create FHIR provider

POST/fhir-provider

Creates a new FHIR provider configuration with authentication credentials.

Note: The "sandbox" provider type cannot be created via this API - it is managed internally.

RequiresBearerauthentication

Body parameters

namestringrequired

Display name for the FHIR provider

descriptionstringoptional

Optional description of the FHIR provider

providerstringrequired

Type of FHIR server provider.

The "sandbox" provider type is managed internally and cannot be created via API. It is used on shared instances.

aidboxathenahealthcanvascernerelationepicgoogle_healthcarehapimeditechmedplumphenostoresandbox

base_urlstring (uri)required

Base URL of the FHIR server

authoneOfrequired

Returns

FHIR provider created successfully

Response fields

successbooleanoptional

messagestringoptional

dataoneOfoptional

Provider details. Sandbox providers return FhirProviderSandboxInfo.

POSTRequest

curl -X POST 'https://experiment.app.pheno.ml/fhir-provider' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Epic Sandbox",
  "description": "Epic sandbox environment for testing",
  "provider": "epic",
  "base_url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4",
  "auth": {
    "auth_method": "jwt",
    "client_id": "your-client-id",
    "credential_expiry": "2024-12-31T23:59:59Z",
    "role": "read",
    "scopes": "system/Patient.read system/Observation.read"
  }
}'

201 CreatedResponse

{
  "success": true,
  "message": "FHIR provider created successfully",
  "data": {
    "id": "1716d214-de93-43a4-aa6b-a878d864e2ad",
    "name": "Epic Sandbox",
    "description": "Epic sandbox environment for testing",
    "provider": "epic",
    "base_url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4",
    "client_id": "your-client-id",
    "auth_configs": {},
    "last_updated": "2024-01-15T10:30:00Z"
  }
}