The athenahealth connector lets your AI agent act in each user's athenahealth account. Each user signs in to athenahealth once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 55 tools.
- Tools
- 55
- What they doRead · write · destructive
- 55 · 0 · 055 read0 write0 destructive
- Users sign in with
- SMART on FHIR
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the athenahealth connection
In AgentKit > Connections, create an athenahealth connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Console steps with screenshots
athenahealth connections use SMART on FHIR and act as the signed-in clinician, through athenaOne’s certified FHIR R4 API. The tools read data only. The connection already has athenahealth’s production authorization and token endpoints; you add the audience (
aud), the FHIR server domain, and the client ID and secret of your athenahealth app.-
Create the connection and copy the redirect URI
In the Scalekit dashboard, go to AgentKit > Connections > Create Connection, find athenahealth and click Create. Copy the Redirect URI.
-
Register a provider app with athenahealth
Register a confidential provider app with athenahealth that uses user-context scopes, and note its client ID and client secret:
- Add the redirect URI you copied.
- Request refresh tokens (
offline_access).
Confirm the exact scope names athenahealth registers for your app; select the same ones on the connection.
-
Enter the values on the connection
Back on the athenahealth connection, enter:
- Client ID and Client Secret: from your athenahealth app.
- Audience (aud):
https://api.platform.athenahealth.com/fhir/r4 - FHIR Server Domain:
api.platform.athenahealth.com/fhir/r4
Select
openid,fhirUserandoffline_access, plus the resource scopes your agent needs, such asuser/Patient.read. Click Save.To test in athenahealth’s preview environment, replace the production values with these:
Field Preview value Authorization Endpoint https://api.preview.platform.athenahealth.com/oauth2/v1/authorizeToken Endpoint https://api.preview.platform.athenahealth.com/oauth2/v1/tokenAudience (aud) https://api.preview.platform.athenahealth.com/fhir/r4FHIR Server Domain api.preview.platform.athenahealth.com/fhir/r4
-
Tools
Pass the exact name toexecute_toolathenahealth_allergy_intolerance_readRetrieve one athenahealth FHIR AllergyIntolerance resource by its logical ID.Read-onlyGet Allergy
Retrieve one athenahealth FHIR AllergyIntolerance resource by its logical ID. Returns the AllergyIntolerance resource: allergies and intolerances recorded on a patient's chart, with substance code, clinical status, reaction, and criticality. Use this when you already have the allergy ID. Use athenahealth_allergy_intolerance_search to find allergies.
Inputs
allergy_intolerance_idstringrequired- Logical ID of the AllergyIntolerance resource (the id element, without the AllergyIntolerance/ prefix).
athenahealth_allergy_intolerance_searchSearch athenahealth FHIR AllergyIntolerance resources (allergies) available to the signed-in clinician.Read-onlySearch Allergies
Search athenahealth FHIR AllergyIntolerance resources (allergies) available to the signed-in clinician. Returns a FHIR Bundle of AllergyIntolerance entries: allergies and intolerances recorded on a patient's chart, with substance code, clinical status, reaction, and criticality; follow the cursor in the Bundle's next link to page. Use this to find or list allergies. Use athenahealth_allergy_intolerance_read when you already have the allergy ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
patientstringrequired- athenahealth FHIR ID of the patient whose allergies to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_lastUpdatedstring- Only return allergies last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
codestring- Allergy substance code as system|code or code, e.g. an RxNorm or SNOMED CT code.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
athenahealth_appointment_readRetrieve one athenahealth FHIR Appointment resource by its logical ID.Read-onlyGet Appointment
Retrieve one athenahealth FHIR Appointment resource by its logical ID. Returns the Appointment resource: a scheduled appointment, with status, start and end time, appointment type, participants (patient, provider, location), and athenahealth appointment extensions. Use this when you already have the appointment ID, for example from an Encounter or a scheduling workflow; athenahealth's FHIR API does not offer an open appointment search.
Inputs
appointment_idstringrequired- Logical ID of the Appointment resource (the id element, without the Appointment/ prefix).
athenahealth_binary_readRetrieve one athenahealth FHIR Binary resource by its logical ID.Read-onlyGet Binary
Retrieve one athenahealth FHIR Binary resource by its logical ID. Returns the Binary resource: raw document content (for example a clinical document or image referenced by a DocumentReference attachment), returned as a FHIR Binary with contentType and base64 data. Use this to fetch the document content referenced by a DocumentReference attachment URL (Binary/<id>).
Inputs
binary_idstringrequired- Logical ID of the Binary resource (the id element, without the Binary/ prefix).
athenahealth_care_plan_readRetrieve one athenahealth FHIR CarePlan resource by its logical ID.Read-onlyGet Care Plan
Retrieve one athenahealth FHIR CarePlan resource by its logical ID. Returns the CarePlan resource: assessment-and-plan care plans, with category, status, intent, period, and narrative text. Use this when you already have the care plan ID. Use athenahealth_care_plan_search to find care plans.
Inputs
care_plan_idstringrequired- Logical ID of the CarePlan resource (the id element, without the CarePlan/ prefix).
athenahealth_care_plan_searchSearch athenahealth FHIR CarePlan resources (care plans) available to the signed-in clinician.Read-onlySearch Care Plans
Search athenahealth FHIR CarePlan resources (care plans) available to the signed-in clinician. Returns a FHIR Bundle of CarePlan entries: assessment-and-plan care plans, with category, status, intent, period, and narrative text; follow the cursor in the Bundle's next link to page. Use this to find or list care plans. Use athenahealth_care_plan_read when you already have the care plan ID. athenahealth requires at least one of: Patient ID; Care Plan ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific CarePlan to match. Returns a Bundle with that one resource; use athenahealth_care_plan_read to fetch it directly.
_lastUpdatedstring- Only return care plans last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
categorystring- Care plan category. athenahealth care plans use the US Core category assess-plan.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
patientstring- athenahealth FHIR ID of the patient whose care plans to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
athenahealth_care_team_readRetrieve one athenahealth FHIR CareTeam resource by its logical ID.Read-onlyGet Care Team
Retrieve one athenahealth FHIR CareTeam resource by its logical ID. Returns the CareTeam resource: a patient's care team, with status and participants (practitioners, organizations, and their roles). Use this when you already have the care team ID. Use athenahealth_care_team_search to find care teams.
Inputs
care_team_idstringrequired- Logical ID of the CareTeam resource (the id element, without the CareTeam/ prefix).
athenahealth_care_team_searchSearch athenahealth FHIR CareTeam resources (care teams) available to the signed-in clinician.Read-onlySearch Care Teams
Search athenahealth FHIR CareTeam resources (care teams) available to the signed-in clinician. Returns a FHIR Bundle of CareTeam entries: a patient's care team, with status and participants (practitioners, organizations, and their roles); follow the cursor in the Bundle's next link to page. Use this to find or list care teams. Use athenahealth_care_team_read when you already have the care team ID. athenahealth requires at least one of: Patient ID; Care Team ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific CareTeam to match. Returns a Bundle with that one resource; use athenahealth_care_team_read to fetch it directly.
_lastUpdatedstring- Only return care teams last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
patientstring- athenahealth FHIR ID of the patient whose care teams to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
statusstring- Filter by care team status: one of proposed, active, suspended, inactive, entered-in-error.one of
proposedactivesuspendedinactiveentered-in-error
athenahealth_condition_readRetrieve one athenahealth FHIR Condition resource by its logical ID.Read-onlyGet Condition
Retrieve one athenahealth FHIR Condition resource by its logical ID. Returns the Condition resource: problems and diagnoses (problem-list items, encounter diagnoses, health concerns), with code, clinical and verification status, category, and onset. Use this when you already have the condition ID. Use athenahealth_condition_search to find conditions.
Inputs
condition_idstringrequired- Logical ID of the Condition resource (the id element, without the Condition/ prefix).
athenahealth_condition_searchSearch athenahealth FHIR Condition resources (conditions) available to the signed-in clinician.Read-onlySearch Conditions
Search athenahealth FHIR Condition resources (conditions) available to the signed-in clinician. Returns a FHIR Bundle of Condition entries: problems and diagnoses (problem-list items, encounter diagnoses, health concerns), with code, clinical and verification status, category, and onset; follow the cursor in the Bundle's next link to page. Use this to find or list conditions. Use athenahealth_condition_read when you already have the condition ID. athenahealth requires at least one of: Encounter ID; Patient ID; Condition ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific Condition to match. Returns a Bundle with that one resource; use athenahealth_condition_read to fetch it directly.
_lastUpdatedstring- Only return conditions last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
categorystring- Condition category as system|code, e.g. http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item, http://terminology.hl7.org/CodeSystem/condition-category|encounter-diagnosis, or http://hl7.org/fhir/us/core/CodeSystem/condition-category|health-concern.
codestring- Condition code as system|code or code, e.g. an ICD-10-CM or SNOMED CT code.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
encounterstring- FHIR ID of the Encounter the conditions belong to, or an Encounter/<id> reference.
patientstring- athenahealth FHIR ID of the patient whose conditions to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
athenahealth_coverage_readRetrieve one athenahealth FHIR Coverage resource by its logical ID.Read-onlyGet Coverage
Retrieve one athenahealth FHIR Coverage resource by its logical ID. Returns the Coverage resource: insurance coverage records, with payor, subscriber, beneficiary, relationship, class (group/plan), status, and period. Use this when you already have the coverage ID. Use athenahealth_coverage_search to find coverages.
Inputs
coverage_idstringrequired- Logical ID of the Coverage resource (the id element, without the Coverage/ prefix).
athenahealth_coverage_searchSearch athenahealth FHIR Coverage resources (coverages) available to the signed-in clinician.Read-onlySearch Coverages
Search athenahealth FHIR Coverage resources (coverages) available to the signed-in clinician. Returns a FHIR Bundle of Coverage entries: insurance coverage records, with payor, subscriber, beneficiary, relationship, class (group/plan), status, and period; follow the cursor in the Bundle's next link to page. Use this to find or list coverages. Use athenahealth_coverage_read when you already have the coverage ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
patientstringrequired- athenahealth FHIR ID of the patient whose coverages to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_lastUpdatedstring- Only return coverages last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
athenahealth_device_readRetrieve one athenahealth FHIR Device resource by its logical ID.Read-onlyGet Device
Retrieve one athenahealth FHIR Device resource by its logical ID. Returns the Device resource: implantable devices recorded for a patient, with UDI, device type, status, and expiration and manufacture details. Use this when you already have the device ID. Use athenahealth_device_search to find devices.
Inputs
device_idstringrequired- Logical ID of the Device resource (the id element, without the Device/ prefix).
athenahealth_device_searchSearch athenahealth FHIR Device resources (devices) available to the signed-in clinician.Read-onlySearch Devices
Search athenahealth FHIR Device resources (devices) available to the signed-in clinician. Returns a FHIR Bundle of Device entries: implantable devices recorded for a patient, with UDI, device type, status, and expiration and manufacture details; follow the cursor in the Bundle's next link to page. Use this to find or list devices. Use athenahealth_device_read when you already have the device ID. athenahealth requires at least one of: Patient ID; Device ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific Device to match. Returns a Bundle with that one resource; use athenahealth_device_read to fetch it directly.
_lastUpdatedstring- Only return devices last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
patientstring- athenahealth FHIR ID of the patient whose devices to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
athenahealth_diagnostic_report_readRetrieve one athenahealth FHIR DiagnosticReport resource by its logical ID.Read-onlyGet Diagnostic Report
Retrieve one athenahealth FHIR DiagnosticReport resource by its logical ID. Returns the DiagnosticReport resource: lab and imaging reports, with category, code, status, effective date, performer, result Observation references, and presented form. Use this when you already have the diagnostic report ID. Use athenahealth_diagnostic_report_search to find diagnostic reports.
Inputs
diagnostic_report_idstringrequired- Logical ID of the DiagnosticReport resource (the id element, without the DiagnosticReport/ prefix).
athenahealth_diagnostic_report_searchSearch athenahealth FHIR DiagnosticReport resources (diagnostic reports) available to the signed-in clinician.Read-onlySearch Diagnostic Reports
Search athenahealth FHIR DiagnosticReport resources (diagnostic reports) available to the signed-in clinician. Returns a FHIR Bundle of DiagnosticReport entries: lab and imaging reports, with category, code, status, effective date, performer, result Observation references, and presented form; follow the cursor in the Bundle's next link to page. Use this to find or list diagnostic reports. Use athenahealth_diagnostic_report_read when you already have the diagnostic report ID. athenahealth requires at least one of: Patient ID; Diagnostic Report ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific DiagnosticReport to match. Returns a Bundle with that one resource; use athenahealth_diagnostic_report_read to fetch it directly.
_lastUpdatedstring- Only return diagnostic reports last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
categorystring- Report category code, e.g. LAB for laboratory reports or RAD for imaging, optionally as system|code (http://terminology.hl7.org/CodeSystem/v2-0074|LAB).
codestring- Report code as system|code, e.g. a LOINC code. Separate multiple codes with commas.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
datestring- Filter by the report's effective date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
encounterstring- FHIR ID of the Encounter the diagnostic reports belong to, or an Encounter/<id> reference.
patientstring- athenahealth FHIR ID of the patient whose diagnostic reports to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
performerstring- Reference to the Practitioner or Organization who performed or is to perform it, as Practitioner/<id> or Organization/<id>.
resultstring- FHIR ID of an Observation that is a result in the report, or an Observation/<id> reference.
athenahealth_document_reference_readRetrieve one athenahealth FHIR DocumentReference resource by its logical ID.Read-onlyGet Document Reference
Retrieve one athenahealth FHIR DocumentReference resource by its logical ID. Returns the DocumentReference resource: clinical notes and documents, with type, category, date, author, status, and attachment links to the document content. Use this when you already have the document reference ID. Use athenahealth_document_reference_search to find document references.
Inputs
document_reference_idstringrequired- Logical ID of the DocumentReference resource (the id element, without the DocumentReference/ prefix).
athenahealth_document_reference_searchSearch athenahealth FHIR DocumentReference resources (document references) available to the signed-in clinician.Read-onlySearch Document References
Search athenahealth FHIR DocumentReference resources (document references) available to the signed-in clinician. Returns a FHIR Bundle of DocumentReference entries: clinical notes and documents, with type, category, date, author, status, and attachment links to the document content; follow the cursor in the Bundle's next link to page. Use this to find or list document references. Use athenahealth_document_reference_read when you already have the document reference ID. athenahealth requires at least one of: Patient ID; Document Reference ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific DocumentReference to match. Returns a Bundle with that one resource; use athenahealth_document_reference_read to fetch it directly.
_lastUpdatedstring- Only return document references last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
authorstring- Reference to the document author, as Practitioner/<id> or Organization/<id>.
categorystring- Document category, e.g. clinical-note (US Core clinical notes), optionally as system|code (http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category|clinical-note).
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
custodianstring- Reference to the Organization that maintains the document, as Organization/<id>.
datestring- Filter by the document date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
encounterstring- FHIR ID of the Encounter the document references belong to, or an Encounter/<id> reference.
patientstring- athenahealth FHIR ID of the patient whose document references to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
typestring- Document type as system|code, e.g. a LOINC document code.
athenahealth_encounter_readRetrieve one athenahealth FHIR Encounter resource by its logical ID.Read-onlyGet Encounter
Retrieve one athenahealth FHIR Encounter resource by its logical ID. Returns the Encounter resource: visits and encounters, with class, type, status, period, participants, location, and service provider. Use this when you already have the encounter ID. Use athenahealth_encounter_search to find encounters.
Inputs
encounter_idstringrequired- Logical ID of the Encounter resource (the id element, without the Encounter/ prefix).
athenahealth_encounter_searchSearch athenahealth FHIR Encounter resources (encounters) available to the signed-in clinician.Read-onlySearch Encounters
Search athenahealth FHIR Encounter resources (encounters) available to the signed-in clinician. Returns a FHIR Bundle of Encounter entries: visits and encounters, with class, type, status, period, participants, location, and service provider; follow the cursor in the Bundle's next link to page. Use this to find or list encounters. Use athenahealth_encounter_read when you already have the encounter ID. athenahealth requires at least one of: Patient ID; Encounter ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific Encounter to match. Returns a Bundle with that one resource; use athenahealth_encounter_read to fetch it directly.
_lastUpdatedstring- Only return encounters last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
datestring- Filter by the encounter period. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
locationstring- FHIR ID of the Location (department) where the encounter took place, or a Location/<id> reference.
patientstring- athenahealth FHIR ID of the patient whose encounters to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
practitionerstring- FHIR ID of a Practitioner who participated in the encounter, or a Practitioner/<id> reference.
service_providerstring- FHIR ID of the Organization responsible for the encounter, or an Organization/<id> reference.
athenahealth_family_member_history_readRetrieve one athenahealth FHIR FamilyMemberHistory resource by its logical ID.Read-onlyGet Family Member History
Retrieve one athenahealth FHIR FamilyMemberHistory resource by its logical ID. Returns the FamilyMemberHistory resource: family medical history entries, with relationship, status, and the relative's conditions. Use this when you already have the family member history ID. Use athenahealth_family_member_history_search to find family member histories.
Inputs
family_member_history_idstringrequired- Logical ID of the FamilyMemberHistory resource (the id element, without the FamilyMemberHistory/ prefix).
athenahealth_family_member_history_searchSearch athenahealth FHIR FamilyMemberHistory resources (family member histories) available to the signed-in clinician.Read-onlySearch Family Member Histories
Search athenahealth FHIR FamilyMemberHistory resources (family member histories) available to the signed-in clinician. Returns a FHIR Bundle of FamilyMemberHistory entries: family medical history entries, with relationship, status, and the relative's conditions. Use this to find or list family member histories. Use athenahealth_family_member_history_read when you already have the family member history ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_idstring- Logical ID of a specific FamilyMemberHistory to match. Returns a Bundle with that one resource; use athenahealth_family_member_history_read to fetch it directly.
_lastUpdatedstring- Only return family member histories last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
codestring- Condition code recorded for the relative, as system|code or code.
patientstring- athenahealth FHIR ID of the patient whose family member histories to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
relationshipstring- Relationship of the family member to the patient as a code or system|code, e.g. FTH (father) or MTH (mother) from the v3 RoleCode system.
statusstring- Filter by family member history status: one of partial, completed, entered-in-error, health-unknown.one of
partialcompletedentered-in-errorhealth-unknown
athenahealth_goal_readRetrieve one athenahealth FHIR Goal resource by its logical ID.Read-onlyGet Goal
Retrieve one athenahealth FHIR Goal resource by its logical ID. Returns the Goal resource: patient care goals, with lifecycle status, description, target, and start date. Use this when you already have the goal ID. Use athenahealth_goal_search to find goals.
Inputs
goal_idstringrequired- Logical ID of the Goal resource (the id element, without the Goal/ prefix).
athenahealth_goal_searchSearch athenahealth FHIR Goal resources (goals) available to the signed-in clinician.Read-onlySearch Goals
Search athenahealth FHIR Goal resources (goals) available to the signed-in clinician. Returns a FHIR Bundle of Goal entries: patient care goals, with lifecycle status, description, target, and start date; follow the cursor in the Bundle's next link to page. Use this to find or list goals. Use athenahealth_goal_read when you already have the goal ID. athenahealth requires at least one of: Patient ID; Goal ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific Goal to match. Returns a Bundle with that one resource; use athenahealth_goal_read to fetch it directly.
_lastUpdatedstring- Only return goals last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
patientstring- athenahealth FHIR ID of the patient whose goals to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
athenahealth_immunization_readRetrieve one athenahealth FHIR Immunization resource by its logical ID.Read-onlyGet Immunization
Retrieve one athenahealth FHIR Immunization resource by its logical ID. Returns the Immunization resource: administered or recorded vaccines, with vaccine code, status, occurrence date, lot number, and performer. Use this when you already have the immunization ID. Use athenahealth_immunization_search to find immunizations.
Inputs
immunization_idstringrequired- Logical ID of the Immunization resource (the id element, without the Immunization/ prefix).
athenahealth_immunization_searchSearch athenahealth FHIR Immunization resources (immunizations) available to the signed-in clinician.Read-onlySearch Immunizations
Search athenahealth FHIR Immunization resources (immunizations) available to the signed-in clinician. Returns a FHIR Bundle of Immunization entries: administered or recorded vaccines, with vaccine code, status, occurrence date, lot number, and performer; follow the cursor in the Bundle's next link to page. Use this to find or list immunizations. Use athenahealth_immunization_read when you already have the immunization ID. athenahealth requires at least one of: Patient ID; Immunization ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific Immunization to match. Returns a Bundle with that one resource; use athenahealth_immunization_read to fetch it directly.
_lastUpdatedstring- Only return immunizations last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
datestring- Filter by the vaccine occurrence date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
encounterstring- FHIR ID of the Encounter the immunizations belong to, or an Encounter/<id> reference.
patientstring- athenahealth FHIR ID of the patient whose immunizations to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
statusstring- Filter by immunization status: one of completed, entered-in-error, not-done.one of
completedentered-in-errornot-done vaccine_codestring- Vaccine product code as system|code or code, e.g. a CVX code.
athenahealth_location_readRetrieve one athenahealth FHIR Location resource by its logical ID.Read-onlyGet Location
Retrieve one athenahealth FHIR Location resource by its logical ID. Returns the Location resource: practice locations (athenahealth departments), with name, address, telecom, and status. Use this when you already have the location ID, for example from a reference on a Patient, Encounter, or other resource; athenahealth's Location search only accepts the ID, so no separate search tool is provided.
Inputs
location_idstringrequired- Logical ID of the Location resource (the id element, without the Location/ prefix).
athenahealth_media_readRetrieve one athenahealth FHIR Media resource by its logical ID.Read-onlyGet Media
Retrieve one athenahealth FHIR Media resource by its logical ID. Returns the Media resource: a media item (such as a photo or scanned image) with its content type, subject, and attachment. Use this when you already have the media ID, for example from a reference on another resource; athenahealth's FHIR API offers no Media search.
Inputs
media_idstringrequired- Logical ID of the Media resource (the id element, without the Media/ prefix).
athenahealth_medication_dispense_readRetrieve one athenahealth FHIR MedicationDispense resource by its logical ID.Read-onlyGet Medication Dispense
Retrieve one athenahealth FHIR MedicationDispense resource by its logical ID. Returns the MedicationDispense resource: medication dispense records, with medication, status, quantity, days supply, and when handed over. Use this when you already have the medication dispense ID. Use athenahealth_medication_dispense_search to find medication dispenses.
Inputs
medication_dispense_idstringrequired- Logical ID of the MedicationDispense resource (the id element, without the MedicationDispense/ prefix).
athenahealth_medication_dispense_searchSearch athenahealth FHIR MedicationDispense resources (medication dispenses) available to the signed-in clinician.Read-onlySearch Medication Dispenses
Search athenahealth FHIR MedicationDispense resources (medication dispenses) available to the signed-in clinician. Returns a FHIR Bundle of MedicationDispense entries: medication dispense records, with medication, status, quantity, days supply, and when handed over. Use this to find or list medication dispenses. Use athenahealth_medication_dispense_read when you already have the medication dispense ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_idstring- Logical ID of a specific MedicationDispense to match. Returns a Bundle with that one resource; use athenahealth_medication_dispense_read to fetch it directly.
_lastUpdatedstring- Only return medication dispenses last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
datestring- Filter by the dispense date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
patientstring- athenahealth FHIR ID of the patient whose medication dispenses to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
statusstring- Filter by medication dispense status: one of preparation, in-progress, cancelled, on-hold, completed, entered-in-error, stopped, declined, unknown.one of
preparationin-progresscancelledon-holdcompletedentered-in-errorstoppeddeclinedunknown
athenahealth_medication_readRetrieve one athenahealth FHIR Medication resource by its logical ID.Read-onlyGet Medication
Retrieve one athenahealth FHIR Medication resource by its logical ID. Returns the Medication resource: medication definitions, with code (RxNorm), form, and ingredients. Use this when you already have the medication ID, for example from a reference on a Patient, Encounter, or other resource; athenahealth's Medication search only accepts the ID, so no separate search tool is provided.
Inputs
medication_idstringrequired- Logical ID of the Medication resource (the id element, without the Medication/ prefix).
athenahealth_medication_request_readRetrieve one athenahealth FHIR MedicationRequest resource by its logical ID.Read-onlyGet Medication Request
Retrieve one athenahealth FHIR MedicationRequest resource by its logical ID. Returns the MedicationRequest resource: prescriptions and medication orders, with medication, status, intent, authored date, requester, and dosage instructions. Use this when you already have the medication request ID. Use athenahealth_medication_request_search to find medication requests.
Inputs
medication_request_idstringrequired- Logical ID of the MedicationRequest resource (the id element, without the MedicationRequest/ prefix).
athenahealth_medication_request_searchSearch athenahealth FHIR MedicationRequest resources (medication requests) available to the signed-in clinician.Read-onlySearch Medication Requests
Search athenahealth FHIR MedicationRequest resources (medication requests) available to the signed-in clinician. Returns a FHIR Bundle of MedicationRequest entries: prescriptions and medication orders, with medication, status, intent, authored date, requester, and dosage instructions; follow the cursor in the Bundle's next link to page. Use this to find or list medication requests. Use athenahealth_medication_request_read when you already have the medication request ID. athenahealth requires at least one of: Patient ID + Intent; Medication Request ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific MedicationRequest to match. Returns a Bundle with that one resource; use athenahealth_medication_request_read to fetch it directly.
_lastUpdatedstring- Only return medication requests last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
authoredonstring- Filter by the date the medication request was authored. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
codestring- RxNorm code of the prescribed medication, as system|code or code. Use together with patient and intent.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
encounterstring- FHIR ID of the Encounter the medication requests belong to, or an Encounter/<id> reference.
ingredient_codestring- Ingredient code of the medication as system|code or code, e.g. an RxNorm ingredient code.
intentstring- Intent of the medication request. athenahealth requires intent together with patient when searching by patient (use order for prescriptions).one of
proposalplanorderoriginal-orderreflex-orderfiller-orderinstance-orderoption medicationstring- Reference to the Medication resource, as Medication/<id>.
patientstring- athenahealth FHIR ID of the patient whose medication requests to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
requesterstring- Reference to the Practitioner who made the request, as Practitioner/<id>.
statusstring- Filter by medication request status: one of active, on-hold, cancelled, completed, entered-in-error, stopped, draft, unknown.one of
activeon-holdcancelledcompletedentered-in-errorstoppeddraftunknown
athenahealth_next_pageFetch the next page of results from a previous athenahealth search tool by following the next link (Bundle.link with relation next) in that search's result.Read-onlyGet Next Page of Search Results
Fetch the next page of results from a previous athenahealth search tool by following the next link (Bundle.link with relation next) in that search's result. Returns a FHIR Bundle with the next set of entries; when a Bundle has no next link, it is the last page.
Inputs
next_page_pathstringrequired- The part of the previous result's next link (Bundle.link with relation next) that comes after /fhir/r4/, copied exactly: it starts with the resource type, has no leading slash, and keeps the whole query string, including cursor. For the next link https://api.preview.platform.athenahealth.com/fhir/r4/Condition?patient=a-80000.E-14545&cursor=a-80000.EncounterDx-55039, pass Condition?patient=a-80000.E-14545&cursor=a-80000.EncounterDx-55039.
athenahealth_observation_readRetrieve one athenahealth FHIR Observation resource by its logical ID.Read-onlyGet Observation
Retrieve one athenahealth FHIR Observation resource by its logical ID. Returns the Observation resource: vital signs, lab results, social history, and other measurements, with code, value, category, status, and effective date. Use this when you already have the observation ID. Use athenahealth_observation_search to find observations.
Inputs
observation_idstringrequired- Logical ID of the Observation resource (the id element, without the Observation/ prefix).
athenahealth_observation_searchSearch athenahealth FHIR Observation resources (observations) available to the signed-in clinician.Read-onlySearch Observations
Search athenahealth FHIR Observation resources (observations) available to the signed-in clinician. Returns a FHIR Bundle of Observation entries: vital signs, lab results, social history, and other measurements, with code, value, category, status, and effective date; follow the cursor in the Bundle's next link to page. Use this to find or list observations. Use athenahealth_observation_read when you already have the observation ID. athenahealth requires at least one of: Patient ID; Observation ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific Observation to match. Returns a Bundle with that one resource; use athenahealth_observation_read to fetch it directly.
_lastUpdatedstring- Only return observations last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
categorystring- Observation category code, e.g. vital-signs, laboratory, social-history, survey, exam, or imaging.
codestring- Observation code as system|code, e.g. a LOINC code. Separate multiple codes with commas.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
datestring- Filter by the observation date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
encounterstring- FHIR ID of the Encounter the observations belong to, or an Encounter/<id> reference.
patientstring- athenahealth FHIR ID of the patient whose observations to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
athenahealth_organization_readRetrieve one athenahealth FHIR Organization resource by its logical ID.Read-onlyGet Organization
Retrieve one athenahealth FHIR Organization resource by its logical ID. Returns the Organization resource: athenahealth organizations (practices, provider groups, chart sharing groups), with name, identifiers, address, and telecom. Use this when you already have the organization ID, for example from a reference on a Patient, Encounter, or other resource; athenahealth's Organization search only accepts the ID, so no separate search tool is provided.
Inputs
organization_idstringrequired- Logical ID of the Organization resource (the id element, without the Organization/ prefix).
athenahealth_patient_readRetrieve one athenahealth FHIR Patient resource by its logical ID.Read-onlyGet Patient
Retrieve one athenahealth FHIR Patient resource by its logical ID. Returns the Patient resource: patient demographics, with name, birth date, gender, identifiers, address, telecom, and athenahealth organization extensions. Use this when you already have the patient ID. Use athenahealth_patient_search to find patients.
Inputs
patient_idstringrequired- Logical ID of the Patient resource (the id element, without the Patient/ prefix).
athenahealth_patient_searchSearch athenahealth FHIR Patient resources (patients) available to the signed-in clinician.Read-onlySearch Patients
Search athenahealth FHIR Patient resources (patients) available to the signed-in clinician. Returns a FHIR Bundle of Patient entries: patient demographics, with name, birth date, gender, identifiers, address, telecom, and athenahealth organization extensions; follow the cursor in the Bundle's next link to page. Use this to find or list patients. Use athenahealth_patient_read when you already have the patient ID. athenahealth requires at least one of: Patient ID; Identifier; Name; Family Name + Birth Date; Family Name + Gender; Family Name + Given Name. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific Patient to match. Returns a Bundle with that one resource; use athenahealth_patient_read to fetch it directly.
_lastUpdatedstring- Only return patients last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
birthdatestring- Patient's date of birth in YYYY-MM-DD format. Use together with family.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
familystring- Part of the patient's family (last) name. Combine with given, birthdate, or gender.
genderstring- Administrative gender: male, female, other, or unknown. Use together with family.one of
malefemaleotherunknown givenstring- Part of the patient's given (first) name. Use together with family.
identifierstring- Patient identifier as system|value or value, e.g. a medical record number.
namestring- Text to match against any part of the patient's name (family, given, prefix, suffix, or text).
athenahealth_practitioner_readRetrieve one athenahealth FHIR Practitioner resource by its logical ID.Read-onlyGet Practitioner
Retrieve one athenahealth FHIR Practitioner resource by its logical ID. Returns the Practitioner resource: practitioners (providers and users), with name, identifiers such as NPI, qualification, and telecom. Use this when you already have the practitioner ID. Use athenahealth_practitioner_search to find practitioners.
Inputs
practitioner_idstringrequired- Logical ID of the Practitioner resource (the id element, without the Practitioner/ prefix).
athenahealth_practitioner_searchSearch athenahealth FHIR Practitioner resources (practitioners) available to the signed-in clinician.Read-onlySearch Practitioners
Search athenahealth FHIR Practitioner resources (practitioners) available to the signed-in clinician. Returns a FHIR Bundle of Practitioner entries: practitioners (providers and users), with name, identifiers such as NPI, qualification, and telecom. Use this to find or list practitioners. Use athenahealth_practitioner_read when you already have the practitioner ID. athenahealth requires at least one of: Practitioner ID; Identifier + Practice. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_idstring- Logical ID of a specific Practitioner to match. Returns a Bundle with that one resource; use athenahealth_practitioner_read to fetch it directly.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
identifierstring- athenaNet username identifier as system|value, i.e. https://identity.athena.io/sid/athenanet-user|<username>. Must be combined with Practice.
athenahealth_procedure_readRetrieve one athenahealth FHIR Procedure resource by its logical ID.Read-onlyGet Procedure
Retrieve one athenahealth FHIR Procedure resource by its logical ID. Returns the Procedure resource: performed procedures, with code, status, performed date or period, performer, and focal device. Use this when you already have the procedure ID. Use athenahealth_procedure_search to find procedures.
Inputs
procedure_idstringrequired- Logical ID of the Procedure resource (the id element, without the Procedure/ prefix).
athenahealth_procedure_searchSearch athenahealth FHIR Procedure resources (procedures) available to the signed-in clinician.Read-onlySearch Procedures
Search athenahealth FHIR Procedure resources (procedures) available to the signed-in clinician. Returns a FHIR Bundle of Procedure entries: performed procedures, with code, status, performed date or period, performer, and focal device; follow the cursor in the Bundle's next link to page. Use this to find or list procedures. Use athenahealth_procedure_read when you already have the procedure ID. athenahealth requires at least one of: Patient ID; Procedure ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific Procedure to match. Returns a Bundle with that one resource; use athenahealth_procedure_read to fetch it directly.
_lastUpdatedstring- Only return procedures last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
datestring- Filter by the procedure date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
device_namestring- Reference to the Device that was implanted or manipulated in the procedure, as Device/<id>.
encounterstring- FHIR ID of the Encounter the procedures belong to, or an Encounter/<id> reference.
patientstring- athenahealth FHIR ID of the patient whose procedures to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
performerstring- Reference to the Practitioner who performed or is to perform it, as Practitioner/<id>.
athenahealth_provenance_readRetrieve one athenahealth FHIR Provenance resource by its logical ID.Read-onlyGet Provenance
Retrieve one athenahealth FHIR Provenance resource by its logical ID. Returns the Provenance resource: provenance (authorship and audit) records for a target resource, with recorded time, agents, and the organization responsible. Use this when you already have the provenance ID. Use athenahealth_provenance_search to find provenance records.
Inputs
provenance_idstringrequired- Logical ID of the Provenance resource (the id element, without the Provenance/ prefix).
athenahealth_provenance_searchSearch athenahealth FHIR Provenance resources (provenance records) available to the signed-in clinician.Read-onlySearch Provenance Records
Search athenahealth FHIR Provenance resources (provenance records) available to the signed-in clinician. Returns a FHIR Bundle of Provenance entries: provenance (authorship and audit) records for a target resource, with recorded time, agents, and the organization responsible. Use this to find or list provenance records. Use athenahealth_provenance_read when you already have the provenance ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
targetstringrequired- Reference to the resource whose provenance to return, as <ResourceType>/<id>, e.g. AllergyIntolerance/12345.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
athenahealth_questionnaire_readRetrieve one athenahealth FHIR Questionnaire resource by its logical ID.Read-onlyGet Questionnaire
Retrieve one athenahealth FHIR Questionnaire resource by its logical ID. Returns the Questionnaire resource: questionnaire definitions (forms), with title, status, code, and item structure. Use this when you already have the questionnaire ID. Use athenahealth_questionnaire_search to find questionnaires.
Inputs
questionnaire_idstringrequired- Logical ID of the Questionnaire resource (the id element, without the Questionnaire/ prefix).
athenahealth_questionnaire_response_readRetrieve one athenahealth FHIR QuestionnaireResponse resource by its logical ID.Read-onlyGet Questionnaire Response
Retrieve one athenahealth FHIR QuestionnaireResponse resource by its logical ID. Returns the QuestionnaireResponse resource: completed or in-progress questionnaire responses, with questionnaire, status, authored date, author, and answered items. Use this when you already have the questionnaire response ID. Use athenahealth_questionnaire_response_search to find questionnaire responses.
Inputs
questionnaire_response_idstringrequired- Logical ID of the QuestionnaireResponse resource (the id element, without the QuestionnaireResponse/ prefix).
athenahealth_questionnaire_response_searchSearch athenahealth FHIR QuestionnaireResponse resources (questionnaire responses) available to the signed-in clinician.Read-onlySearch Questionnaire Responses
Search athenahealth FHIR QuestionnaireResponse resources (questionnaire responses) available to the signed-in clinician. Returns a FHIR Bundle of QuestionnaireResponse entries: completed or in-progress questionnaire responses, with questionnaire, status, authored date, author, and answered items. Use this to find or list questionnaire responses. Use athenahealth_questionnaire_response_read when you already have the questionnaire response ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_idstring- Logical ID of a specific QuestionnaireResponse to match. Returns a Bundle with that one resource; use athenahealth_questionnaire_response_read to fetch it directly.
_lastUpdatedstring- Only return questionnaire responses last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
authoredstring- Filter by the date the questionnaire response was authored. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
encounterstring- FHIR ID of the Encounter the questionnaire responses belong to, or an Encounter/<id> reference.
patientstring- athenahealth FHIR ID of the patient whose questionnaire responses to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
questionnairestring- Questionnaire the responses answer, as its canonical URL or ID.
statusstring- Filter by questionnaire response status: one of in-progress, completed, amended, entered-in-error, stopped.one of
in-progresscompletedamendedentered-in-errorstopped
athenahealth_questionnaire_searchSearch athenahealth FHIR Questionnaire resources (questionnaires) available to the signed-in clinician.Read-onlySearch Questionnaires
Search athenahealth FHIR Questionnaire resources (questionnaires) available to the signed-in clinician. Returns a FHIR Bundle of Questionnaire entries: questionnaire definitions (forms), with title, status, code, and item structure. Use this to find or list questionnaires. Use athenahealth_questionnaire_read when you already have the questionnaire ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_idstring- Logical ID of a specific Questionnaire to match. Returns a Bundle with that one resource; use athenahealth_questionnaire_read to fetch it directly.
codestring- Code that corresponds to one of the questionnaire's items, as system|code or code.
athenahealth_service_request_readRetrieve one athenahealth FHIR ServiceRequest resource by its logical ID.Read-onlyGet Service Request
Retrieve one athenahealth FHIR ServiceRequest resource by its logical ID. Returns the ServiceRequest resource: orders and referrals for services (labs, imaging, referrals), with code, category, status, intent, authored date, requester, and performer. Use this when you already have the service request ID. Use athenahealth_service_request_search to find service requests.
Inputs
service_request_idstringrequired- Logical ID of the ServiceRequest resource (the id element, without the ServiceRequest/ prefix).
athenahealth_service_request_searchSearch athenahealth FHIR ServiceRequest resources (service requests) available to the signed-in clinician.Read-onlySearch Service Requests
Search athenahealth FHIR ServiceRequest resources (service requests) available to the signed-in clinician. Returns a FHIR Bundle of ServiceRequest entries: orders and referrals for services (labs, imaging, referrals), with code, category, status, intent, authored date, requester, and performer; follow the cursor in the Bundle's next link to page. Use this to find or list service requests. Use athenahealth_service_request_read when you already have the service request ID. athenahealth requires at least one of: Service Request ID; Patient ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_countinteger- Maximum number of resources to return per page. The server picks a default when omitted.
_idstring- Logical ID of a specific ServiceRequest to match. Returns a Bundle with that one resource; use athenahealth_service_request_read to fetch it directly.
_lastUpdatedstring- Only return service requests last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
ah_practicestring- athenahealth practice to scope the search, as Organization/a-1.Practice-<practiceId>. Optional for clinician sign-in; athenahealth requires it for practitioner identifier searches.
authoredstring- Filter by the date the service request was authored. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
categorystring- Service request category as a code or system|code, e.g. http://snomed.info/sct|108252007 (laboratory procedure).
codestring- Code of the requested service as system|code or code, e.g. a LOINC or CPT code.
cursorstring- Paging cursor for the next page. Copy the cursor query parameter value from the next link (Bundle.link with relation next) of the previous page's response.
encounterstring- FHIR ID of the Encounter the service requests belong to, or an Encounter/<id> reference.
patientstring- athenahealth FHIR ID of the patient whose service requests to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
performerstring- Reference to the Practitioner or Organization who performed or is to perform it, as Practitioner/<id> or Organization/<id>.
requesterstring- Reference to the Practitioner who made the request, as Practitioner/<id>.
statusstring- Filter by service request status: one of draft, active, on-hold, revoked, completed, entered-in-error, unknown.one of
draftactiveon-holdrevokedcompletedentered-in-errorunknown
athenahealth_specimen_readRetrieve one athenahealth FHIR Specimen resource by its logical ID.Read-onlyGet Specimen
Retrieve one athenahealth FHIR Specimen resource by its logical ID. Returns the Specimen resource: lab specimens, with type, collection details, and status. Use this when you already have the specimen ID. Use athenahealth_specimen_search to find specimens.
Inputs
specimen_idstringrequired- Logical ID of the Specimen resource (the id element, without the Specimen/ prefix).
athenahealth_specimen_searchSearch athenahealth FHIR Specimen resources (specimens) available to the signed-in clinician.Read-onlySearch Specimens
Search athenahealth FHIR Specimen resources (specimens) available to the signed-in clinician. Returns a FHIR Bundle of Specimen entries: lab specimens, with type, collection details, and status. Use this to find or list specimens. Use athenahealth_specimen_read when you already have the specimen ID. If the result has a next link, use athenahealth_next_page to get more.
Inputs
_idstring- Logical ID of a specific Specimen to match. Returns a Bundle with that one resource; use athenahealth_specimen_read to fetch it directly.
_lastUpdatedstring- Only return specimens last updated on or around this date. Prefix with a comparator (eq, gt, lt, ge, le) followed by a date in YYYY-MM-DD format, e.g. ge2024-01-01.
patientstring- athenahealth FHIR ID of the patient whose specimens to return (the Patient.id from athenahealth_patient_search or athenahealth_patient_read), or a Patient/<id> reference.
No tools match.
