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.nimbushealthcaretest.com
  • 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.nimbushealthcaretest.com
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

Carriers

Retrieve available shipment carriers

Operations

Get Carriers

Request

Retrieve a list of available shipment carriers.

Use this endpoint to get the list of carriers that can be used for shipping medication orders.

Security
ApiKeyAuth
curl -i -X GET \
  https://docs.novamed.care/_mock/openapi-partner/api/external/carriers \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

List of available carriers

Bodyapplication/json
successboolean
Example: true
dataobject
Response
application/json
{
  "success": true,
  "data": {
    "carriers": [ … ]
  }
}

Get Carrier Services

Request

Retrieve available shipping services for a specific carrier based on the patient's location.

This endpoint returns pricing information for each available service, including whether free shipping applies.

Security
ApiKeyAuth
Path
carrierIdstringrequired

The carrier ID (e.g., "se-3818360" for FedEx)

Example: se-3818360
Query
patientIdstring(uuid)required

The patient's UUID to determine shipping location and eligibility

Example: patientId=01aabf3a-51cd-4180-be17-8ac9446e9ace
curl -i -X GET \
  'https://docs.novamed.care/_mock/openapi-partner/api/external/carriers/se-3818360/services?patientId=01aabf3a-51cd-4180-be17-8ac9446e9ace' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

List of available shipping services

Bodyapplication/json
successboolean
Example: true
dataArray of objects

List of available shipping services

isFreeShipmentboolean

Whether free shipping applies for this patient

Example: true
freeShipmentTypestring or null

Type of free shipment (e.g., "clinic_specific") or null if not free

Example: "clinic_specific"
patientStatestring

The patient's state used for shipping calculation

Example: "Alabama"
Response
application/json
{
  "success": true,
  "data": [
    { … },
    { … },
    { … }
  ],
  "isFreeShipment": true,
  "freeShipmentType": "clinic_specific",
  "patientState": "Alabama"
}

Webhooks

Webhook configuration for receiving event notifications

Operations