OpenMRS icon

OpenMRS

Interact with OpenMRS FHIR R4 API

Actions18

Patient → Search by Name

AI-generated

Summary

Search for patients by name using partial matching

Inputs

  • name (required) — Patient name (supports partial matching)
  • returnAll — Whether to return all results or only up to a given limit
  • limit — Maximum number of results to return (1‑100)

Output shape

Array of patient FHIR resources

Pagination applies; if returnAll is false the limit caps results, otherwise all matches are returned.

Examples

Example 1: Search for patients named "Patricia"

name = Patricia, returnAll = false, limit = 50

Example 2: Retrieve all patients matching "Lewis"

name = Lewis, returnAll = true

Example 3: Search by name with custom limit

name = Smith, limit = 10, returnAll = false

Links

Discussion