API Reference

Search FHIR resources

post
https://{instanceUrl}/tools/lang2fhir-and-search

Converts natural language to FHIR search parameters and executes search in FHIR server

Body Params
string
required

Natural language text to convert to FHIR search parameters

string

Patient ID to filter results

string

Practitioner ID to filter results

integer
1 to 100

Maximum number of results to return

uuid

FHIR provider ID - must be a valid UUID from existing FHIR providers. also supports provider by name (e.g. medplum)

Headers
string

Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity. Must be in the format: Patient/{uuid} or Practitioner/{uuid}

string

Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}. Multiple FHIR provider integrations can be provided as comma-separated values.

Responses

400

Invalid request

401

Unauthorized

403

Forbidden - requires develop tier access

424

Failed Dependency - lang2fhir service error

500

Server error

Updated 4 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago