Please note:

This version of the UK Core is a development copy.
This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
Please follow the guidance on the Contact Us page if you need any assistance.
A summary of changes is available on the STU3 Sequence Change Log

StructureDefinition-UKCore-List

Canonical_URL	Status	Current_Version	Last_Updated	Description
https://fhir.hl7.org.uk/StructureDefinition/UKCore-List	active	2.4.0	2023-12-12	This profile defines the UK constraints and extensions on the International FHIR resource List.

Profile_Purpose
This profile allows exchange of a flat, possibly ordered collection of records. The list profile can be used in many places, including allergies, medications, alerts, family history, medical history, etc. This list profile can be used to support individual-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc. The list profile supports lists that are homogeneous – consisting of only one type of resource (e.g. Allergy lists) as well as heterogeneous – containing a variety of resources (e.g. a problem list including Condition, AllergyIntolerance, Procedure, etc.).

Profile_Purpose

This profile allows exchange of a flat, possibly ordered collection of records.

The list profile can be used in many places, including allergies, medications, alerts, family history, medical history, etc. This list profile can be used to support individual-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc.

The list profile supports lists that are homogeneous – consisting of only one type of resource (e.g. Allergy lists) as well as heterogeneous – containing a variety of resources (e.g. a problem list including Condition, AllergyIntolerance, Procedure, etc.).

