DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 3). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2 R3 R2

Searchparameter-example.json

FHIR Infrastructure Work Group Maturity Level : N/A Ballot Status : Informative Compartments : Not linked to any defined compartments

Raw JSON ( canonical form )

General example

{
  "resourceType": "SearchParameter",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div><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>name</b>: Example Search Parameter</p><p><b>status</b>: draft</p><p><b>experimental</b>: false</p><p><b>publisher</b>: Health Level Seven International (FHIR Infrastructure)</p><h3>Contacts</h3><table><tr><td>-</td><td><b>Name</b></td><td><b>Telecom</b></td></tr><tr><td>*</td><td>[string]</td><td>http://hl7.org/fhir</td></tr></table><p><b>date</b>: 23/10/2013</p><p><b>requirements</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>description</b>: Search by resource identifier - e.g. same as the read interaction, but can return included resources</p><p><b>xpath</b>: f:*/f:id</p><p><b>xpathUsage</b>: normal</p></div>"

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

  },
  "url": "http://hl7.org/fhir/SearchParameter/example",
  "name": "Example Search Parameter",

  "version": "1",
  "name": "ID-SEARCH-PARAMETER",

  "status": "draft",
  "experimental": false,

  "experimental": true,
  "date": "2013-10-23",

  "publisher": "Health Level Seven International (FHIR Infrastructure)",
  "contact": [
    {
      "name": "[string]",
      "telecom": [
        {
          "fhir_comments": [
            "   0..1 Name of a individual to contact   "
          ],
          "system": "other",

          "system": "url",

          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "date": "2013-10-23",
  "requirements": "Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain",
  "_requirements": {
    "fhir_comments": [
      "    this is the canonical definition for the _id search parameter    "
    ]
  },

  "useContext": [
    {
      "code": {
        "system": "http://hl7.org/fhir/usage-context-type",
        "code": "focus"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/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",

  "base": [
    "Resource"
  ],

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

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

  "xpath": "f:*/f:id",
  "xpathUsage": "normal"

  "xpathUsage": "normal",
  "comparator": [
    "eq"
  ]

}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.