List-operation-find - FHIR v5.0.0-ballot

Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

2.7.17.1 Operation $find on List

FHIR Infrastructure

Work Group

Maturity Level: 1

Trial Use

Compartments: N/A

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. 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).

The canonical URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/List-find

Formal Definition (as a OperationDefinition).

URL: [base]/List/$find

This is an idempotent operation

In Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

patient

1..1

id

The id of a patient resource located on the server on which this operation is executed

name

1..1

code

The code for the functional list that is being found

Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly

2.7.17.1.1 Examples

Request: Find the current allergy list for patient 'example'


GET /ehr/fhir/List/$find?patient=example&name=$current-allergies

Response: Return the current allergies list for the patient


HTTP/1.1 200 OK
[other headers]

<?xml version="1.0" encoding="UTF-8"?>
<List xmlns="http://hl7.org/fhir">
  <id value="current-allergies"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>List prepared for Dr Adam Careful</p>
      <p>Patient Peter Chalmers, DOB = Dec 25, 1974, MRN = 12345 (Acme Healthcare) has the following allergies</p>
      <ul>
        <li>cashew nut allergenic extract Injectable Product (<b>High</b>)</li>
        <li>Allergenic extract, penicillin (high)</li>
      </ul>
    </div>
  </text>
  <extension url="http://hl7.org/fhir/StructureDefinition/list-for">
    <valueReference>
      <reference value="Patient/example"/>
      <display value="Dr Adam Careful"/>
    </valueReference>
  </extension>
  <status value="current"/>
  <mode value="working"/>
  <title value="Current Allergy List"/>
  <code>
    <coding>
      <system value="http://loinc.org"/>
      <code value="52472-8"/>
      <display value="Allergies and Adverse Drug Reactions"/>
    </coding>
    <text value="Current Allergy List"/>
  </code>
  <date value="2015-07-14T23:10:23+11:00"/>
  <source>
    <reference value="Patient/example"/>
  </source>
  <orderedBy>
    <coding>
      <system value="http://terminology.hl7.org/CodeSystem/list-order"/>
      <code value="entry-date"/>
    </coding>
  </orderedBy>
  <entry>
    <item> 
      <reference value="AllergyIntolerance/example"/>
    </item>
  </entry>  
  <entry>
    <item> 
      <reference value="AllergyIntolerance/medication"/>
    </item>
  </entry>  
</List>

For more information about operations, including how they are invoked, see Operations.