HL7 FHIR® US Core Implementation Guide STU 3

This page is part of the US Core (v3.0.0: STU3) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

XML Format: SearchParameter-us-core-patient-family

Download Raw xml 


<SearchParameter xmlns="http://hl7.org/fhir">
  <id value="us-core-patient-family"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>SearchParameter: USCorePatientFamily</h2><p><b> description</b> : A portion of the family name of the patient<br/>
<em>NOTE</em>: This US Core SearchParameter definition extends the usage context of
<a href="http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html">capabilitystatement-expectation</a>
 extension to formally express implementer expectations for these elements:<br/>
 - multipleAnd<br/>
 - multipleOr<br/>
 - modifier<br/>
 - comparator<br/>
 - chain<br/>
 </p><br/><p><b> id</b> us-core-patient-family</p><p><b> url</b> : <b> http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family</b>
			</p><p><b> version</b> : 4.1.0</p><p><b> name</b> : USCorePatientFamily</p><p><b> derivedFrom</b> : http://hl7.org/fhir/SearchParameter/individual-family
			</p><p><b> status</b> : active</p><p><b> experimental</b>  False</p><p><b> date</b> : 2019-05-23</p><p><b> publisher</b> : HL7 International - US Realm Steering Committee</p><p><b> contact</b> : http://www.hl7.org/Special/committees/usrealm/index.cfm</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 of America', 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> : <code>family</code>
			</p><p><b> base</b> :Patient</p><p><b> type</b> : string</p><p><b> expression</b> : <code>Patient.name.family</code>
			</p><p><b> xpath</b> : <code>f:Patient/f:name/f:family</code>
			</p><p><b> xpathUsage</b> : normal</p><p><b> mulitpleOr</b> : True   (Conformance Expectation = MAY)</p><p><b> mulitpleAnd</b> : True  ( Conformance Expectation = MAY)</p><p><b> modifier</b> : <code>missing</code>  (Conformance Expectation =  MAY)</p><p><b> modifier</b> : <code>exact</code>  (Conformance Expectation =  MAY)</p><p><b> modifier</b> : <code>contains</code>  (Conformance Expectation =  MAY)</p></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family"/>
  <version value="3.0.0"/>
  <name value="USCorePatientFamily"/>
  <derivedFrom value="http://hl7.org/fhir/SearchParameter/individual-family"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2019-05-23T14:03:03-04:00"/>
  <publisher value="HL7 International - US Realm Steering Committee"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/usrealm/index.cfm"/>
    </telecom>
  </contact>
  <description
               value="A portion of the family name of the patient&lt;br /&gt;
&lt;em&gt;NOTE&lt;/em&gt;: This US Core SearchParameter definition extends the usage context of
&lt;a href=&quot;http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html&quot;&gt;capabilitystatement-expectation&lt;/a&gt;
 extension to formally express implementer expectations for these elements:&lt;br /&gt;
 - multipleAnd&lt;br /&gt;
 - multipleOr&lt;br /&gt;
 - modifier&lt;br /&gt;
 - comparator&lt;br /&gt;
 - chain&lt;br /&gt;
 "/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <code value="family"/>
  <base value="Patient"/>
  <type value="string"/>
  <expression value="Patient.name.family"/>
  <xpath value="f:Patient/f:name/f:family"/>
  <xpathUsage value="normal"/>
  <multipleOr value="true">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </multipleOr>
  <multipleAnd value="true">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </multipleAnd>
  <modifier value="missing">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </modifier>
  <modifier value="exact">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </modifier>
  <modifier value="contains">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </modifier>
</SearchParameter>