List
Defines the ID Core constraints and extensions on the List resource for the minimal set of data to query and retrieve a list of information.
Usage
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 Conditions, AllergyIntolerances, recent Procedures, etc.).
URL
Type | URL |
---|---|
Canonical | https://fhir.kemkes.go.id/r4/StructureDefinition/List |
Structure
Snapshot
List | I | DomainResource | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | 0..* | Identifier | |
status | Σ ?! | 1..1 | codeBinding |
mode | Σ ?! | 1..1 | codeBinding |
title | Σ | 0..1 | string |
code | Σ | 0..1 | CodeableConcept |
subject | Σ I | 0..1 | Reference(Patient | https://fhir.kemkes.go.id/r4/StructureDefinition/Group | https://fhir.kemkes.go.id/r4/StructureDefinition/Device | Location) |
encounter | I | 0..1 | Reference(Encounter) |
date | Σ | 0..1 | dateTime |
source | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | https://fhir.kemkes.go.id/r4/StructureDefinition/Device) |
orderedBy | 0..1 | CodeableConceptBinding | |
note | 0..* | Annotation | |
entry | I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
flag | 0..1 | CodeableConcept | |
deleted | ?! I | 0..1 | boolean |
date | 0..1 | dateTime | |
item | I | 1..1 | Reference(Resource) |
emptyReason | I | 0..1 | CodeableConceptBinding |
Examples
Dictionary
List | |
Definition | A list is a curated collection of resources. |
Cardinality | 0...* |
Alias | Collection, WorkingList, Organizer |
Invariants |
|
Mappings |
|
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 |
|
Mappings |
|
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 |
|
Mappings |
|
List.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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 |
|
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 |
|
Mappings |
|
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 |
|
Mappings |
|
List.identifier | |
Definition | Identifier for the List assigned for business purposes outside the context of FHIR. |
Cardinality | 0...* |
Type | Identifier |
Invariants |
|
Mappings |
|
List.status | |
Definition | Indicates the current state of this list. |
Cardinality | 1...1 |
Type | code |
Binding | The current state of the list. |
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 |
|
Mappings |
|
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. |
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 |
|
Mappings |
|
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 |
|
Examples | General Dr. Jane's Patients |
Mappings |
|
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. |
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 |
|
Mappings |
|
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 | https://fhir.kemkes.go.id/r4/StructureDefinition/Group | https://fhir.kemkes.go.id/r4/StructureDefinition/Device | Location) |
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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 | https://fhir.kemkes.go.id/r4/StructureDefinition/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 |
|
Mappings |
|
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. |
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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 |
|
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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. |
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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. |
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 |
|
Mappings |
|