description: A list is a curated collection of resources.
package_name: hl7.fhir.r4.examples
derivation: specialization
name: List
type: List
elements:
  date: {short: When the list was prepared, type: dateTime, isSummary: true, index: 7}
  encounter:
    short: Context in which list created
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    index: 6
  orderedBy:
    short: What order the list has
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/list-order'}
    index: 9
  mode:
    isModifier: true
    short: working | snapshot | changes
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/list-mode|4.0.1'}
    isModifierReason: 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
    isSummary: true
    index: 2
  source:
    short: Who and/or what defined the list contents (aka Author)
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole']
    type: Reference
    isSummary: true
    index: 8
  title: {short: Descriptive name for the list, type: string, isSummary: true, index: 3}
  note: {type: Annotation, short: Comments about the list, array: true, index: 10}
  emptyReason:
    short: Why list is empty
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/list-empty-reason'}
    index: 16
  status:
    isModifier: true
    short: current | retired | entered-in-error
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/list-status|4.0.1'}
    isModifierReason: 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
    isSummary: true
    index: 1
  code:
    short: What the purpose of this list is
    type: CodeableConcept
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/list-example-codes'}
    isSummary: true
    index: 4
  identifier: {type: Identifier, short: Business identifier, array: true, index: 0}
  entry:
    short: Entries in the list
    type: BackboneElement
    array: true
    index: 11
    elements:
      flag:
        short: Status/Workflow information about this item
        type: CodeableConcept
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/list-item-flag'}
        index: 12
      deleted: {isModifier: true, short: If this item is actually marked as deleted, type: boolean, meaningWhenMissing: 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', isModifierReason: 'If deleted is true, then the item included in the list isn''t actually part of the list anymore', index: 13}
      date: {short: When item added to list, type: dateTime, index: 14}
      item:
        short: Actual entry
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        index: 15
    required: [item]
  subject:
    short: If all resources have the same subject
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Location', 'http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    isSummary: true
    index: 5
package_version: 4.0.1
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/List
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.0.1
required: [mode, status]