AdvancedMD API Documentation Opens After a Developer Agreement. The Steps From There.
You searched for the AdvancedMD API docs and found an overview, not a reference. That's by design. AdvancedMD's full API documentation and a sandbox come after a developer signs its Certified API Developer Agreement. The exception is its read-only FHIR APIs, part of its certified EHR technology, which are documented separately.
Two API families. The Connect APIs are AdvancedMD's own, offered in XML-RPC and REST. The FHIR APIs follow FHIR R4 and only read.
The full Connect docs come with a signed Certified API Developer Agreement, which carries licensing and support fees. AdvancedMD's sales team handles it.
The sandbox is a demo office key, with login credentials, documentation and tools. Real patient data isn't allowed in it.
Going live takes a vendor worksheet, a test with AdvancedMD's interoperability team if you write data, an API Connect Agreement, then production credentials.
FHIR APIs or Connect APIs: which one your workflow needs
Clinical records, fetched only
- Part of AdvancedMD's certified EHR technology, with documentation of their own.
- GET requests only. Nothing is created, changed or deleted.
- Fits an app that needs to read clinical records it's authorized for.
Practice data, read and write
- AdvancedMD's own APIs, in XML-RPC and REST, for pushing and pulling data such as searches.
- Full create, read, update and delete where the workflow needs it.
- Behind the developer agreement, its fees and AdvancedMD's go-live review.
If your app only reads, start with FHIR. The moment it has to write anything back, AdvancedMD points you to the Connect APIs.
Agreement to production credentials, in order
- 1
Sign the Certified API Developer Agreement
Contact AdvancedMD sales. The agreement includes licensing and support fees, and it's what grants the full API documentation.
- 2
Receive the sandbox key
A demo office set up for testing. Once AdvancedMD's interoperability team gets the request from implementation, it's normally ready within about a day.
Watch for: test data. AdvancedMD doesn't allow development or testing with real patient data, so plan made-up records from the start.
- 3
Build and test in the sandbox
Work through the documentation and tools that come with the key until the integration does everything it will do in production.
- 4
Complete the API vendor worksheet
It documents what your interface does, so AdvancedMD has a record of it.
- 5
Demonstrate it to InterOps
If the integration adds data to AdvancedMD, a test is scheduled with the interoperability team. Production credentials, including a unique app name, follow a successful demonstration and an API Connect Agreement.
Before the AdvancedMD interoperability review
Can you describe every call the interface makes?
The vendor worksheet asks what your interface does. A clear list of reads and writes makes it quick to fill in and easier to review.
Does it write data, or only read?
Writing data is what triggers the scheduled test, and it's also the line between the FHIR APIs and Connect.
Is the sandbox data entirely made up?
Real patient data isn't allowed in the sandbox. Seed it with records that still cover the awkward cases your production data has.
Who at the practice signs off on what data moves?
Live records will include protected health information, so the practice's compliance lead should settle the paperwork between practice and vendor well before production credentials arrive.
What does the integration do when a call fails?
Decide where a refused write or a timeout goes, and who sees it, before demonstrating. The answer should be the same in the demo and in production.
AdvancedMD API documentation questions
Does AdvancedMD have a public API?
Partly. The FHIR APIs have their own documentation and only read. The Connect APIs, which can write, are open to developers who sign the Certified API Developer Agreement and pass AdvancedMD's go-live review.
What is the AdvancedMD API documentation for?
It's the reference for building against AdvancedMD: the calls, data and tools for the Connect APIs, delivered with the sandbox once the developer agreement is signed. The public pages describe what's possible. The full documentation is what you build from.
What is the AdvancedMD Marketplace?
AdvancedMD's directory of partner apps already integrated with it, for needs like patient engagement, e-prescribing and clearinghouse work. A vendor that already has an API connection can ask to be considered for it. Our AdvancedMD page covers when a Marketplace app beats a custom build.
Can a practice get AdvancedMD data into accounting or reporting software automatically?
Not with a built-in feature. A Marketplace app may cover it; otherwise the data comes through the Connect APIs under an approved agreement, or from report exports that a build processes on a set schedule. The AdvancedMD billing page goes into the accounting side.