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

Create Patient

Request

Register a new patient in NovaMed under your partner account.

Notes:

  • All required fields must be provided
  • clinic_id must reference an existing clinic UUID
  • Address information is required for shipping
Security
ApiKeyAuth
Bodyapplication/jsonrequired
first_namestring>= 2 charactersrequired

Patient's first name (minimum 2 characters)

Example: "John"
middle_namestring or null

Patient's middle name (optional)

Example: "Michael"
last_namestringrequired

Patient's last name

Example: "Doe"
genderstring or nullrequired

Patient's gender

Enum"male""female""other""unknown"
Example: "male"
dobstringrequired

Patient's date of birth

Example: "2025-07-13T18:30:00.000Z"
speciesstring or null

Patient's species (for veterinary use)

Enum"human""canine""feline""equine""avian""mammal - other""reptilian""swine"
Example: "human"
animal_owner_namestring or null

Animal owner's name (for veterinary use)

Example: "Jane Smith"
weightstring or null

Patient's weight

Example: "70.5"
weight_recorded_datestring or null

Date when weight was recorded

Example: "2024-01-15"
statusstring or null

Patient's status

Enum"active""inactive"
Example: "active"
practitioner_idstring(uuid)required

ID of the assigned practitioner

Example: "550e8400-e29b-41d4-a716-446655440001"
assigned_clinicstring(uuid)required

ID of the assigned clinic

Example: "550e8400-e29b-41d4-a716-446655440002"
contactsArray of objects

Array of contact information

Example: [{"key":"email","value":"john.doe@example.com"},{"key":"phone","value":"5551234567"}]
addressesArray of objectsrequired

Array of patient addresses (currently only supports single address)

Example: [{"addressLine1":"123 Main Street","addressLine2":"Apt 4B","city":"New York","state":"NY","postalCode":"10001"}]
addresses[].​addressLine1string or nullrequired

First line of address

Example: "123 Main Street"
addresses[].​addressLine2string or null

Second line of address

Example: "Apt 4B"
addresses[].​addressLine3string or null

Third line of address

Example: "Building C"
addresses[].​citystring or nullrequired

City name

Example: "New York"
addresses[].​statestring or nullrequired

State or province

Example: "NY"
addresses[].​postalCodestring or nullrequired

Postal/ZIP code

Example: "10001"
curl -i -X POST \
  https://docs.novamed.care/_mock/openapi-partner/api/external/patient \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "first_name": "John",
    "middle_name": "Michael",
    "last_name": "Doe",
    "gender": "male",
    "dob": "1985-03-15",
    "species": "human",
    "status": "active",
    "practitioner_id": "550e8400-e29b-41d4-a716-446655440001",
    "assigned_clinic": "550e8400-e29b-41d4-a716-446655440002",
    "contacts": [
      {
        "key": "email",
        "value": "john.doe@example.com"
      },
      {
        "key": "phone",
        "value": "5551234567"
      }
    ],
    "addresses": [
      {
        "addressLine1": "123 Main Street",
        "addressLine2": "Apt 4B",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001"
      }
    ]
  }'

Responses

Patient created successfully

Bodyapplication/json
successboolean
Example: true
dataobject
messagestring
Example: "Patient created successfully"
Response
application/json
{
  "success": true,
  "data": {
    "patient_id": "770e8400-e29b-41d4-a716-446655440002"
  },
  "message": "Patient created successfully"
}

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