FHIR R6 API Incubator
0.1.0 - ci-build International flag

FHIR R6 API Incubator, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/api-incubator-ig/ and changes regularly. See the Directory of published versions

: Find a functional list - XML Representation

Page standards status: Trial-use Maturity Level: 1

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="List-find"/>
  <meta>
    <lastUpdated value="2021-01-05T10:01:24.148+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition List-find</b></p><a name="List-find"> </a><a name="hcList-find"> </a><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">Last updated: 2021-01-05 10:01:24+1100</p></div><p>URL: [base]/List/$find</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</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>patient</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#id">id</a></td><td/><td><div><p>The id of a patient resource located on the server on which this operation is executed</p>
</div></td></tr><tr><td>IN</td><td>name</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td/><td><div><p>The code for the functional list that is being found</p>
</div></td></tr></table><div><p>Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly</p>
</div></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/>
  </extension>
  <extension url="http://hl7.org/fhir/build/StructureDefinition/example">
    <extension url="list">
      <valueString value="1"/>
    </extension>
    <extension url="response">
      <valueBoolean value="false"/>
    </extension>
    <extension url="content">
      <valueString value="$find-request.txt"/>
    </extension>
  </extension>
  <extension url="http://hl7.org/fhir/build/StructureDefinition/example">
    <extension url="list">
      <valueString value="1"/>
    </extension>
    <extension url="response">
      <valueBoolean value="true"/>
    </extension>
    <extension url="content">
      <valueString value="$find-response.txt"/>
    </extension>
  </extension>
  <extension url="http://hl7.org/fhir/build/StructureDefinition/footer">
    <valueMarkdown
                   value="Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/>
  </extension>
  <url value="http://hl7.org/fhir/OperationDefinition/List-find"/>
  <version value="0.1.0"/>
  <name value="Find"/>
  <title value="Find a functional list"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2021-01-05T10:01:24+11:00"/>
  <publisher value="HL7 International / FHIR Infrastructure"/>
  <contact>
    <name value="HL7 International / FHIR Infrastructure"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <description
               value="This operation allows a client to find an identified list for a particular function by its function. The operation takes two parameters, the identity of a patient, and the name of a functional list.     The list of defined functional lists can be found at [Current Resource Lists](https://hl7.org/fhir/lifecycle.html#lists). Applications are not required to support all the lists, and may define additional lists of their own.   If the system is able to locate a list that serves the identified purpose, it returns it as the body of the response with a 200 OK status. If the resource cannot be located, the server returns a 404 not found (optionally with an OperationOutcome resource)"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <affectsState value="false"/>
  <code value="find"/>
  <comment
           value="Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly"/>
  <resource value="List"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The id of a patient resource located on the server on which this operation is executed"/>
    <type value="id"/>
  </parameter>
  <parameter>
    <name value="name"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The code for the functional list that is being found"/>
    <type value="code"/>
  </parameter>
</OperationDefinition>