2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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

6.21.8 Resource SearchParameter - Examples

Example Index:

General example for searchin on an extensionXMLJSON
Search parameter for an extension exampleXMLJSON

6.21.8.1 General

XML

General example for searchin on an extension (id = "example")

Raw XML

<SearchParameter xmlns="http://hl7.org/fhir">
  <id value="example"/>
  <url value="http://hl7.org/fhir/SearchParameter/example"/>
  <name value="Example Search Parameter"/>
  <publisher value="HL7 FHIR Project"/>
  <contact>
    <telecom>
    <system value="url"/>
    <value value="http://hl7.org/fhir"/>
  </telecom>
  </contact>
  <!--   this is the canonical definition for the _id search parameter   -->
  <base value="Resource"/>
  <type value="token"/>
  <description value="Search by resource identifier - e.g. same as the read interaction, but can return included
   resources"/>
  <xpath value="f:id"/>
</SearchParameter>

JSON

General example for searchin on an extension

Raw JSON (Canonical)

{
  "resourceType": "SearchParameter",
  "id": "example",
  "url": "http://hl7.org/fhir/SearchParameter/example",
  "name": "Example Search Parameter",
  "publisher": "HL7 FHIR Project",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "base": "Resource",
  "type": "token",
  "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources",
  "xpath": "f:id"
}

6.21.8.2 Extension

XML

Search parameter for an extension example (id = "example-extension")

Raw XML

<SearchParameter xmlns="http://hl7.org/fhir">
  <id value="example-extension"/>
  <url value="http://hl7.org/fhir/SearchParameter/example-extension"/>
  <name value="Example Search Parameter on an extension"/>
  <publisher value="HL7 FHIR Project"/>
  <contact>
    <telecom>
    <system value="url"/>
    <value value="http://hl7.org/fhir"/>
  </telecom>
  </contact>
  <!--   this is the canonical definition for the _id search parameter   -->
  <base value="Patient"/>
  <type value="token"/>
  <description value="Search by url for a participation agreement"/>
  <xpath value="http://example.org/fhir/ExtensionDefinition/participation-agreement"/>
</SearchParameter>

JSON

Search parameter for an extension example

Raw JSON (Canonical)

{
  "resourceType": "SearchParameter",
  "id": "example-extension",
  "url": "http://hl7.org/fhir/SearchParameter/example-extension",
  "name": "Example Search Parameter on an extension",
  "publisher": "HL7 FHIR Project",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "base": "Patient",
  "type": "token",
  "description": "Search by url for a participation agreement",
  "xpath": "http://example.org/fhir/ExtensionDefinition/participation-agreement"
}

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.