Example OperationDefinition/List-find (XML)
Raw XML (canonical form + also see XML Format Specification)
Operation Definition
<?xml version="1.0" encoding="UTF-8"?>
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="List-find"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p> URL: [base]/List/$find</p>
<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> patient</td>
<td> 1..1</td>
<td>
<a href="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> 1..1</td>
<td>
<a href="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>
<url value="http://hl7.org/fhir/OperationDefinition/List-find"/>
<version value="5.0.0-ballot"/>
<name value="Find"/>
<title value="Find a functional list"/>
<status value="draft"/>
<kind value="operation"/>
<experimental value="false"/>
<date value="2022-09-10T04:52:37+10:00"/>
<publisher value="HL7 (FHIR Project)"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://hl7.org/fhir"/>
</telecom>
<telecom>
<system value="email"/>
<value value="fhir@lists.hl7.org"/>
</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](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)"/>
<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>
Usage note: every effort has been made to ensure that the
examples are correct and useful, but they are not a normative part
of the specification.