API Reference

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

curl https://novamed-feapidev.nimbushealthcaretest.com/api/external/practitioner \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

curl -X POST https://novamed-feapidev.nimbushealthcaretest.com/api/external/practitioner \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -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"
  }'

curl -X POST https://novamed-feapidev.nimbushealthcaretest.com/api/external/patient \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -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"
      }
    ]
  }'

curl -X POST https://novamed-feapidev.nimbushealthcaretest.com/api/external/medication-order \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -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
      }
    ]
  }'

curl -X POST https://novamed-feapidev.nimbushealthcaretest.com/api/external/refill-request \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
    "medication_request_id": "990e8400-e29b-41d4-a716-446655440004",
    "shipping_address": {
      "line1": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94102",
      "country": "US"
    },
    "shipment_service_code": "usps_priority",
    "payment_method_id": "pm_card_visa_1234"
  }'

curl -X GET https://novamed-feapidev.nimbushealthcaretest.com/api/external/carriers \
  -H "x-api-key: your-api-key-here" \
  -H "Accept: application/json"

{
  "success": true,
  "data": {
    "carriers": [
      {
        "id": "ameriship",
        "name": "Ameriship"
      },
      {
        "id": "se-3818360",
        "name": "FedEx"
      },
      {
        "id": "se-11225",
        "name": "Stamps.com"
      },
      {
        "id": "se-11226",
        "name": "UPS"
      }
    ]
  }
}

curl -X GET "https://novamed-feapidev.nimbushealthcaretest.com/api/external/carriers/se-3818360/services?patientId=01aabf3a-51cd-4180-be17-8ac9446e9ace" \
  -H "x-api-key: your-api-key-here" \
  -H "Accept: application/json"

{
  "success": true,
  "data": [
    {
      "id": "fedex_ground",
      "name": "FedEx Ground®",
      "totalCost": 0,
      "originalCost": 32.44
    },
    {
      "id": "fedex_2day",
      "name": "FedEx 2Day®",
      "totalCost": 0,
      "originalCost": 56.43
    },
    {
      "id": "fedex_priority_overnight",
      "name": "FedEx Priority Overnight®",
      "totalCost": 0,
      "originalCost": 118.10
    }
  ],
  "isFreeShipment": true,
  "freeShipmentType": "clinic_specific",
  "patientState": "Alabama"
}

{
  "success": true,
  "data": [
    {
      "id": "fedex_ground",
      "name": "FedEx Ground®",
      "totalCost": 32.44,
      "originalCost": 32.44
    },
    {
      "id": "fedex_2day",
      "name": "FedEx 2Day®",
      "totalCost": 56.43,
      "originalCost": 56.43
    }
  ],
  "isFreeShipment": false,
  "freeShipmentType": null,
  "patientState": "California"
}

curl -X POST https://novamed-feapidev.nimbushealthcaretest.com/api/external/webhook \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
    "webhook_url": "https://your-domain.com/webhooks/nimbus"
  }'

curl -X DELETE https://novamed-feapidev.nimbushealthcaretest.com/api/external/webhook \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
    "webhook_id": "aa0e8400-e29b-41d4-a716-446655440005"
  }'

{
  "success": true,
  "data": {
    // Response-specific data
  },
  "message": "Operation completed successfully"
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "field": "email",
      "reason": "Invalid email format"
    }
  }
}