SearchParameter - FHIR Resource (dstu2)


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

Resource Attributes

AttributeField is listTypeDescription
basefalsecode The resource type this search parameter applies to
codefalsecode Code used in URL
contacttrueData Type Contact details of the publisher
datefalsedateTime Publication Date(/time)
descriptionfalsestring Documentation for search parameter
experimentalfalseboolean If for testing purposes, not real usage
namefalsestring Informal name for this search parameter
publisherfalsestring Name of the publisher (Organization or individual)
requirementsfalsestring Why this search parameter is defined
statusfalsecode draft | active | retired
targettruecode Types of resource (if a resource reference)
typefalsecode number | date | string | token | reference | composite | quantity | uri
urlfalseuri Absolute URL used to reference this search parameter
xpathfalsestring C? XPath that extracts the values
xpathUsagefalsecode 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 ParameterField TypeResource Fields Searched
basetextbase
codetextcode
descriptiontextdescription
nametextname
targettexttarget
typetexttype
urluriurl