FHIR for FAIR - FHIR Implementation Guide
1.0.0 - STU 1

FHIR for FAIR - FHIR Implementation Guide, published by Health Level Seven International - SOA Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-for-fair/ and changes regularly. See the Directory of published versions

## Resource Profile: List [Subject Level Medatata]

Official URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/List-uv-f4f | Version: 1.0.0
Active as of 2024-01-05 | Computable Name: ListF4F

This profile defines how to use the List resource to convey subject level metadata information for a FAIR collection of data by using HL7 FHIR

Usage:

- Examples for this Resource Profile: List/example-f4f-list

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from List

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
List |  | 0..* | List | A list is a curated collection of resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
copyright |  | 0..1 | markdown | Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable |  | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment |  | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther |  | 0..* | Reference(Resource) | Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier |  | 0..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
Slices for identifier |  | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:url |  | 0..* | Identifier | GUPRI (uri)
system |  | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986
value |  | 0..1 | string | uri
subject |  | 0..1 | Reference(Patient | Group | Device | Location) | Subject of the listed resources
date |  | 0..1 | dateTime | When the list was prepared.
source |  | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author).
entry |  |  |  |
item |  | 1..1 | Reference(Resource) | A reference to the listed resource.
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
List | C | 0..* | List | A list is a curated collection of resources
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
copyright |  | 0..1 | markdown | Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable |  | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment |  | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther |  | 0..* | Reference(Resource) | Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier |  | 0..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier |  | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:url |  | 0..* | Identifier | GUPRI (uri)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986
value | Σ | 0..1 | string | uri Example General: 123456
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list.
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | Subject of the listed resources
date | Σ | 0..1 | dateTime | When the list was prepared.
source | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author).
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
List.identifier:url.use | required | IdentifierUse
List.status | required | ListStatus
List.mode | required | ListMode

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | List | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | List | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | List | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |
lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() |
lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
List | C | 0..* | List | A list is a curated collection of resources
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
copyright |  | 0..1 | markdown | Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable |  | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment |  | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther |  | 0..* | Reference(Resource) | Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier |  | 0..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier |  | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:url |  | 0..* | Identifier | GUPRI (uri)
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible)
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986
value | Σ | 0..1 | string | uri Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list.
title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients
code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is.
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | Subject of the listed resources
encounter |  | 0..1 | Reference(Encounter) | Context in which list created
date | Σ | 0..1 | dateTime | When the list was prepared.
source | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author).
orderedBy |  | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list.
note |  | 0..* | Annotation | Comments about the list
entry | C | 0..* | BackboneElement | Entries in the list
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | A reference to the listed resource.
emptyReason | C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
List.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
List.identifier:url.use | required | IdentifierUse
List.identifier:url.type | extensible | Identifier Type Codes
List.status | required | ListStatus
List.mode | required | ListMode
List.code | example | ExampleUseCodesForList
List.orderedBy | preferred | ListOrderCodes
List.entry.flag | example | PatientMedicineChangeTypes
List.emptyReason | preferred | ListEmptyReasons

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | List | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | List | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | List | A resource should have narrative for robust management : text.`div`.exists() |
dom-r4b | warning | List.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |
lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() |
lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() |

This structure is derived from List

Summary

Mandatory: 0 element (1 nested mandatory element)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
- http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
- http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
- http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
- http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier

Slices

This structure defines the following Slices:

- The element List.identifier is sliced based on the value of value:system

Differential View

This structure is derived from List

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
List |  | 0..* | List | A list is a curated collection of resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
copyright |  | 0..1 | markdown | Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable |  | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment |  | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther |  | 0..* | Reference(Resource) | Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier |  | 0..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
Slices for identifier |  | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:url |  | 0..* | Identifier | GUPRI (uri)
system |  | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986
value |  | 0..1 | string | uri
subject |  | 0..1 | Reference(Patient | Group | Device | Location) | Subject of the listed resources
date |  | 0..1 | dateTime | When the list was prepared.
source |  | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author).
entry |  |  |  |
item |  | 1..1 | Reference(Resource) | A reference to the listed resource.
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
List | C | 0..* | List | A list is a curated collection of resources
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
copyright |  | 0..1 | markdown | Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable |  | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment |  | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther |  | 0..* | Reference(Resource) | Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier |  | 0..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier |  | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:url |  | 0..* | Identifier | GUPRI (uri)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986
value | Σ | 0..1 | string | uri Example General: 123456
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list.
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | Subject of the listed resources
date | Σ | 0..1 | dateTime | When the list was prepared.
source | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author).
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
List.identifier:url.use | required | IdentifierUse
List.status | required | ListStatus
List.mode | required | ListMode

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | List | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | List | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | List | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |
lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() |
lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
List | C | 0..* | List | A list is a curated collection of resources
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
copyright |  | 0..1 | markdown | Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable |  | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment |  | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther |  | 0..* | Reference(Resource) | Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier |  | 0..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier |  | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:url |  | 0..* | Identifier | GUPRI (uri)
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible)
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986
value | Σ | 0..1 | string | uri Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list.
title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients
code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is.
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | Subject of the listed resources
encounter |  | 0..1 | Reference(Encounter) | Context in which list created
date | Σ | 0..1 | dateTime | When the list was prepared.
source | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author).
orderedBy |  | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list.
note |  | 0..* | Annotation | Comments about the list
entry | C | 0..* | BackboneElement | Entries in the list
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | A reference to the listed resource.
emptyReason | C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
List.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
List.identifier:url.use | required | IdentifierUse
List.identifier:url.type | extensible | Identifier Type Codes
List.status | required | ListStatus
List.mode | required | ListMode
List.code | example | ExampleUseCodesForList
List.orderedBy | preferred | ListOrderCodes
List.entry.flag | example | PatientMedicineChangeTypes
List.emptyReason | preferred | ListEmptyReasons

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | List | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | List | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | List | A resource should have narrative for robust management : text.`div`.exists() |
dom-r4b | warning | List.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |
lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() |
lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() |

This structure is derived from List

Summary

Mandatory: 0 element (1 nested mandatory element)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
- http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
- http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
- http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
- http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier

Slices

This structure defines the following Slices:

- The element List.identifier is sliced based on the value of value:system

Other representations of profile: CSV, Excel, Schematron