STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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

Searchparameter-example.xml

Raw XML (canonical form)

General example (id = "example")

<SearchParameter xmlns="http://hl7.org/fhir">
  <id value="example"/>
  <text><status value="generated"/><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>name</b>: Example Search Parameter</p><p><b>status</b>: draft</p><p><b>experimental</b>: false</p><p><b>date</b>: 23/10/2013</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>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></text><url value="http://hl7.org/fhir/SearchParameter/example"/>
  <name value="Example Search Parameter"/>
  <status value="draft"/>
  <experimental value="false"/>
  <date value="2013-10-23"/>
  <publisher value="Health Level Seven International (FHIR Infrastructure)"/>
  <contact>
  <name value="[string]"/><!--    0..1 Name of an individual to contact    -->
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  
<!--     this is the canonical definition for the _id search parameter     -->
  <requirements value="Need to search by identifier for various infrastructural cases - mainly retrieving packages,
   and matching as part of a chain"/>
  <code value="_id"/>
  <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:*/f:id"/>
  <xpathUsage value="normal"/>
</SearchParameter>

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.