Create a new SearchParameter

SearchParameter on the FHIR specification website.

A search parameter that defines a named search item that can be used to search/filter on a resource.

The body should be a valid FHIR object for SearchParameter.

Here is an example:

{
  "resourceType": "SearchParameter",
  "id": "Account-identifier",
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    }
  ],
  "url": "http://hl7.org/fhir/SearchParameter/Account-identifier",
  "version": "4.0.1",
  "name": "identifier",
  "status": "draft",
  "experimental": false,
  "date": "2019-11-01T09:29:23+11:00",
  "publisher": "Health Level Seven International (Patient Administration)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
        }
      ]
    }
  ],
  "description": "Account number",
  "code": "identifier",
  "base": [
    "Account"
  ],
  "type": "token",
  "expression": "Account.identifier",
  "xpath": "f:Account/f:identifier",
  "xpathUsage": "normal"
}

You can reference the FHIR documentation to determine the format for SearchParameter.

Body Params
Responses

401

Unauthorized

403

Forbidden

500

Internal server error

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json