HL7 FHIR® UK Core R4 | UK Core List

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-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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() lst-1: A list can only have an emptyReason if it is empty `emptyReason.empty() or entry.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-3: An entry date can only be used if the mode of the list is "working" `mode = 'working' or entry.date.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())`
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())`
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())`
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: 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: N/A
extension	I	0..*	Extension	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) 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
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 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
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 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 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 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. 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: .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 w5: FiveWs.what[x] rim: .code
subject	S Σ	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())` Mappings w5: FiveWs.subject[x] rim: .participation[typeCode<SUB].role (and sometimes .player) w5: FiveWs.subject
encounter		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. Data type Reference(Encounter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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 w5: FiveWs.recorded rim: .participation[typeCode<AUT].time[type=TS]
source	Σ	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())` Mappings 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: .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. Data type Annotation Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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: .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 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
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
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: .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: 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: .availabilityTime
item		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. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]

Documentation:

https://simplifier.net/hl7fhirukcorer4/ukcore-list

Last updated on 2/16/2024, 2:45:42 PM

Confirmation

UK Core List

About

Information

Follow us

Links