SearchParameter - FHIR Resource (r4)


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

Validate an SearchParameter FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
basetruecode# The resource type(s) this search parameter applies to
chaintruestring# Chained names supported
codefalsecode# Code used in URL
comparatortruecode# eq | ne | gt | lt | ge | le | sa | eb | ap
componenttrueData Type# For Composite resources to define the parts
contacttrueContactDetail# Contact details for the publisher
datefalsedateTime# Date last changed
derivedFromfalsecanonical(SearchParameter)# Original definition for the search parameter
descriptionfalsemarkdown# Natural language description of the search parameter
experimentalfalseboolean# For testing purposes, not real usage
expressionfalsestring# C? FHIRPath expression that extracts the values
jurisdictiontrueCodeableConcept# Intended jurisdiction for search parameter (if applicable)
modifiertruecode# missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
multipleAndfalseboolean# Allow multiple parameters (and)
multipleOrfalseboolean# Allow multiple values per parameter (or)
namefalsestring# C? Name for this search parameter (computer friendly)
publisherfalsestring# Name of the publisher (organization or individual)
purposefalsemarkdown# Why this search parameter is defined
statusfalsecode# draft | active | retired | unknown
targettruecode# Types of resource (if a resource reference)
typefalsecode# number | date | string | token | reference | composite | quantity | uri | special
urlfalseuri# Canonical identifier for this search parameter, represented as a URI (globally unique)
useContexttrueUsageContext# The context that the content is intended to support
versionfalsestring# Business version of the search parameter
xpathfalsestring# C? XPath that extracts the values
xpathUsagefalsecode# C? normal | phonetic | nearby | distance | other

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 ParameterField TypeResource Fields Searched
basetextbase
codetextcode
componentreferencecomponent.definition
contexttextuseContext.value
context-quantityquantityuseContext.value
context-typetextuseContext.code
context-type-quantitycompositeuseContext
context-type-valuecompositeuseContext
datedatedate
derived-fromreferencederivedFrom
descriptiontextdescription
jurisdictiontextjurisdiction
nametextname
publishertextpublisher
statustextstatus
targettexttarget
typetexttype
urluriurl
versiontextversion