Create a key so another system can read your inventory, connect another organization by code, and see what changes when you revoke either one.
API access lets another system — your own website, a partner’s software, an internal report — read your inventory straight out of ClinikEHR, without anyone exporting a file by hand. You choose exactly what it can see when you create the key, and you can switch it off at any moment.
What this tab controls
Control
What it does
Default
Allow API access
Master switch for the whole workspace. With it off, no key on this workspace can answer a request, even one you already created
Off
Create key
Opens the panel for a new key. Creating a key needs a session that has just passed your second factor; if yours has not, you are asked to verify first (Verify now), and if you have not set up two-factor you are taken to set it up. See Two-factor authentication
—
Key name, in the panel
A label so you can tell keys apart later — name it for the system that will use it, not for yourself
—
Permissions, in the panel
What this specific key is allowed to read. Every permission in this release is read-only — a key can look, never change anything. Inventory permissions are always offered; patient-record permissions (below) only once your clinic’s API add-on is active and you’ve accepted the API data agreement
None selected — choose what this key may read
Expires, in the panel
The date the key stops working on its own. Required, and at most 12 months from today
—
Allowed IP addresses, in the panel
Restricts this key to specific addresses or ranges. A request from any other address is refused, even with the right key. Leave it blank to allow any address
Any address
A key’s row (a card on a phone)
Opens a panel showing that key’s name, Key ID, every permission, when it was created, last used and expires, its allowed addresses and its status. The key itself is never shown there — it was shown once, when you created it
—
Revoke, next to a key or in that panel
Permanently disables that one key
—
Reading the list. The Permissions column shows the first two permissions and a badge such as +3 for the rest — select the row to see them all, grouped by what they cover. A phone shows each key as a card. Once you have more than ten keys, a footer lets you page through them and choose how many to show. A key never used reads Never used.What each inventory permission means:
Availability — whether an item is in stock, running low, or out. No exact numbers.
Catalogue — item names, strengths, forms, barcodes and prices.
Stock levels — exact quantities, by location and batch.
What each patient-record permission means (offered only once the API add-on below is active and you’ve accepted the API data agreement — greyed out, with the reason shown, until then; if your clinic requires two-factor authentication for staff, you must also complete it yourself before these are enabled for you):
Clinical notes — read / Clinical notes — draft only (a key can never sign, lock, or finalize a note)
Drug requests — read / Drug requests — create / cancel / confirm substitution
Dispensing history and flags — read (what was dispensed to a linked patient, and the refill and duplicate-dispensing flags recorded for them; never a price or another customer)
A key only ever sees what you selected for it. There is no permission in this release for your CRM, or for a sale’s price or total, or who served it.Your API settings and keys — never the secret itself — are included when you export this clinic’s data. See Data export.
Set it up
1
Turn on Allow API access
This alone does nothing visible yet — it just makes the rest of the tab available. No system can reach your data until you create a key.
2
Select Create key
This opens the key-creation panel.
3
Enter a Key name
Use something that will still make sense in six months — “Storefront stock widget”, not “Key 1”.
4
Choose Permissions
Nothing is selected to start — select only what the receiving system actually needs. A key that only shows a public “in stock” badge needs Availability alone, not Stock levels. Patient-record permissions appear in their own group below the inventory ones, enabled once the API add-on is active and the agreement is accepted.
5
Choose when the key expires
Every key needs an end date, and it can be at most 12 months away. Pick the date that suits the integration. For one you expect to keep running, choose the furthest date and create a replacement before it ends. We email the clinic’s owners and managers 30 days and 7 days before a key stops working.
6
Set Allowed IP addresses, if this key should only answer from specific places
Optional. Enter one address or range per line — for example 203.0.113.10 or 203.0.113.0/24. A range must be written exactly, starting at its own first address — 10.0.0.0/8, not 10.1.2.3/8. Leave it blank to allow any address.
7
Copy your key now
The dialog titled Copy your key now shows the full key exactly once. Select Copy key and paste it straight into the system that will use it.
The key is shown once, at creation, and never again. Treat it exactly like a password — anyone who has it can read whatever you selected under Permissions. Never paste it into a website’s public code or a mobile app’s code: anyone who views the page source or opens the app package can read it out. It belongs on a server you control, not in anything that reaches someone else’s browser or phone. If you close the dialog before copying it, revoke that key and create a new one — the secret cannot be shown again.
What changes once you save
Allow API access off stops every key on this workspace from answering requests, immediately — nothing is deleted, and turning it back on restores them all without recreating anything.
The list shows a masked key ID, never the key. Each row’s Key ID column reads like ehr_live_••••1234. Select the clipboard icon, Copy key ID, to copy the ID — it identifies the key to anyone helping you, but it cannot be used to call the API. The full key was shown once when you created it and cannot be shown again.
A new key can read only what you chose under Permissions for it, from this workspace’s own data. It shows in the list badged Active.
A key given Allowed IP addresses answers only requests from those addresses or ranges. A request from any other address is refused — even with the correct key — and does not use up anything on the key itself. Leave the field blank and the key answers from anywhere.
Select Revoke, then confirm Revoke key, and that key stops answering requests immediately. This cannot be undone — the key itself is gone for good, though nothing it already returned to another system is affected. If the same integration still needs access, create a new key and update it there.
If your plan drops below Team, every key on the workspace stops answering — the same as switching Allow API access off, but caused by the plan rather than the switch. A key that was Active stays badged Active; the plan is what refuses the request, not the key’s own status. Move back to Team or Enterprise and every key resumes working on its own, with nothing to recreate.
Check it worked
The new key appears in the list, named as you entered it, badged Active.
Its Allowed addresses column reads Any if you left the field blank, or a count such as 2 addresses — hold or select it to see the addresses themselves.
The first time the receiving system actually calls it, a last-used time appears against that key.
After Revoke and Revoke key, the badge changes to Revoked and the next request from that key is refused.
The clinic owner and the person who revoked the key get a notice in the app, and the owner gets an email with the subject An API key was revoked. It names the key, who revoked it and when, and never shows the key. Ozni can also revoke a key for you, after you type the key’s name to confirm.
A key is badged Expired once its Expires date has passed, and stops answering. It cannot be extended past 12 months — create a new key, switch the system that uses it, then revoke the old one. Keys created before this limit existed keep working until you revoke them; we recommend replacing them with a key that has an end date.
Connect another organization
A separate section, Connected organizations, is where another business — a partner’s software, a marketplace, a billing service — asks to connect to your data directly, instead of you handing them a key yourself. You are always the one who decides: nothing is ever granted automatically, and you choose exactly what to share, item by item.There is no directory or search for this — the other organization can only reach you if you give them a one-time code.
Control
What it does
Get a connection code
Opens a panel to generate a one-time code, valid for a length of time you choose (24 hours up to 14 days). Give this code to the other organization out of band — by phone, email, or however you already talk to them
Review, next to a pending request
Opens a panel showing what the organization is asking for. Nothing is selected to start — tick only what you want to grant, then select Approve, or select Decline
Manage, next to an active connection
Opens a panel to narrow what is granted, or to select Revoke
Only the clinic owner can generate a code, or approve, change, decline, or revoke a connection. A manager or a staff member granted the API access permission can still see this list — the panels and buttons are simply not there for them, with one sentence explaining why.
Set up a connection
1
Select Get a connection code
Choose how long the code should last, then select Generate code.
2
Copy the code and give it to the other organization
The dialog titled Give this code to the organization shows the code exactly once, grouped for reading aloud, with its expiry. Select Copy code, or read it aloud in the groups shown. It cannot be shown again — if you close the dialog before sending it, generate a new one.
3
Wait for their request to appear under Pending requests
The organization enters your code on their own side. Their request then appears here, with what they are asking for and why.
4
Select Review, then choose exactly what to grant
Nothing is selected to start. Tick only the items you want to share — you do not have to grant everything they asked for.
5
Select Approve, or select Decline
Approving moves the connection to Active with only what you ticked. Declining lets them try again later with a fresh code, and you may add a reason.
What changes once you decide
Approve grants exactly the items you ticked — never everything requested by default. The connection is badged Active. Approving, and changing what a connection may see, need a session that has just passed your second factor; if yours has not, you are asked to verify first. See Two-factor authentication.
Manage, then changing what is ticked and selecting Save changes, narrows what is shared at any time. To grant something new, the organization has to request it again.
Manage, then Revoke, then confirming Revoke connection ends that organization’s access immediately. This cannot be undone — if they need access again, they need a brand-new code from you.
A declined or revoked connection sits in a collapsed History section at the bottom of the list, so today’s view stays focused on what needs your attention.
Patient information is not part of any connection yet. A request may list it, but approving it has no effect today — the platform does not yet allow any key to read patient data, for any organization you connect. The API add-on below is different: it is about keys you create for your own systems, not about what you share with someone else’s.
Which patients an organization can reach
When a connection does eventually cover patient records, it will only ever reach patients you have specifically linked to it — never your whole patient list. From a connection’s Manage screen you will be able to link an existing patient, or end a link at any time; a patient the organization creates through its own systems is linked automatically. A recorded basis for sharing (for example, that the patient is the organization’s own enrollee) is required before any patient-data item can be approved at all.A patient’s own profile shows an External access card: which organizations are linked to that patient, since when, on what basis, and the last thing that was shared with them. While sharing is not switched on, the card says so and nothing can be received. Opening the card is recorded in your audit log.Patients can see this too. In the patient portal, Privacy & Security has a Who has received my records section listing each organization outside your clinic that received their information, the day, and the kind of record — never the information itself.To keep your own copy, go to Settings → Data Export and choose the API access group: Linked Patients and Disclosures.
Not available yet. Sharing a patient’s information with an outside organization stays off for every clinic until the platform’s own agreement with that organization is in place — the mechanism above is built, but nothing is shared today, regardless of what a connection lists.
Insurer links — tell us which connected organization is an insurer
This section appears only when your Insurance preference is set to Outside the US (Settings → General). It answers one question: which of your connected organizations is one of your insurers or HMOs.Until you link it, a connected organization is treated as a developer. It can send claims and pre-authorization requests for patients you have linked to it, but it cannot see any insurer’s claims, enrollees or plans, and it cannot vet a claim, decide a pre-authorization request or report a payment. Once you link it to an insurer, it can do those things for that insurer only and never for another insurer you work with. It still never sees a claim you have not submitted yet, or a request you have not sent.
Control
What it does
Link an insurer
Opens a panel. Choose a connected organization and one of your insurers, then select Link insurer. Only organizations you have already granted an insurance permission to are offered.
The bin icon, next to a link
Opens End this link. Select End link to stop that organization seeing the insurer’s information straight away. Nothing already recorded changes, and you can link it again later.
Only a clinic owner or manager can link or unlink. Someone with only the API access permission sees the list but no buttons.
Linking does not grant anything by itself. The organization still needs the insurance permissions you approved under Connected organizations, and the platform’s own checks for patient data still apply. A payment an insurer reports through the API is only a message to you: it never changes a claim or your payments. You record the money yourself under Record payment.
The API add-on — reach your own patient records
By default, a key you create can read your workspace’s own non-patient data. The API add-on is what will open everything else your own keys can reach: patients, appointments, clinical notes, your CRM, and your full inventory — still only with keys you create yourself, for your own systems. It does not change what a connected organization can see (that stays as described above, and above Team is available on the Pharmacy and Diagnostics Business plans too).
EvidenceMD needs the same two things. Using EvidenceMD, either as your note assistant or as a connected tool in Agent Studio, requires the add-on (or an Enterprise agreement) to be active and the current API data agreement to be accepted. If either is missing, EvidenceMD is refused with a message naming which one, and a connection you made earlier is kept, not deleted — it works again once both are in place.
Patient-record permissions become selectable in the key-creation panel once the add-on is active AND you’ve accepted the API data agreement below — both are required together. If your clinic requires two-factor authentication for staff, you must also be signed in with it completed before you can create a key carrying a patient-record permission.
Price
$250 a month (₦375,000), on top of your plan. Yearly: $2,400 (₦3,600,000)
Available on
Team, Business (Pharmacy and Diagnostics) — plans that already have API access. Enterprise includes everything the add-on opens, in your contract, at no extra charge, once it exists
Included use
2,000,000 requests a month; beyond that, $0.30 (₦450) per 1,000 requests — billed on your next invoice, never interrupted
Connected organizations
Up to 10, once you have the add-on (3 without it)
Before it’s bought
Nothing about this changes until you buy it — your existing keys keep working exactly as they do today
The add-on card sits above your keys in Settings → API access, and shows:
Section
What it shows
Usage this month
How many requests you have used against your included allowance, and a running estimate of any extra usage charge for the month so far — labelled as an estimate, since the month isn’t over
Status
Not bought, Active with your renewal date, Cancelling with the date access ends, Payment failed (access continues while you fix it), Payment failed — paused (every attempt failed; see below), or Ended
API data agreement
Shown once the wording is published — see below
1
Open Settings → API access
Same tab as your existing keys — the add-on card sits above the keys list.
2
Select Add API access
Choose Monthly or Yearly, then Continue to payment.
3
Complete checkout on the secure payment page
You’re taken to a page outside ClinikEHR to enter your payment details. Nothing is charged until you complete it there.
4
Return to Settings → API access
The card confirms your payment — this can take a few seconds. If it’s still confirming after a while, select Refresh, or check back shortly; nothing was charged if checkout was cancelled.
The API data agreement. Before any key — yours or an add-on customer’s — can reach patient records, the clinic owner must review and accept an agreement covering how the clinic’s own keys may be used and that AI-drafted content is reviewed by a clinician before it is saved. The card shows the full text, the version, and an Accept agreement checkbox and button for the owner. A newer version can replace an older acceptance, and the card asks again.Cancel ends the add-on at the close of the period you already paid for — your keys keep working as they do today until then, and existing keys are never deleted. Resume while cancelling keeps it renewing instead. Extra usage for a month is billed once, automatically, on your following bill. The add-on also appears in Billing → Other subscriptions, where you can cancel or resume it with the same effect.
Listing — get found by network partners
Available on any paid plan — Starter and above — unlike the rest of this tab, which needs Team or Enterprise. On any paid plan, you can list your pharmacy to a connected marketplace partner so it can be found and checked for availability — separate from everything above. Being listed shares only your public listing profile and a general availability band for each item (in stock, low, out of stock, or unknown) — never exact quantities, never prices unless you opt in, never your customers, and never your sales.
Control
What it does
Default
Edit listing profile / Set up listing profile
Opens the panel for your public name, address, phone, hours (shown as your clinic already has them, edited under Settings → General), and your map location
—
Map location, in the panel
Two fields, latitude and longitude — you place this yourself, or select Use my current location. It is never guessed from your address
Not set
Share prices, in the panel
Whether the prices you charge are included in what partners see
Off
Preview
Shows exactly what a partner would see, built from the same information a partner would actually get — never a separate, simplified copy
—
Get listed
Lists your pharmacy to a marketplace partner. Only becomes available once you have saved a listing profile and opened Preview
—
Browse integrations
Opens a list of every organization that has chosen to be found here, with what it does, a support contact, and links to its privacy policy and terms. Request connection on any of them asks you to confirm, exactly as Get listed does. Owners only
—
Un-list, next to a marketplace name
Stops that one marketplace from seeing your pharmacy
—
List with other branches
Lists every eligible pharmacy branch you own to the same marketplace at once
—
Hidden from listing
The categories and items you have withheld, with Restore to undo any of them
—
Only the clinic owner can save the listing profile, get listed, or un-list. A manager or a staff member with the API access permission can still preview, and manage what is hidden — the controls are simply not there for them, with one sentence explaining why.
Get listed
1
Select Set up listing profile
Fill in your pharmacy’s public name, address, and phone. Place your map location yourself — select Use my current location, or enter the coordinates by hand. Leave it blank rather than guess; a pharmacy with no location is still listed, just without a map pin.
2
Decide whether to share prices
Share prices is off by default. Anyone using a connected partner’s app — competitors included — will see any price you share.
3
Select Save
This does not list you yet — it only saves what a partner would see once you do.
4
Select Preview
Read through what a partner would actually see, and the note on what is never shared. Get listed stays unavailable until you have opened this.
5
Select Get listed
Confirm what becomes visible, and to whom.
Browse integrations is for choosing among several organizations rather than the one offered by name. Each entry shows a category (Marketplace, HMO / payer, Analytics, Logistics or Other) and, when the organization has supplied them, a description and links. If none are listed you’ll see No integrations are listed yet. A listing gives an organization no access by itself — Request connection shares only your listing profile and availability bands, never exact quantities, customers or sales, unless you turn on Share prices yourself.For a pharmacy with more than one branch under the same owner, List with other branches lists every eligible branch at once — a branch that is not on a paid plan, or has no saved profile, is skipped and shown as such, never listed silently.
Referred by a partner
If you signed up through a partner’s referral link, the partner’s listing request is waiting for you
in two places: on the Get started page the first time you open it, and at the top of this tab.
Either one shows a banner naming the partner and offering to review their request. Opening it shows
the same Preview you’d see setting up a listing yourself, with Approve and Not now as two
equal choices — neither is highlighted over the other. Approving lists your pharmacy to that partner
exactly as Get listed above does. Choosing Not now removes the banner and leaves a smaller
reminder on this tab, Partner listing request, with Review beside it, which you can come back
to any time.This tab also keeps a line, Introduced by, with the partner’s organization name, whether you
approved, chose Not now, or have not decided.Signing up through a partner never gives them anything on its own — no access, no connection, and
no listing. It only means we remember who introduced you. You can approve, decline, or ignore the
request, and you can use ClinikEHR whether or not you ever connect to that partner.
What changes once you save
Get listed makes your listing profile and item availability bands visible to that one marketplace partner — nothing else on this tab changes, and no other permission is granted.
Un-list takes effect on that partner’s next request. If you are listed to more than one marketplace, un-listing one leaves the others untouched.
Hiding a category or an item removes it from every listing immediately — a hidden item behaves exactly like one you do not stock, never shown as “hidden.”
Confirming which items are which medicine, and seeing which items have nothing partners can search on, both happen on the Inventory screen — see Get found by network partners.
Common issues
The tab shows an upgrade prompt instead of any settings
API access is included in the Team and Enterprise plans, and in Business and Enterprise on the Pharmacy and Diagnostics editions. On any other plan the tab shows an upgrade prompt — see Change your plan.
The tab says I need permission, and shows no settings
You need to be an owner, a manager, or a staff member specifically granted the API access permission. Ask an owner to grant it from Permissions.
I lost the key before I copied it
It cannot be shown again — that is deliberate. Revoke that key and create a new one for the same integration.
A key that worked yesterday stopped working, and nobody revoked it
Check your plan. Falling below Team pauses every key on the workspace without changing its badge. Moving back to Team or Enterprise restores it.
Can I bring back a key I revoked?
No — revoking is permanent. Create a new key with the same permissions and give the new one to the integration instead.
I need a permission that isn't listed
Inventory permissions (Availability, Catalogue, Stock levels) and patient-record permissions (Appointments, Patients, Clinical notes, Drug requests, Dispensing history and flags) exist in this release. CRM and sales permissions aren’t available yet.
Patient-record permissions are greyed out in the key-creation panel
Two separate things can cause this, and the panel names which: either your clinic’s API add-on isn’t active yet, or the current API data agreement hasn’t been accepted (the owner does this from the add-on card above) — or, if your clinic requires two-factor authentication for staff, you haven’t completed it yet this session. Buying the add-on and accepting the agreement clears the first two; signing in with two-factor clears the third.
A key that has the right permission still gets refused
Check its Allowed addresses column. If it shows a count rather than Any, the key only answers from those specific addresses or ranges — a request from anywhere else is refused, even though the key and its permissions are correct. Either send the request from an allowed address, or create a new key with no address restriction.
I don't see Get a connection code, or Review/Manage on a connection
Only the clinic owner can generate a code or act on a connection. If you are a manager or a staff member with the API access permission, you can still see the list — ask the owner to act, or to grant you ownership.
The other organization says the code doesn't work
A code works once, and it expires — check how long you set it for when you generated it. If it has already been used or has expired, select Get a connection code again and share the new one.
Connected organizations shows nothing
No organization has asked to connect yet. Nothing appears here until you give someone a code and they use it to send a request.
Get listed is greyed out
It stays unavailable until you have saved a listing profile and opened Preview at least once — the point is that you see exactly what will be shared before the button is even reachable. If it is still unavailable after that, check your plan: listing needs any paid plan, and you need to be the clinic owner to act on it.
I don't see a map location I can trust
The pin is placed by you — it is never filled in from your address automatically. Select Use my current location, or enter the coordinates yourself; select the map-check link next to the fields to confirm the point before saving.
I un-listed my pharmacy, but it's still listed to another marketplace
That’s expected if you are connected to more than one marketplace — un-listing affects only the one you selected. Repeat for each marketplace you want to stop being listed to.
List with other branches skipped one of my branches
A branch is skipped, and shown as such, when it is not on a paid plan or has no saved listing profile of its own — set that branch up the same way, then try again.
Add API access is missing from the API add-on card
Either the add-on is already active for this clinic, your plan isn’t eligible yet (it needs Team, or Business on the Pharmacy and Diagnostics editions), or you’re signed in as a staff member who isn’t an owner or manager — the card explains which, and states who can act.
The card says it's still confirming after I paid
This can take a few seconds while your payment is confirmed. Select Refresh, or check back shortly — nothing on this screen is charged twice, and the card never assumes the payment succeeded until it hears back.
My add-on shows Payment failed
Access continues — nothing is blocked. Update your payment method wherever you manage billing for this clinic, and the add-on returns to Active once the next payment goes through.
My add-on shows Payment failed — paused
Every payment attempt failed, so the add-on is paused. Nothing is deleted. The clinic owner opens Billing, finds the add-on under Other subscriptions, selects Pay open invoice and pays; the add-on comes back by itself. Managers see a note to ask the owner. You cannot buy a second add-on while one is paused — pay the open invoice first, or contact [email protected] to cancel it.
I don't see an agreement to accept
Only the clinic owner sees the Accept agreement control — a manager or staff member can see that an agreement exists but cannot act on it. If you are the owner and still don’t see it, refresh the page; the card always shows the current version once it loads.
My pharmacy sells through another point-of-sale — can it still be listed?
Not yet available. A setting to mark your pharmacy as selling through another system, and a way
to send in a stock feed from that system so your listed availability stays accurate, are both
still being finished. For now, listing works fully for pharmacies using ClinikEHR’s own till.
Can I invite someone to set up my catalogue without giving them full access?
Not yet available. A time-limited role for exactly this — set up your item list, locations, and
devices, with no access to sales, customers, or money — is planned but not on this screen yet.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ClinikEHR Help Center","description":"How-to guides for ClinikEHR — the AI-powered, HIPAA-compliant EHR for clinics, hospitals, pharmacies and diagnostic centres.","colors":{"primary":"#0D9488","light":"#2DD4BF","dark":"#0F766E"},"logo":{"light":"https://mintcdn.com/clinikehr/ch8sTdM1Y9zKp1JQ/logo/light.svg?fit=max\u0026auto=format\u0026n=ch8sTdM1Y9zKp1JQ\u0026q=85\u0026s=cfc319f5d968bbb63fcb9344a13ebf3d","dark":"https://mintcdn.com/clinikehr/ch8sTdM1Y9zKp1JQ/logo/dark.svg?fit=max\u0026auto=format\u0026n=ch8sTdM1Y9zKp1JQ\u0026q=85\u0026s=2447fdb2ff17c17fe0e522d739b8606f","href":"https://clinikehr.com"},"favicon":"https://mintcdn.com/clinikehr/ch8sTdM1Y9zKp1JQ/favicon.png?fit=max\u0026auto=format\u0026n=ch8sTdM1Y9zKp1JQ\u0026q=85\u0026s=618fbebcde498ae27a63567695d927e5","appearance":{"default":"system"},"navbar":{"links":[{"href":"https://docs.clinikehr.com","label":"API docs"},{"href":"https://status.clinikehr.com","label":"Status"},{"href":"mailto:[email protected]","label":"Contact support"}],"primary":{"type":"button","label":"Open ClinikEHR","href":"https://app.clinikehr.com"}},"footer":{"socials":{"website":"https://clinikehr.com","x":"https://x.com/clinikehr","linkedin":"https://www.linkedin.com/company/clinikehr"},"links":[{"header":"Product","items":[{"label":"ClinikEHR","href":"https://clinikehr.com"},{"label":"Pricing","href":"https://clinikehr.com/pricing"},{"label":"Patient portal","href":"https://client.clinikehr.com"}]},{"header":"Developers","items":[{"label":"API docs","href":"https://docs.clinikehr.com"},{"label":"Status","href":"https://status.clinikehr.com"}]},{"header":"Company","items":[{"label":"Contact support","href":"mailto:[email protected]"},{"label":"Privacy","href":"https://clinikehr.com/privacy"},{"label":"Terms","href":"https://clinikehr.com/terms"}]}]},"seo":{"metatags":{"og:site_name":"ClinikEHR Help Center"},"indexing":"navigable"},"fonts":{"family":"Geist"},"styling":{"eyebrows":"section","codeblocks":"system","latex":true},"integrations":{"posthog":{"apiKey":"phc_817t39VWvmzFeNxvLBBOVQM0CnsuX5INS2qERVGXmIY","apiHost":"https://eu.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clinikehr","hasAudioNarration":false,"actualSubdomain":"clinikehr","customDomains":["help.clinikehr.com"],"gitSource":{"type":"github","owner":"clinikehr","repo":"knowledge-base","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6afc8d7aef26627b6793c48f","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Hospital \u0026 Enterprise","count":124},{"language":"default","tag":"Solo \u0026 Team","count":112},{"language":"default","tag":"Platform","count":98},{"language":"default","tag":"Diagnostics","count":65},{"language":"default","tag":"Pharmacy","count":57},{"language":"default","tag":"Settings · Billing","count":22},{"language":"default","tag":"Settings · Practice","count":22},{"language":"default","tag":"Ozni, your assistant","count":21},{"language":"default","tag":"Every day","count":20},{"language":"default","tag":"Maternity","count":19}],"searchSettings":{"showContentSnippets":true,"maxResults":10}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--ck-teal-50: #f0fdfa;--ck-teal-100: #ccfbf1;--ck-teal-500: #14b8a6;--ck-teal-600: #0d9488;--ck-teal-700: #0f766e;--ck-surface: #ffffff;--ck-surface-muted: #f8fafc;--ck-border: #e2e8f0;--ck-text: #0f172a;--ck-text-muted: #64748b;--ck-edition-clinic: #0d9488;--ck-edition-pharmacy: #7c3aed;--ck-edition-lims: #0284c7;--ck-edition-portal: #db2777}.dark{--ck-surface: #0b1120;--ck-surface-muted: #111827;--ck-border: #1f2937;--ck-text: #e2e8f0;--ck-text-muted: #94a3b8;--ck-edition-clinic: #2dd4bf;--ck-edition-pharmacy: #a78bfa;--ck-edition-lims: #38bdf8;--ck-edition-portal: #f472b6}.ck-avail{display:flex;flex-wrap:wrap;align-items:center;gap:0.5rem;margin:1.25rem 0 1.75rem;padding:0.75rem 0.9rem;border:1px solid var(--ck-border);border-radius:0.75rem;background:var(--ck-surface-muted);font-size:0.8125rem;line-height:1.4}.ck-avail__label{font-weight:600;color:var(--ck-text-muted);text-transform:uppercase;letter-spacing:0.04em;font-size:0.6875rem;margin-right:0.15rem}.ck-pill{display:inline-flex;align-items:center;gap:0.35rem;padding:0.2rem 0.6rem;border-radius:999px;border:1px solid currentColor;font-weight:600;font-size:0.75rem;white-space:nowrap}.ck-pill--clinic{color:var(--ck-edition-clinic)}.ck-pill--pharmacy{color:var(--ck-edition-pharmacy)}.ck-pill--lims{color:var(--ck-edition-lims)}.ck-pill--portal{color:var(--ck-edition-portal)}.ck-pill--plan{color:var(--ck-text-muted);border-style:dashed}.ck-pill--role{color:var(--ck-text-muted);border-color:var(--ck-border);background:var(--ck-surface)}.ck-avail__note{flex-basis:100%;color:var(--ck-text-muted)}.ck-callout{margin:1.5rem 0;padding:0.9rem 1rem;border-radius:0.75rem;border:1px solid var(--ck-border);border-left-width:3px;background:var(--ck-surface-muted)}.ck-callout--note{border-left-color:var(--ck-teal-600)}.ck-callout--info{border-left-color:#6366f1}.dark .ck-callout--note{border-left-color:var(--ck-teal-500)}.dark .ck-callout--info{border-left-color:#818cf8}.ck-callout__body{margin:0;font-size:0.9375rem;line-height:1.6;color:var(--ck-text)}.ck-callout__body a{color:var(--ck-teal-700);text-decoration:underline;text-underline-offset:2px}.dark .ck-callout__body a{color:var(--ck-teal-500)}.ck-task{display:grid;gap:0.75rem;grid-template-columns:repeat(auto-fit, minmax(220px, 1fr));margin:1.5rem 0}.ck-task__cell{border:1px solid var(--ck-border);border-radius:0.75rem;padding:0.85rem 1rem;background:var(--ck-surface)}.ck-task__title{font-size:0.6875rem;font-weight:700;letter-spacing:0.06em;text-transform:uppercase;color:var(--ck-teal-600);margin-bottom:0.35rem}.dark .ck-task__title{color:var(--ck-teal-500)}.ck-task__body{font-size:0.875rem;color:var(--ck-text);margin:0}.ck-path{display:inline-flex;flex-wrap:wrap;align-items:center;gap:0.35rem;padding:0.3rem 0.6rem;border-radius:0.5rem;background:var(--ck-teal-50);border:1px solid var(--ck-teal-100);font-size:0.8125rem;font-weight:500;color:var(--ck-teal-700)}.dark .ck-path{background:rgba(13, 148, 136, 0.12);border-color:rgba(45, 212, 191, 0.28);color:var(--ck-teal-500)}.ck-path__sep{opacity:0.55}#sidebar li>a,#sidebar li>div{font-size:0.8125rem}#content-area a[href]>div.group,#content-area .card{transition:transform 150ms ease, box-shadow 150ms ease, border-color 150ms ease}#content-area a[href]:hover>div.group,#content-area .card:hover{transform:translateY(-2px);box-shadow:0 8px 24px -12px rgba(15, 23, 42, 0.25);border-color:var(--ck-teal-500)}.dark #content-area a[href]:hover>div.group,.dark #content-area .card:hover{box-shadow:0 8px 24px -12px rgba(0, 0, 0, 0.6)}#content-area table{display:block;overflow-x:auto;max-width:100%}#content-area thead th{font-size:0.75rem;text-transform:uppercase;letter-spacing:0.04em;color:var(--ck-text-muted)}#content-area .steps .step-number,#content-area [class*=\"step\"]>div[class*=\"rounded-full\"]{background-color:var(--ck-teal-600);color:#fff}@media (max-width: 768px){#content-area table{font-size:0.8125rem}#content-area th,#content-area td{padding-left:0.6rem;padding-right:0.6rem}}@media (max-width: 640px){.ck-avail{padding:0.6rem 0.7rem;gap:0.4rem;font-size:0.78rem}.ck-pill{padding:0.15rem 0.5rem;font-size:0.7rem}.ck-task{grid-template-columns:1fr;gap:0.5rem}.ck-task__cell{padding:0.7rem 0.85rem}.ck-path{font-size:0.78rem;line-height:1.9}.ck-callout{padding:0.75rem 0.85rem;margin:1.1rem 0}}@media (pointer: coarse){#content-area .card,#content-area a[href]>div.group{min-height:44px}#sidebar li>a{padding-top:0.45rem;padding-bottom:0.45rem}}"}],"page":{"pagePath":"platform/settings/api-access","slug":"/platform/settings/api-access","pageMetadata":{"title":"API access","description":"Create a key so another system can read your inventory, connect another organization by code, and see what changes when you revoke either one.","icon":"/images/icons/plug.svg","href":"/platform/settings/api-access"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a key so another system can read your inventory, connect another organization by code, and see what changes when you revoke either one.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const StillStuck=({topic})=>{const _components={a:`a`,..._provideComponents()};return _jsx(`div`,{className:`ck-callout ck-callout--note`,role:`note`,children:_jsxs(`p`,{className:`ck-callout__body`,children:[_jsxs(`strong`,{children:[`Still stuck`,topic?` with ${topic}`:``,`?`]}),` `,`Check `,_jsx(_components.a,{href:`/platform/help/troubleshooting`,children:`Troubleshooting`}),` first — it covers the failures we see most often. If that does not resolve it,`,` `,_jsx(_components.a,{href:`/platform/help/contact-support`,children:`contact support`}),` and include your workspace name and the time the problem happened, so we can find the matching entry in your audit log.`]})})};const TaskHeader=({before,time,after})=>_jsxs(`div`,{className:`ck-task`,children:[before?_jsxs(`div`,{className:`ck-task__cell`,children:[_jsx(`div`,{className:`ck-task__title`,children:`Before you start`}),_jsx(`p`,{className:`ck-task__body`,children:before})]}):null,time?_jsxs(`div`,{className:`ck-task__cell`,children:[_jsx(`div`,{className:`ck-task__title`,children:`Takes about`}),_jsx(`p`,{className:`ck-task__body`,children:time})]}):null,after?_jsxs(`div`,{className:`ck-task__cell`,children:[_jsx(`div`,{className:`ck-task__title`,children:`When you're done`}),_jsx(`p`,{className:`ck-task__body`,children:after})]}):null]});const Path=({steps=[]})=>_jsx(`span`,{className:`ck-path`,children:steps.map((s,i)=>_jsxs(`span`,{className:`ck-path__step`,children:[i>0?_jsx(`span`,{className:`ck-path__sep`,\"aria-hidden\":`true`,children:`›`}):null,s]},i))});const __snippet_EDITION_LABELS_uyx1hn={clinic:`Clinic \u0026 Hospital`,pharmacy:`Pharmacy`,lims:`Diagnostics`,portal:`Patient Portal`};const Availability=({editions=[`all`],plans,roles,note})=>{const list=editions.includes(`all`)?[`clinic`,`pharmacy`,`lims`]:editions;return _jsxs(`div`,{className:`ck-avail`,role:`note`,\"aria-label\":`Feature availability`,children:[_jsx(`span`,{className:`ck-avail__label`,children:`Available in`}),list.map(e=>_jsx(`span`,{className:`ck-pill ck-pill--${e}`,children:__snippet_EDITION_LABELS_uyx1hn[e]||e},e)),plans?_jsx(`span`,{className:`ck-avail__label`,children:`Plan`}):null,plans?_jsx(`span`,{className:`ck-pill ck-pill--plan`,children:plans}):null,roles?_jsx(`span`,{className:`ck-avail__label`,children:`Who`}):null,roles?_jsx(`span`,{className:`ck-pill ck-pill--role`,children:roles}):null,note?_jsx(`span`,{className:`ck-avail__note`,children:note}):null]})};function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,Heading,Info,Note,Step,Steps,Table,Warning,_MdxComponentBoundary}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`Availability`,children:_jsx(Availability,{editions:[`all`],plans:`Team and Enterprise — Business and Enterprise on the Pharmacy and Diagnostics editions`,roles:`Owner, manager, developer, CTO, or staff granted the API access permission`})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`API access`}),` lets another system — your own website, a partner’s software, an internal report — read your inventory straight out of ClinikEHR, without anyone exporting a file by hand. You choose exactly what it can see when you create the key, and you can switch it off at any moment.`]}),`\n`,_jsx(_MdxComponentBoundary,{name:`Path`,children:_jsx(Path,{steps:[`Sidebar`,`Settings`,`API access`]})}),`\n`,_jsx(_MdxComponentBoundary,{name:`TaskHeader`,children:_jsx(TaskHeader,{before:`A workspace on the Team or Enterprise plan`,time:`A few minutes`,after:`A key another system can use to read your inventory`})}),`\n`,_jsx(Heading,{level:`2`,id:`what-this-tab-controls`,children:`What this tab controls`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Control`}),_jsx(_components.th,{children:`What it does`}),_jsx(_components.th,{children:`Default`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Allow API access`})}),_jsx(_components.td,{children:`Master switch for the whole workspace. With it off, no key on this workspace can answer a request, even one you already created`}),_jsx(_components.td,{children:`Off`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Create key`})}),_jsxs(_components.td,{children:[`Opens the panel for a new key. Creating a key needs a session that has just passed your second factor; if yours has not, you are asked to verify first (`,_jsx(_components.strong,{children:`Verify now`}),`), and if you have not set up two-factor you are taken to set it up. See `,_jsx(_components.a,{href:`/platform/security/mfa#actions-that-always-ask-for-your-second-factor`,children:`Two-factor authentication`})]}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Key name`}),`, in the panel`]}),_jsx(_components.td,{children:`A label so you can tell keys apart later — name it for the system that will use it, not for yourself`}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Permissions`}),`, in the panel`]}),_jsxs(_components.td,{children:[`What this specific key is allowed to read. Every permission in this release is read-only — a key can look, never change anything. Inventory permissions are always offered; patient-record permissions (below) only once your clinic’s `,_jsx(_components.strong,{children:`API add-on`}),` is active and you’ve accepted the `,_jsx(_components.strong,{children:`API data agreement`})]}),_jsx(_components.td,{children:`None selected — choose what this key may read`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Expires`}),`, in the panel`]}),_jsx(_components.td,{children:`The date the key stops working on its own. Required, and at most 12 months from today`}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Allowed IP addresses`}),`, in the panel`]}),_jsx(_components.td,{children:`Restricts this key to specific addresses or ranges. A request from any other address is refused, even with the right key. Leave it blank to allow any address`}),_jsx(_components.td,{children:`Any address`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`A key’s row (a card on a phone)`}),_jsxs(_components.td,{children:[`Opens a panel showing that key’s name, `,_jsx(_components.strong,{children:`Key ID`}),`, every permission, when it was created, last used and expires, its allowed addresses and its status. The key itself is never shown there — it was shown once, when you created it`]}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Revoke`}),`, next to a key or in that panel`]}),_jsx(_components.td,{children:`Permanently disables that one key`}),_jsx(_components.td,{children:`—`})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reading the list.`}),` The `,_jsx(_components.strong,{children:`Permissions`}),` column shows the first two permissions and a badge such as `,_jsx(_components.strong,{children:`+3`}),` for the rest — select the row to see them all, grouped by what they cover. A phone shows each key as a card. Once you have more than ten keys, a footer lets you page through them and choose how many to show. A key never used reads `,_jsx(_components.strong,{children:`Never used`}),`.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`What each inventory permission means:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Availability`}),` — whether an item is in stock, running low, or out. No exact numbers.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Catalogue`}),` — item names, strengths, forms, barcodes and prices.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Stock levels`}),` — exact quantities, by location and batch.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What each patient-record permission means`}),` (offered only once the `,_jsx(_components.strong,{children:`API add-on`}),` below is active and you’ve accepted the API data agreement — greyed out, with the reason shown, until then; if your clinic requires two-factor authentication for staff, you must also complete it yourself before these are enabled for you):`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Appointments — read`}),` / `,_jsx(_components.strong,{children:`Appointments — book, reschedule, cancel`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Patients — read`}),` / `,_jsx(_components.strong,{children:`Patients — create / update`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Clinical notes — read`}),` / `,_jsx(_components.strong,{children:`Clinical notes — draft only`}),` (a key can never sign, lock, or finalize a note)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Drug requests — read`}),` / `,_jsx(_components.strong,{children:`Drug requests — create / cancel / confirm substitution`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Dispensing history and flags — read`}),` (what was dispensed to a linked patient, and the refill and duplicate-dispensing flags recorded for them; never a price or another customer)`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`A key only ever sees what you selected for it. There is no permission in this release for your CRM, or for a sale’s price or total, or who served it.`}),`\n`,_jsxs(_components.p,{children:[`Your API settings and keys — never the secret itself — are included when you export this clinic’s data. See `,_jsx(_components.a,{href:`/platform/security/data-export`,children:`Data export`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`set-it-up`,children:`Set it up`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Turn on Allow API access`,children:_jsx(_components.p,{children:`This alone does nothing visible yet — it just makes the rest of the tab available. No system can reach your data until you create a key.`})}),_jsx(Step,{title:`Select Create key`,children:_jsx(_components.p,{children:`This opens the key-creation panel.`})}),_jsx(Step,{title:`Enter a Key name`,children:_jsx(_components.p,{children:`Use something that will still make sense in six months — “Storefront stock widget”, not “Key 1”.`})}),_jsx(Step,{title:`Choose Permissions`,children:_jsxs(_components.p,{children:[`Nothing is selected to start — select only what the receiving system actually needs. A key that only shows a public “in stock” badge needs `,_jsx(_components.strong,{children:`Availability`}),` alone, not `,_jsx(_components.strong,{children:`Stock levels`}),`. Patient-record permissions appear in their own group below the inventory ones, enabled once the API add-on is active and the agreement is accepted.`]})}),_jsx(Step,{title:`Choose when the key expires`,children:_jsx(_components.p,{children:`Every key needs an end date, and it can be at most 12 months away. Pick the date that suits the integration. For one you expect to keep running, choose the furthest date and create a replacement before it ends. We email the clinic’s owners and managers 30 days and 7 days before a key stops working.`})}),_jsx(Step,{title:`Set Allowed IP addresses, if this key should only answer from specific places`,children:_jsxs(_components.p,{children:[`Optional. Enter one address or range per line — for example `,_jsx(_components.code,{children:`203.0.113.10`}),` or `,_jsx(_components.code,{children:`203.0.113.0/24`}),`. A range must be written exactly, starting at its own first address — `,_jsx(_components.code,{children:`10.0.0.0/8`}),`, not `,_jsx(_components.code,{children:`10.1.2.3/8`}),`. Leave it blank to allow any address.`]})}),_jsx(Step,{title:`Copy your key now`,children:_jsxs(_components.p,{children:[`The dialog titled `,_jsx(_components.strong,{children:`Copy your key now`}),` shows the full key exactly once. Select `,_jsx(_components.strong,{children:`Copy key`}),` and paste it straight into the system that will use it.`]})})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`The key is shown once, at creation, and never again.`}),` Treat it exactly like a password — anyone who has it can read whatever you selected under Permissions. Never paste it into a website’s public code or a mobile app’s code: anyone who views the page source or opens the app package can read it out. It belongs on a server you control, not in anything that reaches someone else’s browser or phone. If you close the dialog before copying it, revoke that key and create a new one — the secret cannot be shown again.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`what-changes-once-you-save`,children:`What changes once you save`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Allow API access off`}),` stops every key on this workspace from answering requests, immediately — nothing is deleted, and turning it back on restores them all without recreating anything.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`The list shows a masked key ID, never the key.`}),` Each row’s `,_jsx(_components.strong,{children:`Key ID`}),` column reads like `,_jsx(_components.code,{children:`ehr_live_••••1234`}),`. Select the clipboard icon, `,_jsx(_components.strong,{children:`Copy key ID`}),`, to copy the ID — it identifies the key to anyone helping you, but it cannot be used to call the API. The full key was shown once when you created it and cannot be shown again.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`A new key`}),` can read only what you chose under Permissions for it, from this workspace’s own data. It shows in the list badged `,_jsx(_components.strong,{children:`Active`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`A key given Allowed IP addresses`}),` answers only requests from those addresses or ranges. A request from any other address is refused — even with the correct key — and does not use up anything on the key itself. Leave the field blank and the key answers from anywhere.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Select Revoke, then confirm Revoke key`}),`, and that key stops answering requests immediately. This cannot be undone — the key itself is gone for good, though nothing it already returned to another system is affected. If the same integration still needs access, create a new key and update it there.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`If your plan drops below Team`}),`, every key on the workspace stops answering — the same as switching `,_jsx(_components.strong,{children:`Allow API access`}),` off, but caused by the plan rather than the switch. A key that was `,_jsx(_components.strong,{children:`Active`}),` stays badged `,_jsx(_components.strong,{children:`Active`}),`; the plan is what refuses the request, not the key’s own status. Move back to Team or Enterprise and every key resumes working on its own, with nothing to recreate.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`check-it-worked`,children:`Check it worked`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The new key appears in the list, named as you entered it, badged `,_jsx(_components.strong,{children:`Active`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Its `,_jsx(_components.strong,{children:`Allowed addresses`}),` column reads `,_jsx(_components.strong,{children:`Any`}),` if you left the field blank, or a count such as `,_jsx(_components.strong,{children:`2 addresses`}),` — hold or select it to see the addresses themselves.`]}),`\n`,_jsx(_components.li,{children:`The first time the receiving system actually calls it, a last-used time appears against that key.`}),`\n`,_jsxs(_components.li,{children:[`After `,_jsx(_components.strong,{children:`Revoke`}),` and `,_jsx(_components.strong,{children:`Revoke key`}),`, the badge changes to `,_jsx(_components.strong,{children:`Revoked`}),` and the next request from that key is refused.`]}),`\n`,_jsxs(_components.li,{children:[`The clinic owner and the person who revoked the key get a notice in the app, and the owner gets an email with the subject `,_jsx(_components.strong,{children:`An API key was revoked`}),`. It names the key, who revoked it and when, and never shows the key. `,_jsx(_components.a,{href:`/platform/ozni/api-access-and-webhooks`,children:`Ozni`}),` can also revoke a key for you, after you type the key’s name to confirm.`]}),`\n`,_jsxs(_components.li,{children:[`A key is badged `,_jsx(_components.strong,{children:`Expired`}),` once its `,_jsx(_components.strong,{children:`Expires`}),` date has passed, and stops answering. It cannot be extended past 12 months — create a new key, switch the system that uses it, then revoke the old one. Keys created before this limit existed keep working until you revoke them; we recommend replacing them with a key that has an end date.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`connect-another-organization`,children:`Connect another organization`}),`\n`,_jsxs(_components.p,{children:[`A separate section, `,_jsx(_components.strong,{children:`Connected organizations`}),`, is where another business — a partner’s software, a marketplace, a billing service — asks to connect to your data directly, instead of you handing them a key yourself. You are always the one who decides: nothing is ever granted automatically, and you choose exactly what to share, item by item.`]}),`\n`,_jsx(_components.p,{children:`There is no directory or search for this — the other organization can only reach you if you give them a one-time code.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Control`}),_jsx(_components.th,{children:`What it does`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Get a connection code`})}),_jsx(_components.td,{children:`Opens a panel to generate a one-time code, valid for a length of time you choose (24 hours up to 14 days). Give this code to the other organization out of band — by phone, email, or however you already talk to them`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Review`}),`, next to a pending request`]}),_jsxs(_components.td,{children:[`Opens a panel showing what the organization is asking for. Nothing is selected to start — tick only what you want to grant, then select `,_jsx(_components.strong,{children:`Approve`}),`, or select `,_jsx(_components.strong,{children:`Decline`})]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Manage`}),`, next to an active connection`]}),_jsxs(_components.td,{children:[`Opens a panel to narrow what is granted, or to select `,_jsx(_components.strong,{children:`Revoke`})]})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Only the clinic `,_jsx(_components.strong,{children:`owner`}),` can generate a code, or approve, change, decline, or revoke a connection. A manager or a staff member granted the API access permission can still see this list — the panels and buttons are simply not there for them, with one sentence explaining why.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`set-up-a-connection`,children:`Set up a connection`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Select Get a connection code`,children:_jsxs(_components.p,{children:[`Choose how long the code should last, then select `,_jsx(_components.strong,{children:`Generate code`}),`.`]})}),_jsx(Step,{title:`Copy the code and give it to the other organization`,children:_jsxs(_components.p,{children:[`The dialog titled `,_jsx(_components.strong,{children:`Give this code to the organization`}),` shows the code exactly once, grouped for reading aloud, with its expiry. Select `,_jsx(_components.strong,{children:`Copy code`}),`, or read it aloud in the groups shown. It cannot be shown again — if you close the dialog before sending it, generate a new one.`]})}),_jsx(Step,{title:`Wait for their request to appear under Pending requests`,children:_jsx(_components.p,{children:`The organization enters your code on their own side. Their request then appears here, with what they are asking for and why.`})}),_jsx(Step,{title:`Select Review, then choose exactly what to grant`,children:_jsx(_components.p,{children:`Nothing is selected to start. Tick only the items you want to share — you do not have to grant everything they asked for.`})}),_jsx(Step,{title:`Select Approve, or select Decline`,children:_jsxs(_components.p,{children:[`Approving moves the connection to `,_jsx(_components.strong,{children:`Active`}),` with only what you ticked. Declining lets them try again later with a fresh code, and you may add a reason.`]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`what-changes-once-you-decide`,children:`What changes once you decide`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Approve`}),` grants exactly the items you ticked — never everything requested by default. The connection is badged `,_jsx(_components.strong,{children:`Active`}),`. Approving, and changing what a connection may see, need a session that has just passed your second factor; if yours has not, you are asked to verify first. See `,_jsx(_components.a,{href:`/platform/security/mfa#actions-that-always-ask-for-your-second-factor`,children:`Two-factor authentication`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Manage`}),`, then changing what is ticked and selecting `,_jsx(_components.strong,{children:`Save changes`}),`, narrows what is shared at any time. To grant something new, the organization has to request it again.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Manage`}),`, then `,_jsx(_components.strong,{children:`Revoke`}),`, then confirming `,_jsx(_components.strong,{children:`Revoke connection`}),` ends that organization’s access immediately. This cannot be undone — if they need access again, they need a brand-new code from you.`]}),`\n`,_jsxs(_components.li,{children:[`A declined or revoked connection sits in a collapsed `,_jsx(_components.strong,{children:`History`}),` section at the bottom of the list, so today’s view stays focused on what needs your attention.`]}),`\n`]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Patient information is not part of any connection yet. A request may list it, but approving it has no effect today — the platform does not yet allow any key to read patient data, for any `,_jsx(_components.strong,{children:`organization`}),` you connect. The `,_jsx(_components.strong,{children:`API add-on`}),` below is different: it is about keys `,_jsx(_components.strong,{children:`you`}),` create for your own systems, not about what you share with someone else’s.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`which-patients-an-organization-can-reach`,children:`Which patients an organization can reach`}),`\n`,_jsxs(_components.p,{children:[`When a connection does eventually cover patient records, it will only ever reach patients you have specifically `,_jsx(_components.strong,{children:`linked`}),` to it — never your whole patient list. From a connection’s `,_jsx(_components.strong,{children:`Manage`}),` screen you will be able to link an existing patient, or end a link at any time; a patient the organization creates through its own systems is linked automatically. A recorded `,_jsx(_components.strong,{children:`basis`}),` for sharing (for example, that the patient is the organization’s own enrollee) is required before any patient-data item can be approved at all.`]}),`\n`,_jsxs(_components.p,{children:[`A patient’s own profile shows an `,_jsx(_components.strong,{children:`External access`}),` card: which organizations are linked to that patient, since when, on what basis, and the last thing that was shared with them. While sharing is not switched on, the card says so and nothing can be received. Opening the card is recorded in your audit log.`]}),`\n`,_jsxs(_components.p,{children:[`Patients can see this too. In the patient portal, `,_jsx(_components.strong,{children:`Privacy \u0026 Security`}),` has a `,_jsx(_components.strong,{children:`Who has received my records`}),` section listing each organization outside your clinic that received their information, the day, and the kind of record — never the information itself.`]}),`\n`,_jsxs(_components.p,{children:[`To keep your own copy, go to `,_jsx(_components.strong,{children:`Settings`}),` → `,_jsx(_components.strong,{children:`Data Export`}),` and choose the `,_jsx(_components.strong,{children:`API access`}),` group: `,_jsx(_components.strong,{children:`Linked Patients`}),` and `,_jsx(_components.strong,{children:`Disclosures`}),`.`]}),`\n`,_jsx(Info,{children:_jsx(_components.p,{children:`Not available yet. Sharing a patient’s information with an outside organization stays off for every clinic until the platform’s own agreement with that organization is in place — the mechanism above is built, but nothing is shared today, regardless of what a connection lists.`})}),`\n`,_jsx(Heading,{level:`2`,id:`insurer-links-—-tell-us-which-connected-organization-is-an-insurer`,children:`Insurer links — tell us which connected organization is an insurer`}),`\n`,_jsxs(_components.p,{children:[`This section appears only when your `,_jsx(_components.strong,{children:`Insurance`}),` preference is set to `,_jsx(_components.strong,{children:`Outside the US`}),` (`,_jsx(_components.strong,{children:`Settings`}),` → `,_jsx(_components.strong,{children:`General`}),`). It answers one question: which of your connected organizations `,_jsx(_components.strong,{children:`is`}),` one of your insurers or HMOs.`]}),`\n`,_jsxs(_components.p,{children:[`Until you link it, a connected organization is treated as a developer. It can send claims and pre-authorization requests for patients you have linked to it, but it cannot see any insurer’s claims, enrollees or plans, and it cannot vet a claim, decide a pre-authorization request or report a payment. Once you link it to an insurer, it can do those things `,_jsx(_components.strong,{children:`for that insurer only`}),` and never for another insurer you work with. It still never sees a claim you have not submitted yet, or a request you have not sent.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Control`}),_jsx(_components.th,{children:`What it does`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Link an insurer`})}),_jsxs(_components.td,{children:[`Opens a panel. Choose a connected organization and one of your insurers, then select `,_jsx(_components.strong,{children:`Link insurer`}),`. Only organizations you have already granted an insurance permission to are offered.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`The bin icon, next to a link`}),_jsxs(_components.td,{children:[`Opens `,_jsx(_components.strong,{children:`End this link`}),`. Select `,_jsx(_components.strong,{children:`End link`}),` to stop that organization seeing the insurer’s information straight away. Nothing already recorded changes, and you can link it again later.`]})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Only a clinic `,_jsx(_components.strong,{children:`owner`}),` or `,_jsx(_components.strong,{children:`manager`}),` can link or unlink. Someone with only the API access permission sees the list but no buttons.`]})}),`\n`,_jsxs(_components.p,{children:[`Linking does not grant anything by itself. The organization still needs the insurance permissions you approved under `,_jsx(_components.strong,{children:`Connected organizations`}),`, and the platform’s own checks for patient data still apply. A payment an insurer reports through the API is only a message to you: it never changes a claim or your payments. You record the money yourself under `,_jsx(_components.strong,{children:`Record payment`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`the-api-add-on-—-reach-your-own-patient-records`,children:`The API add-on — reach your own patient records`}),`\n`,_jsxs(_components.p,{children:[`By default, a key you create can read your workspace’s own non-patient data. The `,_jsx(_components.strong,{children:`API add-on`}),` is what will open everything else your own keys can reach: patients, appointments, clinical notes, your CRM, and your full inventory — still only with keys you create yourself, for your own systems. It does not change what a connected `,_jsx(_components.strong,{children:`organization`}),` can see (that stays as described above, and above Team is available on the Pharmacy and Diagnostics Business plans too).`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`EvidenceMD needs the same two things.`}),` Using EvidenceMD, either as your note assistant or as a connected tool in Agent Studio, requires the add-on (or an Enterprise agreement) to be active `,_jsx(_components.strong,{children:`and`}),` the current API data agreement to be accepted. If either is missing, EvidenceMD is refused with a message naming which one, and a connection you made earlier is kept, not deleted — it works again once both are in place.`]})}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Patient-record permissions become selectable in the key-creation panel once the add-on is active AND you’ve accepted the API data agreement below — both are required together. If your clinic requires two-factor authentication for staff, you must also be signed in with it completed before you can create a key carrying a patient-record permission.`})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Price`})}),_jsx(_components.td,{children:`$250 a month (₦375,000), on top of your plan. Yearly: $2,400 (₦3,600,000)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Available on`})}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Team`}),`, `,_jsx(_components.strong,{children:`Business`}),` (Pharmacy and Diagnostics) — plans that already have API access. Enterprise includes everything the add-on opens, in your contract, at no extra charge, once it exists`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Included use`})}),_jsx(_components.td,{children:`2,000,000 requests a month; beyond that, $0.30 (₦450) per 1,000 requests — billed on your next invoice, never interrupted`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Connected organizations`})}),_jsx(_components.td,{children:`Up to 10, once you have the add-on (3 without it)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Before it’s bought`})}),_jsx(_components.td,{children:`Nothing about this changes until you buy it — your existing keys keep working exactly as they do today`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`The add-on card sits above your keys in `,_jsx(_components.strong,{children:`Settings → API access`}),`, and shows:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Section`}),_jsx(_components.th,{children:`What it shows`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Usage this month`})}),_jsx(_components.td,{children:`How many requests you have used against your included allowance, and a running estimate of any extra usage charge for the month so far — labelled as an estimate, since the month isn’t over`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Status`})}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Not bought`}),`, `,_jsx(_components.strong,{children:`Active`}),` with your renewal date, `,_jsx(_components.strong,{children:`Cancelling`}),` with the date access ends, `,_jsx(_components.strong,{children:`Payment failed`}),` (access continues while you fix it), `,_jsx(_components.strong,{children:`Payment failed — paused`}),` (every attempt failed; see below), or `,_jsx(_components.strong,{children:`Ended`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`API data agreement`})}),_jsx(_components.td,{children:`Shown once the wording is published — see below`})]})]})]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Open Settings → API access`,children:_jsx(_components.p,{children:`Same tab as your existing keys — the add-on card sits above the keys list.`})}),_jsx(Step,{title:`Select Add API access`,children:_jsxs(_components.p,{children:[`Choose `,_jsx(_components.strong,{children:`Monthly`}),` or `,_jsx(_components.strong,{children:`Yearly`}),`, then `,_jsx(_components.strong,{children:`Continue to payment`}),`.`]})}),_jsx(Step,{title:`Complete checkout on the secure payment page`,children:_jsx(_components.p,{children:`You’re taken to a page outside ClinikEHR to enter your payment details. Nothing is charged until you complete it there.`})}),_jsx(Step,{title:`Return to Settings → API access`,children:_jsxs(_components.p,{children:[`The card confirms your payment — this can take a few seconds. If it’s still confirming after a while, select `,_jsx(_components.strong,{children:`Refresh`}),`, or check back shortly; nothing was charged if checkout was cancelled.`]})})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`The API data agreement.`}),` Before any key — yours or an add-on customer’s — can reach patient records, the clinic `,_jsx(_components.strong,{children:`owner`}),` must review and accept an agreement covering how the clinic’s own keys may be used and that AI-drafted content is reviewed by a clinician before it is saved. The card shows the full text, the version, and an `,_jsx(_components.strong,{children:`Accept agreement`}),` checkbox and button for the owner. A newer version can replace an older acceptance, and the card asks again.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Cancel`}),` ends the add-on at the close of the period you already paid for — your keys keep working as they do today until then, and existing keys are never deleted. `,_jsx(_components.strong,{children:`Resume`}),` while cancelling keeps it renewing instead. Extra usage for a month is billed once, automatically, on your following bill. The add-on also appears in `,_jsx(_components.strong,{children:`Billing → Other subscriptions`}),`, where you can cancel or resume it with the same effect.`]}),`\n`,_jsx(Heading,{level:`2`,id:`listing-—-get-found-by-network-partners`,children:`Listing — get found by network partners`}),`\n`,_jsxs(_components.p,{children:[`Available on `,_jsx(_components.strong,{children:`any paid plan`}),` — Starter and above — unlike the rest of this tab, which needs Team or Enterprise. On any paid plan, you can list your pharmacy to a connected marketplace partner so it can be found and checked for availability — separate from everything above. Being listed shares `,_jsx(_components.strong,{children:`only`}),` your public listing profile and a general availability band for each item (in stock, low, out of stock, or unknown) — never exact quantities, never prices unless you opt in, never your customers, and never your sales.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Control`}),_jsx(_components.th,{children:`What it does`}),_jsx(_components.th,{children:`Default`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Edit listing profile`}),` / `,_jsx(_components.strong,{children:`Set up listing profile`})]}),_jsxs(_components.td,{children:[`Opens the panel for your public name, address, phone, hours (shown as your clinic already has them, edited under `,_jsx(_components.strong,{children:`Settings → General`}),`), and your map location`]}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Map location`}),`, in the panel`]}),_jsxs(_components.td,{children:[`Two fields, latitude and longitude — you place this yourself, or select `,_jsx(_components.strong,{children:`Use my current location`}),`. It is never guessed from your address`]}),_jsx(_components.td,{children:`Not set`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Share prices`}),`, in the panel`]}),_jsx(_components.td,{children:`Whether the prices you charge are included in what partners see`}),_jsx(_components.td,{children:`Off`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Preview`})}),_jsx(_components.td,{children:`Shows exactly what a partner would see, built from the same information a partner would actually get — never a separate, simplified copy`}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Get listed`})}),_jsxs(_components.td,{children:[`Lists your pharmacy to a marketplace partner. Only becomes available once you have saved a listing profile and opened `,_jsx(_components.strong,{children:`Preview`})]}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Browse integrations`})}),_jsxs(_components.td,{children:[`Opens a list of every organization that has chosen to be found here, with what it does, a support contact, and links to its privacy policy and terms. `,_jsx(_components.strong,{children:`Request connection`}),` on any of them asks you to confirm, exactly as `,_jsx(_components.strong,{children:`Get listed`}),` does. Owners only`]}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Un-list`}),`, next to a marketplace name`]}),_jsx(_components.td,{children:`Stops that one marketplace from seeing your pharmacy`}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`List with other branches`})}),_jsx(_components.td,{children:`Lists every eligible pharmacy branch you own to the same marketplace at once`}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Hidden from listing`})}),_jsxs(_components.td,{children:[`The categories and items you have withheld, with `,_jsx(_components.strong,{children:`Restore`}),` to undo any of them`]}),_jsx(_components.td,{children:`—`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Only the clinic `,_jsx(_components.strong,{children:`owner`}),` can save the listing profile, get listed, or un-list. A manager or a staff member with the API access permission can still preview, and manage what is hidden — the controls are simply not there for them, with one sentence explaining why.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`get-listed`,children:`Get listed`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Select Set up listing profile`,children:_jsxs(_components.p,{children:[`Fill in your pharmacy’s public name, address, and phone. Place your `,_jsx(_components.strong,{children:`map location`}),` yourself — select `,_jsx(_components.strong,{children:`Use my current location`}),`, or enter the coordinates by hand. Leave it blank rather than guess; a pharmacy with no location is still listed, just without a map pin.`]})}),_jsx(Step,{title:`Decide whether to share prices`,children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Share prices`}),` is off by default. Anyone using a connected partner’s app — competitors included — will see any price you share.`]})}),_jsx(Step,{title:`Select Save`,children:_jsx(_components.p,{children:`This does not list you yet — it only saves what a partner would see once you do.`})}),_jsx(Step,{title:`Select Preview`,children:_jsxs(_components.p,{children:[`Read through what a partner would actually see, and the note on what is never shared. `,_jsx(_components.strong,{children:`Get listed`}),` stays unavailable until you have opened this.`]})}),_jsx(Step,{title:`Select Get listed`,children:_jsx(_components.p,{children:`Confirm what becomes visible, and to whom.`})})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Browse integrations`}),` is for choosing among several organizations rather than the one offered by name. Each entry shows a category (`,_jsx(_components.strong,{children:`Marketplace`}),`, `,_jsx(_components.strong,{children:`HMO / payer`}),`, `,_jsx(_components.strong,{children:`Analytics`}),`, `,_jsx(_components.strong,{children:`Logistics`}),` or `,_jsx(_components.strong,{children:`Other`}),`) and, when the organization has supplied them, a description and links. If none are listed you’ll see `,_jsx(_components.strong,{children:`No integrations are listed yet.`}),` A listing gives an organization no access by itself — `,_jsx(_components.strong,{children:`Request connection`}),` shares only your listing profile and availability bands, never exact quantities, customers or sales, unless you turn on `,_jsx(_components.strong,{children:`Share prices`}),` yourself.`]}),`\n`,_jsxs(_components.p,{children:[`For a pharmacy with more than one branch under the same owner, `,_jsx(_components.strong,{children:`List with other branches`}),` lists every eligible branch at once — a branch that is not on a paid plan, or has no saved profile, is skipped and shown as such, never listed silently.`]}),`\n`,_jsx(Heading,{level:`3`,id:`referred-by-a-partner`,children:`Referred by a partner`}),`\n`,_jsxs(_components.p,{children:[`If you signed up through a partner’s referral link, the partner’s listing request is waiting for you\nin two places: on the `,_jsx(_components.strong,{children:`Get started`}),` page the first time you open it, and at the top of this tab.\nEither one shows a banner naming the partner and offering to review their request. Opening it shows\nthe same `,_jsx(_components.strong,{children:`Preview`}),` you’d see setting up a listing yourself, with `,_jsx(_components.strong,{children:`Approve`}),` and `,_jsx(_components.strong,{children:`Not now`}),` as two\nequal choices — neither is highlighted over the other. Approving lists your pharmacy to that partner\nexactly as `,_jsx(_components.strong,{children:`Get listed`}),` above does. Choosing `,_jsx(_components.strong,{children:`Not now`}),` removes the banner and leaves a smaller\nreminder on this tab, `,_jsx(_components.strong,{children:`Partner listing request`}),`, with `,_jsx(_components.strong,{children:`Review`}),` beside it, which you can come back\nto any time.`]}),`\n`,_jsxs(_components.p,{children:[`This tab also keeps a line, `,_jsx(_components.strong,{children:`Introduced by`}),`, with the partner’s organization name, whether you\napproved, chose `,_jsx(_components.strong,{children:`Not now`}),`, or have not decided.`]}),`\n`,_jsx(_components.p,{children:`Signing up through a partner never gives them anything on its own — no access, no connection, and\nno listing. It only means we remember who introduced you. You can approve, decline, or ignore the\nrequest, and you can use ClinikEHR whether or not you ever connect to that partner.`}),`\n`,_jsx(Heading,{level:`3`,id:`what-changes-once-you-save-2`,children:`What changes once you save`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Get listed`}),` makes your listing profile and item availability bands visible to that one marketplace partner — nothing else on this tab changes, and no other permission is granted.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Un-list`}),` takes effect on that partner’s next request. If you are listed to more than one marketplace, un-listing one leaves the others untouched.`]}),`\n`,_jsx(_components.li,{children:`Hiding a category or an item removes it from every listing immediately — a hidden item behaves exactly like one you do not stock, never shown as “hidden.”`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Confirming which items are which medicine, and seeing which items have nothing partners can search on, both happen on the `,_jsx(_components.strong,{children:`Inventory`}),` screen — see `,_jsx(_components.a,{href:`/pharmacy/inventory/listing`,children:`Get found by network partners`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`common-issues`,children:`Common issues`}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`The tab shows an upgrade prompt instead of any settings`,id:`the-tab-shows-an-upgrade-prompt-instead-of-any-settings`,children:_jsxs(_components.p,{children:[`API access is included in the `,_jsx(_components.strong,{children:`Team`}),` and `,_jsx(_components.strong,{children:`Enterprise`}),` plans, and in `,_jsx(_components.strong,{children:`Business`}),` and `,_jsx(_components.strong,{children:`Enterprise`}),` on the Pharmacy and Diagnostics editions. On any other plan the tab shows an upgrade prompt — see `,_jsx(_components.a,{href:`/platform/plans/change-plan`,children:`Change your plan`}),`.`]})}),_jsx(Accordion,{title:`The tab says I need permission, and shows no settings`,id:`the-tab-says-i-need-permission-and-shows-no-settings`,children:_jsxs(_components.p,{children:[`You need to be an owner, a manager, or a staff member specifically granted the API access permission. Ask an owner to grant it from `,_jsx(_components.a,{href:`/platform/team/permissions`,children:`Permissions`}),`.`]})}),_jsx(Accordion,{title:`I lost the key before I copied it`,id:`i-lost-the-key-before-i-copied-it`,children:_jsx(_components.p,{children:`It cannot be shown again — that is deliberate. Revoke that key and create a new one for the same integration.`})}),_jsx(Accordion,{title:`A key that worked yesterday stopped working, and nobody revoked it`,id:`a-key-that-worked-yesterday-stopped-working-and-nobody-revoked-it`,children:_jsx(_components.p,{children:`Check your plan. Falling below Team pauses every key on the workspace without changing its badge. Moving back to Team or Enterprise restores it.`})}),_jsx(Accordion,{title:`Can I bring back a key I revoked?`,id:`can-i-bring-back-a-key-i-revoked`,children:_jsx(_components.p,{children:`No — revoking is permanent. Create a new key with the same permissions and give the new one to the integration instead.`})}),_jsx(Accordion,{title:`I need a permission that isn't listed`,id:`i-need-a-permission-that-isnt-listed`,children:_jsx(_components.p,{children:`Inventory permissions (Availability, Catalogue, Stock levels) and patient-record permissions (Appointments, Patients, Clinical notes, Drug requests, Dispensing history and flags) exist in this release. CRM and sales permissions aren’t available yet.`})}),_jsx(Accordion,{title:`Patient-record permissions are greyed out in the key-creation panel`,id:`patient-record-permissions-are-greyed-out-in-the-key-creation-panel`,children:_jsx(_components.p,{children:`Two separate things can cause this, and the panel names which: either your clinic’s API add-on isn’t active yet, or the current API data agreement hasn’t been accepted (the owner does this from the add-on card above) — or, if your clinic requires two-factor authentication for staff, you haven’t completed it yet this session. Buying the add-on and accepting the agreement clears the first two; signing in with two-factor clears the third.`})}),_jsx(Accordion,{title:`A key that has the right permission still gets refused`,id:`a-key-that-has-the-right-permission-still-gets-refused`,children:_jsxs(_components.p,{children:[`Check its `,_jsx(_components.strong,{children:`Allowed addresses`}),` column. If it shows a count rather than `,_jsx(_components.strong,{children:`Any`}),`, the key only answers from those specific addresses or ranges — a request from anywhere else is refused, even though the key and its permissions are correct. Either send the request from an allowed address, or create a new key with no address restriction.`]})}),_jsx(Accordion,{title:`I don't see Get a connection code, or Review/Manage on a connection`,id:`i-dont-see-get-a-connection-code-or-review-manage-on-a-connection`,children:_jsx(_components.p,{children:`Only the clinic owner can generate a code or act on a connection. If you are a manager or a staff member with the API access permission, you can still see the list — ask the owner to act, or to grant you ownership.`})}),_jsx(Accordion,{title:`The other organization says the code doesn't work`,id:`the-other-organization-says-the-code-doesnt-work`,children:_jsxs(_components.p,{children:[`A code works once, and it expires — check how long you set it for when you generated it. If it has already been used or has expired, select `,_jsx(_components.strong,{children:`Get a connection code`}),` again and share the new one.`]})}),_jsx(Accordion,{title:`Connected organizations shows nothing`,id:`connected-organizations-shows-nothing`,children:_jsx(_components.p,{children:`No organization has asked to connect yet. Nothing appears here until you give someone a code and they use it to send a request.`})}),_jsx(Accordion,{title:`Get listed is greyed out`,id:`get-listed-is-greyed-out`,children:_jsxs(_components.p,{children:[`It stays unavailable until you have saved a listing profile and opened `,_jsx(_components.strong,{children:`Preview`}),` at least once — the point is that you see exactly what will be shared before the button is even reachable. If it is still unavailable after that, check your plan: listing needs any paid plan, and you need to be the clinic owner to act on it.`]})}),_jsx(Accordion,{title:`I don't see a map location I can trust`,id:`i-dont-see-a-map-location-i-can-trust`,children:_jsxs(_components.p,{children:[`The pin is placed by you — it is never filled in from your address automatically. Select `,_jsx(_components.strong,{children:`Use my current location`}),`, or enter the coordinates yourself; select the map-check link next to the fields to confirm the point before saving.`]})}),_jsx(Accordion,{title:`I un-listed my pharmacy, but it's still listed to another marketplace`,id:`i-un-listed-my-pharmacy-but-its-still-listed-to-another-marketplace`,children:_jsx(_components.p,{children:`That’s expected if you are connected to more than one marketplace — un-listing affects only the one you selected. Repeat for each marketplace you want to stop being listed to.`})}),_jsx(Accordion,{title:`List with other branches skipped one of my branches`,id:`list-with-other-branches-skipped-one-of-my-branches`,children:_jsx(_components.p,{children:`A branch is skipped, and shown as such, when it is not on a paid plan or has no saved listing profile of its own — set that branch up the same way, then try again.`})}),_jsx(Accordion,{title:`Add API access is missing from the API add-on card`,id:`add-api-access-is-missing-from-the-api-add-on-card`,children:_jsx(_components.p,{children:`Either the add-on is already active for this clinic, your plan isn’t eligible yet (it needs Team, or Business on the Pharmacy and Diagnostics editions), or you’re signed in as a staff member who isn’t an owner or manager — the card explains which, and states who can act.`})}),_jsx(Accordion,{title:`The card says it's still confirming after I paid`,id:`the-card-says-its-still-confirming-after-i-paid`,children:_jsxs(_components.p,{children:[`This can take a few seconds while your payment is confirmed. Select `,_jsx(_components.strong,{children:`Refresh`}),`, or check back shortly — nothing on this screen is charged twice, and the card never assumes the payment succeeded until it hears back.`]})}),_jsx(Accordion,{title:`My add-on shows Payment failed`,id:`my-add-on-shows-payment-failed`,children:_jsxs(_components.p,{children:[`Access continues — nothing is blocked. Update your payment method wherever you manage billing for this clinic, and the add-on returns to `,_jsx(_components.strong,{children:`Active`}),` once the next payment goes through.`]})}),_jsx(Accordion,{title:`My add-on shows Payment failed — paused`,id:`my-add-on-shows-payment-failed-paused`,children:_jsxs(_components.p,{children:[`Every payment attempt failed, so the add-on is paused. Nothing is deleted. The clinic `,_jsx(_components.strong,{children:`owner`}),` opens `,_jsx(_components.strong,{children:`Billing`}),`, finds the add-on under `,_jsx(_components.strong,{children:`Other subscriptions`}),`, selects `,_jsx(_components.strong,{children:`Pay open invoice`}),` and pays; the add-on comes back by itself. Managers see a note to ask the owner. You cannot buy a second add-on while one is paused — pay the open invoice first, or contact `,_jsx(_components.a,{href:`mailto:[email protected]`,children:`[email protected]`}),` to cancel it.`]})}),_jsx(Accordion,{title:`I don't see an agreement to accept`,id:`i-dont-see-an-agreement-to-accept`,children:_jsxs(_components.p,{children:[`Only the clinic `,_jsx(_components.strong,{children:`owner`}),` sees the `,_jsx(_components.strong,{children:`Accept agreement`}),` control — a manager or staff member can see that an agreement exists but cannot act on it. If you are the owner and still don’t see it, refresh the page; the card always shows the current version once it loads.`]})}),_jsx(Accordion,{title:`My pharmacy sells through another point-of-sale — can it still be listed?`,id:`my-pharmacy-sells-through-another-point-of-sale-can-it-still-be-listed`,children:_jsx(_components.p,{children:`Not yet available. A setting to mark your pharmacy as selling through another system, and a way\nto send in a stock feed from that system so your listed availability stays accurate, are both\nstill being finished. For now, listing works fully for pharmacies using ClinikEHR’s own till.`})}),_jsx(Accordion,{title:`Can I invite someone to set up my catalogue without giving them full access?`,id:`can-i-invite-someone-to-set-up-my-catalogue-without-giving-them-full-access`,children:_jsx(_components.p,{children:`Not yet available. A time-limited role for exactly this — set up your item list, locations, and\ndevices, with no access to sales, customers, or money — is planned but not on this screen yet.`})})]}),`\n`,_jsx(_MdxComponentBoundary,{name:`StillStuck`,children:_jsx(StillStuck,{})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{StillStuck,TaskHeader,Path,__snippet_EDITION_LABELS_uyx1hn,Availability,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"API access","description":"Create a key so another system can read your inventory, connect another organization by code, and see what changes when you revoke either one.","icon":"/images/icons/plug.svg","href":"/platform/settings/api-access"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[146,2584,")=>null;const TaskHeader=()=>null;const Path=()=>null;const __snippet_EDITION_LABELS_uyx1hn=undefined;const Availability=()=>null;function _"]]},"mdxExtracts":{"tableOfContents":[{"title":"What this tab controls","slug":"what-this-tab-controls","depth":2,"children":[]},{"title":"Set it up","slug":"set-it-up","depth":2,"children":[]},{"title":"What changes once you save","slug":"what-changes-once-you-save","depth":2,"children":[]},{"title":"Check it worked","slug":"check-it-worked","depth":2,"children":[]},{"title":"Connect another organization","slug":"connect-another-organization","depth":2,"children":[{"title":"Set up a connection","slug":"set-up-a-connection","depth":3,"children":[]},{"title":"What changes once you decide","slug":"what-changes-once-you-decide","depth":3,"children":[]},{"title":"Which patients an organization can reach","slug":"which-patients-an-organization-can-reach","depth":3,"children":[]}]},{"title":"Insurer links — tell us which connected organization is an insurer","slug":"insurer-links-—-tell-us-which-connected-organization-is-an-insurer","depth":2,"children":[]},{"title":"The API add-on — reach your own patient records","slug":"the-api-add-on-—-reach-your-own-patient-records","depth":2,"children":[]},{"title":"Listing — get found by network partners","slug":"listing-—-get-found-by-network-partners","depth":2,"children":[{"title":"Get listed","slug":"get-listed","depth":3,"children":[]},{"title":"Referred by a partner","slug":"referred-by-a-partner","depth":3,"children":[]},{"title":"What changes once you save","slug":"what-changes-once-you-save-2","depth":3,"children":[]}]},{"title":"Common issues","slug":"common-issues","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"clinikehr","siteName":"ClinikEHR Help Center","title":"API access - ClinikEHR Help Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T03:48:56.382Z","originalFileLocation":"platform/settings/api-access.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a key so another system can read your inventory, connect another organization by code, and see what changes when you revoke either one.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ClinikEHR Help Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clinikehr/vHO-d-rYR96rH25I/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/clinikehr/vHO-d-rYR96rH25I/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clinikehr/vHO-d-rYR96rH25I/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/clinikehr/vHO-d-rYR96rH25I/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/clinikehr/vHO-d-rYR96rH25I/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clinikehr/vHO-d-rYR96rH25I/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clinikehr/vHO-d-rYR96rH25I/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/clinikehr/vHO-d-rYR96rH25I/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/clinikehr/vHO-d-rYR96rH25I/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API access - ClinikEHR Help Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a key so another system can read your inventory, connect another organization by code, and see what changes when you revoke either one.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ClinikEHR Help Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.clinikehr.com/platform/settings/api-access\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clinikehr.mintlify.site/_mintlify/api/og/v2?division=Settings\u0026amp;title=API+access\u0026amp;description=Create+a+key+so+another+system+can+read+your+inventory%2C+connect+another+organization+by+code%2C+and+see+what+changes+when+you+revoke+either+one.\u0026amp;theme=599505931db38f6a01645061\u0026amp;signature=cafded381a7ddbcc85317b8b0801d9a078cf3b1d0d8c7005fb411f6064d3f621\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API access - ClinikEHR Help Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a key so another system can read your inventory, connect another organization by code, and see what changes when you revoke either one.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clinikehr.mintlify.site/_mintlify/api/og/v2?division=Settings\u0026amp;title=API+access\u0026amp;description=Create+a+key+so+another+system+can+read+your+inventory%2C+connect+another+organization+by+code%2C+and+see+what+changes+when+you+revoke+either+one.\u0026amp;theme=599505931db38f6a01645061\u0026amp;signature=cafded381a7ddbcc85317b8b0801d9a078cf3b1d0d8c7005fb411f6064d3f621\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/clinikehr/vHO-d-rYR96rH25I/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ClinikEHR Help Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9488\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.clinikehr.com/platform/settings/api-access\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform/settings/api-access.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.clinikehr.com/#organization\",\"name\":\"ClinikEHR Help Center\",\"url\":\"https://help.clinikehr.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/clinikehr/ch8sTdM1Y9zKp1JQ/logo/light.svg?fit=max\u0026auto=format\u0026n=ch8sTdM1Y9zKp1JQ\u0026q=85\u0026s=cfc319f5d968bbb63fcb9344a13ebf3d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.clinikehr.com#website\",\"name\":\"ClinikEHR Help Center\",\"url\":\"https://help.clinikehr.com\",\"publisher\":{\"@id\":\"https://help.clinikehr.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.clinikehr.com/platform/settings/api-access#webpage\",\"url\":\"https://help.clinikehr.com/platform/settings/api-access\",\"name\":\"API access\",\"description\":\"Create a key so another system can read your inventory, connect another organization by code, and see what changes when you revoke either one.\",\"dateModified\":\"2026-11-10T03:48:56.382Z\",\"isPartOf\":{\"@id\":\"https://help.clinikehr.com#website\"},\"breadcrumb\":{\"@id\":\"https://help.clinikehr.com/platform/settings/api-access#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.clinikehr.com/platform/settings/api-access#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Settings\",\"item\":\"https://help.clinikehr.com/platform/settings/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API access\",\"item\":\"https://help.clinikehr.com/platform/settings/api-access\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://help.clinikehr.com/platform/settings/api-access#article\",\"headline\":\"API access\",\"name\":\"API access\",\"description\":\"Create a key so another system can read your inventory, connect another organization by code, and see what changes when you revoke either one.\",\"url\":\"https://help.clinikehr.com/platform/settings/api-access\",\"mainEntityOfPage\":{\"@id\":\"https://help.clinikehr.com/platform/settings/api-access#webpage\"},\"dateModified\":\"2026-11-10T03:48:56.382Z\",\"publisher\":{\"@id\":\"https://help.clinikehr.com/#organization\"},\"isPartOf\":{\"@id\":\"https://help.clinikehr.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ClinikEHR Help Center\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ClinikEHR Help Center\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/platform/settings/api-access.md","siteName":"ClinikEHR Help Center","nav":{"global":null,"dropdowns":[{"dropdown":"Start here","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/rocket.svg","description":"New to ClinikEHR? Begin here.","groups":[{"group":"Welcome","pages":[{"title":"ClinikEHR Help Center","sidebarTitle":"Welcome","mode":"wide","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/rocket.svg","href":""},{"title":"The three editions","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/layers.svg","href":"/start/editions"},{"title":"How ClinikEHR is organised","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/network.svg","href":"/start/concepts"},{"title":"A tour of your workspace","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/compass.svg","href":"/start/tour"},{"title":"Who can see and do what","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-lock.svg","href":"/start/roles-and-access"},{"title":"Glossary","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/book.svg","href":"/start/glossary"}]}]},{"dropdown":"Solo \u0026 Team","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user.svg","description":"Solo practitioners and small teams. Clients, sessions and a simple money trail.","groups":[{"group":"Start here","pages":[{"title":"Set up your practice","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/rocket.svg","href":"/practice/get-started"},{"title":"Create your account","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-plus.svg","href":"/practice/get-started/create-account"},{"title":"Write your first clinical note","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-plus.svg","href":"/practice/get-started/first-note"},{"title":"Add your first client","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user.svg","href":"/practice/get-started/add-clients"},{"title":"Schedule your first appointment","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/practice/get-started/first-appointment"},{"title":"Add the services you offer","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/practice/get-started/services"},{"title":"Publish your booking page","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/globe.svg","href":"/practice/get-started/booking-page"},{"title":"Choose a plan","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/credit-card.svg","href":"/practice/get-started/choose-plan"},{"title":"Complete your clinic profile","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/building.svg","href":"/practice/get-started/practice-profile"},{"title":"Invite your team","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/users.svg","href":"/practice/get-started/invite-team"}]},{"group":"Every day","pages":[{"title":"Your dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/app-window.svg","href":"/practice/work/dashboard"},{"title":"Manage the appointment book","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/practice/work/appointments"},{"title":"Add Out of Office","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/practice/work/out-of-office"},{"title":"Your public booking page","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/globe.svg","href":"/practice/work/booking-page"},{"title":"Run group classes","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/practice/work/group-classes"},{"title":"Keep a waitlist for earlier appointments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/practice/work/waitlist"},{"title":"Manage your client list","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-plus.svg","href":"/practice/work/clients"},{"title":"Work referrals sent to your clinic","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-check.svg","href":"/practice/work/referrals"},{"title":"The client chart","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/folder-open.svg","href":"/practice/work/client-chart"},{"title":"Restrict a client to assigned staff","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-lock.svg","href":"/practice/work/client-security"},{"title":"Check a client in and out","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-check.svg","href":"/practice/work/check-in"},{"title":"Contacts and enquiries","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/book-user.svg","href":"/practice/work/contacts"},{"title":"Read your mail","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/mail.svg","href":"/practice/work/mail"},{"title":"Email a patient safely","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-lock.svg","href":"/practice/work/mail-secure-messages"},{"title":"When a message does not arrive","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/mail.svg","href":"/practice/work/mail-delivery"},{"title":"Mail storage, and what happens when Drive fills","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/mail.svg","href":"/practice/work/mail-storage"},{"title":"Send marketing campaigns","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/megaphone.svg","href":"/practice/work/marketing"},{"title":"What happens when you press Send","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/megaphone.svg","href":"/practice/work/marketing-sending"},{"title":"Automated journeys","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sitemap.svg","href":"/practice/work/marketing-journeys"},{"title":"Campaign results","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-column.svg","href":"/practice/work/marketing-results"}]},{"group":"Clinical work","pages":[{"title":"Write a clinical note","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/square-pen.svg","href":"/practice/clinical/notes"},{"title":"Note templates","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-list.svg","href":"/practice/clinical/note-templates"},{"title":"Snippets","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/copy.svg","href":"/practice/clinical/snippets"},{"title":"Generate a note with AI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/mic.svg","href":"/practice/clinical/ai-notes"},{"title":"Choose a note assistant","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bot.svg","href":"/practice/clinical/note-assistant"},{"title":"Run a video session","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/video.svg","href":"/practice/clinical/telehealth"},{"title":"Run a supervision meeting","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/video.svg","href":"/practice/clinical/supervision-meetings"},{"title":"Keep a supervision hours log","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-halved.svg","href":"/practice/clinical/supervision-hours-log"},{"title":"Set up co-signing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-halved.svg","href":"/practice/clinical/cosign-settings"},{"title":"Write psychotherapy notes","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-halved.svg","href":"/practice/clinical/psychotherapy-notes"},{"title":"Prescribe and e-prescribe","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/pill.svg","href":"/practice/clinical/prescriptions"},{"title":"Drug requests","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/pill.svg","href":"/practice/clinical/drug-requests"},{"title":"Send a document for signature","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-pen.svg","href":"/practice/clinical/documents"},{"title":"Treatment Planners","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/square-pen.svg","href":"/practice/clinical/treatment-planners"}]},{"group":"Forms","pages":[{"title":"Forms","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-list.svg","href":"/practice/forms/index"},{"title":"Build a form","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/square-pen.svg","href":"/practice/forms/build-a-form"},{"title":"Publish a form","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/circle-check.svg","href":"/practice/forms/publish-a-form"},{"title":"Send a form","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/mail.svg","href":"/practice/forms/send-a-form"},{"title":"Prepare a document for signature","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/practice/forms/prepare-a-document-for-signature"},{"title":"Share a document for signature with other clinics","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/practice/forms/share-a-document-for-signature"},{"title":"Document seal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/practice/forms/document-seal"},{"title":"Read and export responses","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/table.svg","href":"/practice/forms/read-responses"},{"title":"Form settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sliders.svg","href":"/practice/forms/form-settings"},{"title":"Envelope packs and form files","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/boxes-stacked.svg","href":"/practice/forms/usage-and-packs"},{"title":"Scored measures","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-line.svg","href":"/practice/forms/scored-measures"},{"title":"Form automation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/arrows-repeat.svg","href":"/practice/forms/automation"}]},{"group":"Money","pages":[{"title":"Billing overview","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/receipt-text.svg","href":"/practice/money/billing"},{"title":"Create and send an invoice","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-text.svg","href":"/practice/money/invoices"},{"title":"Superbills and statements","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-text.svg","href":"/practice/money/superbills-and-statements"},{"title":"Record and collect payments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hand-coins.svg","href":"/practice/money/payments"},{"title":"Track insurance and EAP authorizations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-halved.svg","href":"/practice/money/insurance-authorizations"},{"title":"Financial reports","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-line.svg","href":"/practice/money/financial-reports"},{"title":"Your services and prices","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/tags.svg","href":"/practice/money/services"},{"title":"Sell memberships","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-card.svg","href":"/practice/money/memberships"},{"title":"Sell packages, gift cards and promo codes","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gift.svg","href":"/practice/money/packages-and-gift-cards"},{"title":"Run an online store","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shop.svg","href":"/practice/money/store"},{"title":"File insurance claims","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-halved.svg","href":"/practice/money/insurance-claims"}]},{"group":"ClinikEHR Claims","pages":[{"title":"ClinikEHR Claims for Medi-Cal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-export.svg","sidebarTitle":"Overview","href":"/practice/claims/index"},{"title":"Get set up with Medi-Cal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/practice/claims/get-set-up"},{"title":"Add claims","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-csv.svg","href":"/practice/claims/add-claims"},{"title":"Review and confirm a claim","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-check.svg","href":"/practice/claims/review-a-claim"},{"title":"Approve claims","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/circle-check.svg","href":"/practice/claims/approve-claims"},{"title":"Make a Medi-Cal file","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-export.svg","href":"/practice/claims/make-a-file"},{"title":"Corrected claims and voids","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-pen.svg","href":"/practice/claims/corrected-claims-and-voids"},{"title":"Saved details and copying a claim","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/copy.svg","href":"/practice/claims/saved-details"},{"title":"Read Medi-Cal's reports","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-lines.svg","href":"/practice/claims/reports"},{"title":"Dashboard, files and your data","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gauge.svg","href":"/practice/claims/dashboard-and-files"},{"title":"Sign up for a Claims workspace","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user.svg","href":"/practice/claims/claims-workspace"}]},{"group":"Operations","pages":[{"title":"Track stock and supplies","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/boxes-stacked.svg","href":"/practice/ops/inventory"},{"title":"Partial-vial dispensing","href":"/practice/ops/partial-vial-dispensing"},{"title":"AI agents","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/robot.svg","href":"/practice/ops/ai-agents"}]},{"group":"Insights","pages":[{"title":"The executive dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gauge.svg","href":"/practice/insights/dashboard"},{"title":"Reports and analytics","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-line.svg","href":"/practice/insights/analytics"},{"title":"Achievements and your clinic tier","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/practice/insights/achievements"}]},{"group":"Settings · Practice","pages":[{"title":"Settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/settings.svg","href":"/practice/settings/index"},{"title":"General settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/building.svg","href":"/practice/settings/general"},{"title":"Find your Account ID","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-badge.svg","href":"/practice/settings/account-id"},{"title":"Staff and teams","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/users.svg","href":"/practice/settings/staff"},{"title":"Navigation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/practice/settings/navigation"},{"title":"Shifts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/practice/settings/shifts"},{"title":"Notifications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bell.svg","href":"/practice/settings/notifications"},{"title":"Inventory settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/boxes.svg","href":"/practice/settings/inventory"},{"title":"Locations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/map.svg","href":"/practice/settings/locations"}]},{"group":"Settings · Billing","pages":[{"title":"Billing and plans","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/credit-card.svg","href":"/practice/settings/billing"},{"title":"Insurance settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-halved.svg","href":"/practice/settings/insurance"},{"title":"Online payments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/money-bill-transfer.svg","href":"/practice/settings/online-payments"},{"title":"Payment details","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/banknote.svg","href":"/practice/settings/payment-details"},{"title":"Auto Pay","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/arrows-repeat.svg","href":"/practice/settings/auto-pay"},{"title":"Membership page","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-badge.svg","href":"/practice/settings/memberships"},{"title":"Appointment services","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/concierge-bell.svg","href":"/practice/settings/appointment-services"},{"title":"Store page","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/store.svg","href":"/practice/settings/store-page"}]},{"group":"Settings · Client experience","pages":[{"title":"Calendar integrations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/arrows-repeat.svg","href":"/practice/settings/calendar-integrations"},{"title":"Booking settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-check.svg","href":"/practice/settings/booking-settings"},{"title":"Booking page designer","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/palette.svg","href":"/practice/settings/booking-page-designer"},{"title":"Contact form","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/inbox.svg","href":"/practice/settings/contact-form"},{"title":"Client portal settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/globe.svg","href":"/practice/settings/portal"},{"title":"Sharable documents","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/practice/settings/sharable-docs"}]},{"group":"Settings · Communications \u0026 AI","pages":[{"title":"Communications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/comments.svg","href":"/practice/settings/communications"},{"title":"Mail","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/mail.svg","href":"/practice/settings/mail"},{"title":"Marketing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/megaphone.svg","href":"/practice/settings/marketing"},{"title":"AI settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bot.svg","href":"/practice/settings/ai-settings"}]},{"group":"Settings · System","pages":[{"title":"Security","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/practice/settings/security"},{"title":"Data export","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-export.svg","href":"/practice/settings/data-export"}]}]},{"dropdown":"Hospital \u0026 Enterprise","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hospital.svg","description":"Multi-department hospitals. Front desk, wards, theatre, diagnostics and pharmacy.","groups":[{"group":"Set up your hospital","pages":[{"title":"Set up your hospital","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hospital.svg","href":"/hospital/get-started"},{"title":"Turn on your care areas","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/toggle-on.svg","href":"/hospital/get-started/care-areas"},{"title":"Set up departments and sub-units","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sitemap.svg","href":"/hospital/get-started/departments"},{"title":"Set up wards and beds","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bed.svg","href":"/hospital/get-started/wards-and-beds"},{"title":"Set up your theatres","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-check.svg","href":"/hospital/get-started/theatre-setup"},{"title":"Invite hospital staff","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-plus.svg","href":"/hospital/get-started/invite-team"},{"title":"Set up antenatal care","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/baby.svg","href":"/hospital/get-started/maternity-setup"}]},{"group":"Overview","pages":[{"title":"Read your hospital dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gauge.svg","href":"/hospital/overview/dashboard"},{"title":"Build an AI agent for your hospital","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bot.svg","href":"/hospital/overview/ai-agents"},{"title":"Read your mail","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/mail.svg","href":"/hospital/overview/mail"},{"title":"Send marketing campaigns","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/megaphone.svg","href":"/hospital/overview/marketing"}]},{"group":"Front desk","pages":[{"title":"Work the front desk board","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/concierge-bell.svg","href":"/hospital/front-desk/overview"},{"title":"Work the appointment book","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/hospital/front-desk/appointments"},{"title":"Add Out of Office","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/hospital/front-desk/out-of-office"},{"title":"Register and find patients","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hospital-user.svg","href":"/hospital/front-desk/patients"},{"title":"Restrict a patient to assigned staff","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-lock.svg","href":"/hospital/front-desk/patient-security"},{"title":"Track contacts and enquiries","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/address-book.svg","href":"/hospital/front-desk/contacts"},{"title":"Run an outreach event","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/map.svg","href":"/hospital/front-desk/outreach-events"}]},{"group":"Outpatient","pages":[{"title":"Triage a patient and route them to a department","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/heart-pulse.svg","href":"/hospital/outpatient/triage"},{"title":"Look up past triage records","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clock-rotate-left.svg","href":"/hospital/outpatient/triage-history"},{"title":"Run a consultation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/stethoscope.svg","href":"/hospital/outpatient/consultation"},{"title":"Look up past consultations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clock-rotate-left.svg","href":"/hospital/outpatient/consultation-history"},{"title":"Write a clinic note","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/square-pen.svg","href":"/hospital/outpatient/notes"},{"title":"Run a video consultation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/video.svg","href":"/hospital/outpatient/telehealth"}]},{"group":"Inpatient","pages":[{"title":"Ward admissions","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bed-double.svg","href":"/hospital/inpatient/admissions"},{"title":"Ward discharges","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-check.svg","href":"/hospital/inpatient/discharges"},{"title":"Nursing station","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/syringe.svg","href":"/hospital/inpatient/nursing-station"}]},{"group":"Maternity","pages":[{"title":"Maternity","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/woman.svg","href":"/hospital/maternity/overview"},{"title":"Today's Clinic","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-check.svg","href":"/hospital/maternity/todays-clinic"},{"title":"Open, re-date and close a pregnancy record","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-pen.svg","href":"/hospital/maternity/pregnancy-records"},{"title":"Record an antenatal contact","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-plus.svg","href":"/hospital/maternity/record-a-contact"},{"title":"The antenatal card","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-line.svg","href":"/hospital/maternity/antenatal-card"},{"title":"Programme doses","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/syringe.svg","href":"/hospital/maternity/programme-doses"},{"title":"PMTCT status","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-heart.svg","href":"/hospital/maternity/pmtct"},{"title":"Labour Ward","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/heart-pulse.svg","href":"/hospital/maternity/labour-ward"},{"title":"The labour record","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/hospital/maternity/labour-record"},{"title":"The labour chart","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-line.svg","href":"/hospital/maternity/labour-chart"},{"title":"Babies and birth records","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/baby.svg","href":"/hospital/maternity/babies"},{"title":"Postnatal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/baby.svg","href":"/hospital/maternity/postnatal"},{"title":"Close a referral","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/baby.svg","href":"/hospital/maternity/close-a-referral"},{"title":"Retract a record","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/circle-xmark.svg","href":"/hospital/maternity/retract-a-record"},{"title":"Antenatal Register","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/book.svg","href":"/hospital/maternity/register"},{"title":"Antenatal Coverage","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-column.svg","href":"/hospital/maternity/coverage"},{"title":"Maternity Activity","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/table.svg","href":"/hospital/maternity/monthly-activity"},{"title":"The pregnancy on the chart","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-heart.svg","href":"/hospital/maternity/pregnancy-on-the-chart"},{"title":"The Maternity tab on a ward chart","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bed.svg","href":"/hospital/maternity/ward-maternity-tab"}]},{"group":"Theatre","pages":[{"title":"Today's theatre list","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/scissors.svg","href":"/hospital/theatre/list"},{"title":"Case history","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clock-rotate-left.svg","href":"/hospital/theatre/history"}]},{"group":"Diagnostics","pages":[{"title":"Lab test list","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/flask-conical.svg","href":"/hospital/diagnostics/laboratory"},{"title":"Lab station","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/microscope.svg","href":"/hospital/diagnostics/lab-station"},{"title":"Worklist","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-list.svg","href":"/hospital/diagnostics/worklist"},{"title":"Lab reports","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-lines.svg","href":"/hospital/diagnostics/lab-reports"},{"title":"Walk-in lab and imaging clients","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/flask-conical.svg","href":"/hospital/diagnostics/walk-in-clients"},{"title":"Referring doctors","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/address-book.svg","href":"/hospital/diagnostics/referrers"},{"title":"Radiology list","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/scan.svg","href":"/hospital/diagnostics/radiology"},{"title":"Radiology station","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/display.svg","href":"/hospital/diagnostics/radiology-station"},{"title":"Radiology reports","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-text.svg","href":"/hospital/diagnostics/radiology-reports"},{"title":"Modalities","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/plug.svg","href":"/hospital/diagnostics/modalities"}]},{"group":"Pharmacy unit","pages":[{"title":"Work the prescription list","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-prescription.svg","href":"/hospital/pharmacy/prescriptions"},{"title":"Search the prescription history","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clock-rotate-left.svg","href":"/hospital/pharmacy/prescription-history"},{"title":"Record a prescription pickup","sidebarTitle":"Pickups","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/hospital/pharmacy/pickups"},{"title":"Run the pharmacy station","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/pill.svg","href":"/hospital/pharmacy/station"},{"title":"Sell at the pharmacy counter","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calculator.svg","href":"/hospital/pharmacy/pos"},{"title":"Review pharmacy sales","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/cash-register.svg","href":"/hospital/pharmacy/sales"},{"title":"Refill and duplicate-dispensing checks","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/hospital/pharmacy/dispensing-checks"},{"title":"Possibly the same person","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/hospital/pharmacy/possible-same-person"}]},{"group":"Revenue","pages":[{"title":"Read the billing dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/receipt-text.svg","href":"/hospital/revenue/billing"},{"title":"Financial reports","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-line.svg","href":"/hospital/revenue/financial-reports"},{"title":"Create and send an invoice","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-invoice.svg","href":"/hospital/revenue/invoices"},{"title":"Record and collect payments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hand-coins.svg","href":"/hospital/revenue/payments"},{"title":"Build your services and prices","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/tags.svg","href":"/hospital/revenue/services"},{"title":"Sell memberships","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-card.svg","href":"/hospital/revenue/memberships"},{"title":"Sell packages, gift cards and promo codes","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gift.svg","href":"/hospital/revenue/packages-and-gift-cards"},{"title":"Run the online store","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/store.svg","href":"/hospital/revenue/store"}]},{"group":"Insurance","pages":[{"title":"Insurance dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/hospital/insurance/overview"},{"title":"Request a pre-authorization","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-check.svg","href":"/hospital/insurance/pre-authorization"},{"title":"File and track claims","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-lock.svg","href":"/hospital/insurance/claims"},{"title":"Set up an HMO","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/hospital/insurance/hmo-setup"},{"title":"Bill an HMO at the till","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/hospital/insurance/bill-hmo"},{"title":"Record an HMO payment","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/hospital/insurance/hmo-payments"},{"title":"Write off an HMO balance","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/hospital/insurance/hmo-write-offs"},{"title":"How claims reach your HMOs","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/hospital/insurance/how-claims-reach-hmos"},{"title":"Connect Curacel","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/hospital/insurance/connect-curacel"}]},{"group":"Supply chain","pages":[{"title":"Manage hospital inventory","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/boxes-stacked.svg","href":"/hospital/supply/inventory"}]},{"group":"Records","pages":[{"title":"Work the records desk","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/folder-open.svg","href":"/hospital/records/overview"},{"title":"Forms","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-list.svg","href":"/hospital/records/forms"},{"title":"Send and track documents","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/hospital/records/documents"},{"title":"Manage patient records","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/book-user.svg","href":"/hospital/records/patient-records"},{"title":"Guardians and records access","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-shield.svg","href":"/hospital/records/guardians"}]},{"group":"Executive","pages":[{"title":"The executive dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gauge.svg","href":"/hospital/executive/dashboard"},{"title":"Hospital reports and analytics","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-column.svg","href":"/hospital/executive/analytics"}]},{"group":"Settings · Practice","pages":[{"title":"Settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/settings.svg","href":"/hospital/settings/index"},{"title":"General settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/building.svg","href":"/hospital/settings/general"},{"title":"Find your Account ID","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-badge.svg","href":"/practice/settings/account-id"},{"title":"Facility","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hospital.svg","href":"/hospital/settings/facility"},{"title":"Departments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sitemap.svg","href":"/hospital/settings/departments"},{"title":"Ward management","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bed-double.svg","href":"/hospital/settings/wards"},{"title":"Theatre","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/scissors.svg","href":"/hospital/settings/theatre"},{"title":"Staff and teams","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/users-gear.svg","href":"/hospital/settings/staff"},{"title":"Shifts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/hospital/settings/shifts"},{"title":"Role navigation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-lock.svg","href":"/hospital/settings/role-navigation"},{"title":"Navigation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/hospital/settings/navigation"},{"title":"Notifications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bell.svg","href":"/hospital/settings/notifications"},{"title":"Inventory settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/boxes-stacked.svg","href":"/hospital/settings/inventory"},{"title":"Pickup settings","sidebarTitle":"Pickups","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/hospital/settings/pharmacy-pickups"},{"title":"Locations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/map.svg","href":"/hospital/settings/locations"}]},{"group":"Settings · Billing","pages":[{"title":"Billing and plans","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/credit-card.svg","href":"/hospital/settings/billing"},{"title":"Online payments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/wallet.svg","href":"/hospital/settings/online-payments"},{"title":"Payment details","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/banknote.svg","href":"/hospital/settings/payment-details"},{"title":"Auto Pay","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/arrows-repeat.svg","href":"/hospital/settings/auto-pay"},{"title":"Membership page","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-badge.svg","href":"/hospital/settings/memberships"},{"title":"Appointment services","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/concierge-bell.svg","href":"/hospital/settings/appointment-services"},{"title":"Store page","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/store.svg","href":"/hospital/settings/store-page"}]},{"group":"Settings · Patient experience","pages":[{"title":"Calendar integrations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/hospital/settings/calendar-integrations"},{"title":"Booking settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-check.svg","href":"/hospital/settings/booking-settings"},{"title":"Booking page designer","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/palette.svg","href":"/hospital/settings/booking-page-designer"},{"title":"Contact form","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/inbox.svg","href":"/hospital/settings/contact-form"},{"title":"Patient portal settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/globe.svg","href":"/hospital/settings/portal"},{"title":"Sharable documents","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/hospital/settings/sharable-docs"}]},{"group":"Settings · Communications \u0026 AI","pages":[{"title":"Communications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/comments.svg","href":"/hospital/settings/communications"},{"title":"Mail","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/mail.svg","href":"/hospital/settings/mail"},{"title":"Marketing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/megaphone.svg","href":"/hospital/settings/marketing"},{"title":"AI settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bot.svg","href":"/hospital/settings/ai-settings"}]},{"group":"Settings · System","pages":[{"title":"Security","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/hospital/settings/security"},{"title":"Data export","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-export.svg","href":"/hospital/settings/data-export"}]}]},{"dropdown":"Pharmacy","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/pill-bottle.svg","description":"Retail and hospital pharmacies running the Pharmacy edition.","groups":[{"group":"Set up your pharmacy","pages":[{"title":"Set up your pharmacy","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/rocket.svg","href":"/pharmacy/get-started"},{"title":"Choose a plan","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/credit-card.svg","href":"/pharmacy/get-started/choose-plan"},{"title":"Add your first stock item","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/boxes.svg","href":"/pharmacy/get-started/first-stock-item"},{"title":"Record your first sale","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calculator.svg","href":"/pharmacy/get-started/first-sale"},{"title":"Add your first customer","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user.svg","href":"/pharmacy/get-started/first-customer"},{"title":"Complete your pharmacy profile","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/store.svg","href":"/pharmacy/get-started/pharmacy-profile"},{"title":"Invite your team","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/users.svg","href":"/pharmacy/get-started/invite-team"},{"title":"The Listing plan","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/credit-card.svg","href":"/pharmacy/get-started/listing-plan"}]},{"group":"At the counter","pages":[{"title":"The pharmacy station","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/pill-bottle.svg","href":"/pharmacy/dispensing/station"},{"title":"Ring up a sale","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calculator.svg","href":"/pharmacy/pos/index"},{"title":"Scan barcodes at the till","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/barcode.svg","href":"/pharmacy/pos/barcode"},{"title":"Take payment","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/banknote.svg","href":"/pharmacy/pos/payments"},{"title":"Hold a cart and apply discounts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/circle-pause.svg","href":"/pharmacy/pos/held-carts"},{"title":"Print and reprint receipts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/receipt.svg","href":"/pharmacy/pos/receipts"},{"title":"Selling when the internet is down","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/wifi-off.svg","href":"/pharmacy/pos/offline"},{"title":"Returns, voids and amendments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/rotate-ccw.svg","href":"/pharmacy/pos/returns"},{"title":"Record a prescription pickup at the till","sidebarTitle":"Prescription pickups","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/pharmacy/pos/pickups"},{"title":"Drug interaction screening","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/pharmacy/dispensing/interaction-screening"},{"title":"Refill and duplicate-dispensing checks","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/pharmacy/dispensing/refill-and-duplicate-checks"},{"title":"Possibly the same person","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/pharmacy/dispensing/possible-same-person"}]},{"group":"Sales","pages":[{"title":"The sales dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-line.svg","href":"/pharmacy/money/sales"}]},{"group":"Stock","pages":[{"title":"Stock control","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/boxes.svg","href":"/pharmacy/inventory/index"},{"title":"Batches, expiry and FEFO","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hourglass.svg","href":"/pharmacy/inventory/batches-and-expiry"},{"title":"Purchase orders and suppliers","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-text.svg","href":"/pharmacy/inventory/purchase-orders"},{"title":"Run a stock count","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-list.svg","href":"/pharmacy/inventory/stock-counts"},{"title":"Count with a CipherLab scanner","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/barcode.svg","href":"/pharmacy/inventory/cipherlab"},{"title":"Import and export your catalogue","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-spreadsheet.svg","href":"/pharmacy/inventory/import-export"},{"title":"Transfer stock between branches","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/truck.svg","href":"/pharmacy/inventory/transfers"},{"title":"Get found by network partners","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/store.svg","href":"/pharmacy/inventory/listing"}]},{"group":"Customers","pages":[{"title":"Customer records","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/users.svg","href":"/pharmacy/customers/index"},{"title":"Money on account","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/wallet.svg","href":"/pharmacy/customers/wallet"},{"title":"Who may collect on someone's behalf","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-group.svg","href":"/pharmacy/customers/dependents"}]},{"group":"Billing","pages":[{"title":"Invoices and payments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/receipt-text.svg","href":"/pharmacy/money/billing"},{"title":"Payments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hand-coins.svg","href":"/pharmacy/money/payments"},{"title":"Services and prices","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/concierge-bell.svg","href":"/pharmacy/money/services"},{"title":"Track expenses and your net position","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/receipt.svg","href":"/pharmacy/money/expenses"},{"title":"Sell online with your store","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shop.svg","href":"/pharmacy/money/online-store"}]},{"group":"Oversight","pages":[{"title":"The executive dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/briefcase.svg","href":"/pharmacy/money/executive"},{"title":"Run a report","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-column.svg","href":"/pharmacy/money/analytics"}]},{"group":"Hardware \u0026 desktop","pages":[{"title":"Install the desktop app","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/monitor.svg","href":"/pharmacy/hardware/desktop-app"},{"title":"Set up your receipt printer","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/printer.svg","href":"/pharmacy/hardware/thermal-printer"},{"title":"Set up a barcode scanner","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/barcode.svg","href":"/pharmacy/hardware/barcode-scanner"}]},{"group":"Settings · Pharmacy","pages":[{"title":"Settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/settings.svg","href":"/pharmacy/settings/index"},{"title":"General settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/building.svg","href":"/pharmacy/settings/general"},{"title":"Find your Account ID","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-badge.svg","href":"/practice/settings/account-id"},{"title":"Staff and teams","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/users-gear.svg","href":"/pharmacy/settings/staff"},{"title":"Navigation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/pharmacy/settings/navigation"},{"title":"Setup Assistant","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hourglass.svg","href":"/pharmacy/settings/setup-assistant"},{"title":"Inventory settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/boxes-stacked.svg","href":"/pharmacy/settings/inventory"},{"title":"Stock source","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/boxes.svg","href":"/pharmacy/settings/stock-source"},{"title":"Pickup settings","sidebarTitle":"Pickups","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/pharmacy/settings/pickups"},{"title":"Notifications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bell.svg","href":"/pharmacy/settings/notifications"}]},{"group":"Settings · Billing","pages":[{"title":"Billing and plans","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/credit-card.svg","href":"/pharmacy/settings/billing"},{"title":"Online payments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/money-bill-transfer.svg","href":"/pharmacy/settings/online-payments"},{"title":"Payment details","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/banknote.svg","href":"/pharmacy/settings/payment-details"},{"title":"Loyalty program","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/tag.svg","href":"/pharmacy/settings/loyalty"}]},{"group":"Settings · System","pages":[{"title":"Security","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/pharmacy/settings/security"},{"title":"Data export","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-export.svg","href":"/pharmacy/settings/data-export"}]}]},{"dropdown":"Diagnostics","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/microscope.svg","description":"Standalone labs, imaging centres and DOT collection sites.","groups":[{"group":"Set up your lab","pages":[{"title":"Set up your lab","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/rocket.svg","href":"/lims/get-started"},{"title":"Choose a plan","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/credit-card.svg","href":"/lims/get-started/choose-plan"},{"title":"Add your tests and panels","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/test-tubes.svg","href":"/lims/get-started/tests-and-panels"},{"title":"Register your first patient","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user.svg","href":"/lims/get-started/first-patient"},{"title":"Log your first sample","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/test-tube.svg","href":"/lims/get-started/first-sample"},{"title":"Complete your lab profile","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hospital.svg","href":"/lims/get-started/lab-profile"},{"title":"Invite your team","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/users.svg","href":"/lims/get-started/invite-team"}]},{"group":"Lab workflow","pages":[{"title":"Read the Lab Station dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gauge.svg","href":"/lims/lab/lab-station"},{"title":"Work the bench queue","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/lims/lab/worklist"},{"title":"Raise a test request","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/test-tube.svg","href":"/lims/lab/test-requests"},{"title":"Accession an incoming specimen","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/barcode.svg","href":"/lims/lab/accessioning"},{"title":"Enter and verify results","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/flask-conical.svg","href":"/lims/lab/results"},{"title":"Produce and release a report","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-text.svg","href":"/lims/lab/reports"},{"title":"Walk-in clients","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/test-tube.svg","href":"/lims/lab/walk-in-clients"},{"title":"Turnaround time","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/timer.svg","href":"/lims/lab/turnaround-time"}]},{"group":"DOT \u0026 workplace testing","pages":[{"title":"DOT and workplace drug testing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/test-tube-diagonal.svg","href":"/lims/dot/index"},{"title":"Collect a specimen and complete the CCF","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-check.svg","href":"/lims/dot/collection"},{"title":"Screen and confirm a specimen","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/test-tubes.svg","href":"/lims/dot/screening-and-confirmation"},{"title":"MRO review and the employer report","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/briefcase-medical.svg","href":"/lims/dot/reports"},{"title":"Look up a finished drug-testing order","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clock-rotate-left.svg","href":"/lims/dot/history"},{"title":"Reference lab mode: intake to report","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/inbox.svg","href":"/lims/dot/lab-intake-mode"}]},{"group":"Imaging","pages":[{"title":"The radiology station","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gauge.svg","href":"/lims/imaging/station"},{"title":"Raise an imaging request","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/scan.svg","href":"/lims/imaging/requests"},{"title":"Report an imaging study","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-heart.svg","href":"/lims/imaging/reports"},{"title":"Connect your imaging machines","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/plug.svg","href":"/lims/imaging/modalities"}]},{"group":"Quality \u0026 instruments","pages":[{"title":"Run quality control","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-line.svg","href":"/lims/quality/quality-control"},{"title":"Connect your analysers","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/microscope.svg","href":"/lims/quality/analyzers"}]},{"group":"Referrals \u0026 revenue","pages":[{"title":"Referring doctors and their portal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/briefcase-medical.svg","href":"/lims/business/referrers"},{"title":"Referral commissions","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/receipt-text.svg","href":"/lims/business/commissions"},{"title":"Billing dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/receipt.svg","href":"/lims/business/billing"},{"title":"Payments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/banknote.svg","href":"/lims/business/payments"},{"title":"Tests and prices","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/tags.svg","href":"/lims/business/services"}]},{"group":"Oversight","pages":[{"title":"The owner summary","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gauge.svg","href":"/lims/business/executive"},{"title":"Lab analytics","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-line.svg","href":"/lims/business/lab-analytics"},{"title":"The report catalogue","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/chart-column.svg","href":"/lims/business/analytics"}]},{"group":"Front desk","pages":[{"title":"Appointments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/lims/front-desk/appointment"},{"title":"Add Out of Office","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/lims/front-desk/out-of-office"},{"title":"Patients","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/address-book.svg","href":"/lims/front-desk/patients"}]},{"group":"Stock","pages":[{"title":"Reagents and consumables","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/test-tubes.svg","href":"/lims/inventory/reagents"},{"title":"Send specimens to a hub lab","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/truck.svg","href":"/lims/inventory/transfers"}]},{"group":"Settings · Laboratory","pages":[{"title":"Settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/settings.svg","href":"/lims/settings/index"},{"title":"General settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/building.svg","href":"/lims/settings/general"},{"title":"Find your Account ID","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-badge.svg","href":"/practice/settings/account-id"},{"title":"Staff and teams","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/users-gear.svg","href":"/lims/settings/staff"},{"title":"Navigation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/lims/settings/navigation"},{"title":"Inventory settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/vials.svg","href":"/lims/settings/inventory"},{"title":"Lab workflow","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/test-tube.svg","href":"/lims/settings/lab-workflow"},{"title":"Notifications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bell.svg","href":"/lims/settings/notifications"}]},{"group":"Settings · Billing","pages":[{"title":"Billing and plans","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/credit-card.svg","href":"/lims/settings/billing"},{"title":"Online payments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/money-bill-transfer.svg","href":"/lims/settings/online-payments"},{"title":"Payment details","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/banknote.svg","href":"/lims/settings/payment-details"}]},{"group":"Settings · Client experience","pages":[{"title":"Client Portal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/globe.svg","href":"/lims/settings/portal"},{"title":"Sharable documents","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-signature.svg","href":"/lims/settings/sharable-docs"}]},{"group":"Settings · System","pages":[{"title":"Security","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/lims/settings/security"},{"title":"Data export","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-export.svg","href":"/lims/settings/data-export"}]}]},{"dropdown":"Patient Portal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user.svg","description":"The patient-facing portal — for patients and for the clinics that run it.","groups":[{"group":"For patients","pages":[{"title":"Sign in to your patient portal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/log-in.svg","href":"/portal/patients/sign-in"},{"title":"See what is waiting on you","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/portal/patients/to-do"},{"title":"Book and manage appointments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/portal/patients/appointments"},{"title":"Packages and gift cards","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gift.svg","href":"/portal/patients/packages-and-gift-cards"},{"title":"Read and sign documents","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-pen.svg","href":"/portal/patients/documents"},{"title":"Files your clinic has shared with you","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/folder-open.svg","href":"/portal/patients/files"},{"title":"Join a video visit","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/video.svg","href":"/portal/patients/telehealth"},{"title":"Message your care team","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/messages-square.svg","href":"/portal/patients/messages"},{"title":"View your results, visits and medications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clipboard-plus.svg","href":"/portal/patients/records"},{"title":"Privacy and security","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/lock.svg","href":"/portal/patients/privacy-and-security"},{"title":"Portal problems and how to fix them","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/circle-question-mark.svg","href":"/portal/patients/troubleshooting"}]},{"group":"For clinics","pages":[{"title":"Turn on the patient portal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/toggle-right.svg","href":"/portal/setup/enable"},{"title":"Give a patient portal access","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-check.svg","href":"/portal/setup/invite-patients"},{"title":"Choose what patients can see and do","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sliders-horizontal.svg","href":"/portal/setup/features"},{"title":"Brand your portal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/palette.svg","href":"/portal/setup/branding"}]}]},{"dropdown":"Platform","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/settings.svg","description":"Account, plans, team, security and integrations — shared by every edition.","groups":[{"group":"Your account","pages":[{"title":"Your personal dashboard","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/gauge.svg","href":"/platform/account/dashboard"},{"title":"Your Clinics","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/building.svg","href":"/platform/account/clinics-list"},{"title":"Your profile and credentials","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-card.svg","href":"/platform/account/profile"},{"title":"Secure your account","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-half.svg","href":"/platform/account/security"},{"title":"Choose which emails you get","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/mail.svg","href":"/platform/account/notifications"},{"title":"Your calendar connections","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-check.svg","href":"/platform/account/calendars"},{"title":"Work across more than one workspace","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/arrow-left-right.svg","href":"/platform/account/switching-workspaces"},{"title":"Delete your account","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/trash.svg","href":"/platform/account/delete-account"}]},{"group":"Plans \u0026 billing","pages":[{"title":"Plans and what they include","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/table.svg","href":"/platform/plans/overview"},{"title":"Change your plan","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/trending-up.svg","href":"/platform/plans/change-plan"},{"title":"Staff seats and how they are charged","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/users.svg","href":"/platform/plans/seats"},{"title":"AI credits","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/coins.svg","href":"/platform/plans/credits"},{"title":"Clinical credits","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/coins.svg","href":"/platform/plans/clinical-credits"},{"title":"Payment methods","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/credit-card.svg","href":"/platform/plans/payment-methods"},{"title":"Your subscription invoices and receipts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/receipt-text.svg","href":"/platform/plans/invoices-and-receipts"},{"title":"Legacy plans","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/clock-rotate-left.svg","href":"/platform/plans/legacy-plans"},{"title":"New Practice Startup Program","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/rocket.svg","href":"/platform/plans/startup-program"}]},{"group":"Your team","pages":[{"title":"Invite someone to your team","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/user-plus.svg","href":"/platform/team/invite-staff"},{"title":"Roles","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-card.svg","href":"/platform/team/roles"},{"title":"Permissions — control what each person can do","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sliders-horizontal.svg","href":"/platform/team/permissions"},{"title":"Message your team","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/messages-square.svg","href":"/platform/team/team-chat"},{"title":"Share files, voice notes, polls and scheduled messages","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/messages-square.svg","href":"/platform/team/team-chat-files-and-polls"},{"title":"Send urgent alerts, set your status and pause notifications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bell.svg","href":"/platform/team/team-chat-urgent-and-status"},{"title":"Talk about a patient, mention groups, and forward or approve in chat","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/messages-square.svg","href":"/platform/team/team-chat-patients-and-teams"},{"title":"Find messages and organise Team chat your way","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/messages-square.svg","href":"/platform/team/team-chat-find-and-organise"},{"title":"Use Team chat on any screen, and keep it safe","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/messages-square.svg","href":"/platform/team/team-chat-views-and-safety"},{"title":"Send emergency codes, start a huddle and catch up after a shift","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bell.svg","href":"/platform/team/team-chat-codes-and-calls"},{"title":"Quiet hours, announcements, the policy and who can use Team chat","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/messages-square.svg","href":"/platform/team/team-chat-people-and-rules"},{"title":"Work with AI agents in Team chat","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/messages-square.svg","href":"/platform/team/team-chat-ai-agents"},{"title":"Staff credentials — view and verify","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/id-card.svg","href":"/platform/team/credentials"},{"title":"Care areas (hospitals)","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/hospital.svg","href":"/platform/team/care-areas"}]},{"group":"Settings","pages":[{"title":"Settings: what's where","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sliders-horizontal.svg","href":"/platform/settings/overview"},{"title":"Complete your business profile","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/building.svg","href":"/platform/settings/business-profile"},{"title":"Set your currency, tax and free-clinic mode","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/coins.svg","href":"/platform/settings/currency"},{"title":"Choose which notifications your workspace gets","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bell.svg","href":"/platform/settings/notifications"},{"title":"Brand your public pages","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/palette.svg","href":"/platform/settings/branding"},{"title":"Serve a page on your own domain","description":"Publish your booking page, store, membership page, contact form or AI assistant on a web address you own, with a certificate issued for you.","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/globe.svg","href":"/platform/settings/custom-domain"},{"title":"API access","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/plug.svg","href":"/platform/settings/api-access"},{"title":"Legal","description":"Read the agreements between your clinic and Bettar Platforms, Inc., see who accepted which version and when, download the record, and respond to an update.","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-halved.svg","href":"/platform/settings/legal"}]},{"group":"Drive","pages":[{"title":"Get started with Drive","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/folder-open.svg","href":"/platform/drive/get-started"},{"title":"Use Clinic Drive, My Drive and folders","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/folder-open.svg","href":"/platform/drive/clinic-drive-and-folders"},{"title":"Share a file or folder inside the clinic","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/folder-open.svg","href":"/platform/drive/share-files"},{"title":"Choose who can open a folder","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/folder-open.svg","href":"/platform/drive/folder-access"},{"title":"Send a file outside the clinic","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/folder-open.svg","href":"/platform/drive/secure-links"},{"title":"Share a file with a patient","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/folder-open.svg","href":"/platform/drive/share-with-patients"},{"title":"File a patient's documents by type and visit","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-heart.svg","href":"/platform/drive/patient-files"},{"title":"Forms, signed documents, bills and chat files in Drive","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/folder-open.svg","href":"/platform/drive/documents-in-the-chart"},{"title":"Entered in error and Trash","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/trash-can.svg","href":"/platform/drive/entered-in-error-and-trash"},{"title":"Storage and limits","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/database.svg","href":"/platform/drive/storage-and-limits"},{"title":"Search inside documents","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/magnifying-glass.svg","href":"/platform/drive/search-inside-documents"},{"title":"Ozni and your Drive","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/drive/ozni-and-drive"}]},{"group":"Ozni, your assistant","pages":[{"title":"Meet Ozni","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/meet-ozni"},{"title":"Making changes with Ozni","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/making-changes"},{"title":"Clinic instructions for Ozni","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/clinic-instructions"},{"title":"What Ozni can see and do","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/what-ozni-can-do"},{"title":"Reports, charts and what changed","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/reports-and-charts"},{"title":"Stock and inventory","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/stock-and-inventory"},{"title":"Credits and prices","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/coins.svg","href":"/platform/ozni/credits"},{"title":"What Ozni remembers","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/memory"},{"title":"Commands and saved prompts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/commands-and-saved-prompts"},{"title":"Saved views and sharing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/saved-views-and-sharing"},{"title":"Projects","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/projects"},{"title":"Connectors","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/connectors"},{"title":"API access and webhooks with Ozni","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/api-access-and-webhooks"},{"title":"Run in background","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/background-tasks"},{"title":"Assistant documents","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/clinic-documents"},{"title":"Attaching a file to a chat","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/attachments"},{"title":"Drafts from Ozni","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/drafts"},{"title":"Deep look","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","href":"/platform/ozni/deep-look"},{"title":"US insurance and Medi-Cal claims with Ozni","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-halved.svg","href":"/platform/ozni/insurance-and-claims"},{"title":"Privacy and Ozni","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/platform/ozni/privacy"},{"title":"Getting set up with Ozni","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/rocket.svg","href":"/platform/ozni/getting-set-up"}]},{"group":"AI agents","pages":[{"title":"Build an AI agent","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bot.svg","href":"/platform/ai/agents"},{"title":"Agent template gallery","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/bot.svg","href":"/platform/ai/agent-templates"},{"title":"Give an agent tools and knowledge","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/toolbox.svg","href":"/platform/ai/agent-tools"},{"title":"Publish an agent","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/globe.svg","href":"/platform/ai/publishing-agents"},{"title":"Control which roles can use an agent","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/toolbox.svg","href":"/platform/ai/agent-role-access"},{"title":"How agent credits are used","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/coins.svg","href":"/platform/ai/credits"},{"title":"AI safety and patient data","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-check.svg","href":"/platform/ai/safety"}]},{"group":"Security \u0026 compliance","pages":[{"title":"HIPAA and compliance","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/shield-half.svg","href":"/platform/security/hipaa"},{"title":"Two-factor authentication","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/key.svg","href":"/platform/security/mfa"},{"title":"Automatic logoff","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/timer.svg","href":"/platform/security/automatic-logoff"},{"title":"The audit log","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/platform/security/audit-log"},{"title":"Substance use records and 42 CFR Part 2","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/platform/security/substance-use-records-part-2"},{"title":"Client requests about their record","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/list-check.svg","href":"/platform/security/client-record-requests"},{"title":"Send a report securely","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/link.svg","href":"/platform/security/send-a-report"},{"title":"Export your data","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/file-output.svg","href":"/platform/security/data-export"},{"title":"Single sign-on","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/log-in.svg","href":"/platform/security/sso"}]},{"group":"Apps \u0026 offline","pages":[{"title":"Install ClinikEHR on your phone or tablet","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/smartphone.svg","href":"/platform/apps/mobile-pwa"},{"title":"The desktop app","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/app-window.svg","href":"/platform/apps/desktop"},{"title":"Working without internet","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/wifi-off.svg","href":"/platform/apps/offline"}]},{"group":"Integrations","pages":[{"title":"Connect an external calendar","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/calendar-days.svg","href":"/platform/integrations/calendar"},{"title":"Send a prescription electronically","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/pill.svg","href":"/platform/integrations/eprescribe"},{"title":"The developer API","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/code.svg","href":"/platform/integrations/developer-api"},{"title":"Accept outside data automatically","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/code.svg","href":"/platform/integrations/auto-accept-outside-data"},{"title":"Embed ClinikEHR on your website","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/code.svg","href":"/platform/integrations/embeds"}]},{"group":"Help","pages":[{"title":"Troubleshooting","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/wrench.svg","href":"/platform/help/troubleshooting"},{"title":"Contact support","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/life-buoy.svg","href":"/platform/help/contact-support"}]}]},{"dropdown":"Changelog","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","description":"What's new in ClinikEHR — releases, improvements and fixes.","groups":[{"group":"Releases","pages":[{"title":"Changelog","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehr/images/icons/sparkles.svg","mode":"center","href":"/changelog"}]}]}]},"basePath":"","title":"API access - ClinikEHR Help Center","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}