SearchParameter - FHIR Resource (dstu2)
This SearchParameter Resource uses the FHIR API standard for access and structure.
Validate an SearchParameter FHIR Resource (dstu2)
SearchParameter Attributes
AttributeField is listTypeDescription
Description: draft | active | retired
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (SearchParameter) status FHIR attribute
Description: Name of the publisher (Organization or individual)
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": Learn more about the (SearchParameter) publisher FHIR attribute
Description: Code used in URL
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": Learn more about the (SearchParameter) code FHIR attribute
Description: Why this search parameter is defined
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requirements": Learn more about the (SearchParameter) requirements FHIR attribute
Description: Informal name for this search parameter
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (SearchParameter) name FHIR attribute
Description: C? XPath that extracts the values
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"xpath": Learn more about the (SearchParameter) xpath FHIR attribute
Description: Absolute URL used to reference this search parameter
FHIR Version: dstu2
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (SearchParameter) url FHIR attribute
Description: Documentation for search parameter
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (SearchParameter) description FHIR attribute
Description: C? normal | phonetic | nearby | distance | other
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"xpathUsage": Learn more about the (SearchParameter) xpathUsage FHIR attribute
Description: Contact details of the publisher
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (SearchParameter) contact FHIR attribute
Description: The resource type this search parameter applies to
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"base": Learn more about the (SearchParameter) base FHIR attribute
Description: Publication Date(/time)
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (SearchParameter) date FHIR attribute
Description: number | date | string | token | reference | composite | quantity | uri
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (SearchParameter) type FHIR attribute
Description: If for testing purposes, not real usage
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (SearchParameter) experimental FHIR attribute
Description: Types of resource (if a resource reference)
FHIR Version: dstu2
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
SearchParameter Structure
{
"resourceType" : "SearchParameter",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // R! Absolute URL used to reference this search parameter
"name" : "<string>", // R! Informal name for this search parameter
"status" : "<code>", // draft | active | retired
"experimental" : <boolean>, // If for testing purposes, not real usage
"publisher" : "<string>", // Name of the publisher (Organization or individual)
"contact" : [{ // Contact details of the publisher
"name" : "<string>", // Name of a individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"date" : "<dateTime>", // Publication Date(/time)
"requirements" : "<string>", // Why this search parameter is defined
"code" : "<code>", // R! Code used in URL
"base" : "<code>", // R! The resource type this search parameter applies to
"type" : "<code>", // R! number | date | string | token | reference | composite | quantity | uri
"description" : "<string>", // R! Documentation for search parameter
"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)
}
SearchParameter Search Parameters
The following search parameters can be used to query SearchParameter resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/SearchParameter?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
base | text | base |
code | text | code |
description | text | description |
name | text | name |
target | text | target |
type | text | type |
url | uri | url |
