SearchParameter - FHIR Resource (stu3)

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

Validate an SearchParameter FHIR Resource (stu3)

SearchParameter Attributes

AttributeField is listTypeDescription

Description: C? normal | phonetic | nearby | distance | other

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"xpathUsage": "normal"

Learn more about the (SearchParameter) xpathUsage FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (SearchParameter) status FHIR attribute

Description: Code used in URL

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code": "_id"

Learn more about the (SearchParameter) code FHIR attribute

Description: Chained names supported

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"chain":

Learn more about the (SearchParameter) chain FHIR attribute

Description: Intended jurisdiction for search parameter (if applicable)

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"jurisdiction": [
  {
    "coding": [
      {
        "code": "US",
        "system": "urn:iso:std:iso:3166",
        "display": "United States of America (the)"
      }
    ]
  }
]

Learn more about the (SearchParameter) jurisdiction FHIR attribute

Description: Business version of the search parameter

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version": "1"

Learn more about the (SearchParameter) version FHIR attribute

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"type": "token"

Learn more about the (SearchParameter) type FHIR attribute

Description: C? XPath that extracts the values

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"xpath": "f:*/f:id"

Learn more about the (SearchParameter) xpath FHIR attribute

Description: Natural language description of the search parameter

FHIR Version: stu3

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources"

Learn more about the (SearchParameter) description FHIR attribute

Description: Original Definition for the search parameter

FHIR Version: stu3

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"derivedFrom": "http://hl7.org/fhir/SearchParameter/Resource-id"

Learn more about the (SearchParameter) derivedFrom FHIR attribute

Description: For Composite resources to define the parts

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"component":

Learn more about the (SearchParameter) component FHIR attribute

Description: The resource type(s) this search parameter applies to

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"base": [
  "Resource"
]

Learn more about the (SearchParameter) base FHIR attribute

Description: Context the content is intended to support

FHIR Version: stu3

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"useContext": [
  {
    "valueCodeableConcept": {
      "coding": [
        {
          "code": "positive",
          "system": "http://hl7.org/fhir/variant-state"
        }
      ]
    },
    "code": {
      "code": "focus",
      "system": "http://hl7.org/fhir/usage-context-type"
    }
  }
]

Learn more about the (SearchParameter) useContext FHIR attribute

Description: Why this search parameter is defined

FHIR Version: stu3

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"purpose": "Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain"

Learn more about the (SearchParameter) purpose FHIR attribute

Description: Date this was last changed

FHIR Version: stu3

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date": "2013-10-23"

Learn more about the (SearchParameter) date FHIR attribute

Description: Types of resource (if a resource reference)

FHIR Version: stu3

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

Description: Name of the publisher (organization or individual)

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher": "Health Level Seven International (FHIR Infrastructure)"

Learn more about the (SearchParameter) publisher FHIR attribute

Description: Name for this search parameter (computer friendly)

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": "ID-SEARCH-PARAMETER"

Learn more about the (SearchParameter) name FHIR attribute

Description: eq | ne | gt | lt | ge | le | sa | eb | ap

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"comparator": [
  "eq"
]

Learn more about the (SearchParameter) comparator FHIR attribute

Description: Logical URI to reference this search parameter (globally unique)

FHIR Version: stu3

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url": "http://hl7.org/fhir/SearchParameter/example"

Learn more about the (SearchParameter) url FHIR attribute

Description: Contact details for the publisher

FHIR Version: stu3

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact": [
  {
    "telecom": [
      {
        "system": "url",
        "value": "http://hl7.org/fhir"
      }
    ],
    "name": "[string]"
  }
]

Learn more about the (SearchParameter) contact FHIR attribute

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"modifier":

Learn more about the (SearchParameter) modifier FHIR attribute

Description: C? FHIRPath expression that extracts the values

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"expression": "id"

Learn more about the (SearchParameter) expression FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental": true

Learn more about the (SearchParameter) experimental FHIR attribute

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 them like so:

https://api.1up.health/fhir/stu3/SearchParameter?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`base`	`text`	`base`
`code`	`text`	`code`
`component`	`reference`	`component.definition`
`date`	`date`	`date`
`derived-from`	`uri`	`derivedFrom`
`description`	`text`	`description`
`jurisdiction`	`text`	`jurisdiction`
`name`	`text`	`name`
`publisher`	`text`	`publisher`
`status`	`text`	`status`
`target`	`text`	`target`
`type`	`text`	`type`
`url`	`uri`	`url`
`version`	`text`	`version`