{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API Reference","description":"API documentation for integrating with NovaMed - healthcare partner integration platform","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-reference","__idx":0},"children":["API Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Complete reference documentation for all NovaMed Partner API endpoints."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-urls","__idx":1},"children":["Base URLs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"URL"},"children":["URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Development"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://novamed-feapidev.nimbushealthcaretest.com"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://feapi.novamed.care"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":2},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API requests require an API key in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-api-key"]}," header:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl https://novamed-feapidev.nimbushealthcaretest.com/api/external/practitioner \\\n  -H \"x-api-key: your-api-key-here\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Accept: application/json\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"required-headers","__idx":3},"children":["Required Headers"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-api-key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your API key"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"practitioners","__idx":4},"children":["Practitioners"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Manage practitioners (doctors, veterinarians) in the NovaMed platform."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/external/practitioner"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a new practitioner"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-practitioner","__idx":5},"children":["Create Practitioner"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://novamed-feapidev.nimbushealthcaretest.com/api/external/practitioner \\\n  -H \"x-api-key: your-api-key-here\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"email\": \"john.doe@example.com\",\n    \"npi\": \"1234567890\",\n    \"is_veterinarian\": true,\n    \"assigned_clinic\": \"550e8400-e29b-41d4-a716-446655440001\",\n    \"phone\": \"1234567890\",\n    \"address_line_1\": \"123 Main St\",\n    \"address_line_2\": \"Apt 1\",\n    \"city\": \"San Antonio\",\n    \"state_code\": \"TX\",\n    \"zip_code\": \"78201\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/practitioners"},"children":["View full Practitioner documentation →"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"patients","__idx":6},"children":["Patients"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Register and manage patients in the NovaMed platform."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/external/patient"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a new patient"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-patient","__idx":7},"children":["Create Patient"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://novamed-feapidev.nimbushealthcaretest.com/api/external/patient \\\n  -H \"x-api-key: your-api-key-here\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"first_name\": \"John\",\n    \"middle_name\": \"Michael\",\n    \"last_name\": \"Doe\",\n    \"gender\": \"male\",\n    \"dob\": \"1985-03-15\",\n    \"species\": \"human\",\n    \"status\": \"active\",\n    \"practitioner_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n    \"assigned_clinic\": \"550e8400-e29b-41d4-a716-446655440002\",\n    \"contacts\": [\n      { \"key\": \"email\", \"value\": \"john.doe@example.com\" },\n      { \"key\": \"phone\", \"value\": \"5551234567\" }\n    ],\n    \"addresses\": [\n      {\n        \"addressLine1\": \"123 Main Street\",\n        \"addressLine2\": \"Apt 4B\",\n        \"city\": \"New York\",\n        \"state\": \"NY\",\n        \"postalCode\": \"10001\"\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/patients"},"children":["View full Patient documentation →"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"medication-requests","__idx":8},"children":["Medication Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create medication orders for patients."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/external/medication-order"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a new medication request"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-medication-request","__idx":9},"children":["Create Medication Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://novamed-feapidev.nimbushealthcaretest.com/api/external/medication-order \\\n  -H \"x-api-key: your-api-key-here\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"patient_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n    \"practitioner_id\": \"550e8400-e29b-41d4-a716-446655440002\",\n    \"clinic_id\": \"550e8400-e29b-41d4-a716-446655440003\",\n    \"carrier_id\": \"se-3818360\",\n    \"service_id\": \"fedex_ground\",\n    \"is_refrigerated\": true,\n    \"medication_requests\": [\n      {\n        \"medication\": \"Testosterone Cypionate\",\n        \"dose\": \"200mg/ml\",\n        \"unit_of_measure\": \"mg\",\n        \"quantity\": 1,\n        \"refills\": \"3\",\n        \"direction\": \"Inject 0.5ml (100mg) intramuscularly twice weekly\",\n        \"days_supply\": 30\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/medication-requests"},"children":["View full Medication Request documentation →"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"refills","__idx":10},"children":["Refills"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Request prescription refills for existing medication orders."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/external/refill-request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request a prescription refill"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-refill-request","__idx":11},"children":["Create Refill Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://novamed-feapidev.nimbushealthcaretest.com/api/external/refill-request \\\n  -H \"x-api-key: your-api-key-here\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"clinic_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"medication_request_id\": \"990e8400-e29b-41d4-a716-446655440004\",\n    \"shipping_address\": {\n      \"line1\": \"123 Main Street\",\n      \"city\": \"San Francisco\",\n      \"state\": \"CA\",\n      \"zip\": \"94102\",\n      \"country\": \"US\"\n    },\n    \"shipment_service_code\": \"usps_priority\",\n    \"payment_method_id\": \"pm_card_visa_1234\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/refills"},"children":["View full Refill documentation →"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"carriers","__idx":12},"children":["Carriers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve available shipment carriers and their services."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/external/carriers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get list of available carriers"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/external/carriers/{carrierId}/services"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get carrier services for a patient"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-carriers","__idx":13},"children":["Get Carriers"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET https://novamed-feapidev.nimbushealthcaretest.com/api/external/carriers \\\n  -H \"x-api-key: your-api-key-here\" \\\n  -H \"Accept: application/json\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": true,\n  \"data\": {\n    \"carriers\": [\n      {\n        \"id\": \"ameriship\",\n        \"name\": \"Ameriship\"\n      },\n      {\n        \"id\": \"se-3818360\",\n        \"name\": \"FedEx\"\n      },\n      {\n        \"id\": \"se-11225\",\n        \"name\": \"Stamps.com\"\n      },\n      {\n        \"id\": \"se-11226\",\n        \"name\": \"UPS\"\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-carrier-services","__idx":14},"children":["Get Carrier Services"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get available shipping services for a specific carrier based on the patient's location."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://novamed-feapidev.nimbushealthcaretest.com/api/external/carriers/se-3818360/services?patientId=01aabf3a-51cd-4180-be17-8ac9446e9ace\" \\\n  -H \"x-api-key: your-api-key-here\" \\\n  -H \"Accept: application/json\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response (Free Shipping)"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": \"fedex_ground\",\n      \"name\": \"FedEx Ground®\",\n      \"totalCost\": 0,\n      \"originalCost\": 32.44\n    },\n    {\n      \"id\": \"fedex_2day\",\n      \"name\": \"FedEx 2Day®\",\n      \"totalCost\": 0,\n      \"originalCost\": 56.43\n    },\n    {\n      \"id\": \"fedex_priority_overnight\",\n      \"name\": \"FedEx Priority Overnight®\",\n      \"totalCost\": 0,\n      \"originalCost\": 118.10\n    }\n  ],\n  \"isFreeShipment\": true,\n  \"freeShipmentType\": \"clinic_specific\",\n  \"patientState\": \"Alabama\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response (Paid Shipping)"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": \"fedex_ground\",\n      \"name\": \"FedEx Ground®\",\n      \"totalCost\": 32.44,\n      \"originalCost\": 32.44\n    },\n    {\n      \"id\": \"fedex_2day\",\n      \"name\": \"FedEx 2Day®\",\n      \"totalCost\": 56.43,\n      \"originalCost\": 56.43\n    }\n  ],\n  \"isFreeShipment\": false,\n  \"freeShipmentType\": null,\n  \"patientState\": \"California\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/carriers"},"children":["View full Carriers documentation →"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"webhooks","__idx":15},"children":["Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Register webhook endpoints to receive real-time event notifications."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/external/webhook"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Register a webhook endpoint"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/external/webhook"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete a webhook endpoint"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"register-webhook","__idx":16},"children":["Register Webhook"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://novamed-feapidev.nimbushealthcaretest.com/api/external/webhook \\\n  -H \"x-api-key: your-api-key-here\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"clinic_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"webhook_url\": \"https://your-domain.com/webhooks/nimbus\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-webhook","__idx":17},"children":["Delete Webhook"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X DELETE https://novamed-feapidev.nimbushealthcaretest.com/api/external/webhook \\\n  -H \"x-api-key: your-api-key-here\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"clinic_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"webhook_id\": \"aa0e8400-e29b-41d4-a716-446655440005\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/webhooks"},"children":["View full Webhook documentation →"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-format","__idx":18},"children":["Response Format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All successful responses follow this structure:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": true,\n  \"data\": {\n    // Response-specific data\n  },\n  \"message\": \"Operation completed successfully\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-handling","__idx":19},"children":["Error Handling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Error responses include a standardized error object:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"VALIDATION_ERROR\",\n    \"message\": \"Invalid request parameters\",\n    \"details\": {\n      \"field\": \"email\",\n      \"reason\": \"Invalid email format\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"common-error-codes","__idx":20},"children":["Common Error Codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Status"},"children":["HTTP Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VALIDATION_ERROR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid request parameters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNAUTHORIZED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or invalid API key"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FORBIDDEN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient permissions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Resource not found"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RATE_LIMIT_EXCEEDED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["429"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Too many requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INTERNAL_ERROR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["500"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server error"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"interactive-api-documentation","__idx":21},"children":["Interactive API Documentation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For interactive API documentation with \"Try it\" functionality, explore the OpenAPI endpoints:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/practitioners"},"children":["Practitioners"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/patients"},"children":["Patients"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/medication-requests"},"children":["Medication Requests"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/refills"},"children":["Refills"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/carriers"},"children":["Carriers"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi-partner/webhooks"},"children":["Webhooks"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"external-resources","__idx":22},"children":["External Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://documenter.getpostman.com/view/49178248/2sB3QML9Jg"},"children":["Postman Collection"]}," - Interactive API testing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-terms"},"children":["API Terms & Conditions"]}," - Usage terms and policies"]}]}]},"headings":[{"value":"API Reference","id":"api-reference","depth":1},{"value":"Base URLs","id":"base-urls","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Required Headers","id":"required-headers","depth":2},{"value":"Practitioners","id":"practitioners","depth":2},{"value":"Create Practitioner","id":"create-practitioner","depth":3},{"value":"Patients","id":"patients","depth":2},{"value":"Create Patient","id":"create-patient","depth":3},{"value":"Medication Requests","id":"medication-requests","depth":2},{"value":"Create Medication Request","id":"create-medication-request","depth":3},{"value":"Refills","id":"refills","depth":2},{"value":"Create Refill Request","id":"create-refill-request","depth":3},{"value":"Carriers","id":"carriers","depth":2},{"value":"Get Carriers","id":"get-carriers","depth":3},{"value":"Get Carrier Services","id":"get-carrier-services","depth":3},{"value":"Webhooks","id":"webhooks","depth":2},{"value":"Register Webhook","id":"register-webhook","depth":3},{"value":"Delete Webhook","id":"delete-webhook","depth":3},{"value":"Response Format","id":"response-format","depth":2},{"value":"Error Handling","id":"error-handling","depth":2},{"value":"Common Error Codes","id":"common-error-codes","depth":3},{"value":"Interactive API Documentation","id":"interactive-api-documentation","depth":2},{"value":"External Resources","id":"external-resources","depth":2}],"frontmatter":{"title":"API Reference","description":"Complete NovaMed Partner API endpoint documentation","seo":{"title":"API Reference"}},"lastModified":"2026-01-12T13:39:25.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}