SearchParameter - FHIR Resource (r4)
This SearchParameter Resource uses the FHIR API standard for access and structure.
Validate an SearchParameter FHIR Resource (r4)
SearchParameter Attributes
AttributeField is listTypeDescription
Description: Canonical identifier for this search parameter, represented as a URI (globally unique)
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": "http://hl7.org/fhir/SearchParameter/example"Learn more about the (SearchParameter) url FHIR attribute
Description: Business version of the search parameter
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": "1"Learn more about the (SearchParameter) version FHIR attribute
Description: C? Name for this search parameter (computer friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "ID-SEARCH-PARAMETER"Learn more about the (SearchParameter) name FHIR attribute
Description: Original definition for the search parameter
FHIR Version: r4
Attribute Type : canonical(SearchParameter)
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"derivedFrom": "http://hl7.org/fhir/SearchParameter/Resource-id"Learn more about the (SearchParameter) derivedFrom FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "draft"Learn more about the (SearchParameter) status FHIR attribute
Description: For testing purposes, not real usage
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": trueLearn more about the (SearchParameter) experimental FHIR attribute
Description: Date last changed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2013-10-23"Learn more about the (SearchParameter) date FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": "Health Level Seven International (FHIR Infrastructure)"Learn more about the (SearchParameter) publisher FHIR attribute
Description: Contact details for the publisher
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": [
{
"name": "[string]",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
]Learn more about the (SearchParameter) contact FHIR attribute
Description: Natural language description of the search parameter
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources"Learn more about the (SearchParameter) description FHIR attribute
Description: The context that the content is intended to support
FHIR Version: r4
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": [
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "focus"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/variant-state",
"code": "positive"
}
]
}
}
]Learn more about the (SearchParameter) useContext FHIR attribute
Description: Intended jurisdiction for search parameter (if applicable)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America (the)"
}
]
}
]Learn more about the (SearchParameter) jurisdiction FHIR attribute
Description: Why this search parameter is defined
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"purpose": "Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain"Learn more about the (SearchParameter) purpose FHIR attribute
Description: Code used in URL
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": "_id"Learn more about the (SearchParameter) code FHIR attribute
Description: The resource type(s) this search parameter applies to
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"base": [
"Resource"
]Learn more about the (SearchParameter) base FHIR attribute
Description: number | date | string | token | reference | composite | quantity | uri | special
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": "token"Learn more about the (SearchParameter) type FHIR attribute
Description: C? FHIRPath expression that extracts the values
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"expression": "id"Learn more about the (SearchParameter) expression FHIR attribute
Description: C? XPath that extracts the values
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"xpath": "f:*/f:id"Learn more about the (SearchParameter) xpath FHIR attribute
Description: C? normal | phonetic | nearby | distance | other
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"xpathUsage": "normal"Learn more about the (SearchParameter) xpathUsage FHIR attribute
Description: Types of resource (if a resource reference)
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"target": Learn more about the (SearchParameter) target FHIR attribute
Description: Allow multiple values per parameter (or)
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"multipleOr": Learn more about the (SearchParameter) multipleOr FHIR attribute
Description: Allow multiple parameters (and)
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"multipleAnd": Learn more about the (SearchParameter) multipleAnd FHIR attribute
Description: eq | ne | gt | lt | ge | le | sa | eb | ap
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"comparator": [
"eq"
]Learn more about the (SearchParameter) comparator FHIR attribute
Description: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"modifier": Learn more about the (SearchParameter) modifier FHIR attribute
Description: Chained names supported
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"chain": Learn more about the (SearchParameter) chain FHIR attribute
Description: For Composite resources to define the parts
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"component": Learn more about the (SearchParameter) component FHIR attribute
SearchParameter Example
{
"resourceType": "SearchParameter",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>url</b>: <b>http://hl7.org/fhir/SearchParameter/example</b></p><p><b>version</b>: 1</p><p><b>name</b>: ID-SEARCH-PARAMETER</p><p><b>derivedFrom</b>: <a>http://hl7.org/fhir/SearchParameter/Resource-id</a></p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 23/10/2013</p><p><b>publisher</b>: Health Level Seven International (FHIR Infrastructure)</p><p><b>contact</b>: </p><p><b>description</b>: Search by resource identifier - e.g. same as the read interaction, but can return included resources</p><p><b>useContext</b>: </p><p><b>jurisdiction</b>: United States of America (the) <span>(Details : {urn:iso:std:iso:3166 code 'US' = 'United States of America', given as 'United States of America (the)'})</span></p><p><b>purpose</b>: Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain</p><p><b>code</b>: _id</p><p><b>base</b>: Resource</p><p><b>type</b>: token</p><p><b>expression</b>: id</p><p><b>xpath</b>: f:*/f:id</p><p><b>xpathUsage</b>: normal</p><p><b>comparator</b>: eq</p></div>"
},
"url": "http://hl7.org/fhir/SearchParameter/example",
"version": "1",
"name": "ID-SEARCH-PARAMETER",
"derivedFrom": "http://hl7.org/fhir/SearchParameter/Resource-id",
"status": "draft",
"experimental": true,
"date": "2013-10-23",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"name": "[string]",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources",
"useContext": [
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "focus"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/variant-state",
"code": "positive"
}
]
}
}
],
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America (the)"
}
]
}
],
"purpose": "Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain",
"code": "_id",
"base": [
"Resource"
],
"type": "token",
"expression": "id",
"xpath": "f:*/f:id",
"xpathUsage": "normal",
"comparator": [
"eq"
]
}SearchParameter Structure
{
"resourceType" : "SearchParameter",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // R! Canonical identifier for this search parameter, represented as a URI (globally unique)
"version" : "<string>", // Business version of the search parameter
"name" : "<string>", // C? R! Name for this search parameter (computer friendly)
"derivedFrom" : { canonical(SearchParameter) }, // Original definition for the search parameter
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // R! Natural language description of the search parameter
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for search parameter (if applicable)
"purpose" : "<markdown>", // Why this search parameter is defined
"code" : "<code>", // R! Code used in URL
"base" : ["<code>"], // R! The resource type(s) this search parameter applies to
"type" : "<code>", // R! number | date | string | token | reference | composite | quantity | uri | special
"expression" : "<string>", // C? FHIRPath expression that extracts the values
"xpath" : "<string>", // C? XPath that extracts the values
"xpathUsage" : "<code>", // C? normal | phonetic | nearby | distance | other
"target" : ["<code>"], // Types of resource (if a resource reference)
"multipleOr" : <boolean>, // Allow multiple values per parameter (or)
"multipleAnd" : <boolean>, // Allow multiple parameters (and)
"comparator" : ["<code>"], // eq | ne | gt | lt | ge | le | sa | eb | ap
"modifier" : ["<code>"], // missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
"chain" : ["<string>"], // Chained names supported
"component" : [{ // For Composite resources to define the parts
"definition" : { canonical(SearchParameter) }, // R! Defines how the part works
"expression" : "<string>" // R! Subexpression relative to main expression
}]
}
SearchParameter Search Parameters
The following search parameters can be used to query SearchParameter resources. Just submit them like so:
https://api.1up.health/fhir/r4/SearchParameter?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
base | text | base |
code | text | code |
component | reference | component.definition |
context | text | useContext.value |
context-quantity | quantity | useContext.value |
context-type | text | useContext.code |
context-type-quantity | composite | useContext |
context-type-value | composite | useContext |
date | date | date |
derived-from | reference | derivedFrom |
description | text | description |
jurisdiction | text | jurisdiction |
name | text | name |
publisher | text | publisher |
status | text | status |
target | text | target |
type | text | type |
url | uri | url |
version | text | version |
