Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OPENAI_API_KEY | No | Your OpenAI API key (required for llm-test-harness.ts) | |
| MEDPLUM_BASE_URL | Yes | URL of your Medplum server instance | |
| MEDPLUM_CLIENT_ID | Yes | Your Medplum client ID for authentication | |
| MEDPLUM_CLIENT_SECRET | Yes | Your Medplum client secret for authentication |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| createPatient | Creates a new patient resource. Requires first name, last name, and birth date. |
| getPatientById | Retrieves a patient resource by their unique ID. |
| updatePatient | Updates an existing patient's information. Requires the patient's ID and the fields to update. |
| searchPatients | Searches for patients based on criteria like name or birth date. |
| searchPractitionersByName | Searches for medical practitioners based on their given name, family name, or a general name string. |
| createPractitioner | Creates a new medical practitioner. Requires given name and family name. |
| getPractitionerById | Retrieves a practitioner resource by their unique ID. |
| updatePractitioner | Updates an existing practitioner's information. Requires the practitioner's ID and the fields to update. |
| searchPractitioners | Searches for practitioners based on various criteria like name, specialty, or identifier. |
| createOrganization | Creates a new organization (e.g., hospital, clinic). Requires organization name. |
| getOrganizationById | Retrieves an organization by its unique ID. |
| updateOrganization | Updates an existing organization. Requires the organization ID and the fields to update. |
| searchOrganizations | Searches for organizations based on criteria like name or address. Provide at least one criterion. |
| createEncounter | Creates a new encounter (patient visit). Requires patient ID and status. |
| getEncounterById | Retrieves an encounter by its unique ID. |
| updateEncounter | Updates an existing encounter. Requires the encounter ID and the fields to update. |
| searchEncounters | Searches for encounters based on criteria like patient ID or status. |
| createObservation | Creates a new observation (lab result, vital sign, etc.). Requires patient ID and code. |
| getObservationById | Retrieves an observation by its unique ID. |
| updateObservation | Updates an existing observation. Requires the observation ID and the fields to update. |
| searchObservations | Searches for observations based on criteria like patient ID or code. |
| createMedicationRequest | Creates a new medication request (prescription). Requires patient ID, medication reference, and prescriber. |
| getMedicationRequestById | Retrieves a medication request by its unique ID. |
| updateMedicationRequest | Updates an existing medication request. Requires the medication request ID and fields to update. |
| searchMedicationRequests | Searches for medication requests based on criteria like patient ID or medication. |
| createMedication | Creates a new medication resource. Requires medication code or identifier. |
| getMedicationById | Retrieves a medication by its unique ID. |
| searchMedications | Searches for medications based on criteria like code or name. |
| createEpisodeOfCare | Creates a new episode of care for a patient. Requires patient ID and status. |
| getEpisodeOfCareById | Retrieves an episode of care by its unique ID. |
| updateEpisodeOfCare | Updates an existing episode of care. Requires the episode ID and fields to update. |
| searchEpisodesOfCare | Searches for episodes of care based on criteria like patient ID or status. |
| createCondition | Creates a new condition or diagnosis for a patient. Requires a patient ID and a condition code. |
| getConditionById | Retrieves a condition resource by its unique ID. |
| updateCondition | Updates an existing condition. Requires the condition ID and at least one field to update. |
| searchConditions | Searches for conditions based on patient and other criteria. Requires a patient ID. |
| generalFhirSearch | Performs a generic FHIR search operation on any resource type with custom query parameters. |