Generated Narrative: StructureDefinition profile-List Name Flags Card. Type Description & Constraints List 0..* List Information summarized from a list of other resources #xD; subject #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: If all resources have the same subject(s) additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference #xD; encounter #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference #xD; source #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:source 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: source URL: http://hl7.org/fhir/StructureDefinition/alternate-reference #xD; entry #xD; item #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:item 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: item additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference #xD; Documentation for this format
Cross-version Profile for R5.List for use in FHIR STU3
This cross-version profile allows R5 List content to be represented via FHIR STU3 List resources.
Information summarized from a list of other resources
A set of information summarized from a list of other resources.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL NOT contain any narrative
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
The deleted flag can only be used if the mode of the list is "changes"
mode = 'changes' or entry.deleted.empty()
(f:mode/@value = 'changes') or not(exists(f:entry/f:deleted))
A list can only have an emptyReason if it is empty
not(exists(f:emptyReason) and exists(f:entry))
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource, and may 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.
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 in formation is added later.
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.
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.
Additional Content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. In order 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.
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.
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. Usually modifier elements provide negation or qualification. In order 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.
Identifier for the List assigned for business purposes outside the context of FHIR.
Indicates the current state of this list.
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
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.
This element is labeled as a modifier because a change list must not be mis-understood as a complete list.
Lists are used in various ways, and it must be known in what way it is safe to use them.
The processing mode that applies to this list
A label for the list assigned by the author.
Allows customization beyond just the code identifying the kind of list.
This code defines the purpose of the list - why it was created.
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.
Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.
The common subject (or patient) of the resources that are in the list, if there is one.
Some purely arbitrary lists do not have a common subject, so this is optional.
The primary purpose of listing the subject explicitly is to help with finding the right list.
.participation[typeCode<SUB].role (and sometimes .player)
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
R5: If all resources have the same subject(s) additional types
R5: `List.subject` additional types from child elements (display, identifier, reference, type)
Element `List.subject` is mapped to FHIR STU3 element `List.subject` as `SourceIsBroaderThanTarget`. The mappings for `List.subject` do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `List.subject` with unmapped reference targets: Resource. Some purely arbitrary lists do not have a common subject, so this is optional. Lists having multiple subjects may raise challenges for systems that base access control or other security considerations on linkages to 'subject'. E.g. if a List is associated with multiple Patient subjects, then it would be nominally part of multiple patient compartments, which might drive access rights.
Literal reference, Relative, internal or absolute URL
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Logical reference, when literal reference is not known
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
The encounter that is the context in which this list was created.
inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
R5: `List.encounter` additional types from child elements (display, identifier, reference, type)
Element `List.encounter` is mapped to FHIR STU3 element `List.encounter` as `SourceIsBroaderThanTarget`. The mappings for `List.encounter` do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `List.encounter` with unmapped reference targets: Encounter.
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.
Identifies how current the list is which affects relevance.
Who and/or what defined the list contents (aka Author)
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.
The primary source is the entity that made the decisions what items are in the list. This may be software or user.
.participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST] or .participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]
Element `List.source` is mapped to FHIR STU3 element `List.source` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `List.source` with unmapped reference targets: CareTeam, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson. The primary source is the entity that made the decisions what items are in the list. This may be software or user.
What order applies to the items in the list.
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.
Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
What order applies to the items in a list
.outboundRelationship[typeCode=COMP].sequenceNumber > 1
Comments that apply to the overall list.
If there are no entries in the list, an emptyReason SHOULD be provided.
All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
.outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Status/Workflow information about this item
The flag allows the system constructing the list to indicate the role and significance of the item in the list.
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".
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.
Codes that provide further information about the reason and meaning of the item in the list
If this item is actually marked as deleted
True if this item is marked as deleted in the list.
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.
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".
added: .updateMode=("A","AR") retained: .updateMode="NC" updated: .updateMode="R" deleted: .updateMode="D"
This is only useful and meaningful when the mode is "working".
The date may be significant for understanding the meaning of items in a working list.
A reference to the actual resource from which data was derived.
R5: `List.entry.item` additional types from child elements (display, identifier, reference, type)
Element `List.entry.item` is mapped to FHIR STU3 element `List.entry.item` as `SourceIsBroaderThanTarget`. The mappings for `List.entry.item` do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `List.entry.item` with unmapped reference targets: Resource.
If the list is empty, why the list is empty.
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.
Allows capturing things like "none exist" or "not asked" which can be important for most lists.