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
Overview
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

Create Medication Request

Request

Create a new medication request for a patient. This endpoint initiates the prescription and fulfillment process.

Notes:

  • Patient and practitioner must already exist in the system
  • Medication details must be valid
  • The request will be validated against the clinic's available medications
Security
ApiKeyAuth
Bodyapplication/jsonrequired
patient_idstring(uuid)required

ID of the patient

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

ID of the practitioner

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

ID of the clinic

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

ID of the shipping carrier (from GET /api/external/carriers)

Example: "se-3818360"
service_idstringrequired

ID of the shipping service (from GET /api/external/carriers/{carrierId}/services)

Example: "fedex_ground"
is_refrigeratedboolean

Is refrigerated

Example: true
shipment_group_idstring

Shipment group ID

Example: "550e8400-e29b-41d4-a716-446655440001"
medication_requestsArray of objectsrequired

Array of medication requests

medication_requests[].​medicationstringrequired

Name of the medication

Example: "Aspirin"
medication_requests[].​dosestringrequired

Dose of the medication

Example: "100mg"
medication_requests[].​unit_of_measurestring

Unit of measure (recommended). If omitted, NovaMed will attempt to derive this from the dose string (e.g. "0.25 mg" -> "mg").

Example: "mg"
medication_requests[].​quantitynumberrequired

Quantity of the medication

Example: 100
medication_requests[].​refillsstring

Number of refills

Example: "3"
medication_requests[].​directionstringrequired

Direction of the medication

Example: "Take 1 tablet by mouth daily"
medication_requests[].​days_supplynumber

Days supply

Example: 30
medication_requests[].​flavorstring

Flavor of the medication

Example: "Orange"
medication_requests[].​notesstring

Notes for the medication

Example: "Patient has a history of allergies"
medication_requests[].​do_not_refillboolean

Do not refill

Example: true
medication_requests[].​do_not_fillboolean

Do not fill

Example: true
medication_requests[].​patient_contact_requestedboolean

Patient contact requested

Example: true
medication_requests[].​reason_for_compoundingstring

Reason for compounding

Example: "Patient has a history of allergies"
medication_requests[].​reason_for_compounding_additional_contextstring

Additional context for reason for compounding

Example: "Patient has a history of allergies"
curl -i -X POST \
  https://docs.novamed.care/_mock/openapi-partner/api/external/medication-order \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "patient_id": "550e8400-e29b-41d4-a716-446655440001",
    "practitioner_id": "550e8400-e29b-41d4-a716-446655440002",
    "clinic_id": "550e8400-e29b-41d4-a716-446655440003",
    "carrier_id": "se-3818360",
    "service_id": "fedex_ground",
    "is_refrigerated": true,
    "medication_requests": [
      {
        "medication": "Testosterone Cypionate",
        "dose": "200mg/ml",
        "unit_of_measure": "mg",
        "quantity": 1,
        "refills": "3",
        "direction": "Inject 0.5ml (100mg) intramuscularly twice weekly",
        "days_supply": 30
      }
    ]
  }'

Responses

Medication request created successfully

Bodyapplication/json
successboolean
Example: true
dataobject
messagestring
Example: "Medication request created successfully"
Response
application/json
{ "success": true, "data": { "medication_request_id": "880e8400-e29b-41d4-a716-446655440003" }, "message": "Medication request created successfully" }

Refills

Prescription refill request management

Operations

Carriers

Retrieve available shipment carriers

Operations

Webhooks

Webhook configuration for receiving event notifications

Operations