Practice Info Reference

The Practice Info Reference allows the user to view the configured practice information in the system.

The Practice Access Reference returns an acknowledgement that the request was received and that this API key has access to the given practice.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Get list of practice(s), athena-products enabled for the user
GET
/v1/{practiceid}/practiceinfo

Retrieves the practice information

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
ccmenabled string When called with a Context ID, this will return whether or not Cronic Care Management is enabled for the given practice. Currently, this is only available when querying an individual practice (not practice ID 1).
experiencemode string This is a practice setting which is set to one of the following: STREAMLINEDONLY, STREAMLINEDANDCLASSIC, CLASSICONLY, LEGACYSTREAMLINED, or BYUSER
golivedate string The date that this practice went (or will go) live in athenaNet. Note that, if in the future, this date might change as implementations are moved around.
hasclinicals string Does this practice use athenaClinicals.
hascollector string Does this practice use athenaCollector.
hascommunicator string Does this practice use athenaCommunicator.
iscoordinatorreceiver string
iscoordinatorsender string
mastercontextid string This will appear only in athena's demo environment, and indicates the context ID (Practice's ID number) of the practice this was copied from. Please note - a master's context ID may change roughly once per week in the future. If you need to refer to a master context in a static manner, see MASTERID.
mastercontextname string This will appear only in athena's demo environment, and indicates the name of the practice this was copied from.
masterid string This will appear only in athena's demo environment. The MASTERID is the ID for a master, which is static throughout the lifetime of the master. Though a master's schema number (MASTERCONTEXTID) may change, the MASTERID field will never change. The MASTERID is analogous to finishing third in a race - you will always be known for finishing third. The MASTERCONTEXTID is analogous to your phone number, which may change if you ditch your phone line for a different carrier.
name string The name athenahealth uses internally for this practice. Note that practices may use different names for patients.
nsaenabled string When called with a Context ID, this will return whether or not New Schedule Admin is enabled for the given practice.
practiceid string The athenaNet practice ID.
publicnames string When available, one or more names that the practices uses externally from athenaCommunicator. Again, this name should be verified with the practice before using it for patients. Currently, this is only available when querying an individual practice (not practice ID 1).
Example Code
Return an acknowledgement that request was received and that this API key has access to the given practice.
GET
/v1/{practiceid}/ping

No description

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

Output Parameters

Expand all
pong string Acknowledgement of request
Example Code