UKCoreList (List)	I		List	There are no (further) constraints on this element Element id List Short description A list is a curated collection of resources Alternate names Collection, WorkingList, Organizer Definition A list is a curated collection of resources. Data type List Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: 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-3: 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` lst-3: An entry date can only be used if the mode of the list is "working" `mode = 'working' or entry.date.empty()` lst-2: The deleted flag can only be used if the mode of the list is "changes" `mode = 'changes' or entry.deleted.empty()` lst-1: A list can only have an emptyReason if it is empty `emptyReason.empty() or entry.empty()` Mappings rim: Entity. Role, or Act rim: Act[classCode<ORG,moodCode=EVN]
id	Σ	0..1	string	There are no (further) constraints on this element Element id List.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id List.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id List.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id List.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id List.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id List.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id List.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
careSettingType	I	0..1	Extension(CodeableConcept)	Element id List.extension:careSettingType Short description An extension to support the type of care setting associated with a composition or a list. Alternate names extensions, user content Definition An extension to carry the Care setting type. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension(CodeableConcept) Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
listWarningCode	I	0..*	Extension(CodeableConcept)	Element id List.extension:listWarningCode Short description To support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit. Alternate names extensions, user content Definition To capture warnings that the list may be incomplete. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension(CodeableConcept) Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id List.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
identifier		0..*	Identifier	There are no (further) constraints on this element Element id List.identifier Short description Business identifier Definition Identifier for the List assigned for business purposes outside the context of FHIR. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier rim: .id
status	S Σ ?!	1..1	codeBinding	Element id List.status Short description Indicates the current state of this list. Definition Indicates the current state of this list. Comments This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Data type code Binding The current state of the list. ListStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.status rim: .status[current=active;retired=obsolete;entered-in-error=nullified]
mode	S Σ ?!	1..1	codeBinding	Element id List.mode Short description Indicates how this list was prepared: working \| snapshot \| changes Definition How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Requirements Lists are used in various ways, and it must be known in what way it is safe to use them. Comments This element is labeled as a modifier because a change list must not be misunderstood as a complete list. Data type code Binding The processing mode that applies to this list. ListMode (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.class rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
title	Σ	0..1	string	There are no (further) constraints on this element Element id List.title Short description Descriptive name for the list Definition A label for the list assigned by the author. Requirements Allows customization beyond just the code identifying the kind of list. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Dr. Jane's Patients Mappings rim: n/a rim: .title
code	S Σ	0..1	CodeableConceptBinding	Element id List.code Short description This code defines the purpose of the list - why it was created. Definition This code defines the purpose of the list - why it was created. Requirements Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. 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. Data type CodeableConcept Binding What the purpose of a list is. UKCoreListCode (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.what[x] rim: .code
subject	S Σ I	0..1	Reference(Patient \| Group \| Device \| Location)	Element id List.subject Short description The common subject (or patient) of the resources that are in the list if there is one. Definition The common subject (or patient) of the resources that are in the list if there is one. Requirements The primary purpose of listing the subject explicitly is to help with finding the right list. Comments Some purely arbitrary lists do not have a common subject, so this is optional. Data type Reference(Patient \| Group \| Device \| Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.subject[x] rim: .participation[typeCode<SUB].role (and sometimes .player) w5: FiveWs.subject
encounter	I	0..1	Reference(Encounter)	There are no (further) constraints on this element Element id List.encounter Short description Context in which list created Definition The encounter that is the context in which this list was created. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Encounter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.context rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
date	Σ	0..1	dateTime	There are no (further) constraints on this element Element id List.date Short description When the list was prepared Definition The date that the list was prepared. Requirements Identifies how current the list is which affects relevance. 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. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.recorded rim: .participation[typeCode<AUT].time[type=TS]
source	Σ I	0..1	Reference(Practitioner \| PractitionerRole \| Patient \| Device)	There are no (further) constraints on this element Element id List.source Short description Who and/or what defined the list contents (aka Author) Alternate names Author Definition The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. Requirements Allows follow-up as well as context. Comments The primary source is the entity that made the decisions what items are in the list. This may be software or user. Data type Reference(Practitioner \| PractitionerRole \| Patient \| Device) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.author rim: .participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST] or .participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]
orderedBy		0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id List.orderedBy Short description What order the list has Definition What order applies to the items in the list. Requirements Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. 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. Data type CodeableConcept Binding What order applies to the items in a list. ListOrderCodes (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
note		0..*	Annotation	There are no (further) constraints on this element Element id List.note Short description Comments about the list Definition Comments that apply to the overall list. Comments For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). Data type Annotation Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: N/A rim: Act rim: .inboundRelationship[typeCode=SUBJ].act.text
entry	I	0..*	BackboneElement	There are no (further) constraints on this element Element id List.entry Short description Entries in the list Definition Entries in this list. Comments If there are no entries in the list, an emptyReason SHOULD be provided. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
id		0..1	string	There are no (further) constraints on this element Element id List.entry.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id List.entry.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id List.entry.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
flag		0..1	CodeableConcept	There are no (further) constraints on this element Element id List.entry.flag Short description Status/Workflow information about this item Definition The flag allows the system constructing the list to indicate the role and significance of the item in the list. Requirements This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list. 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". Data type CodeableConcept Binding Codes that provide further information about the reason and meaning of the item in the list. PatientMedicineChangeTypes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
deleted	?! I	0..1	boolean	There are no (further) constraints on this element Element id List.entry.deleted Short description If this item is actually marked as deleted Definition True if this item is marked as deleted in the list. Requirements The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted". 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. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list. Meaning when missing 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' Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: added: .updateMode=("A","AR") retained: .updateMode="NC" updated: .updateMode="R" deleted: .updateMode="D"
date		0..1	dateTime	There are no (further) constraints on this element Element id List.entry.date Short description When item added to list Definition When this item was added to the list. Requirements The date may be significant for understanding the meaning of items in a working list. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .availabilityTime
item	I	1..1	Reference(Resource)	There are no (further) constraints on this element Element id List.entry.item Short description Actual entry Definition A reference to the actual resource from which data was derived. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim: .target or .role or .role.entity
emptyReason	I	0..1	CodeableConceptBinding	Element id List.emptyReason Short description Why list is empty Definition If the list is empty, why the list is empty. Requirements Allows capturing things like "none exist" or "not asked" which can be important for most lists. 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. Data type CodeableConcept Binding If a list is empty, why it is empty. UKCoreListEmptyReasonCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]

Detailed Descriptions

List
Definition	A list is a curated collection of resources.
Cardinality	0...*
Alias	Collection, WorkingList, Organizer
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: 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-3: 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` lst-3: An entry date can only be used if the mode of the list is "working" `mode = 'working' or entry.date.empty()` lst-2: The deleted flag can only be used if the mode of the list is "changes" `mode = 'changes' or entry.deleted.empty()` lst-1: A list can only have an emptyReason if it is empty `emptyReason.empty() or entry.empty()`
Mappings	rim: Entity. Role, or Act rim: Act[classCode<ORG,moodCode=EVN]
List.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
List.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: N/A
List.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
List.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
List.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: N/A rim: Act.text?
List.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: Entity. Role, or Act rim: N/A
List.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
List.extension:careSettingType
Definition	An extension to carry the Care setting type.
Cardinality	0...1
Type	Extension(CodeableConcept)
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
List.extension:listWarningCode
Definition	To capture warnings that the list may be incomplete.
Cardinality	0...*
Type	Extension(CodeableConcept)
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
List.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
List.identifier
Definition	Identifier for the List assigned for business purposes outside the context of FHIR.
Cardinality	0...*
Type	Identifier
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier rim: .id
List.status
Definition	Indicates the current state of this list.
Cardinality	1...1
Type	code
Binding	The current state of the list. ListStatus (required)
Must Support	True
Modifier	True
Summary	True
Comments	This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a w5: FiveWs.status rim: .status[current=active;retired=obsolete;entered-in-error=nullified]
List.mode
Definition	How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Cardinality	1...1
Type	code
Binding	The processing mode that applies to this list. ListMode (required)
Must Support	True
Modifier	True
Summary	True
Requirements	Lists are used in various ways, and it must be known in what way it is safe to use them.
Comments	This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a w5: FiveWs.class rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
List.title
Definition	A label for the list assigned by the author.
Cardinality	0...1
Type	string
Summary	True
Requirements	Allows customization beyond just the code identifying the kind of list.
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General Dr. Jane's Patients
Mappings	rim: n/a rim: .title
List.code
Definition	This code defines the purpose of the list - why it was created.
Cardinality	0...1
Type	CodeableConcept
Binding	What the purpose of a list is. UKCoreListCode (preferred)
Must Support	True
Summary	True
Requirements	Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.what[x] rim: .code
List.subject
Definition	The common subject (or patient) of the resources that are in the list if there is one.
Cardinality	0...1
Type	Reference(Patient \| Group \| Device \| Location)
Must Support	True
Summary	True
Requirements	The primary purpose of listing the subject explicitly is to help with finding the right list.
Comments	Some purely arbitrary lists do not have a common subject, so this is optional.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.subject[x] rim: .participation[typeCode<SUB].role (and sometimes .player) w5: FiveWs.subject
List.encounter
Definition	The encounter that is the context in which this list was created.
Cardinality	0...1
Type	Reference(Encounter)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.context rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
List.date
Definition	The date that the list was prepared.
Cardinality	0...1
Type	dateTime
Summary	True
Requirements	Identifies how current the list is which affects relevance.
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a w5: FiveWs.recorded rim: .participation[typeCode<AUT].time[type=TS]
List.source
Definition	The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
Cardinality	0...1
Type	Reference(Practitioner \| PractitionerRole \| Patient \| Device)
Summary	True
Alias	Author
Requirements	Allows follow-up as well as context.
Comments	The primary source is the entity that made the decisions what items are in the list. This may be software or user.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.author rim: .participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST] or .participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]
List.orderedBy
Definition	What order applies to the items in the list.
Cardinality	0...1
Type	CodeableConcept
Binding	What order applies to the items in a list. ListOrderCodes (preferred)
Requirements	Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
List.note
Definition	Comments that apply to the overall list.
Cardinality	0...*
Type	Annotation
Comments	For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: N/A rim: Act rim: .inboundRelationship[typeCode=SUBJ].act.text
List.entry
Definition	Entries in this list.
Cardinality	0...*
Type	BackboneElement
Comments	If there are no entries in the list, an emptyReason SHOULD be provided.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
List.entry.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
List.entry.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
List.entry.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
List.entry.flag
Definition	The flag allows the system constructing the list to indicate the role and significance of the item in the list.
Cardinality	0...1
Type	CodeableConcept
Binding	Codes that provide further information about the reason and meaning of the item in the list. PatientMedicineChangeTypes (example)
Requirements	This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.
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".
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
List.entry.deleted
Definition	True if this item is marked as deleted in the list.
Cardinality	0...1
Type	boolean
Modifier	True
Requirements	The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted".
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. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: added: .updateMode=("A","AR") retained: .updateMode="NC" updated: .updateMode="R" deleted: .updateMode="D"
List.entry.date
Definition	When this item was added to the list.
Cardinality	0...1
Type	dateTime
Requirements	The date may be significant for understanding the meaning of items in a working list.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: .availabilityTime
List.entry.item
Definition	A reference to the actual resource from which data was derived.
Cardinality	1...1
Type	Reference(Resource)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim: .target or .role or .role.entity
List.emptyReason
Definition	If the list is empty, why the list is empty.
Cardinality	0...1
Type	CodeableConcept
Binding	If a list is empty, why it is empty. UKCoreListEmptyReasonCode (extensible)
Requirements	Allows capturing things like "none exist" or "not asked" which can be important for most lists.
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]

