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
This artefact is marked as a draft.
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.
{todo}Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Directory | 0..* | Message | Directory | |
complete | 1..1 | CompleteDirectory | an indicator that states whether the complete directory listing is included in entries or whether additional retrievals are needed to get the full listing | |
numEntries | 1..1 | NaturalNumber | the number of entries in this directory segment | |
prev | 0..1 | DirectoryURI | a URI that, when de-referenced, produces the preceding set of entries in the directory | |
next | 0..1 | DirectoryURI | a URI that, when de-referenced, produces the next set of entries in the directory | |
directoryFilter | 0..1 | Filter | the filter(s) that were applied to generate this directory | |
sortCriteria | 0..1 | SortCriteria | the sort criteria used in the directory | |
Documentation for this format |
UML Diagram
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Directory | 0..* | Message | Directory | |
complete | 1..1 | CompleteDirectory | an indicator that states whether the complete directory listing is included in entries or whether additional retrievals are needed to get the full listing | |
numEntries | 1..1 | NaturalNumber | the number of entries in this directory segment | |
prev | 0..1 | DirectoryURI | a URI that, when de-referenced, produces the preceding set of entries in the directory | |
next | 0..1 | DirectoryURI | a URI that, when de-referenced, produces the next set of entries in the directory | |
directoryFilter | 0..1 | Filter | the filter(s) that were applied to generate this directory | |
sortCriteria | 0..1 | SortCriteria | the sort criteria used in the directory | |
Documentation for this format |