This page is part of the FHIR Specification (v0.06: DSTU 1 Ballot 2). 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 R3 R2

Resource List - Content 3.7

Status: Draft Infrastructure resource under consideration by the FHIR project team

A set of information summarized from a list of other resources.

The resource name as it appears in a RESTful URL is /list/

List resources are used in many places, including for allergies, medications, alerts, medical history, etc.

Resource Content 3.7.1

UML Image

<List xmlns="http://hl7.org/fhir">
 <code><!-- 0..1 CodeableConcept What the purpose of this list is --></code>
 <source><!-- 0..1 Resource(Person|Agent|Device) Source of the list --></source>
 <date><!-- 0..1 dateTime When the list was prepared --></date>
 <ordered><!-- 0..1 boolean Whether list is ordered or not --></ordered>
 <entry>  <!-- 0..* Entries in the list -->
  <status><!-- 0..1 code added | retained | updated| deleted --></status>
  <item><!-- 1..1 Resource(Any) Actual entry --></item>
 </entry>
 <emptyReason><!-- 0..1 CodeableConcept Why list is empty --></emptyReason>
 <extension><!-- 0..* Extension  See Extensions  --></extension>
 <text><!-- 1..1 Narrative Text summary of resource (for human interpretation) --></text>
</List>

Alternate definitions: Schema/Schematron, RDF (to do), XML, XMI (to do), Resource Profile

Terminology Bindings

Path	Details	Strength
List.code	What the purpose of a list is (not bound to any particular codes)	complete/unstated
List.entry.status	Status of an entry in a list. (see http://hl7.org/fhir/list-entry-status for values)	complete/required
List.emptyReason	If a list is empty, why it is empty (not bound to any particular codes)	complete/unstated

Path

Details

Strength

List.code

What the purpose of a list is (not bound to any particular codes)

complete/unstated

List.entry.status

Status of an entry in a list. (see http://hl7.org/fhir/list-entry-status for values)

complete/required

List.emptyReason

If a list is empty, why it is empty (not bound to any particular codes)

complete/unstated

Constraints

A list can only have an emptyReason if it is empty (xpath: not(exists(f:emptyReason) and exists(f:entry)))

Item Status 3.7.2

Each entry in the list includes a status. The status code can be one of the following values:

3.7.2.1

added	This item was added to the list
retained	This item has been retained in the list
updated	This item is still in the list, but its summary information changed
deleted	This item has been deleted from the list

The status values are not instructions about what should happen, but a record of what did happen. The context of the list must be known in order to understand the meaning of changes to the list. For example, if the list concerns current patient medications, then a deleted medication means the patient was instructed not to take the medication.

It is not necessary to label an item with a status. However systems must ensure that an item with no status code is not deleted.

Narrative Content 3.7.3

The narrative portion of the List resource should contain a summary of key properties of the items in the list, along with their status as indicated in the entry.

An HTML table is the recommended approach, though this is not required. There should be a representation in the narrative for each item in the list, and vice versa, along with clear use of visual hints (borders, lines, bullet marks, etc.) to ensure that human readers do not get confused about which status belongs with which item on space-poor displays.

Empty Reason 3.7.4

If the list is empty, there could be several different reasons why this is so. For example:

There are no appropriate entries for the list (i.e. the patient has no known medications/allergies/history)
The sender (human or system) deemed that these were not related to this context of patient care (usually for privacy related reasons)
The source system doesn't support these type of entries
The information to populate the list wasn't gathered - i.e. "Not asked"

Given these possibilities, and the common and significant first case, source systems SHOULD provide an empty reason if the list is empty. Because of the importance of this case, the special value "nil known" should be used when there are no (significant) entries in this context of care. Note that this concept is sometimes described differently, such as "patient denies taking medications", or "patient was unable to identify any relevant medical history".

When receiving a list, systems should not assume that the list is complete (some entries may have been withheld for a variety of reasons), unless there are specific trading partner arrangements in place or, if the list is empty, that there are actually nil known, unless the "nil known" code is present.

If the list is empty, the narrative should contain text equivalent to the empty reason.

Search Parameters 3.7.5

Search Parameters for RESTful searches. The standard parameters also apply. See Searching for more information.

$page : integer	Starting offset of the first record to return in the search set	single
$count : integer	Number of return records requested. The server is not bound to conform	single
$id : token	The logical resource id associated with the resource (must be supported by all servers)	single
source : qtoken	[List.source]	union
item : qtoken	[List.entry.item]	union
emptyReason : qtoken	[List.emptyReason]	single
date : date	date equal to [List.date]	single
date-before : date	date before or equal to [List.date]	single
date-after : date	date after or equal to [List.date]	single
code : qtoken	[List.code]	union

(See Searching).

This is an old version of FHIR retained for archive purposes. Do not use for anything else
Implementers are welcome to experiment with the content defined here, but should note that the contents are subject to change without prior notice.
© HL7.org 2011 - 2012. FHIR v0.06 generated on Tue, Dec 4, 2012 00:03+1100. License