Table View

List		..
List.extension	Extension	..1
List.extension	Extension	..
List.status		..
List.mode		..
List.code		..
List.subject		..
List.emptyReason		..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-List" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-List" />
    <version value="2.4.0" />
    <name value="UKCoreList" />
    <title value="UK Core List" />
    <status value="active" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [List](https://hl7.org/fhir/R4/List.html)." />
    <purpose value="This profile allows exchange of a flat, possibly ordered collection of records. \n\nThe list profile can be used in many places, including allergies, medications, alerts, family history, medical history, etc. This list profile can be used to support individual-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc. \n\nThe list profile supports lists that are homogeneous – consisting of only one type of resource (e.g. Allergy lists) as well as heterogeneous – containing a variety of resources (e.g. a problem list including Condition, AllergyIntolerance, Procedure, etc.)." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="List" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/List" />
    <derivation value="constraint" />
    <differential>
        <element id="List.extension:careSettingType">
            <path value="List.extension" />
            <sliceName value="careSettingType" />
            <short value="An extension to support the type of care setting associated with a composition or a list." />
            <definition value="An extension to carry the Care setting type." />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType" />
            </type>
        </element>
        <element id="List.extension:listWarningCode">
            <path value="List.extension" />
            <sliceName value="listWarningCode" />
            <short value="To support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit." />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode" />
            </type>
        </element>
        <element id="List.status">
            <path value="List.status" />
            <short value="Indicates the current state of this list." />
            <mustSupport value="true" />
        </element>
        <element id="List.mode">
            <path value="List.mode" />
            <short value="Indicates how this list was prepared: working | snapshot | changes" />
            <mustSupport value="true" />
        </element>
        <element id="List.code">
            <path value="List.code" />
            <short value="This code defines the purpose of the list - why it was created." />
            <mustSupport value="true" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ListCode" />
            </binding>
        </element>
        <element id="List.subject">
            <path value="List.subject" />
            <short value="The common subject (or patient) of the resources that are in the list if there is one." />
            <mustSupport value="true" />
        </element>
        <element id="List.emptyReason">
            <path value="List.emptyReason" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ListEmptyReasonCode" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-List",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-List",
    "version": "2.4.0",
    "name": "UKCoreList",
    "title": "UK Core List",
    "status": "active",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [List](https://hl7.org/fhir/R4/List.html).",
    "purpose": "This profile allows exchange of a flat, possibly ordered collection of records. \n\nThe list profile can be used in many places, including allergies, medications, alerts, family history, medical history, etc. This list profile can be used to support individual-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc. \n\nThe list profile supports lists that are homogeneous – consisting of only one type of resource (e.g. Allergy lists) as well as heterogeneous – containing a variety of resources (e.g. a problem list including Condition, AllergyIntolerance, Procedure, etc.).",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "List",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/List",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "List.extension:careSettingType",
                "path": "List.extension",
                "sliceName": "careSettingType",
                "short": "An extension to support the type of care setting associated with a composition or a list.",
                "definition": "An extension to carry the Care setting type.",
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType"
                        ]
                    }
                ]
            },
            {
                "id": "List.extension:listWarningCode",
                "path": "List.extension",
                "sliceName": "listWarningCode",
                "short": "To support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit.",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode"
                        ]
                    }
                ]
            },
            {
                "id": "List.status",
                "path": "List.status",
                "short": "Indicates the current state of this list.",
                "mustSupport": true
            },
            {
                "id": "List.mode",
                "path": "List.mode",
                "short": "Indicates how this list was prepared: working | snapshot | changes",
                "mustSupport": true
            },
            {
                "id": "List.code",
                "path": "List.code",
                "short": "This code defines the purpose of the list - why it was created.",
                "mustSupport": true,
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ListCode"
                }
            },
            {
                "id": "List.subject",
                "path": "List.subject",
                "short": "The common subject (or patient) of the resources that are in the list if there is one.",
                "mustSupport": true
            },
            {
                "id": "List.emptyReason",
                "path": "List.emptyReason",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ListEmptyReasonCode"
                }
            }
        ]
    }
}

