AdvancedMD connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. 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>

3. Set up the connector

   Register your AdvancedMD credentials with Scalekit so it can authenticate requests on your behalf. You do this once per environment.

   Dashboard setup steps

   AdvancedMD uses the SMART on FHIR OAuth 2.0 authorization code flow with PKCE. Because each AdvancedMD FHIR environment exposes its own endpoints, you supply the authorization and token endpoints, the audience (aud), and the FHIR server domain when you create the connection. You also register a client with AdvancedMD to obtain a client ID, and a client secret if AdvancedMD issues one.

   1. Discover your AdvancedMD FHIR server’s SMART configuration

      Your AdvancedMD FHIR server publishes its OAuth endpoints at a well-known discovery URL:

      <advancedmd-fhir-base-url>/.well-known/smart-configuration

      Fetch that URL and note these values:

      • authorization_endpoint — the Authorization endpoint
      • token_endpoint — the Token endpoint
      • the AdvancedMD FHIR base URL, for example https://providerapi.advancedmd.com/v1/r4 — this gives you both the Audience (aud) value and the FHIR server domain (the same URL without the https:// scheme, for example providerapi.advancedmd.com)

      Find your exact FHIR base URL in the AdvancedMD developer program documentation for your office key and environment (sandbox vs. production).

      Why aud is required

      SMART on FHIR requires every authorization request to include an aud parameter set to the FHIR resource server’s base URL. If aud doesn’t match the server exactly, the authorization request fails.

   2. Register an app with AdvancedMD

      • Register a new app through the AdvancedMD developer program to obtain a client ID. Scalekit uses PKCE, so a public client works; if AdvancedMD issues a client secret, note it as well and add it in the next step.

      • When prompted for a redirect URI, leave the field open for now — you’ll copy the exact value from Scalekit in the next step.

   3. Copy the redirect URI from Scalekit

      In the Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find AdvancedMD and click Create. Copy the redirect URI — it looks like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.

      Return to your AdvancedMD app registration and paste this redirect URI into the app’s allowed redirect URIs.

   4. Create the connection in Scalekit

      Back in the Scalekit dashboard, finish creating the connection with the values you gathered:

      • Client ID — the client ID from your AdvancedMD app registration
      • Client Secret — the client secret from your AdvancedMD app registration, if one was issued; leave blank for a public PKCE client
      • Authorization Endpoint — the authorization_endpoint from .well-known/smart-configuration
      • Token Endpoint — the token_endpoint from .well-known/smart-configuration
      • Audience (aud) — the AdvancedMD FHIR base URL, sent as the required aud parameter on the authorization request
      • FHIR Server Domain — the AdvancedMD FHIR server domain without the https:// scheme, for example providerapi.advancedmd.com. Scalekit routes every tool call to this host

      FHIR server domain is required for tool calls

      Scalekit uses the FHIR Server Domain as the base host for every API request a tool makes. If you leave it blank, authorization can still succeed, but every tool call fails because Scalekit has no server to route the request to.

      Under Scopes, select the SMART on FHIR scopes your agent needs. Start with openid and offline_access for identity and refresh tokens, then add resource-specific scopes such as patient/Patient.read, patient/Observation.read, or the broader patient/*.read and patient/*.rs scopes. The scopes you select here must match what’s enabled on your AdvancedMD app registration.

      Click Save.

   5. Verify the connection is active

      Go to Connected Accounts for your AdvancedMD connection and confirm the status shows Active after a user completes authorization.

What you can do

Connect this agent connector to let your agent:

• Read clinical records — retrieve a Patient, Practitioner, Organization, Encounter, Condition, Observation, AllergyIntolerance, Immunization, MedicationRequest, DiagnosticReport, Procedure, or Appointment by its FHIR logical ID
• Search clinical records — find any supported FHIR resource using parameters like patient, clinical status, category, date, and code
• Create clinical records — add new records for any of the twelve supported FHIR resource types
• Update clinical records — modify an existing FHIR resource by its logical ID
• Delete clinical records — remove a FHIR resource by its logical ID
• Retrieve everything for a patient — invoke the $everything operation on a Patient to pull all associated clinical resources in a single Bundle

Common workflows

Proxy API call

Call the FHIR server’s REST API directly through the Scalekit proxy. Use standard FHIR search paths such as /Patient or /Observation.

Node.js

const result = await actions.request({
  connectionName: 'advancedmd',
  identifier: 'user_123',
  path: '/Patient?family=Smith&_count=10',
  method: 'GET',
});
console.log(result);

Python

result = actions.request(
    connection_name='advancedmd',
    identifier='user_123',
    path="/Patient?family=Smith&_count=10",
    method="GET"
)
print(result)

Search for patients

Node.js

const patients = await actions.executeTool({
  connector: 'advancedmd',
  identifier: 'user_123',
  toolName: 'advancedmd_patient_search',
  toolInput: {
    family: 'Smith',
    given: 'Jane',
    birthdate: '1985-04-12',
    _count: 10,
  },
});
console.log('Matching patients:', patients);

Python

patients = actions.execute_tool(
    connection_name='advancedmd',
    identifier='user_123',
    tool_name="advancedmd_patient_search",
    tool_input={
        "family": "Smith",
        "given": "Jane",
        "birthdate": "1985-04-12",
        "_count": 10,
    },
)
print("Matching patients:", patients)

Retrieve everything for a patient

Invoke the FHIR $everything operation to pull all clinical resources for one patient in a single Bundle. Pass _type to limit the response to specific resource types.

Node.js

const bundle = await actions.executeTool({
  connector: 'advancedmd',
  identifier: 'user_123',
  toolName: 'advancedmd_patient_everything',
  toolInput: {
    patient_id: 'a1b2c3d4-0000-1111-2222-333344445555',
    _type: 'Condition,Observation,MedicationRequest',
    _count: 50,
  },
});
console.log('Bundle entries:', bundle);

Python

bundle = actions.execute_tool(
    connection_name='advancedmd',
    identifier='user_123',
    tool_name="advancedmd_patient_everything",
    tool_input={
        "patient_id": "a1b2c3d4-0000-1111-2222-333344445555",
        "_type": "Condition,Observation,MedicationRequest",
        "_count": 50,
    },
)
print("Bundle entries:", bundle)

Search a patient’s observations

Node.js

const observations = await actions.executeTool({
  connector: 'advancedmd',
  identifier: 'user_123',
  toolName: 'advancedmd_observation_search',
  toolInput: {
    patient: 'a1b2c3d4-0000-1111-2222-333344445555',
    category: 'vital-signs',
    date: 'ge2026-01-01',
    _count: 25,
  },
});
console.log('Observations:', observations);

Python

observations = actions.execute_tool(
    connection_name='advancedmd',
    identifier='user_123',
    tool_name="advancedmd_observation_search",
    tool_input={
        "patient": "a1b2c3d4-0000-1111-2222-333344445555",
        "category": "vital-signs",
        "date": "ge2026-01-01",
        "_count": 25,
    },
)
print("Observations:", observations)

Record a vital-sign observation

Create an Observation such as a heart-rate reading. The code and code_system identify the measurement — this example uses the LOINC code 8867-4 (Heart rate).

Node.js

const observation = await actions.executeTool({
  connector: 'advancedmd',
  identifier: 'user_123',
  toolName: 'advancedmd_observation_create',
  toolInput: {
    patient_id: 'a1b2c3d4-0000-1111-2222-333344445555',
    status: 'final',
    code: '8867-4',
    code_system: 'http://loinc.org',
    code_display: 'Heart rate',
    category: 'vital-signs',
    effective_date_time: new Date().toISOString(),
    value: 72,
    unit: '/min',
  },
});
console.log('Created observation:', observation);

Python

from datetime import datetime, timezone

observation = actions.execute_tool(
    connection_name='advancedmd',
    identifier='user_123',
    tool_name="advancedmd_observation_create",
    tool_input={
        "patient_id": "a1b2c3d4-0000-1111-2222-333344445555",
        "status": "final",
        "code": "8867-4",
        "code_system": "http://loinc.org",
        "code_display": "Heart rate",
        "category": "vital-signs",
        "effective_date_time": datetime.now(timezone.utc).isoformat(),
        "value": 72,
        "unit": "/min",
    },
)
print("Created observation:", observation)

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

advancedmd_allergy_intolerance_create#Create a new FHIR AllergyIntolerance resource recording a patient's allergy or intolerance to a substance.10 params▾

Create a new FHIR AllergyIntolerance resource recording a patient's allergy or intolerance to a substance.

NameTypeRequiredDescription

codestringrequiredCode identifying the substance (RxNorm, SNOMED, or NDF-RT)

code_systemstringrequiredCode system URI for the substance code

patient_idstringrequiredFHIR logical ID of the patient

categorystringoptionalCategory: food, medication, environment, biologic

clinical_statusstringoptionalClinical status: active, inactive, resolved

code_displaystringoptionalHuman-readable display for the substance

criticalitystringoptionalCriticality: low, high, unable-to-assess

notestringoptionalFree-text note about the allergy

onset_date_timestringoptionalDate/time of allergy onset (ISO 8601)

typestringoptionalType: allergy or intolerance

advancedmd_allergy_intolerance_delete#Delete a FHIR AllergyIntolerance resource by its logical ID.1 param▾

Delete a FHIR AllergyIntolerance resource by its logical ID.

NameTypeRequiredDescription

allergy_intolerance_idstringrequiredThe logical ID of the AllergyIntolerance resource to delete

advancedmd_allergy_intolerance_read#Retrieve a single FHIR AllergyIntolerance resource by its logical ID. Represents a patient's allergy or intolerance to a substance.1 param▾

Retrieve a single FHIR AllergyIntolerance resource by its logical ID. Represents a patient's allergy or intolerance to a substance.

NameTypeRequiredDescription

allergy_intolerance_idstringrequiredThe logical ID of the AllergyIntolerance resource

advancedmd_allergy_intolerance_search#Search for FHIR AllergyIntolerance resources using parameters like patient, clinical status, type, category, and criticality.8 params▾

Search for FHIR AllergyIntolerance resources using parameters like patient, clinical status, type, category, and criticality.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

categorystringoptionalCategory: food, medication, environment, biologic

clinical_statusstringoptionalClinical status: active, inactive, resolved

codestringoptionalSubstance code (RxNorm, SNOMED, or NDF-RT)

criticalitystringoptionalCriticality: low, high, unable-to-assess

patientstringoptionalPatient ID to filter allergy intolerances by

typestringoptionalAllergy or intolerance type: allergy, intolerance

advancedmd_allergy_intolerance_update#Update an existing FHIR AllergyIntolerance resource by its ID.10 params▾

Update an existing FHIR AllergyIntolerance resource by its ID.

NameTypeRequiredDescription

allergy_intolerance_idstringrequiredThe logical ID of the AllergyIntolerance resource to update

codestringrequiredCode identifying the substance

code_systemstringrequiredCode system URI for the substance code

patient_idstringrequiredFHIR logical ID of the patient

categorystringoptionalCategory: food, medication, environment, biologic

clinical_statusstringoptionalClinical status: active, inactive, resolved

code_displaystringoptionalHuman-readable display for the substance

criticalitystringoptionalCriticality: low, high, unable-to-assess

notestringoptionalFree-text note about the allergy

typestringoptionalType: allergy or intolerance

advancedmd_appointment_create#Create a new FHIR Appointment resource to book a patient visit with a practitioner.8 params▾

Create a new FHIR Appointment resource to book a patient visit with a practitioner.

NameTypeRequiredDescription

endstringrequiredEnd date/time of the appointment (ISO 8601)

patient_idstringrequiredFHIR logical ID of the patient participant

startstringrequiredStart date/time of the appointment (ISO 8601)

statusstringrequiredAppointment status: proposed, pending, booked, arrived, fulfilled, cancelled, noshow, entered-in-error, checked-in, waitlist

commentstringoptionalAdditional comments about the appointment

descriptionstringoptionalShort description of the appointment

practitioner_idstringoptionalFHIR logical ID of the practitioner participant

service_type_codestringoptionalService type code for the appointment

advancedmd_appointment_delete#Delete a FHIR Appointment resource by its logical ID.1 param▾

Delete a FHIR Appointment resource by its logical ID.

NameTypeRequiredDescription

appointment_idstringrequiredThe logical ID of the Appointment resource to delete

advancedmd_appointment_read#Retrieve a single FHIR Appointment resource by its logical ID. Appointments represent bookings for a patient, practitioner, or location at a specific time.1 param▾

Retrieve a single FHIR Appointment resource by its logical ID. Appointments represent bookings for a patient, practitioner, or location at a specific time.

NameTypeRequiredDescription

appointment_idstringrequiredThe logical ID of the Appointment resource

advancedmd_appointment_search#Search for FHIR Appointment resources using parameters like patient, practitioner, status, and date.7 params▾

Search for FHIR Appointment resources using parameters like patient, practitioner, status, and date.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

datestringoptionalFilter by appointment date (YYYY-MM-DD or range with prefix)

patientstringoptionalPatient ID to filter appointments by

practitionerstringoptionalPractitioner ID to filter appointments by

service_typestringoptionalType of service being delivered, e.g. 57 for Immunology

statusstringoptionalAppointment status: proposed, pending, booked, arrived, fulfilled, cancelled, noshow, entered-in-error, checked-in, waitlist

advancedmd_appointment_update#Update an existing FHIR Appointment resource by its ID, e.g. to reschedule or cancel.8 params▾

Update an existing FHIR Appointment resource by its ID, e.g. to reschedule or cancel.

NameTypeRequiredDescription

appointment_idstringrequiredThe logical ID of the Appointment resource to update

endstringrequiredEnd date/time of the appointment (ISO 8601)

patient_idstringrequiredFHIR logical ID of the patient participant

startstringrequiredStart date/time of the appointment (ISO 8601)

statusstringrequiredAppointment status: proposed, pending, booked, arrived, fulfilled, cancelled, noshow, entered-in-error, checked-in, waitlist

commentstringoptionalAdditional comments about the appointment

descriptionstringoptionalShort description of the appointment

practitioner_idstringoptionalFHIR logical ID of the practitioner participant

advancedmd_condition_create#Create a new FHIR Condition resource representing a diagnosis or health problem for a patient.9 params▾

Create a new FHIR Condition resource representing a diagnosis or health problem for a patient.

NameTypeRequiredDescription

codestringrequiredICD-10 or SNOMED code for the condition

code_systemstringrequiredCode system URI

patient_idstringrequiredFHIR logical ID of the patient

categorystringoptionalCondition category: problem-list-item, encounter-diagnosis

clinical_statusstringoptionalClinical status: active, recurrence, relapse, inactive, remission, resolved

code_displaystringoptionalHuman-readable display for the condition code

notestringoptionalFree-text note about the condition

onset_date_timestringoptionalDate/time of condition onset (ISO 8601)

verification_statusstringoptionalVerification status: unconfirmed, provisional, differential, confirmed, refuted, entered-in-error

advancedmd_condition_delete#Delete a FHIR Condition resource by its logical ID.1 param▾

Delete a FHIR Condition resource by its logical ID.

NameTypeRequiredDescription

condition_idstringrequiredThe logical ID of the Condition resource to delete

advancedmd_condition_read#Retrieve a single FHIR Condition resource by its logical ID. Conditions represent clinical diagnoses, problems, or health concerns.1 param▾

Retrieve a single FHIR Condition resource by its logical ID. Conditions represent clinical diagnoses, problems, or health concerns.

NameTypeRequiredDescription

condition_idstringrequiredThe logical ID of the Condition resource

advancedmd_condition_search#Search for FHIR Condition resources representing diagnoses and health problems using parameters like patient, clinical status, category, and code.7 params▾

Search for FHIR Condition resources representing diagnoses and health problems using parameters like patient, clinical status, category, and code.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

categorystringoptionalCategory of condition, e.g. problem-list-item, encounter-diagnosis

clinical_statusstringoptionalClinical status: active, recurrence, relapse, inactive, remission, resolved

codestringoptionalICD-10 or SNOMED code for the condition

onset_datestringoptionalFilter by onset date (YYYY-MM-DD or range with prefix)

patientstringoptionalPatient ID to filter conditions by

advancedmd_condition_update#Update an existing FHIR Condition resource by its ID. Replaces the resource with the provided data.10 params▾

Update an existing FHIR Condition resource by its ID. Replaces the resource with the provided data.

NameTypeRequiredDescription

codestringrequiredICD-10 or SNOMED code for the condition

code_systemstringrequiredCode system URI

condition_idstringrequiredThe logical ID of the Condition resource to update

patient_idstringrequiredFHIR logical ID of the patient

categorystringoptionalCondition category: problem-list-item, encounter-diagnosis

clinical_statusstringoptionalClinical status: active, recurrence, relapse, inactive, remission, resolved

code_displaystringoptionalHuman-readable display for the condition code

notestringoptionalFree-text note about the condition

onset_date_timestringoptionalDate/time of condition onset (ISO 8601)

verification_statusstringoptionalVerification status: unconfirmed, provisional, differential, confirmed, refuted, entered-in-error

advancedmd_diagnostic_report_create#Create a new FHIR DiagnosticReport resource representing findings from a laboratory, imaging, or other diagnostic service.8 params▾

Create a new FHIR DiagnosticReport resource representing findings from a laboratory, imaging, or other diagnostic service.

NameTypeRequiredDescription

codestringrequiredLOINC code identifying the type of report

code_systemstringrequiredCode system URI for the report code

patient_idstringrequiredFHIR logical ID of the patient

statusstringrequiredReport status: registered, partial, preliminary, final, amended, corrected, appended, cancelled, entered-in-error

categorystringoptionalReport category: LAB, RAD, etc.

code_displaystringoptionalHuman-readable display for the report type

conclusionstringoptionalClinical interpretation of the report findings

effective_date_timestringoptionalDate/time the report is clinically relevant (ISO 8601)

advancedmd_diagnostic_report_delete#Delete a FHIR DiagnosticReport resource by its logical ID.1 param▾

Delete a FHIR DiagnosticReport resource by its logical ID.

NameTypeRequiredDescription

diagnostic_report_idstringrequiredThe logical ID of the DiagnosticReport resource to delete

advancedmd_diagnostic_report_read#Retrieve a single FHIR DiagnosticReport resource by its logical ID. Diagnostic reports represent the findings from diagnostic services such as laboratory tests and imaging studies.1 param▾

Retrieve a single FHIR DiagnosticReport resource by its logical ID. Diagnostic reports represent the findings from diagnostic services such as laboratory tests and imaging studies.

NameTypeRequiredDescription

diagnostic_report_idstringrequiredThe logical ID of the DiagnosticReport resource

advancedmd_diagnostic_report_search#Search for FHIR DiagnosticReport resources representing lab and imaging findings using parameters like patient, category, code, date, and status.7 params▾

Search for FHIR DiagnosticReport resources representing lab and imaging findings using parameters like patient, category, code, date, and status.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

categorystringoptionalReport category: LAB, RAD (radiology), etc.

codestringoptionalLOINC code for the type of report

datestringoptionalFilter by report date (YYYY-MM-DD or range with prefix)

patientstringoptionalPatient ID to filter diagnostic reports by

statusstringoptionalReport status: registered, partial, preliminary, final, amended, corrected, appended, cancelled, entered-in-error

advancedmd_diagnostic_report_update#Update an existing FHIR DiagnosticReport resource by its ID.9 params▾

Update an existing FHIR DiagnosticReport resource by its ID.

NameTypeRequiredDescription

codestringrequiredLOINC code identifying the type of report

code_systemstringrequiredCode system URI for the report code

diagnostic_report_idstringrequiredThe logical ID of the DiagnosticReport resource to update

patient_idstringrequiredFHIR logical ID of the patient

statusstringrequiredReport status: registered, partial, preliminary, final, amended, corrected, appended, cancelled, entered-in-error

categorystringoptionalReport category: LAB, RAD, etc.

code_displaystringoptionalHuman-readable display for the report type

conclusionstringoptionalClinical interpretation of the report findings

effective_date_timestringoptionalDate/time the report is clinically relevant (ISO 8601)

advancedmd_encounter_create#Create a new FHIR Encounter resource representing a patient visit or admission.8 params▾

Create a new FHIR Encounter resource representing a patient visit or admission.

NameTypeRequiredDescription

class_codestringrequiredEncounter class code: AMB (ambulatory), IMP (inpatient), EMER (emergency), HH (home health)

patient_idstringrequiredFHIR logical ID of the patient

statusstringrequiredEncounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled

period_endstringoptionalEnd date/time of the encounter (ISO 8601)

period_startstringoptionalStart date/time of the encounter (ISO 8601)

reason_codestringoptionalSNOMED code for the reason of the encounter

type_codestringoptionalSpecific type of encounter by SNOMED code

type_displaystringoptionalHuman-readable display for the encounter type

advancedmd_encounter_delete#Delete a FHIR Encounter resource by its logical ID.1 param▾

Delete a FHIR Encounter resource by its logical ID.

NameTypeRequiredDescription

encounter_idstringrequiredThe logical ID of the Encounter resource to delete

advancedmd_encounter_read#Retrieve a single FHIR Encounter resource by its logical ID. Encounters represent patient visits, admissions, or interactions with healthcare providers.1 param▾

Retrieve a single FHIR Encounter resource by its logical ID. Encounters represent patient visits, admissions, or interactions with healthcare providers.

NameTypeRequiredDescription

encounter_idstringrequiredThe logical ID of the Encounter resource

advancedmd_encounter_search#Search for FHIR Encounter resources representing patient visits and admissions using parameters like patient, status, date, and class.7 params▾

Search for FHIR Encounter resources representing patient visits and admissions using parameters like patient, status, date, and class.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

classstringoptionalEncounter class: AMB (ambulatory), IMP (inpatient), EMER (emergency)

datestringoptionalFilter by encounter date (YYYY-MM-DD or range with prefix)

patientstringoptionalPatient ID to filter encounters by

statusstringoptionalEncounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled

typestringoptionalSpecific type of encounter by code

advancedmd_encounter_update#Update an existing FHIR Encounter resource by its ID. Replaces the resource with the provided data.9 params▾

Update an existing FHIR Encounter resource by its ID. Replaces the resource with the provided data.

NameTypeRequiredDescription

class_codestringrequiredEncounter class: AMB (ambulatory), IMP (inpatient), EMER (emergency), HH (home health)

encounter_idstringrequiredThe logical ID of the Encounter resource to update

patient_idstringrequiredFHIR logical ID of the patient

statusstringrequiredEncounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled

period_endstringoptionalEnd date/time of the encounter (ISO 8601)

period_startstringoptionalStart date/time of the encounter (ISO 8601)

reason_codestringoptionalSNOMED code for the reason of the encounter

type_codestringoptionalSpecific type of encounter by SNOMED code

type_displaystringoptionalHuman-readable display for the encounter type

advancedmd_immunization_create#Create a new FHIR Immunization resource recording a vaccination event for a patient.8 params▾

Create a new FHIR Immunization resource recording a vaccination event for a patient.

NameTypeRequiredDescription

occurrence_date_timestringrequiredDate/time the vaccination occurred (ISO 8601)

patient_idstringrequiredFHIR logical ID of the patient

statusstringrequiredImmunization status: completed, entered-in-error, not-done

vaccine_codestringrequiredCVX vaccine code

vaccine_systemstringrequiredCode system URI for the vaccine code

lot_numberstringoptionalVaccine lot number

notestringoptionalAdditional notes about the immunization

vaccine_displaystringoptionalHuman-readable display for the vaccine

advancedmd_immunization_delete#Delete a FHIR Immunization resource by its logical ID.1 param▾

Delete a FHIR Immunization resource by its logical ID.

NameTypeRequiredDescription

immunization_idstringrequiredThe logical ID of the Immunization resource to delete

advancedmd_immunization_read#Retrieve a single FHIR Immunization resource by its logical ID. Represents a vaccination event administered to a patient.1 param▾

Retrieve a single FHIR Immunization resource by its logical ID. Represents a vaccination event administered to a patient.

NameTypeRequiredDescription

immunization_idstringrequiredThe logical ID of the Immunization resource

advancedmd_immunization_search#Search for FHIR Immunization resources representing vaccination events using parameters like patient, status, vaccine code, and date.6 params▾

Search for FHIR Immunization resources representing vaccination events using parameters like patient, status, vaccine code, and date.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

datestringoptionalFilter by vaccination date (YYYY-MM-DD or range with prefix)

patientstringoptionalPatient ID to filter immunizations by

statusstringoptionalImmunization status: completed, entered-in-error, not-done

vaccine_codestringoptionalCVX vaccine code

advancedmd_immunization_update#Update an existing FHIR Immunization resource by its ID.9 params▾

Update an existing FHIR Immunization resource by its ID.

NameTypeRequiredDescription

immunization_idstringrequiredThe logical ID of the Immunization resource to update

occurrence_date_timestringrequiredDate/time the vaccination occurred (ISO 8601)

patient_idstringrequiredFHIR logical ID of the patient

statusstringrequiredImmunization status: completed, entered-in-error, not-done

vaccine_codestringrequiredCVX vaccine code

vaccine_systemstringrequiredCode system URI for the vaccine code

lot_numberstringoptionalVaccine lot number

notestringoptionalAdditional notes about the immunization

vaccine_displaystringoptionalHuman-readable display for the vaccine

advancedmd_medication_request_create#Create a new FHIR MedicationRequest resource representing a prescription or medication order for a patient.9 params▾

Create a new FHIR MedicationRequest resource representing a prescription or medication order for a patient.

NameTypeRequiredDescription

intentstringrequiredIntent: proposal, plan, order, instance-order

medication_codestringrequiredRxNorm or other medication code

medication_systemstringrequiredCode system URI for the medication code

patient_idstringrequiredFHIR logical ID of the patient

statusstringrequiredStatus: active, on-hold, cancelled, completed, entered-in-error, stopped, draft, unknown

authored_onstringoptionalDate the prescription was authored (ISO 8601)

dosage_textstringoptionalFree-text dosage instructions

medication_displaystringoptionalHuman-readable medication name

notestringoptionalAdditional notes about the prescription

advancedmd_medication_request_delete#Delete a FHIR MedicationRequest resource by its logical ID.1 param▾

Delete a FHIR MedicationRequest resource by its logical ID.

NameTypeRequiredDescription

medication_request_idstringrequiredThe logical ID of the MedicationRequest resource to delete

advancedmd_medication_request_read#Retrieve a single FHIR MedicationRequest resource by its logical ID. MedicationRequests represent prescriptions and medication orders.1 param▾

Retrieve a single FHIR MedicationRequest resource by its logical ID. MedicationRequests represent prescriptions and medication orders.

NameTypeRequiredDescription

medication_request_idstringrequiredThe logical ID of the MedicationRequest resource

advancedmd_medication_request_search#Search for FHIR MedicationRequest resources representing prescriptions using parameters like patient, status, medication code, and authored date.7 params▾

Search for FHIR MedicationRequest resources representing prescriptions using parameters like patient, status, medication code, and authored date.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

authoredonstringoptionalDate the prescription was authored (YYYY-MM-DD or range with prefix)

intentstringoptionalIntent of the request: proposal, plan, order, instance-order

medicationstringoptionalRxNorm or other medication code

patientstringoptionalPatient ID to filter medication requests by

statusstringoptionalMedication request status: active, on-hold, cancelled, completed, entered-in-error, stopped, draft, unknown

advancedmd_medication_request_update#Update an existing FHIR MedicationRequest resource by its ID. Replaces the resource with the provided data.10 params▾

Update an existing FHIR MedicationRequest resource by its ID. Replaces the resource with the provided data.

NameTypeRequiredDescription

intentstringrequiredIntent: proposal, plan, order, instance-order

medication_codestringrequiredRxNorm or other medication code

medication_request_idstringrequiredThe logical ID of the MedicationRequest resource to update

medication_systemstringrequiredCode system URI for the medication code

patient_idstringrequiredFHIR logical ID of the patient

statusstringrequiredStatus: active, on-hold, cancelled, completed, entered-in-error, stopped, draft, unknown

authored_onstringoptionalDate the prescription was authored (ISO 8601)

dosage_textstringoptionalFree-text dosage instructions

medication_displaystringoptionalHuman-readable medication name

notestringoptionalAdditional notes about the prescription

advancedmd_observation_create#Create a new FHIR Observation resource such as a vital sign or lab result for a patient.10 params▾

Create a new FHIR Observation resource such as a vital sign or lab result for a patient.

NameTypeRequiredDescription

codestringrequiredCode identifying the observation type (e.g. LOINC code)

code_systemstringrequiredCode system URI for the observation code

patient_idstringrequiredFHIR logical ID of the patient this observation belongs to

statusstringrequiredObservation status: registered, preliminary, final, amended

categorystringoptionalObservation category: vital-signs, laboratory, social-history, imaging, etc.

code_displaystringoptionalHuman-readable display for the code

effective_date_timestringoptionalDate/time the observation was clinically relevant (ISO 8601)

notestringoptionalFree-text note about the observation

unitstringoptionalUnit of measure for the value (UCUM code)

valuenumberoptionalNumeric value of the observation

advancedmd_observation_delete#Delete a FHIR Observation resource by its logical ID.1 param▾

Delete a FHIR Observation resource by its logical ID.

NameTypeRequiredDescription

observation_idstringrequiredThe logical ID of the Observation resource to delete

advancedmd_observation_read#Retrieve a single FHIR Observation resource by its logical ID. Observations represent measurements and simple assertions about a patient, such as vitals and lab results.1 param▾

Retrieve a single FHIR Observation resource by its logical ID. Observations represent measurements and simple assertions about a patient, such as vitals and lab results.

NameTypeRequiredDescription

observation_idstringrequiredThe logical ID of the Observation resource

advancedmd_observation_search#Search for FHIR Observation resources such as vitals and lab results using parameters like patient, category, code, and date.7 params▾

Search for FHIR Observation resources such as vitals and lab results using parameters like patient, category, code, and date.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

categorystringoptionalCategory of observation, e.g. vital-signs, laboratory, social-history

codestringoptionalLOINC or SNOMED code for the observation type

datestringoptionalFilter by observation date (YYYY-MM-DD or range with prefix e.g. ge2024-01-01)

patientstringoptionalPatient ID to filter observations by

statusstringoptionalObservation status: registered, preliminary, final, amended

advancedmd_observation_update#Update an existing FHIR Observation resource by its ID. Replaces the resource with the provided data.11 params▾

Update an existing FHIR Observation resource by its ID. Replaces the resource with the provided data.

NameTypeRequiredDescription

codestringrequiredCode identifying the observation type (e.g. LOINC code)

code_systemstringrequiredCode system URI for the observation code

observation_idstringrequiredThe logical ID of the Observation resource to update

patient_idstringrequiredFHIR logical ID of the patient

statusstringrequiredObservation status: registered, preliminary, final, amended

categorystringoptionalObservation category: vital-signs, laboratory, social-history, imaging, etc.

code_displaystringoptionalHuman-readable display for the code

effective_date_timestringoptionalDate/time the observation was clinically relevant (ISO 8601)

notestringoptionalFree-text note about the observation

unitstringoptionalUnit of measure for the value (UCUM code)

valuenumberoptionalNumeric value of the observation

advancedmd_organization_create#Create a new FHIR Organization resource representing a hospital, clinic, or other healthcare entity.9 params▾

Create a new FHIR Organization resource representing a hospital, clinic, or other healthcare entity.

NameTypeRequiredDescription

namestringrequiredName of the organization

activebooleanoptionalWhether the organization is active

address_linestringoptionalStreet address line

citystringoptionalCity

emailstringoptionalOrganization's email address

phonestringoptionalOrganization's main phone number

postal_codestringoptionalPostal or ZIP code

statestringoptionalState or province

type_codestringoptionalOrganization type: prov (provider), dept (department), team, govt, ins (insurer), cg (clinical group)

advancedmd_organization_delete#Delete a FHIR Organization resource by its logical ID.1 param▾

Delete a FHIR Organization resource by its logical ID.

NameTypeRequiredDescription

organization_idstringrequiredThe logical ID of the Organization resource to delete

advancedmd_organization_read#Retrieve a single FHIR Organization resource by its logical ID. Organizations represent formally or informally recognized groupings of people or entities in the healthcare domain.1 param▾

Retrieve a single FHIR Organization resource by its logical ID. Organizations represent formally or informally recognized groupings of people or entities in the healthcare domain.

NameTypeRequiredDescription

organization_idstringrequiredThe logical ID of the Organization resource

advancedmd_organization_search#Search for FHIR Organization resources such as hospitals and clinics using parameters like name, type, identifier, and active status.6 params▾

Search for FHIR Organization resources such as hospitals and clinics using parameters like name, type, identifier, and active status.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

activestringoptionalWhether the organization record is active: true or false

identifierstringoptionalOrganization identifier such as NPI

namestringoptionalName of the organization

typestringoptionalOrganization type code, e.g. prov (provider), dept (department), govt

advancedmd_organization_update#Update an existing FHIR Organization resource by its ID.10 params▾

Update an existing FHIR Organization resource by its ID.

NameTypeRequiredDescription

namestringrequiredName of the organization

organization_idstringrequiredThe logical ID of the Organization resource to update

activebooleanoptionalWhether the organization is active

address_linestringoptionalStreet address line

citystringoptionalCity

emailstringoptionalOrganization's email address

phonestringoptionalOrganization's main phone number

postal_codestringoptionalPostal or ZIP code

statestringoptionalState or province

type_codestringoptionalOrganization type: prov, dept, team, govt, ins, cg

advancedmd_patient_create#Create a new FHIR Patient resource with demographic information including name, gender, birth date, contact details, and address.11 params▾

Create a new FHIR Patient resource with demographic information including name, gender, birth date, contact details, and address.

NameTypeRequiredDescription

family_namestringrequiredPatient's family (last) name

address_linestringoptionalStreet address line

birth_datestringoptionalDate of birth in YYYY-MM-DD format

citystringoptionalCity

countrystringoptionalCountry code (ISO 3166)

emailstringoptionalPatient's email address

genderstringoptionalAdministrative gender: male, female, other, unknown

given_namesarrayoptionalList of given (first/middle) names

phonestringoptionalPatient's phone number

postal_codestringoptionalPostal or ZIP code

statestringoptionalState or province

advancedmd_patient_delete#Delete a FHIR Patient resource by its logical ID.1 param▾

Delete a FHIR Patient resource by its logical ID.

NameTypeRequiredDescription

patient_idstringrequiredThe logical ID of the Patient resource to delete

advancedmd_patient_everything#Invoke the $everything operation on a Patient to retrieve all clinical resources associated with that patient in a single Bundle response.4 params▾

Invoke the $everything operation on a Patient to retrieve all clinical resources associated with that patient in a single Bundle response.

NameTypeRequiredDescription

patient_idstringrequiredThe logical ID of the Patient resource

_countnumberoptionalMaximum number of resources to return per page

_sincestringoptionalOnly include resources updated after this instant (ISO 8601 datetime)

_typestringoptionalComma-separated list of resource types to include (e.g. Observation,Condition)

advancedmd_patient_read#Retrieve a single FHIR Patient resource by its logical ID.1 param▾

Retrieve a single FHIR Patient resource by its logical ID.

NameTypeRequiredDescription

patient_idstringrequiredThe logical ID of the Patient resource

advancedmd_patient_search#Search for FHIR Patient resources using common search parameters such as name, birthdate, gender, and identifier.9 params▾

Search for FHIR Patient resources using common search parameters such as name, birthdate, gender, and identifier.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

birthdatestringoptionalPatient's date of birth in YYYY-MM-DD format

emailstringoptionalPatient's email address

familystringoptionalFamily (last) name of the patient

genderstringoptionalAdministrative gender: male, female, other, unknown

givenstringoptionalGiven (first) name of the patient

identifierstringoptionalPatient identifier (e.g. MRN) in system|value format

phonestringoptionalPatient's phone number

advancedmd_patient_update#Update an existing FHIR Patient resource by its ID. Replaces the resource with the provided demographic data.12 params▾

Update an existing FHIR Patient resource by its ID. Replaces the resource with the provided demographic data.

NameTypeRequiredDescription

family_namestringrequiredPatient's family (last) name

patient_idstringrequiredThe logical ID of the Patient resource to update

address_linestringoptionalStreet address line

birth_datestringoptionalDate of birth in YYYY-MM-DD format

citystringoptionalCity

countrystringoptionalCountry code (ISO 3166)

emailstringoptionalPatient's email address

genderstringoptionalAdministrative gender: male, female, other, unknown

given_namesarrayoptionalList of given (first/middle) names

phonestringoptionalPatient's phone number

postal_codestringoptionalPostal or ZIP code

statestringoptionalState or province

advancedmd_practitioner_create#Create a new FHIR Practitioner resource representing a healthcare professional such as a doctor or nurse.6 params▾

Create a new FHIR Practitioner resource representing a healthcare professional such as a doctor or nurse.

NameTypeRequiredDescription

family_namestringrequiredPractitioner's family (last) name

emailstringoptionalPractitioner's email address

genderstringoptionalAdministrative gender: male, female, other, unknown

given_namesarrayoptionalList of given (first/middle) names

npistringoptionalNational Provider Identifier (NPI)

phonestringoptionalPractitioner's phone number

advancedmd_practitioner_delete#Delete a FHIR Practitioner resource by its logical ID.1 param▾

Delete a FHIR Practitioner resource by its logical ID.

NameTypeRequiredDescription

practitioner_idstringrequiredThe logical ID of the Practitioner resource to delete

advancedmd_practitioner_read#Retrieve a single FHIR Practitioner resource by its logical ID. Practitioners represent healthcare professionals such as doctors and nurses.1 param▾

Retrieve a single FHIR Practitioner resource by its logical ID. Practitioners represent healthcare professionals such as doctors and nurses.

NameTypeRequiredDescription

practitioner_idstringrequiredThe logical ID of the Practitioner resource

advancedmd_practitioner_search#Search for FHIR Practitioner resources representing healthcare professionals using parameters like name, identifier, and active status.6 params▾

Search for FHIR Practitioner resources representing healthcare professionals using parameters like name, identifier, and active status.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

activestringoptionalWhether the practitioner record is active: true or false

familystringoptionalFamily (last) name of the practitioner

givenstringoptionalGiven (first) name of the practitioner

identifierstringoptionalPractitioner identifier such as NPI

advancedmd_practitioner_update#Update an existing FHIR Practitioner resource by its ID.7 params▾

Update an existing FHIR Practitioner resource by its ID.

NameTypeRequiredDescription

family_namestringrequiredPractitioner's family (last) name

practitioner_idstringrequiredThe logical ID of the Practitioner resource to update

emailstringoptionalPractitioner's email address

genderstringoptionalAdministrative gender: male, female, other, unknown

given_namesarrayoptionalList of given (first/middle) names

npistringoptionalNational Provider Identifier (NPI)

phonestringoptionalPractitioner's phone number

advancedmd_procedure_create#Create a new FHIR Procedure resource recording a clinical action performed on or for a patient.8 params▾

Create a new FHIR Procedure resource recording a clinical action performed on or for a patient.

NameTypeRequiredDescription

codestringrequiredSNOMED or CPT code for the procedure

code_systemstringrequiredCode system URI for the procedure code

patient_idstringrequiredFHIR logical ID of the patient

statusstringrequiredProcedure status: preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, unknown

code_displaystringoptionalHuman-readable display for the procedure code

notestringoptionalFree-text note about the procedure

performed_date_timestringoptionalDate/time the procedure was performed (ISO 8601)

reason_codestringoptionalSNOMED code for the reason the procedure was performed

advancedmd_procedure_delete#Delete a FHIR Procedure resource by its logical ID.1 param▾

Delete a FHIR Procedure resource by its logical ID.

NameTypeRequiredDescription

procedure_idstringrequiredThe logical ID of the Procedure resource to delete

advancedmd_procedure_read#Retrieve a single FHIR Procedure resource by its logical ID. Procedures represent actions performed on or for a patient.1 param▾

Retrieve a single FHIR Procedure resource by its logical ID. Procedures represent actions performed on or for a patient.

NameTypeRequiredDescription

procedure_idstringrequiredThe logical ID of the Procedure resource

advancedmd_procedure_search#Search for FHIR Procedure resources representing clinical actions performed on a patient using parameters like patient, status, code, and date.6 params▾

Search for FHIR Procedure resources representing clinical actions performed on a patient using parameters like patient, status, code, and date.

NameTypeRequiredDescription

_countnumberoptionalMaximum number of results to return per page

_offsetnumberoptionalNumber of results to skip for pagination

codestringoptionalSNOMED or CPT code for the procedure

datestringoptionalFilter by procedure date (YYYY-MM-DD or range with prefix)

patientstringoptionalPatient ID to filter procedures by

statusstringoptionalProcedure status: preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, unknown

advancedmd_procedure_update#Update an existing FHIR Procedure resource by its ID.9 params▾

Update an existing FHIR Procedure resource by its ID.

NameTypeRequiredDescription

codestringrequiredSNOMED or CPT code for the procedure

code_systemstringrequiredCode system URI for the procedure code

patient_idstringrequiredFHIR logical ID of the patient

procedure_idstringrequiredThe logical ID of the Procedure resource to update

statusstringrequiredProcedure status: preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, unknown

code_displaystringoptionalHuman-readable display for the procedure code

notestringoptionalFree-text note about the procedure

performed_date_timestringoptionalDate/time the procedure was performed (ISO 8601)

reason_codestringoptionalSNOMED code for the reason the procedure was performed