{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["cards","card"]},"type":"markdown"},"seo":{"title":"NovaMed Partner API","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":"novamed","__idx":0},"children":["NovaMed ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"accent"},"children":["Partner API"]}]},{"$$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":"div","attributes":{"className":"info-card"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"info-card-icon"},"children":[{"$$mdtype":"Tag","name":"svg","attributes":{"width":"24","height":"24","viewbox":"0 0 24 24","fill":"none","stroke":"currentColor","strokeWidth":"2"},"children":[{"$$mdtype":"Tag","name":"path","attributes":{"d":"M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"},"children":[]},{"$$mdtype":"Tag","name":"path","attributes":{"d":"M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"info-card-content"},"children":[{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["Postman Documentation"]},{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://documenter.getpostman.com/view/49178248/2sB3QML9Jg","target":"_blank"},"children":["View in Postman →"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-urls","__idx":1},"children":["Base URLs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the appropriate base URL for your environment:"]},{"$$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":"authentication","__idx":2},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We will provide an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Key"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Clinic Id"]},". All requests need to pass a header ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-api-key"]}," with the provided value."]},{"$$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":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/authentication"},"children":["Learn more about authentication →"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-links","__idx":3},"children":["Quick Links"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Quickstart","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/quickstart"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get your first API call working in minutes."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"API Reference","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/api-reference"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Complete endpoint documentation with examples."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Webhooks","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/webhooks"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Receive real-time event notifications."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-endpoints","__idx":4},"children":["API Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The NovaMed Partner API supports the following core capabilities:"]},{"$$mdtype":"Tag","name":"ol","attributes":{"className":"workflow-list"},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Practitioners"]}," — Create and manage practitioners (doctors, veterinarians)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Patients"]}," — Register and manage patients in the platform"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Medication Requests"]}," — Create medication orders for patients"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Refills"]}," — Request prescription refills for existing orders"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhooks"]}," — Receive real-time notifications for status updates"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request-and-response-format","__idx":5},"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":"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":"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":"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":"Heading","attributes":{"level":2,"id":"next-steps","__idx":6},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/quickstart#get-your-api-key"},"children":["Get your API key"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/quickstart#make-your-first-request"},"children":["Make your first request"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/webhooks"},"children":["Set up webhooks"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-reference"},"children":["Explore the API reference"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-terms","__idx":7},"children":["API Terms"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NovaMed API Terms (Approved Partners Only)."]}," By accessing NovaMed APIs you agree to these terms. Access is by written approval only; credentials are unique per tenant and must be protected. APIs may process PHI; production PHI access requires a BAA. Do not send PHI to Development environment. No scraping, reverse engineering, benchmarking, resale/sublicensing (except serving authorized customers), or security testing without written approval. No PCI/card data. NovaMed may change/suspend APIs; best efforts notice. APIs \"as is\"; liability capped to fees paid in prior 3 months. Notices: legal@nimbushealthcare.com. Travis County, TX."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-terms"},"children":["View full API License Terms & Conditions →"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Need help? Contact ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"mailto:api@nimbus-os.com"},"children":["api@nimbus-os.com"]}]}]},"headings":[{"value":"NovaMed","id":"novamed","depth":1},{"value":"Base URLs","id":"base-urls","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Quick Links","id":"quick-links","depth":2},{"value":"API Endpoints","id":"api-endpoints","depth":2},{"value":"Request and Response Format","id":"request-and-response-format","depth":2},{"value":"Next Steps","id":"next-steps","depth":2},{"value":"API Terms","id":"api-terms","depth":2}],"frontmatter":{"title":"NovaMed Partner API Documentation","description":"The NovaMed Integration API helps your app integrate with NovaMed","seo":{"title":"NovaMed Partner API"}},"lastModified":"2025-12-19T22:59:22.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}