Loading...

XML

Word

Printable

JSON

Specification:

FHIR Core (FHIR)
Raised in Version:

R5
Work Group:

FHIR Infrastructure
Related URL:
http://build.fhir.org/search.html#Summary
Related Page(s):

REST (http)
Search
Grouping:
- searchPage
Resolution Description:
Hide

Rename the top-level "Summary Table" to "Table of Contents"

Add links to the column headers of the ToC, so they link directly to the relevant page sections

Provide consistent navigation so each search param type has its own section

Work through discussion on zulip
Show
Rename the top-level "Summary Table" to "Table of Contents" Add links to the column headers of the ToC, so they link directly to the relevant page sections Provide consistent navigation so each search param type has its own section Work through discussion on zulip
Resolution Vote:
Rick Geimer/Jose Costa Teixeira: 13-0-0
Change Category:
Clarification
Change Impact:
Non-substantive
Applied for Version:

R5

The Summary Table on the Search page is confusing:

the table mixes Search Parameters and result parameters (which are just query parameters)
"result parameters" specific to search and generic ones (e.g., _format) are mixed

I recommend either splitting into an additional column (to address the second issue) or splitting into multiple tables:

Option 1:
—

Search Parameter Types	Search Parameters for all Resources	Search result query parameters	Generic parameters
Number	_id	_sort	_format
Date/DateTime	_lastUpdated	_count	_summary
...	...	...	...

—

Option 2:
—

Search Parameter Types:

Type	Description
Number	Searching on a simple numerical value in a resource
Date/DateTime	A date parameter searches on a date/time or period.
...	...

Search Parameters for all resources:

Search Parameter	Description
_id	The logical id of the resource, which can be used when the search context specifies a resource type.
_lastUpdated	Select resources based on the last time they were changed.
...	...

Query Parameters for Search results:

Query Parameter	Description
_sort	The client can indicate which order to return the results by using the parameter _sort, which can contain a comma-separated list of sort rules in priority order.
_count	The parameter _count is defined as an instruction to the server regarding how many resources should be returned in a single page.
...	...

Generic Query Parameters for all interactions:

Query Parameter	Description
_format	In order to support various implementation limitations, servers SHOULD support the optional _format parameter to specify alternative response formats by their MIME-types.
_summary	The _summary parameter requests the server to return a subset of the resource.
...	...

—

If possible, I would also like to see a conformance expectation for each one (e.g., _format is a SHOULD support, _summary is a MAY support, etc.).

has to be finished together with

FHIR-32851 Search parameter joining

FHIR-32852 Fix structure of Search page

FHIR-33158 Clarify "composite" vs "AND" and "OR" search parameters