US Core Implementation Guide
4.0.0 - STU4 Release

This page is part of the US Core (v4.0.0: STU4) 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

: USCoreDocumentReferencePeriod - XML Representation

Raw xml | Download



<SearchParameter xmlns="http://hl7.org/fhir">
  <id value="us-core-documentreference-period"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">  <!-- <h2>SearchParameter: USCoreDocumentReferencePeriod</h2> --><b> description</b> : <p><strong>Time of service that is being documented</strong><br/><strong>NOTE</strong>: This US Core SearchParameter definition extends the usage context of the
<a href="http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html">Conformance expectation extension</a></p>
<ul><li>multipleAnd</li><li>multipleOr</li><li>comparator</li><li>modifier</li><li>chain</li></ul>

			<br/>
			<p><b> id</b> us-core-documentreference-period</p>
			<p><b> url</b> : <b> http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period</b>
			</p>
			<p><b> version</b> : 4.0.1</p>
			<p><b> name</b> : USCoreDocumentReferencePeriod</p>
			<p><b> derivedFrom</b> : http://hl7.org/fhir/SearchParameter/DocumentReference-period
			</p>
			<p><b> status</b> : active</p>
			<p><b> experimental</b>  False</p>
			<p><b> date</b> : 2020-11-20</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>period</code>
			</p>
			<p><b> base</b> :DocumentReference</p>
			<p><b> type</b> : date</p>
			<p><b> expression</b> : <code>DocumentReference.context.period</code>
			</p>
			<p><b> xpath</b> : <code>f:DocumentReference/f:context/f:period</code>
			</p>
			<p><b> xpathUsage</b> : normal</p>
			<p><b> mulitpleOr</b> : True   (Conformance Expectation = MAY)</p>
			<p><b> mulitpleAnd</b> : True  ( Conformance Expectation = SHOULD)</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 = SHALL)</p>
    
    <p><b> comparator</b> : <code>ge</code> ( Conformance Expectation = SHALL)</p>
    
    <p><b> comparator</b> : <code>lt</code> ( Conformance Expectation = SHALL)</p>
    
    <p><b> comparator</b> : <code>le</code> ( Conformance Expectation = SHALL)</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>
  <url
       value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period"/>
  <version value="4.0.0"/>
  <name value="USCoreDocumentReferencePeriod"/>
  <derivedFrom
               value="http://hl7.org/fhir/SearchParameter/DocumentReference-period"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2020-11-20T05:19:28.258166Z"/>
  <publisher value="HL7 International - US Realm Steering Committee"/>
  <contact>
    <name value="HL7 International - US Realm Steering Committee"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/usrealm/index.cfm"/>
    </telecom>
  </contact>
  <description
               value="**Time of service that is being documented**  
**NOTE**: This US Core SearchParameter definition extends the usage context of the
[Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)
 - multipleAnd
 - multipleOr
 - comparator
 - modifier
 - chain"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <code value="period"/>
  <base value="DocumentReference"/>
  <type value="date"/>
  <expression value="DocumentReference.context.period"/>
  <xpath value="f:DocumentReference/f:context/f:period"/>
  <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="SHOULD"/>
    </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="SHALL"/>
    </extension>
  </comparator>
  <comparator value="ge">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="SHALL"/>
    </extension>
  </comparator>
  <comparator value="lt">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="SHALL"/>
    </extension>
  </comparator>
  <comparator value="le">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="SHALL"/>
    </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>