Skip to content
Last updated

API Reference

Complete reference documentation for all NovaMed Partner API endpoints.

Base URLs

EnvironmentURL
Developmenthttps://novamed-feapidev.stackmod.info
Productionhttps://feapi.novamed.care

Authentication

All API requests require an API key in the x-api-key header:

curl https://novamed-feapidev.stackmod.info/api/external/practitioner \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Required Headers

HeaderValueRequired
x-api-keyYour API keyYes
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes

Practitioners

Manage practitioners (doctors, veterinarians) in the NovaMed platform.

MethodEndpointDescription
POST/api/external/practitionerCreate a new practitioner

Create Practitioner

curl -X POST https://novamed-feapidev.stackmod.info/api/external/practitioner \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "npi_number": "1234567890",
    "first_name": "Sarah",
    "last_name": "Johnson",
    "email": "dr.johnson@partnerclinic.com",
    "phone": "+1-555-0123",
    "credentials": "MD",
    "specialty": "Internal Medicine",
    "license_number": "MD-12345",
    "license_state": "CA",
    "license_expiration": "2026-12-31",
    "dea_number": "FJ1234563",
    "dea_expiration": "2026-06-30",
    "signature_image": "base64_encoded_image_string",
    "assigned_clinic": "550e8400-e29b-41d4-a716-446655440000"
  }'

View full Practitioner documentation →


Patients

Register and manage patients in the NovaMed platform.

MethodEndpointDescription
POST/api/external/patientCreate a new patient

Create Patient

curl -X POST https://novamed-feapidev.stackmod.info/api/external/patient \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
    "first_name": "John",
    "last_name": "Smith",
    "date_of_birth": "1985-03-15",
    "gender": "male",
    "email": "john.smith@email.com",
    "phone": "+1-555-0199",
    "address": {
      "line1": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94102",
      "country": "US"
    }
  }'

View full Patient documentation →


Medication Requests

Create medication orders for patients.

MethodEndpointDescription
POST/api/external/medication-requestCreate a new medication request

Create Medication Request

curl -X POST https://novamed-feapidev.stackmod.info/api/external/medication-request \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
    "patient_id": "660e8400-e29b-41d4-a716-446655440001",
    "practitioner_id": "770e8400-e29b-41d4-a716-446655440002",
    "medication_id": "880e8400-e29b-41d4-a716-446655440003",
    "quantity": 1,
    "refills": 3,
    "days_supply": 30,
    "instructions": "Inject 0.5ml (100mg) intramuscularly twice weekly",
    "diagnosis_codes": ["E29.1"]
  }'

View full Medication Request documentation →


Refills

Request prescription refills for existing medication orders.

MethodEndpointDescription
POST/api/external/refill-requestRequest a prescription refill

Create Refill Request

curl -X POST https://novamed-feapidev.stackmod.info/api/external/refill-request \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
    "medication_request_id": "990e8400-e29b-41d4-a716-446655440004",
    "shipping_address": {
      "line1": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94102",
      "country": "US"
    },
    "shipment_service_code": "usps_priority",
    "payment_method_id": "pm_card_visa_1234"
  }'

View full Refill documentation →


Webhooks

Register webhook endpoints to receive real-time event notifications.

MethodEndpointDescription
POST/api/external/webhookRegister a webhook endpoint
DELETE/api/external/webhookDelete a webhook endpoint

Register Webhook

curl -X POST https://novamed-feapidev.stackmod.info/api/external/webhook \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
    "webhook_url": "https://your-domain.com/webhooks/nimbus"
  }'

Delete Webhook

curl -X DELETE https://novamed-feapidev.stackmod.info/api/external/webhook \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
    "webhook_id": "aa0e8400-e29b-41d4-a716-446655440005"
  }'

View full Webhook documentation →


Response Format

All successful responses follow this structure:

{
  "success": true,
  "data": {
    // Response-specific data
  },
  "message": "Operation completed successfully"
}

Error Handling

Error responses include a standardized error object:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "field": "email",
      "reason": "Invalid email format"
    }
  }
}

Common Error Codes

CodeHTTP StatusDescription
VALIDATION_ERROR400Invalid request parameters
UNAUTHORIZED401Missing or invalid API key
FORBIDDEN403Insufficient permissions
NOT_FOUND404Resource not found
RATE_LIMIT_EXCEEDED429Too many requests
INTERNAL_ERROR500Server error

Interactive API Documentation

For interactive API documentation with "Try it" functionality, explore the OpenAPI endpoints:

External Resources