Skip to content

NovaMed Partner API (1.0.0)

The NovaMed Partner API enables healthcare partners to integrate with NovaMed for patient care management, prescription fulfillment, and order tracking.

Authentication: All requests require an x-api-key header with your API key.

Base URLs:

  • Development: https://novamed-feapidev.stackmod.info
  • Production: https://feapi.novamed.care

For detailed guides, see the Getting Started documentation.

Download OpenAPI description
openapi-partner.json
openapi-partner.yaml
Overview
NovaMed API Support
api@nimbus-os.com
License
API License Terms & Conditions
Languages
Servers
Mock server
https://docs.novamed.care/_mock/openapi-partner/
Development environment
https://novamed-feapidev.stackmod.info/
Production environment
https://feapi.novamed.care/

Practitioners

Manage practitioners (doctors, veterinarians) in the system

Operations

Patients

Patient registration and management

Operations

Medication Requests

Medication order management

Operations

Refills

Prescription refill request management

Operations

Webhooks

Webhook configuration for receiving event notifications

Operations

Register Webhook

Request

Register a webhook URL to receive real-time event notifications.

Once registered, you will receive webhook events for:

  • Shipment creation and updates
  • Prescription status changes
  • Medication order status updates

Webhooks are sent via HTTPS POST requests with an x-api-key header for authentication.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
clinic_idstring(uuid)required

UUID of the clinic associated with this webhook

Example: "550e8400-e29b-41d4-a716-446655440000"
webhook_urlstring(uri)required

HTTPS URL where webhook events will be sent

Example: "https://partner.example.com/webhooks/novamed"
curl -i -X POST \
  https://docs.novamed.care/_mock/openapi-partner/api/external/webhook \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
    "webhook_url": "https://partner.example.com/webhooks/novamed"
  }'

Responses

Webhook registered successfully

Bodyapplication/json
successboolean
Example: true
dataobject
messagestring
Example: "Webhook created successfully"
Response
application/json
{
  "success": true,
  "data": {
    "webhook_id": "bb0e8400-e29b-41d4-a716-446655440006"
  },
  "message": "Webhook created successfully"
}

Delete Webhook

Request

Remove a webhook configuration. The webhook will stop receiving events immediately.

Security
ApiKeyAuth
Query
idstring(uuid)required

Webhook ID to delete

Example: id=bb0e8400-e29b-41d4-a716-446655440006
curl -i -X DELETE \
  'https://docs.novamed.care/_mock/openapi-partner/api/external/webhook?id=bb0e8400-e29b-41d4-a716-446655440006' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Webhook deleted successfully

Bodyapplication/json
successboolean
Example: true
messagestring
Example: "Webhook deleted successfully"
Response
application/json
{
  "success": true,
  "message": "Webhook deleted successfully"
}