0.1.0 - trial-use

KisimScheduling - Local Development build (v0.1.0). See the Directory of published versions

: Search Appointments by Encounter - XML Representation

Draft as of 2022-09-05

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="appointment-query-searchByEncounter"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>SearchAppointmentByEncounter</h2><p>QUERY: SearchAppointmentByEncounter</p><p>The official URL for this operation definition is: </p><pre>http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/appointment-query-searchByEncounter</pre><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>_query</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#string">string</a>)</td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>Extended search parameter, value has to be searchByEncounter</p>
</div></td></tr><tr><td>IN</td><td>encounter</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#string">string</a>)</td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>The encounter ID.</p>
</div></td></tr><tr><td>IN</td><td>from</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>Starting date/time for the search.</p>
</div></td></tr><tr><td>IN</td><td>to</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>Stopping date/time for the search.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>A bundle of appointment ressources.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/appointment-query-searchByEncounter"/>
  <version value="0.1.0"/>
  <name value="SearchAppointmentByEncounter"/>
  <status value="draft"/>
  <kind value="query"/>
  <date value="2022-09-05T14:14:42+02:00"/>
  <publisher value="Cistec AG"/>
  <contact>
    <name value="Cistec AG"/>
    <telecom>
      <system value="url"/>
      <value value="https://www.cistec.com"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="robert.birri@cistec.com"/>
    </telecom>
  </contact>
  <code value="searchByUser"/>
  <resource value="Appointment"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="_query"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Extended search parameter, value has to be searchByEncounter"/>
    <type value="string"/>
    <searchType value="string"/>
    <binding>
      <strength value="required"/>
      <valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
    </binding>
  </parameter>
  <parameter>
    <name value="encounter"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The encounter ID."/>
    <type value="string"/>
    <searchType value="string"/>
    <binding>
      <strength value="required"/>
      <valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
    </binding>
  </parameter>
  <parameter>
    <name value="from"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Starting date/time for the search."/>
    <type value="dateTime"/>
    <binding>
      <strength value="required"/>
      <valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
    </binding>
  </parameter>
  <parameter>
    <name value="to"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Stopping date/time for the search."/>
    <type value="dateTime"/>
    <binding>
      <strength value="required"/>
      <valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
    </binding>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="A bundle of appointment ressources."/>
    <type value="Bundle"/>
    <binding>
      <strength value="required"/>
      <valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
    </binding>
  </parameter>
</OperationDefinition>