SearchParameter.name

FHIR attribute (r4)

In the SearchParameter resource for FHIR r4 , the name attribute identifies the C? Name for this search parameter (computer friendly)

name (SearchParameter) description

Resource Type: SearchParameter

Attribute Name: name

Description: C? Name for this search parameter (computer friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

SearchParameter.name Example

"name": "ID-SEARCH-PARAMETER"

SearchParameter attributes

AttributeField is listTypeDescription

Description: Canonical identifier for this search parameter, represented as a URI (globally unique)

FHIR Version: r4

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: Business version of the search parameter

FHIR Version: r4

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

Description: C? Name for this search parameter (computer friendly)

FHIR Version: r4

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: Original definition for the search parameter

FHIR Version: r4

Attribute Type : canonical(SearchParameter)

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: draft | active | retired | unknown

FHIR Version: r4

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: For testing purposes, not real usage

FHIR Version: r4

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

Description: Date last changed

FHIR Version: r4

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: Name of the publisher (organization or individual)

FHIR Version: r4

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: Contact details for the publisher

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

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

Learn more about the (SearchParameter) contact FHIR attribute

Description: Natural language description of the search parameter

FHIR Version: r4

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: The context that the content is intended to support

FHIR Version: r4

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"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"
        }
      ]
    }
  }
]

Learn more about the (SearchParameter) useContext FHIR attribute

Description: Intended jurisdiction for search parameter (if applicable)

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

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

Learn more about the (SearchParameter) jurisdiction FHIR attribute

Description: Why this search parameter is defined

FHIR Version: r4

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: Code used in URL

FHIR Version: r4

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: The resource type(s) this search parameter applies to

FHIR Version: r4

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

FHIR Version: r4

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? FHIRPath expression that extracts the values

FHIR Version: r4

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: C? XPath that extracts the values

FHIR Version: r4

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: C? normal | phonetic | nearby | distance | other

FHIR Version: r4

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: Types of resource (if a resource reference)

FHIR Version: r4

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: Allow multiple values per parameter (or)

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"multipleOr":

Learn more about the (SearchParameter) multipleOr FHIR attribute

Description: Allow multiple parameters (and)

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"multipleAnd":

Learn more about the (SearchParameter) multipleAnd FHIR attribute

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

FHIR Version: r4

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

FHIR Version: r4

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: Chained names supported

FHIR Version: r4

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: For Composite resources to define the parts

FHIR Version: r4

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