STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

??.??.3 Resource Directory - Detailed Descriptions

Detailed Descriptions for the elements in the Directory resource.

Directory
Definition

Provides a directory or list of resources that match a specific filter and are ordered in a specified order. A directory is read-only and is not necessarily immutable.Note that the name of the link to DirectoryEntry is called "entries" rather than "entry". This allows subclasses to use "entry" without type collisions in the Z.

Control0..*
TypeMessage
Directory.complete(complete)
Definition

an indicator that states whether the complete directory listing is included in entries or whether additional retrievals are needed to get the full listing.

Control1..1
TypeCompleteDirectory
Directory.numEntries(numEntries)
Definition

the number of entries in this directory segment. Note that this is not the total number of entries in the complete directory listing - just the number of entries in this segment.

Control1..1
TypeNaturalNumber
Directory.prev(prev)
Definition

a URI that, when de-referenced, produces the preceding set of entries in the directory.

Control0..1
TypeDirectoryURI
Directory.next(next)
Definition

a URI that, when de-referenced, produces the next set of entries in the directory.

Control0..1
TypeDirectoryURI
Directory.directoryFilter(directoryFilter)
Definition

the filter(s) that were applied to generate this directory

Control0..1
TypeFilter
Directory.sortCriteria(sortCriteria)
Definition

the sort criteria used in the directory. When this is left as optional, there is the possibility that some directories may not be ordered. Some PSMs may chose to make sortCriteria mandatory, meaning that all directory listings must reflect some sort order.

Control0..1
TypeSortCriteria