type: resource-definitionsresource: List

List Definitions

List

A list is a curated collection of resources

Definition: A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.

Aliases: Collection, WorkingList, Organizer

Cardinality: 0..*

Constraints: lst-1 | error | A list can only have an emptyReason if it is empty | emptyReason.empty() or entry.empty()

Mappings: rim=Act[classCode<ORG,moodCode=EVN]; w5=infrastructure.documents

List.identifier

Business identifier

Definition: Identifier for the List assigned for business purposes outside the context of FHIR.

Cardinality: 0..*

Type: Identifier

Mappings: w5=FiveWs.identifier; rim=.id; xds=SubmissionSet.uniqueId, SubmissionSet.entryUUID

List.status

current | retired | entered-in-error

Definition: Indicates the current state of this list.

Comments: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Cardinality: 1..1

Type: code

Binding: required:list-status

Summary: true

Is Modifier: true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)

Mappings: w5=FiveWs.status; rim=.status[current=active;retired=obsolete;entered-in-error=nullified]; xds=SubmissionSet status

Definition: How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Comments: This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Requirements: Lists are used in various ways, and it must be known in what way it is safe to use them.

Cardinality: 1..1

Type: code

Binding: required:list-mode

Summary: true

Is Modifier: true (Reason: If set to "changes", the list is considered incomplete, while the other two codes indicate the list is complete, which changes the understanding of the elements listed)

Mappings: w5=FiveWs.class; rim=.outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value

List.title

Descriptive name for the list

Definition: A label for the list assigned by the author.

Requirements: Allows customization beyond just the code identifying the kind of list.

Cardinality: 0..1

Type: string

Summary: true

Mappings: rim=.title; xds=SubmissionSet.title

List.code

What the purpose of this list is

Definition: This code defines the purpose of the list - why it was created.

Comments: If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.

Requirements: Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:list-example-codes

Summary: true

Mappings: w5=FiveWs.what[x]; rim=.code; xds=SubmissionSet.contentTypeCode

List.subject

If all resources have the same subject(s)

Definition: The common subject(s) (or patient(s)) of the resources that are in the list if there is one (or a set of subjects).

Comments: Some purely arbitrary lists do not have a common subject, so this is optional. Lists having multiple subjects may raise challenges for systems that base access control or other security considerations on linkages to 'subject'. E.g. if a List is associated with multiple Patient subjects, then it would be nominally part of multiple patient compartments, which might drive access rights.

Requirements: The primary purpose of listing the subject explicitly is to help with finding the right list.

Cardinality: 0..*

Type: Reference(Resource)

Summary: true

Mappings: w5=FiveWs.subject; rim=.participation[typeCode<SUB].role (and sometimes .player); xds=SubmissionSet.patientId

List.encounter

Context in which list created

Definition: The encounter that is the context in which this list was created.

Cardinality: 0..1

Type: Reference(Encounter)

Mappings: w5=FiveWs.context; rim=inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]

List.date

When the list was prepared

Definition: Date list was last reviewed/revised and determined to be 'current'.

Comments: The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.

Requirements: Identifies how current the list is which affects relevance.

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: w5=FiveWs.recorded; rim=.participation[typeCode<AUT].time[type=TS]; xds=SubmissionSet.submissionTime

List.source

Who and/or what defined the list contents (aka Author)

Definition: The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.

Comments: The primary source is the entity that made the decisions what items are in the list. This may be software or user.

Requirements: Allows follow-up as well as context.

Aliases: Author

Cardinality: 0..1

Type: Reference(Practitioner, PractitionerRole, Patient, Device, Organization, RelatedPerson, CareTeam, Group)

Summary: true

Mappings: w5=FiveWs.author; rim=.participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST] or .participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]; xds=SubmissionSet.author

List.orderedBy

What order the list has

Definition: What order applies to the items in the list.

Comments: Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Requirements: Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Cardinality: 0..1

Type: CodeableConcept

Binding: preferred:list-order

Mappings: rim=.outboundRelationship[typeCode=COMP].sequenceNumber > 1

List.note

Comments about the list

Definition: Comments that apply to the overall list.

Cardinality: 0..*

Type: Annotation

Mappings: rim=.inboundRelationship[typeCode=SUBJ].act.text

List.entry

Entries in the list

Definition: Entries in this list.

Comments: If there are no entries in the list, an emptyReason SHOULD be provided.

Conditions: lst-1

Cardinality: 0..*

Type: BackboneElement

Mappings: rim=.outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]; xds=SubmissionSet DocumentEntry(s)

List.entry.flag

Status/Workflow information about this item

Definition: The flag allows the system constructing the list to indicate the role and significance of the item in the list.

Comments: The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true

Requirements: This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:list-item-flag

Mappings: rim=.outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value

List.entry.deleted

If this item is actually marked as deleted

Definition: True if this item is marked as deleted in the list.

Comments: If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. A deleted entry should be displayed in narrative as deleted. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list.

Requirements: The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted".

Meaning if Missing: List items are generally only treated as deleted when this element explicitly carries a value of true. Systems SHOULD always populate this value when mode is 'changes'

Cardinality: 0..1

Type: boolean

Is Modifier: true (Reason: If deleted is true, then the item included in the list isn't actually part of the list anymore)

Mappings: rim=added: .updateMode=("A","AR") retained: .updateMode="NC" updated: .updateMode="R" deleted: .updateMode="D"

List.entry.date

When item added to list

Definition: When this item was added to the list.

Requirements: The date may be significant for understanding the meaning of items in a working list.

Cardinality: 0..1

Type: dateTime

Mappings: rim=.availabilityTime

List.entry.item

Actual entry

Definition: A reference to the actual resource from which data was derived.

Cardinality: 1..1

Type: Reference(Resource)

Mappings: rim=.target or .role or .role.entity

List.emptyReason

Why list is empty

Definition: If the list is empty, why the list is empty.

Comments: The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Requirements: Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Conditions: lst-1

Cardinality: 0..1

Type: CodeableConcept

Binding: preferred:list-empty-reason

Mappings: rim=.inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]