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

Create Practitioner

Request

Creates a new practitioner (doctor or veterinarian) in the system. This endpoint is used to onboard practitioners by collecting their personal, professional, and contact information.

Notes:

  • All required fields must be provided and valid
  • assigned_clinic must reference an existing clinic UUID
  • Validation errors will return descriptive messages for each field
Security
ApiKeyAuth
Bodyapplication/jsonrequired
first_namestring>= 2 charactersrequired

Practitioner's first name (minimum 2 characters)

Example: "John"
last_namestring>= 2 charactersrequired

Practitioner's last name (minimum 2 characters)

Example: "Doe"
emailstring(email)required

Practitioner's email

Example: "john.doe@example.com"
npistringrequired

Practitioner's NPI number

Example: "1234567890"
is_veterinarianbooleanrequired

Whether the practitioner is a veterinarian

Example: true
assigned_clinicstring(uuid)required

ID of the assigned clinic

Example: "550e8400-e29b-41d4-a716-446655440001"
phonestring

Practitioner's phone number

Example: "1234567890"
address_line_1stringrequired

Practitioner's address line 1

Example: "123 Main St"
address_line_2string

Practitioner's address line 2

Example: "Apt 1"
citystringrequired

Practitioner's city

Example: "San Antonio"
state_codestringrequired

Practitioner's state code

Example: "TX"
zip_codestringrequired

Practitioner's zip code

Example: "78201"
curl -i -X POST \
  https://docs.novamed.care/_mock/openapi-partner/api/external/practitioner \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "npi": "1234567890",
    "is_veterinarian": true,
    "assigned_clinic": "550e8400-e29b-41d4-a716-446655440001",
    "phone": "1234567890",
    "address_line_1": "123 Main St",
    "address_line_2": "Apt 1",
    "city": "San Antonio",
    "state_code": "TX",
    "zip_code": "78201"
  }'

Responses

Practitioner created successfully

Bodyapplication/json
successboolean
Example: true
dataobject
messagestring
Example: "Practitioner created successfully"
Response
application/json
{
  "success": true,
  "data": {
    "practitioner_id": "660e8400-e29b-41d4-a716-446655440001"
  },
  "message": "Practitioner created successfully"
}

Patients

Patient registration and management

Operations

Medication Requests

Medication order management

Operations

Refills

Prescription refill request management

Operations

Carriers

Retrieve available shipment carriers

Operations

Webhooks

Webhook configuration for receiving event notifications

Operations