{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Overview","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":"overview","__idx":0},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The NovaMed Integration API is a set of HTTP endpoints that help your app integrate with NovaMed for complete patient care management, prescription fulfillment, and order tracking."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-urls","__idx":1},"children":["Base URLs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"env-table"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"env-row"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"env-label"},"children":["Development"]},{"$$mdtype":"Tag","name":"code","attributes":{"className":"env-url"},"children":["https://novamed-feapidev.nimbushealthcaretest.com"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"env-row"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"env-label"},"children":["Production"]},{"$$mdtype":"Tag","name":"code","attributes":{"className":"env-url"},"children":["https://feapi.novamed.care"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request-and-response-format","__idx":2},"children":["Request and Response Format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API access is over HTTPS. All data is sent and received as JSON."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"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":"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":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request body format"]}]},{"$$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":["Expected response format"]}]},{"$$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":["Authentication"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-capabilities","__idx":3},"children":["Key Capabilities"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"practitioners","__idx":4},"children":["Practitioners"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create and manage practitioners (doctors, veterinarians) in the NovaMed system."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Onboard new practitioners with credentials"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Assign practitioners to clinics"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Manage practitioner details and signatures"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"patients","__idx":5},"children":["Patients"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Register and manage patients in the NovaMed platform."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create patient profiles with demographics"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Manage patient contact and address information"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Link patients to clinics"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"medication-requests","__idx":6},"children":["Medication Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create and manage medication orders for patients."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Submit medication requests with prescribing practitioner"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Specify medication details, dosing, and refills"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Track medication order status"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"refills","__idx":7},"children":["Refills"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Request prescription refills for existing medication orders."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Initiate refill requests for shipped/delivered medications"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Automatic eligibility checking"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Track refill status through fulfillment"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"webhooks","__idx":8},"children":["Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Receive real-time notifications for important events."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Shipment creation and updates"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Medication order status changes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Prescription status updates"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"use-cases","__idx":9},"children":["Use Cases"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pharmacy-management-systems","__idx":10},"children":["Pharmacy Management Systems"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Integrate order creation and tracking into existing pharmacy workflows. Automate fulfillment processes and reduce manual data entry."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"patient-portals","__idx":11},"children":["Patient Portals"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enable patients to request refills and track orders through your application. Provide real-time status updates and delivery estimates."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"care-coordination-platforms","__idx":12},"children":["Care Coordination Platforms"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Connect pharmacy operations with care management systems. Automate refill requests based on patient needs and care plans."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"telemedicine-platforms","__idx":13},"children":["Telemedicine Platforms"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Integrate prescription workflows into virtual care. Create medication orders directly from consultations."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"architecture","__idx":14},"children":["Architecture"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The NovaMed API follows RESTful principles with JSON request and response bodies. All endpoints use HTTPS and require API key authentication."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authentication","__idx":15},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All requests require an API key sent in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-api-key"]}," header. You'll also need a Clinic ID for most operations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/authentication"},"children":["Learn more about authentication →"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"hipaa--security","__idx":16},"children":["HIPAA & Security"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The NovaMed API handles Protected Health Information (PHI) and is designed to comply with HIPAA requirements. All data is encrypted in transit using TLS 1.2 or higher."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When building integrations:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store API keys securely"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use HTTPS for all requests"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Implement proper access controls"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Follow your organization's HIPAA compliance policies"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Important"]},": API access is limited to Approved Partners only. Production access involving PHI requires a Business Associate Agreement (BAA). Do not send PHI to the Development environment. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-terms"},"children":["API Terms & Conditions"]}," for complete requirements."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"getting-started","__idx":17},"children":["Getting Started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ready to start building? Follow our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/quickstart"},"children":["Quickstart guide"]}," to make your first API call in minutes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"support","__idx":18},"children":["Support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Need help? Contact our API support team at ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"mailto:api@nimbus-os.com"},"children":["api@nimbus-os.com"]},"."]}]},"headings":[{"value":"Overview","id":"overview","depth":1},{"value":"Base URLs","id":"base-urls","depth":2},{"value":"Request and Response Format","id":"request-and-response-format","depth":2},{"value":"Key Capabilities","id":"key-capabilities","depth":2},{"value":"Practitioners","id":"practitioners","depth":3},{"value":"Patients","id":"patients","depth":3},{"value":"Medication Requests","id":"medication-requests","depth":3},{"value":"Refills","id":"refills","depth":3},{"value":"Webhooks","id":"webhooks","depth":3},{"value":"Use Cases","id":"use-cases","depth":2},{"value":"Pharmacy Management Systems","id":"pharmacy-management-systems","depth":3},{"value":"Patient Portals","id":"patient-portals","depth":3},{"value":"Care Coordination Platforms","id":"care-coordination-platforms","depth":3},{"value":"Telemedicine Platforms","id":"telemedicine-platforms","depth":3},{"value":"Architecture","id":"architecture","depth":2},{"value":"Authentication","id":"authentication","depth":3},{"value":"HIPAA & Security","id":"hipaa--security","depth":2},{"value":"Getting Started","id":"getting-started","depth":2},{"value":"Support","id":"support","depth":2}],"frontmatter":{"title":"Overview","description":"Introduction to the NovaMed Partner API","seo":{"title":"Overview"}},"lastModified":"2025-12-19T22:43:10.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}