description: A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.
package_name: hl7.fhir.r6.core
derivation: specialization
name: List
type: List
elements:
  date: {isModifier: false, short: When the list was prepared, type: dateTime, mustSupport: false, isSummary: true, index: 7}
  encounter:
    isModifier: false
    short: Context in which list created
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 6
  orderedBy:
    isModifier: false
    short: What order the list has
    type: CodeableConcept
    mustSupport: false
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/list-order'}
    isSummary: false
    index: 9
  mode:
    isModifier: true
    short: working | snapshot | changes
    index: 2
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/list-mode|6.0.0-ballot4'}
    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
  source:
    isModifier: false
    short: Who and/or what defined the list contents (aka Author)
    refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 8
  title: {isModifier: false, short: Descriptive name for the list, type: string, mustSupport: false, isSummary: true, index: 3}
  note: {isModifier: false, short: Comments about the list, type: Annotation, mustSupport: false, array: true, isSummary: false, index: 10}
  emptyReason:
    isModifier: false
    short: Why list is empty
    type: CodeableConcept
    mustSupport: false
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/list-empty-reason'}
    isSummary: false
    index: 16
  status:
    isModifier: true
    short: current | retired | entered-in-error
    index: 1
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/list-status|6.0.0-ballot4'}
    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
  code:
    isModifier: false
    short: What the purpose of this list is
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/list-example-codes'}
    isSummary: true
    index: 4
  identifier: {isModifier: false, short: Business identifier, type: Identifier, mustSupport: false, array: true, isSummary: false, index: 0}
  entry:
    isModifier: false
    short: Entries in the list
    index: 11
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      flag:
        isModifier: false
        short: Status/Workflow information about this item
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/list-item-flag'}
        isSummary: false
        index: 12
      deleted: {isModifier: true, short: If this item is actually marked as deleted, type: boolean, mustSupport: false, 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', isSummary: false, index: 13}
      date: {isModifier: false, short: When item added to list, type: dateTime, mustSupport: false, isSummary: false, index: 14}
      item:
        isModifier: false
        short: Actual entry
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 15
    orderMeaning: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy.
    required: [item]
    isSummary: false
  subject:
    isModifier: false
    short: If all resources have the same subject(s)
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 5
package_version: 6.0.0-ballot4
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/List
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 6.0.0-ballot4
required: [mode, status]