getEncounterById
Retrieve specific healthcare encounter details by providing its unique ID, enabling efficient access to patient interaction records within the Medplum FHIR server.
Instructions
Retrieves an encounter by its unique ID.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| encounterId | Yes | The unique ID of the encounter to retrieve. |
Implementation Reference
- src/tools/encounterUtils.ts:115-129 (handler)The core handler function that authenticates with Medplum, validates the encounter ID, reads the Encounter FHIR resource by ID, returns it or null if not found, handling not-found errors gracefully.export async function getEncounterById(args: { encounterId: string }): Promise<Encounter | null> { await ensureAuthenticated(); if (!args.encounterId) { throw new Error('Encounter ID is required to fetch an encounter.'); } try { const encounter = await medplum.readResource('Encounter', args.encounterId); return encounter; } catch (error: any) { if (error.outcome?.issue?.[0]?.code === 'not-found') { return null; } throw error; } }
- src/tools/toolSchemas.ts:348-360 (schema)JSON Schema definition for the input parameters of the getEncounterById tool, specifying the required 'encounterId' string parameter.name: 'getEncounterById', description: 'Retrieves a specific encounter resource by its unique ID.', input_schema: { type: 'object', properties: { encounterId: { type: 'string', description: 'The unique ID of the encounter to retrieve.', }, }, required: ['encounterId'], }, },
- src/index.ts:402-413 (schema)MCP-specific inputSchema for the getEncounterById tool used by the server, defining the required 'encounterId' parameter.name: "getEncounterById", description: "Retrieves an encounter by its unique ID.", inputSchema: { type: "object", properties: { encounterId: { type: "string", description: "The unique ID of the encounter to retrieve.", }, }, required: ["encounterId"], },
- src/index.ts:32-37 (registration)Import statement registering the getEncounterById function from encounterUtils for use in the MCP server.import { createEncounter, getEncounterById, updateEncounter, searchEncounters, } from './tools/encounterUtils.js';
- src/index.ts:965-965 (registration)Entry in the toolMapping object that maps the tool name 'getEncounterById' to its handler function for execution.getEncounterById,