Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). 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

Example SearchParameter/example (XML)

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

Raw XML ( canonical form + also see XML Format Specification )

Jump past Narrative

General example (id = "example")

<?xml version="1.0" encoding="UTF-8"?>

<SearchParameter xmlns="http://hl7.org/fhir">
  <id value="example"/> 
  
    
    
      
        
      
      display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px
       solid #8da1b4; border-radius: 5px; line-height: 60%
        
      
      
        : 
        
      
      
        : 1
      
      
        : ID-SEARCH-PARAMETER
      
      
        : 
        
      
      
        : draft
      
      
        : true
      
      
        : 2013-10-23
      
      
        : Health Level Seven International (FHIR Infrastructure)
      
      
        : [string]: 
        
      
      
        : Search by resource identifier - e.g. same as the read interaction, but can return included
         resources
      
      
        : United States of America (the) 
        
      
      
        : Need to search by identifier for various infrastructural cases - mainly retrieving packages,
         and matching as part of a chain
      
      
        : _id
      
      
        : Resource
      
      
        : token
      
      
        : id
      
      
        : f:*/f:id
      
      
        : normal
      
      
        : eq
      
    
  
  
  

  <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative: SearchParameter</b> <a name="example"> </a> </p> <div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border:
       1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource SearchParameter &quot;example&quot; </p> </div> <p> <b> url</b> : <code> http://hl7.org/fhir/SearchParameter/example</code> </p> <p> <b> version</b> : 1</p> <p> <b> name</b> : ID-SEARCH-PARAMETER</p> <p> <b> derivedFrom</b> : <a href="http://hl7.org/fhir/SearchParameter/Resource-id">http://hl7.org/fhir/SearchParameter/Resource-id</a> </p> <p> <b> status</b> : draft</p> <p> <b> experimental</b> : true</p> <p> <b> date</b> : 2013-10-23</p> <p> <b> publisher</b> : Health Level Seven International (FHIR Infrastructure)</p> <p> <b> contact</b> : [string]: <a href="http://hl7.org/fhir">http://hl7.org/fhir</a> </p> <p> <b> description</b> : Search by resource identifier - e.g. same as the read interaction, but can return
         included resources</p> <h3> UseContexts</h3> <table class="grid"><tr> <td> -</td> <td> <b> Code</b> </td> <td> <b> Value[x]</b> </td> </tr> <tr> <td> *</td> <td> Clinical Focus (Details: http://terminology.hl7.org/CodeSystem/usage-context-type
             code focus = 'Clinical Focus', stated as 'null')</td> <td> positive <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.1.0/CodeSystem-variant-state.html">sequenceStatus</a> #positive)</span> </td> </tr> </table> <p> <b> jurisdiction</b> : United States of America (the) <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (unknown#US)</span> </p> <p> <b> purpose</b> : <span title="   this is the canonical definition for the _id search parameter   ">Need to search by identifier for various infrastructural cases - mainly retrieving
           packages, and matching as part of a chain</span> </p> <p> <b> code</b> : _id</p> <p> <b> base</b> : Resource</p> <p> <b> type</b> : token</p> <p> <b> expression</b> : id</p> <p> <b> processingMode</b> : normal</p> </div> </text> <url value="http://hl7.org/fhir/SearchParameter/example"/> 
    <version value="1"/> 
  <name value="ID-SEARCH-PARAMETER"/> 
  <derivedFrom value="http://hl7.org/fhir/SearchParameter/Resource-id"/> 
  <status value="draft"/> 
  <experimental value="true"/> 
  <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="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  Search by resource identifier - e.g. same as the read interaction, but can return included
   resources

  <description value="Search by resource identifier - e.g. same as the read interaction, but can return
   included resources"/> 

  <useContext> 
    <code> 
      <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/> 
      <code value="focus"/> 
    </code> 
    <valueCodeableConcept> 
      <coding> 
        <system value="http://terminology.hl7.org/CodeSystem/variant-state"/> 
        <code value="positive"/> 
      </coding> 
    </valueCodeableConcept> 
  </useContext> 
  <jurisdiction> 
    <coding> 
      <system value="urn:iso:std:iso:3166"/> 
      <code value="US"/> 
      <display value="United States of America (the)"/> 
    </coding> 
  </jurisdiction> 
  Need to search by identifier for various infrastructural cases - mainly retrieving packages,
   and matching as part of a chain


  <!--     this is the canonical definition for the _id search parameter     -->
  <purpose 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"/> 
  <expression value="id"/> 
  
  
  

  <processingMode 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.