SearchParameter - FHIR Resource (stu3)


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

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 this was last changed
derivedFromfalseuri 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
namefalsestring 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
urlfalseuri Logical URI to reference this search parameter (globally unique)
useContexttrueUsageContext Context 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

{
  "xpathUsage": "normal",
  "xpath": "f:*/f:id",
  "code": "_id",
  "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>: <a>http://hl7.org/fhir/SearchParameter/example</a></p><p><b>version</b>: 1</p><p><b>name</b>: ID-SEARCH-PARAMETER</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>useContext</b>: </p><p><b>jurisdiction</b>: United States of America (the) <span>(Details : {urn:iso:std:iso:3166 code 'US' = 'United States', 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>derivedFrom</b>: <a>http://hl7.org/fhir/SearchParameter/Resource-id</a></p><p><b>description</b>: Search by resource identifier - e.g. same as the read interaction, but can return included resources</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>"
  },
  "jurisdiction": [
    {
      "coding": [
        {
          "code": "US",
          "system": "urn:iso:std:iso:3166",
          "display": "United States of America (the)"
        }
      ]
    }
  ],
  "id": "example",
  "version": "1",
  "type": "token",
  "status": "draft",
  "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources",
  "derivedFrom": "http://hl7.org/fhir/SearchParameter/Resource-id",
  "base": [
    "Resource"
  ],
  "useContext": [
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "positive",
            "system": "http://hl7.org/fhir/variant-state"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    }
  ],
  "purpose": "Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain",
  "date": "2013-10-23",
  "publisher": "Health Level Seven International (FHIR Infrastructure)",
  "name": "ID-SEARCH-PARAMETER",
  "comparator": [
    "eq"
  ],
  "resourceType": "SearchParameter",
  "url": "http://hl7.org/fhir/SearchParameter/example",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ],
      "name": "[string]"
    }
  ],
  "expression": "id",
  "experimental": true
}

SearchParameter Structure


  
{
  "resourceType" : "SearchParameter",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Logical URI to reference this search parameter (globally unique)
  "version" : "<string>", // Business version of the search parameter
  "name" : "<string>", // R!  Name for this search parameter (computer friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "useContext" : [{ UsageContext }], // Context 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
  "derivedFrom" : "<uri>", // Original Definition for the search parameter
  "description" : "<markdown>", // R!  Natural language description of the search parameter
  "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)
  "comparator" : ["<code>"], // eq | ne | gt | lt | ge | le | sa | eb | ap
  "modifier" : ["<code>"], // missing | exact | contains | not | text | in | not-in | below | above | type
  "chain" : ["<string>"], // Chained names supported
  "component" : [{ // For Composite resources to define the parts
    "definition" : { Reference(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 the like so:

https://api.1up.health/fhir/stu3/SearchParameter?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
basetextbase
codetextcode
componentreferencecomponent.definition
datedatedate
derived-fromuriderivedFrom
descriptiontextdescription
jurisdictiontextjurisdiction
nametextname
publishertextpublisher
statustextstatus
targettexttarget
typetexttype
urluriurl
versiontextversion