WARNING
This guidance is under active development by NHS England and content may be added or updated on a regular basis.SearchParameter Design
A search parameter that defines a named search item that can be used to search/filter on a resource. Top be used to add additional search / filtering capability to a resources, such as where we have defined a Mustsupport element, or to allow searching on an extension
Further information about the SearchParameter is available online.
Naming Convention
The NHSE search parameter name SHOULD follow an agreed format.
The name of a parameter consists of a number of name segments, and will be in the form:-
[Base][FHIRAssetName][SearchName]
The segments are defined as follows:-
- Base: (Mandatory) - The base for a profile this will always be England.
- FHIRAssetName: (Mandatory) - The name of the base FHIR Resource. such as the Extension-ExtensionName, or a Resource name
- SearchName: (Mandatory) - This SHOULD be the name of the element or the search criteria such s a specific value that is being searched on.
Note: "Mandatory" means that a segment SHALL be present. "Required" means that a segment SHOULD be present, in this case in the event of there being multiple profiles for one base resource.
The physical file name SHALL be in the format [Base]-[FHIRAssetName]-[SearchName] and SHALL be created in the file XML format.