{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Quickstart","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":"quickstart","__idx":0},"children":["Quickstart"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get your first API call working in under 5 minutes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An API key and Clinic ID (provided by NovaMed team)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["curl"]}," or your preferred HTTP client"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access to the development environment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Approved Partner status"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": By using the API, you agree to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-terms"},"children":["API License Terms & Conditions"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-your-api-key","__idx":2},"children":["Get Your API Key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API credentials are provided by the NovaMed team upon partner approval:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Complete the partner onboarding process"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sign the Business Associate Agreement (BAA) if accessing PHI"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Receive your API Key and Clinic ID from the NovaMed team"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store credentials securely"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Contact"]},": ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"mailto:api@nimbus-os.com"},"children":["api@nimbus-os.com"]}," to request API access."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"make-your-first-request","__idx":3},"children":["Make Your First Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Let's create a practitioner to verify your setup:"]},{"$$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  -H \"Accept: application/json\" \\\n  -d '{\n    \"first_name\": \"Sarah\",\n    \"last_name\": \"Johnson\",\n    \"email\": \"dr.johnson@partnerclinic.com\",\n    \"npi_number\": \"1234567890\",\n    \"assigned_clinic\": \"your-clinic-id-here\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If successful, you'll receive a JSON response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": true,\n  \"data\": {\n    \"practitioner_id\": \"660e8400-e29b-41d4-a716-446655440001\"\n  },\n  \"message\": \"Practitioner created successfully\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-a-patient","__idx":4},"children":["Create a Patient"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now let's create a 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  -H \"Accept: application/json\" \\\n  -d '{\n    \"clinic_id\": \"your-clinic-id-here\",\n    \"first_name\": \"John\",\n    \"last_name\": \"Smith\",\n    \"date_of_birth\": \"1985-03-15\",\n    \"gender\": \"male\",\n    \"email\": \"john.smith@email.com\",\n    \"phone\": \"+1-555-0199\",\n    \"address_line1\": \"123 Main Street\",\n    \"city\": \"San Francisco\",\n    \"state\": \"CA\",\n    \"zip\": \"94102\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes the created patient:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": true,\n  \"data\": {\n    \"patient_id\": \"770e8400-e29b-41d4-a716-446655440002\"\n  },\n  \"message\": \"Patient created successfully\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-a-medication-request","__idx":5},"children":["Create a Medication Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now create a medication request for the patient:"]},{"$$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  -H \"Accept: application/json\" \\\n  -d '{\n    \"patient_id\": \"770e8400-e29b-41d4-a716-446655440002\",\n    \"practitioner_id\": \"660e8400-e29b-41d4-a716-446655440001\",\n    \"clinic_id\": \"your-clinic-id-here\",\n    \"carrier_id\": \"se-3818360\",\n    \"service_id\": \"fedex_ground\",\n    \"medication_requests\": [\n      {\n        \"medication\": \"Testosterone Cypionate\",\n        \"dose\": \"200mg/ml\",\n        \"quantity\": 1,\n        \"refills\": \"3\",\n        \"direction\": \"Inject 0.5ml intramuscularly twice weekly\",\n        \"days_supply\": 30\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": true,\n  \"data\": {\n    \"medication_request_id\": \"880e8400-e29b-41d4-a716-446655440003\"\n  },\n  \"message\": \"Medication request created successfully\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"set-up-webhooks","__idx":6},"children":["Set Up Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Register a webhook to receive real-time notifications:"]},{"$$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  -H \"Accept: application/json\" \\\n  -d '{\n    \"clinic_id\": \"your-clinic-id-here\",\n    \"webhook_url\": \"https://your-server.com/webhooks/novamed\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": true,\n  \"data\": {\n    \"webhook_id\": \"bb0e8400-e29b-41d4-a716-446655440006\"\n  },\n  \"message\": \"Webhook created successfully\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"complete-integration-flow","__idx":7},"children":["Complete Integration Flow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Here's the typical integration workflow:"]},{"$$mdtype":"Tag","name":"ol","attributes":{"className":"workflow-list"},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Practitioner"]}," — Onboard prescribing practitioners"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Patient"]}," — Register patients with demographics and address"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Medication Request"]}," — Submit prescriptions for fulfillment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Register Webhook"]}," — Receive status updates automatically"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request Refills"]}," — Initiate refills for shipped medications"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":8},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/authentication"},"children":["Learn about authentication"]}]},{"$$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":"/guides/errors-idempotency"},"children":["Handle errors"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-reference"},"children":["Read the API reference"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-issues","__idx":9},"children":["Common Issues"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"401-unauthorized","__idx":10},"children":["401 Unauthorized"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your API key is missing or invalid. Verify:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The key is included in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-api-key"]}," header (lowercase)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The key hasn't been revoked"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You're using the correct environment"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"400-bad-request","__idx":11},"children":["400 Bad Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The request is invalid. Common causes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Missing required fields"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clinic_id"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invalid UUID format"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invalid email format"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"404-not-found","__idx":12},"children":["404 Not Found"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The resource doesn't exist. Check:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The resource ID is correct"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The resource belongs to your clinic"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You're using the correct environment"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"environment-urls","__idx":13},"children":["Environment 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":"Base URL"},"children":["Base URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","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":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://feapi.novamed.care"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Important"]},": Do not send PHI to the Development environment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"need-help","__idx":14},"children":["Need Help?"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-reference"},"children":["API Reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/errors-idempotency"},"children":["Error Handling Guide"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"mailto:api@nimbus-os.com"},"children":["Contact Support"]}]}]}]},"headings":[{"value":"Quickstart","id":"quickstart","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Get Your API Key","id":"get-your-api-key","depth":2},{"value":"Make Your First Request","id":"make-your-first-request","depth":2},{"value":"Create a Patient","id":"create-a-patient","depth":2},{"value":"Create a Medication Request","id":"create-a-medication-request","depth":2},{"value":"Set Up Webhooks","id":"set-up-webhooks","depth":2},{"value":"Complete Integration Flow","id":"complete-integration-flow","depth":2},{"value":"Next Steps","id":"next-steps","depth":2},{"value":"Common Issues","id":"common-issues","depth":2},{"value":"401 Unauthorized","id":"401-unauthorized","depth":3},{"value":"400 Bad Request","id":"400-bad-request","depth":3},{"value":"404 Not Found","id":"404-not-found","depth":3},{"value":"Environment URLs","id":"environment-urls","depth":2},{"value":"Need Help?","id":"need-help","depth":2}],"frontmatter":{"title":"Quickstart","description":"Get started with the NovaMed Partner API in minutes","seo":{"title":"Quickstart"}},"lastModified":"2026-01-12T13:39:25.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/quickstart","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}