SearchParameter - FHIR Resource (dstu2)

This SearchParameter Resource uses the FHIR API standard for access and structure.

Validate an SearchParameter FHIR Resource (dstu2)

Resource Attributes

Attribute	Field is list	Type	Description
base	false	code	The resource type this search parameter applies to
code	false	code	Code used in URL
contact	true	Data Type	Contact details of the publisher
date	false	dateTime	Publication Date(/time)
description	false	string	Documentation for search parameter
experimental	false	boolean	If for testing purposes, not real usage
name	false	string	Informal name for this search parameter
publisher	false	string	Name of the publisher (Organization or individual)
requirements	false	string	Why this search parameter is defined
status	false	code	draft | active | retired
target	true	code	Types of resource (if a resource reference)
type	false	code	number | date | string | token | reference | composite | quantity | uri
url	false	uri	Absolute URL used to reference this search parameter
xpath	false	string	C? XPath that extracts the values
xpathUsage	false	code	C? normal | phonetic | nearby | distance | other

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 the 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