description: Base StructureDefinition for List Resource
package_name: hl7.fhir.r2b.examples
derivation: specialization
name: List
type: null
elements:
  date:
    isModifier: false
    short: When the list was prepared
    index: 7
    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.
    type: dateTime
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: List.date}
    isSummary: true
  encounter:
    isModifier: false
    short: Context in which list created
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: List.encounter}
    isSummary: false
    index: 6
  orderedBy:
    isModifier: false
    short: What order the list has
    index: 9
    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.
    type: CodeableConcept
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: List.orderedBy}
    isSummary: false
  mode:
    isModifier: true
    short: working | snapshot | changes
    index: 2
    type: code
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: List.mode}
    isSummary: true
  source:
    isModifier: false
    short: Who and/or what defined the list contents (aka Author)
    index: 8
    comments: The primary source is the entity that made the decisions what items are in the list. This may be software or user.
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: List.source}
    isSummary: true
  title:
    isModifier: false
    short: Descriptive name for the list
    index: 3
    type: string
    mustSupport: false
    maxLength: 0
    exampleString: Dr. Jane's Patients
    base: {max: '1', min: 0, path: List.title}
    isSummary: true
  note:
    isModifier: false
    short: Comments about the list
    index: 10
    type: Annotation
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: List.note}
    isSummary: false
  emptyReason:
    isModifier: false
    short: Why list is empty
    index: 16
    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.
    type: CodeableConcept
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: List.emptyReason}
    isSummary: false
  status:
    isModifier: true
    short: current | retired | entered-in-error
    index: 1
    type: code
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: List.status}
    isSummary: true
  code:
    isModifier: false
    short: What the purpose of this list is
    index: 4
    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.
    type: CodeableConcept
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: List.code}
    isSummary: true
  identifier:
    isModifier: false
    short: Business identifier
    index: 0
    type: Identifier
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: List.identifier}
    isSummary: false
  entry:
    isModifier: false
    short: Entries in the list
    index: 11
    comments: If there are no entries in the list, an emptyReason SHOULD be provided.
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      flag:
        isModifier: false
        short: Status/Workflow information about this item
        index: 12
        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. Deleted can only be used if the List.mode is "changes".
        type: CodeableConcept
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: List.entry.flag}
        isSummary: false
      deleted:
        isModifier: true
        short: If this item is actually marked as deleted
        index: 13
        comments: If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is "changes". A deleted entry should be displayed in narrative as deleted.
        type: boolean
        defaultValueBoolean: false
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: List.entry.deleted}
        isSummary: false
      date:
        isModifier: false
        short: When item added to list
        index: 14
        comments: This is only useful and meaningful when the mode is "working".
        type: dateTime
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: List.entry.date}
        isSummary: false
      item:
        isModifier: false
        short: Actual entry
        index: 15
        type: Reference
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: List.entry.item}
        isSummary: false
    maxLength: 0
    base: {max: '*', min: 0, path: List.entry}
    required: [item]
    isSummary: false
  subject:
    isModifier: false
    short: If all resources have the same subject
    index: 5
    comments: Some purely arbitrary lists do not have a common subject, so this is optional.
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: List.subject}
    isSummary: true
package_version: 1.4.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/List
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [mode, status]