List

ResourceBase · ManagementTrial useMaturity 1

A list is a curated collection of resources.

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifier	0..*	Identifier	Business identifier
statusRequired?!Σ	1..1	code	current \| retired \| entered-in-errorBinding (required): list-status
modeRequired?!Σ	1..1	code	working \| snapshot \| changesBinding (required): list-mode
titleΣ	0..1	string	Descriptive name for the list
codeΣ	0..1	CodeableConcept	What the purpose of this list isBinding (example): list-example-codes
subjectΣ	0..1	Reference(Patient \| Group \| Device \| Location)	If all resources have the same subject
encounter	0..1	Reference(Encounter)	Context in which list created
dateΣ	0..1	dateTime	When the list was prepared
sourceΣ	0..1	Reference(Practitioner \| PractitionerRole \| Patient \| Device)	Who and/or what defined the list contents (aka Author)
orderedBy	0..1	CodeableConcept	What order the list hasBinding (preferred): list-order
note	0..*	Annotation	Comments about the list
entry	0..*	BackboneElement	Entries in the list
flag	0..1	CodeableConcept	Status/Workflow information about this itemBinding (example): list-item-flag
deleted?!	0..1	boolean	If this item is actually marked as deleted
date	0..1	dateTime	When item added to list
itemRequired	1..1	Reference(Resource)	Actual entry
emptyReason	0..1	CodeableConcept	Why list is emptyBinding (preferred): list-empty-reason

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Query with GET [base]/List?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description
`code`	token	What the purpose of this list is `List.code`
`date`	date	When the list was prepared `List.date`
`empty-reason`	token	Why list is empty `List.emptyReason`
`encounter`	reference	Context in which list created `List.encounter`
`identifier`	token	Business identifier `List.identifier`
`item`	reference	Actual entry `List.entry.item`
`notes`	string	The annotation - text content (as markdown) `List.note.text`
`patient`	reference	If all resources have the same subject `List.subject.where(resolve() is Patient)`
`source`	reference	Who and/or what defined the list contents (aka Author) `List.source`
`status`	token	current \| retired \| entered-in-error `List.status`
`subject`	reference	If all resources have the same subject `List.subject`
`title`	string	Descriptive name for the list `List.title`

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

`_haste-health-author`	reference	The author of the resource
`_id`	token	Logical id of this artifact
`_lastUpdated`	date	When the resource version last changed
`_profile`	uri	Profiles this resource claims to conform to
`_security`	token	Security Labels applied to this resource
`_source`	uri	Identifies where the resource comes from
`_tag`	token	Tags applied to this resource
`_type`	token	Derived from the R4B Definition