Search Clinical Concepts Encounters

Request

Search for encounter clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated.

Security

bearer

Query

pageNumbernumber

Page number to retrieve (1-based index)

Default:1

pageSizenumber

Number of items per page

Default:50

sortFieldstring

Field to sort by

Default:"score"

Enum:"date""score"

sortIsDescendingboolean

Whether to sort in descending order

Default:false

subjectIdstringrequired

Subject ID (GUID)

Example:subjectId=123e4567-e89b-12d3-a456-426614174000

dateStartstring

Start date for filtering (ISO string)

Example:dateStart=2025-01-01

dateEndstring

End date for filtering (ISO string)

Example:dateEnd=2025-12-31

searchTermstring

Search term for filtering

Example:searchTerm=aspirin

searchTermModestring

Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided.

Enum:"lexical""semantic""hybrid"

codestring

Filter by code value

Example:code=E11.9

codeSystemstring

Filter by code system

Example:codeSystem=http://hl7.org/fhir/sid/icd-10

ProjectIdstring, (uuid)required

Example:e6b01018-a333-4732-917e-fe38e91b0fdf

GET

/api/v1/patient-registry/clinical-concepts/encounter

curl -i -X GET \
  'https://partner.xcures.com/api/v1/patient-registry/clinical-concepts/encounter?pageNumber=1&pageSize=50&sortField=date&sortIsDescending=false&subjectId=123e4567-e89b-12d3-a456-426614174000&dateStart=2025-01-01&dateEnd=2025-12-31&searchTerm=aspirin&searchTermMode=lexical&code=E11.9&codeSystem=http%3A%2F%2Fhl7.org%2Ffhir%2Fsid%2Ficd-10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'ProjectId: e6b01018-a333-4732-917e-fe38e91b0fdf'

Responses

Bodyapplication/json

totalCountnumberrequired

Total number of items matching the query

resultsArray of objectsrequired

List of results for the current page