JSON Value Descriptions for the Filter Segment - Hyland Clinician Window - 23.3 - 23.3 - Other - external

Hyland Clinician Window

Platform
Other
Product
Hyland Clinician Window
Release
23.3
License

Once you have the filter criteria expressed as a JSON string, you can update the values as needed. The following table describes the name-value pairs that may be included.

Name

Description

fd

Specifies the start date for the date range filter.

Use the following format:

2016-01-31T05:00:00.000Z

Omit to retrieve all contents from the specified end date (td) and earlier. If no fd or td values are specified, then no date filter is applied.

td

Specifies the end date for the date range filter.

Use the same format as fd.

Omit to retrieve all contents from the specified start date (fd) up to and including the present date. If no fd or td values are specified, then no date filter is applied.

f

Specifies non-date filter criteria. The value is an array of one or more objects.

fid

Specifies the filter type. Possible values are description, type, encounterId, facility, department, and modality.

i

Contains an array of one or more objects, which contain the options or criteria to apply for the specified filter type.

n

Used for content type filters only. The value is the name of the content type as defined in the source system.

v

Specifies a filter value.

  • For content types, the value is the internal ID number of the content type as determined by the source system.

  • For other filter types, the value should match the value displayed in the filter pane.

q

Specifies a query string for a full-text search. Full-text searching is available only in environments that meet specific requirements. For more information, see Enabling Full-Text Search.