> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List

> A list is a curated collection of resources.

## Properties

| Name                | Required | Type                                                                                                                                                                                                                                    | Description                                            |
| ------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| identifier          | No       | [Identifier](/medical-api/fhir/data-types/identifier)\[]                                                                                                                                                                                | Business identifier                                    |
| status              | Yes      | code                                                                                                                                                                                                                                    | current / retired / entered-in-error                   |
| mode                | Yes      | code                                                                                                                                                                                                                                    | working / snapshot / changes                           |
| title               | No       | string                                                                                                                                                                                                                                  | Descriptive name for the list                          |
| code                | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)                                                                                                                                                                         | What the purpose of this list is                       |
| subject             | No       | Reference\<[Patient](/medical-api/fhir/resources/patient) / [Group](/medical-api/fhir/resources/group) / [Device](/medical-api/fhir/resources/device) / [Location](/medical-api/fhir/resources/location)>                               | If all resources have the same subject                 |
| encounter           | No       | Reference\<[Encounter](/medical-api/fhir/resources/encounter)>                                                                                                                                                                          | Context in which list created                          |
| date                | No       | dateTime                                                                                                                                                                                                                                | When the list was prepared                             |
| source              | No       | Reference\<[Practitioner](/medical-api/fhir/resources/practitioner) / [PractitionerRole](/medical-api/fhir/resources/practitionerrole) / [Patient](/medical-api/fhir/resources/patient) / [Device](/medical-api/fhir/resources/device)> | Who and/or what defined the list contents (aka Author) |
| orderedBy           | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)                                                                                                                                                                         | What order the list has                                |
| note                | No       | [Annotation](/medical-api/fhir/data-types/annotation)\[]                                                                                                                                                                                | Comments about the list                                |
| entry               | No       | ListEntry                                                                                                                                                                                                                               | Entries in the list                                    |
| - id                | No       | string                                                                                                                                                                                                                                  | Unique id for inter-element referencing                |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                                                                  | Additional content defined by implementations          |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                                                                  | Extensions that cannot be ignored even if unrecognized |
| - flag              | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)                                                                                                                                                                         | Status/Workflow information about this item            |
| - deleted           | No       | boolean                                                                                                                                                                                                                                 | If this item is actually marked as deleted             |
| - date              | No       | dateTime                                                                                                                                                                                                                                | When item added to list                                |
| - item              | Yes      | Reference\<Resource>                                                                                                                                                                                                                    | Actual entry                                           |
| emptyReason         | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)                                                                                                                                                                         | Why list is empty                                      |

## Search Parameters

| Name         | Type      | Description                                            | Expression       |
| ------------ | --------- | ------------------------------------------------------ | ---------------- |
| code         | token     | What the purpose of this list is                       | List.code        |
| date         | date      | When the list was prepared                             | List.date        |
| identifier   | token     | Business identifier                                    | List.identifier  |
| patient      | reference | If all resources have the same subject                 | List.subject     |
| encounter    | reference | Context in which list created                          | List.encounter   |
| empty-reason | token     | Why list is empty                                      | List.emptyReason |
| item         | reference | Actual entry                                           | List.entry.item  |
| notes        | string    | The annotation - text content (as markdown)            | List.note.text   |
| 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       |

## Inherited Properties

| Name              | Required | Type                                                   | Description                                            |
| ----------------- | -------- | ------------------------------------------------------ | ------------------------------------------------------ |
| id                | No       | string                                                 | Logical id of this artifact                            |
| meta              | No       | [Meta](/medical-api/fhir/data-types/meta)              | Metadata about the resource                            |
| implicitRules     | No       | uri                                                    | A set of rules under which this content was created    |
| language          | No       | code                                                   | Language of the resource content                       |
| text              | No       | [Narrative](/medical-api/fhir/data-types/narrative)    | Text summary of the resource, for human interpretation |
| contained         | No       | Resource\[]                                            | Contained, inline Resources                            |
| extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations          |
| modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored                      |

To view the FHIR specification for this resource, see [List](https://www.hl7.org/fhir/StructureDefinition/List).