# NovaMed Partner API

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](/guides/quickstart) documentation.


Version: 1.0.0
License: API License Terms & Conditions

## Servers

Development environment
```
https://novamed-feapidev.stackmod.info
```

Production environment
```
https://feapi.novamed.care
```

## Security

### ApiKeyAuth

Partner API key for authentication. Contact api@nimbus-os.com to obtain your API key.

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

[NovaMed Partner API](https://nimbus-os.redocly.app/_bundle/openapi-partner.yaml)

## Practitioners

Manage practitioners (doctors, veterinarians) in the system

### Create Practitioner

 - [POST /api/external/practitioner](https://nimbus-os.redocly.app/openapi-partner/practitioners/createpractitioner.md): 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

## Patients

Patient registration and management

### Create Patient

 - [POST /api/external/patient](https://nimbus-os.redocly.app/openapi-partner/patients/createpatient.md): 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

## Medication Requests

Medication order management

### Create Medication Request

 - [POST /api/external/medication-request](https://nimbus-os.redocly.app/openapi-partner/medication-requests/createmedicationrequest.md): 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

## Refills

Prescription refill request management

### Create Refill Request

 - [POST /api/external/refill-request](https://nimbus-os.redocly.app/openapi-partner/refills/createrefillrequest.md): Request a refill for an existing medication order that has been shipped or delivered.

Eligibility Requirements:
- Medication must have been shipped or delivered
- Refills must be authorized on the original prescription
- No pending refill request already exists

The refill request will create a new prescription and medication order automatically.

## Webhooks

Webhook configuration for receiving event notifications

### Register Webhook

 - [POST /api/external/webhook](https://nimbus-os.redocly.app/openapi-partner/webhooks/createwebhook.md): 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.

### Delete Webhook

 - [DELETE /api/external/webhook](https://nimbus-os.redocly.app/openapi-partner/webhooks/deletewebhook.md): Remove a webhook configuration. The webhook will stop receiving events immediately.