OpenMRS icon

OpenMRS

Interact with OpenMRS FHIR R4 API

Actions18

Patient → Search by Identifier

AI-generated

Summary

Searches OpenMRS for patients matching a required identifier, such as an OpenMRS ID or National ID, and returns matching patient resources.

Inputs

  • Identifier (required) — OpenMRS ID or National ID used as the FHIR Patient identifier search value.
  • Return All — When enabled, omits the result count limit. Defaults to false.
  • Limit — Maximum results when Return All is disabled. Defaults to 50; the UI allows values from 1 to 100.

Output shape

A list of patient resources, one output item per returned match.

Sends a GET request to the OpenMRS FHIR R4 Patient endpoint with the identifier query parameter; when Return All is disabled, also sends _count using Limit. If the response contains no entries, the operation raises a no-results error. Errors can instead be emitted as an error item when the node is configured to continue on fail.

Links

Discussion