Feedback

Click here to:

Report issue for UKCore-List, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Examples

Empty List - This example shows the use of an empty List to indicate that there is no content. This is not supposed to represent actual system behaviour.
Example UKCore-List-EmptyList

Bundled Allergy List - This example is an example FHIR Bundle that could be returned following a query for the allergies for a patient. Note: the use of List and Bundle is not mandated and is used to illustrate a possible use of the List Profile and is not expected system behaviour.
Example UKCore-Bundle-AllergyList

List Warning Code - An example to illustrate a warning being provided in a List resource.
Example UKCore-Extension-ListWarningCode

Example Usage Scenarios

The following are example usage scenarios for the UK Core List profile:

A list of allergies for a Patient
A list of current medication for a Patient
Record or update a list of information for Patient

Profile Specific Implementation Guidance:

Mandatory and Must Support Data Elements

The following elements are identified as MustSupport, and it is expected that consumers and suppliers SHALL support these as per the MustSupport Guidance.

Element	Reason
`List.status`	Indicates the current state of this list.
`List.mode`	Indicates how this list was prepared: working \| snapshot \| changes
`List.code`	This code defines the purpose of the list - why it was created.
`List.subject`	The common subject (or patient) of the resources that are in the list if there is one.

Extensions

More information about the extensions on the UKCore-List profile can be found using the links below.

Extension	Context	Link	Comment
careSettingType	List.extension	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType	An extension to support the type of care setting associated with a composition or a list.
listWarningCode	List.extension	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode	To support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit.

Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context	Strength	Link
List.code	preferred	https://fhir.hl7.org.uk/ValueSet/UKCore-ListCode
List.emptyReason	extensible	https://fhir.hl7.org.uk/ValueSet/UKCore-ListEmptyReasonCode

List.extension:careSettingType	preferred	ValueSet UKCore-CareSettingType
List.extension:listWarningCode	extensible	ValueSet UKCore-ListWarningCode

`subject`

Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:

`encounter`

Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Encounter.

`source`

Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:

`note`

The resource being referenced by List.note.authorReference SHOULD conform to one of the following:

`entry`

Where a UK Core profile exists the resource being referenced SHOULD conform to the profile.