This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Detailed Descriptions for the elements in the SearchParameter resource.
SearchParameter | |
Definition | A Search Parameter that defines a named search item that can be used to search/filter on a resource. |
Control | 1..1 |
Comments | In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content. |
SearchParameter.url | |
Definition | An absolute URL at which this search parameter is (or will be) published, and which is used to reference this profile in conformance statements. |
Control | 1..1 |
Type | uri |
Requirements | To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash). |
SearchParameter.name | |
Definition | The name of the standard or custom search parameter. |
Control | 1..1 |
Type | string |
Summary | true |
Comments | This is the name to be used for this parameter in the search parameters in the URL. |
SearchParameter.publisher | |
Definition | The name of the individual or organization that published the search parameter. |
Control | 0..1 |
Type | string |
Requirements | Helps establish the "authority/credibility" of the search parameter. May also allow for contact. |
Summary | true |
Comments | Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context. |
SearchParameter.contact | |
Definition | Contacts to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Summary | true |
Comments | May be a web site, an email address, a telephone number (tel:), etc. |
SearchParameter.contact.name | |
Definition | The name of an individual to contact regarding the search parameter. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | If there is no named individual, the telecom is for the organization as a whole. |
SearchParameter.contact.telecom | |
Definition | Contact details for individual (if a name was provided) or the publisher. |
Control | 0..* |
Type | ContactPoint |
Summary | true |
SearchParameter.requirements | |
Definition | The Scope and Usage that this search parameter was created to meet. |
Control | 0..1 |
Type | string |
SearchParameter.status | |
Definition | The status of this search parameter definition. |
Control | 0..1 |
Binding | ConformanceResourceStatus: Required: http://hl7.org/fhir/conformance-resource-status (The lifecycle status of a Value Set or Concept Map) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems. |
SearchParameter.experimental | |
Definition | A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
Control | 0..1 |
Type | boolean |
Summary | true |
Comments | Allows filtering of search parameter definitions that are appropriate for use vs. not. |
SearchParameter.date | |
Definition | The date (and optionally time) when the search parameter definition was published. |
Control | 0..1 |
Type | dateTime |
Summary | true |
SearchParameter.base | |
Definition | The base resource type that this search parameter refers to. |
Control | 1..1 |
Binding | ResourceType: Any defined Resource Type name |
Type | code |
SearchParameter.type | |
Definition | The type of value a search parameter refers to, and how the content is interpreted. |
Control | 1..1 |
Binding | SearchParamType: Required: http://hl7.org/fhir/search-param-type (Data types allowed to be used for search parameters) |
Type | code |
SearchParameter.description | |
Definition | A description of the search parameters and how it used. |
Control | 1..1 |
Type | string |
SearchParameter.xpath | |
Definition | An XPath expression that returns a set of elements for the search parameter. |
Control | 0..1 |
Type | string |
Comments | Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them. E.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system. |
SearchParameter.target | |
Definition | Types of resource (if a resource is referenced). |
Control | 0..* |
Binding | ResourceType: Any defined Resource Type name |
Type | code |