US Core Implementation Guide
8.0.0-ballot - STU8 Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 8.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

: USCorePatientBirthdate - XML Representation

Page standards status: Trial-use Maturity Level: 3

Raw xml | Download


<SearchParameter xmlns="http://hl7.org/fhir">
  <id value="us-core-patient-birthdate"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">  <!-- <h2>SearchParameter: USCorePatientBirthdate</h2>
				<b> description</b> : <p><strong>The patient's date of birth</strong><br />
NOTE: This SearchParameter is defined only to document Server and Client expectations. Its definition is derived from the standard FHIR SearchParameter and it uses the <a href="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">Conformance expectation extension</a> to define additional expectations for the following SearchParameter elements:</p>
<ul>
<li><code>multipleAnd</code></li>
<li><code>multipleOr</code></li>
<li><code>comparator</code></li>
<li><code>modifier</code></li>
<li><code>chain</code></li>
</ul>
<p>For search operations, Servers and Clients <strong>SHOULD</strong> use standard FHIR SearchParameter.</p>

			<br/> --><p><b> id</b> us-core-patient-birthdate</p><p><b> url</b> : <b> http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate</b>
			</p><p><b> name</b> : USCorePatientBirthdate</p><p><b> derivedFrom</b> : http://hl7.org/fhir/SearchParameter/individual-birthdate</p><p><b> status</b> : active</p><p><b> date</b> : 11/17/2024</p><p><b> publisher</b> : HL7 International - Cross-Group Projects</p><p><b> contact</b> : http://www.hl7.org/Special/committees/cgp</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>birthdate</code>
			</p><p><b> base</b> :Patient</p><p><b> type</b> : date</p><p><b> expression</b> : <code>Patient.birthDate</code>
			</p><p><b> xpath</b> : <code>f:Patient/f:birthDate|f:Person/f:birthDate|f:RelatedPerson/f:birthDate</code>
			</p><p><b> xpathUsage</b> : normal</p><p><b> multipleOr</b> : True   (Conformance Expectation = MAY)</p><p><b> multipleAnd</b> : True  ( Conformance Expectation = MAY)</p><p><b> comparator</b> : <code>eq</code> ( Conformance Expectation = MAY)</p><p><b> comparator</b> : <code>ne</code> ( Conformance Expectation = MAY)</p><p><b> comparator</b> : <code>gt</code> ( Conformance Expectation = MAY)</p><p><b> comparator</b> : <code>ge</code> ( Conformance Expectation = MAY)</p><p><b> comparator</b> : <code>lt</code> ( Conformance Expectation = MAY)</p><p><b> comparator</b> : <code>le</code> ( Conformance Expectation = MAY)</p><p><b> comparator</b> : <code>sa</code> ( Conformance Expectation = MAY)</p><p><b> comparator</b> : <code>eb</code> ( Conformance Expectation = MAY)</p><p><b> comparator</b> : <code>ap</code> ( Conformance Expectation = MAY)</p></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cgp"/>
  </extension>
  <url
       value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate"/>
  <version value="8.0.0-ballot"/>
  <name value="USCorePatientBirthdate"/>
  <derivedFrom
               value="http://hl7.org/fhir/SearchParameter/individual-birthdate"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-11-17"/>
  <publisher value="HL7 International / Cross-Group Projects"/>
  <contact>
    <name value="HL7 International / Cross-Group Projects"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cgp"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="cgp@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="**The patient's date of birth**  
NOTE: This SearchParameter is defined only to document Server and Client expectations. Its definition is derived from the standard FHIR SearchParameter and it uses the [Conformance expectation extension](http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation) to define additional expectations for the following SearchParameter elements:
- `multipleAnd`
- `multipleOr`
- `comparator`
- `modifier`
- `chain`

It **SHALL NOT** be used as a search parameter for search. Servers and Clients **SHOULD** use the standard FHIR SearchParameter.
"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <code value="birthdate"/>
  <base value="Patient"/>
  <type value="date"/>
  <expression value="Patient.birthDate"/>
  <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>
  <comparator value="eq">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </comparator>
  <comparator value="ne">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </comparator>
  <comparator value="gt">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </comparator>
  <comparator value="ge">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </comparator>
  <comparator value="lt">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </comparator>
  <comparator value="le">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </comparator>
  <comparator value="sa">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </comparator>
  <comparator value="eb">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </comparator>
  <comparator value="ap">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </comparator>
</SearchParameter>