Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build
Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2019-07-29 |
Definitions for the IHE.MHD.List resource profile.
Guidance on how to interpret the contents of this table can be found here
0. List | |
2. List.identifier | |
Comments | When the List.identifier carries the entryUUID then the List.identifier.use shall be ‘official’; and the uniqueId then the List.identifier.use shall be ‘usual’. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..? |
4. List.mode | |
Comments | shall be ‘working’ |
Fixed Value | working |
6. List.title | |
Control | 1..? |
8. List.code | |
Comments | code.coding is [0..*] so may contain many. |
Control | 1..? |
10. List.subject | |
Comments | URL Points to an existing Patient resource representing Affinity Domain Patient. |
Control | 1..? |
Type | Reference(Patient) |
12. List.encounter | |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. |
Control | 0..0 |
14. List.source | |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. |
Control | 0..0 |
16. List.orderedBy | |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. |
Control | 0..0 |
18. List.entry | |
20. List.entry.flag | |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. |
Control | 0..0 |
22. List.entry.deleted | |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. |
Control | 0..0 |
24. List.entry.date | |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. |
Control | 0..0 |
26. List.emptyReason | |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here
0. List | |
Definition | A set of information summarized from a list of other resources. |
Short | Information summarized from a list of other resources |
Control | 0..* |
Alternate Names | Collection, WorkingList, Organizer |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.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 ( contained.where(('#'+id in %resource.descendants().reference).not()).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() )dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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 (contained.where(('#'+id in %resource.descendants().reference).not()).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()) |
2. 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. |
Short | A set of rules under which this content was created |
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. 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. |
Control | 0..1 |
Type | uri |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
4. 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. 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. |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Alternate Names | extensions, user content |
6. List.identifier | |
Definition | Identifier for the List assigned for business purposes outside the context of FHIR. |
Short | Business identifier |
Comments | When the List.identifier carries the entryUUID then the List.identifier.use shall be ‘official’; and the uniqueId then the List.identifier.use shall be ‘usual’. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..* |
Type | Identifier |
8. List.status | |
Definition | Indicates the current state of this list. |
Short | current | retired | entered-in-error |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from ListStatushttp://hl7.org/fhir/ValueSet/list-status (required to http://hl7.org/fhir/ValueSet/list-status )The current state of the list |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
10. 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. |
Short | working | snapshot | changes |
Comments | shall be ‘working’ This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
Control | 1..1 |
Binding | The codes SHALL be taken from ListModehttp://hl7.org/fhir/ValueSet/list-mode (required to http://hl7.org/fhir/ValueSet/list-mode )The processing mode that applies to this list |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Lists are used in various ways, and it must be known in what way it is safe to use them. |
Fixed Value | working |
12. List.title | |
Definition | A label for the list assigned by the author. |
Short | Descriptive name for the list |
Control | 10..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows customization beyond just the code identifying the kind of list. |
Example | <br/><b>General</b>:Dr. Jane's Patients |
14. List.code | |
Definition | This code defines the purpose of the list - why it was created. |
Short | What the purpose of this list is |
Comments | code.coding is [0..*] so may contain many. 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. |
Control | 10..1 |
Binding | For example codes, see Example Use Codes for Listhttp://hl7.org/fhir/ValueSet/list-example-codes (example to http://hl7.org/fhir/ValueSet/list-example-codes )What the purpose of a list is |
Type | CodeableConcept |
Summary | true |
Requirements | Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. |
16. List.subject | |
Definition | The common subject (or patient) of the resources that are in the list, if there is one. |
Short | If all resources have the same subject |
Comments | URL Points to an existing Patient resource representing Affinity Domain Patient. Some purely arbitrary lists do not have a common subject, so this is optional. |
Control | 10..1 |
Type | Reference(Patient, Group, Device, Location) |
Summary | true |
Requirements | The primary purpose of listing the subject explicitly is to help with finding the right list. |
18. List.encounter | |
Definition | The encounter that is the context in which this list was created. |
Short | Context in which list created |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. |
Control | 0..01 |
Type | Reference(Encounter) |
20. 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. |
Short | Who and/or what defined the list contents (aka Author) |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. The primary source is the entity that made the decisions what items are in the list. This may be software or user. |
Control | 0..01 |
Type | Reference(Practitioner, Patient, Device) |
Summary | true |
Requirements | Allows follow-up as well as context. |
Alternate Names | Author |
22. List.orderedBy | |
Definition | What order applies to the items in the list. |
Short | What order the list has |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. 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. |
Control | 0..01 |
Binding | The codes SHOULD be taken from List Order Codeshttp://hl7.org/fhir/ValueSet/list-order (preferred to http://hl7.org/fhir/ValueSet/list-order )What order applies to the items in a list |
Type | CodeableConcept |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
24. List.emptyReason | |
Definition | If the list is empty, why the list is empty. |
Short | Why list is empty |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. 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. |
Control | 0..01 This element is affected by the following invariants: lst-1 |
Binding | The codes SHOULD be taken from List Empty Reasonshttp://hl7.org/fhir/ValueSet/list-empty-reason (preferred to http://hl7.org/fhir/ValueSet/list-empty-reason )If a list is empty, why it is empty |
Type | CodeableConcept |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Guidance on how to interpret the contents of this table can be found here
0. List | |||||
Definition | A set of information summarized from a list of other resources. | ||||
Short | Information summarized from a list of other resources | ||||
Control | 0..* | ||||
Alternate Names | Collection, WorkingList, Organizer | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.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 ( contained.where(('#'+id in %resource.descendants().reference).not()).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() ) | ||||
2. List.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
4. List.meta | |||||
Definition | 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. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
6. 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. | ||||
Short | A set of rules under which this content was created | ||||
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. 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
8. List.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
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). | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
10. List.text | |||||
Definition | 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. | ||||
Short | Text summary of the resource, for human interpretation | ||||
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 in formation is added later. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
12. 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. | ||||
Short | Contained, inline 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. List.extension | |||||
Definition | 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
16. 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. 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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Alternate Names | extensions, user content | ||||
18. List.identifier | |||||
Definition | Identifier for the List assigned for business purposes outside the context of FHIR. | ||||
Short | Business identifier | ||||
Comments | When the List.identifier carries the entryUUID then the List.identifier.use shall be ‘official’; and the uniqueId then the List.identifier.use shall be ‘usual’. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 1..* | ||||
Type | Identifier | ||||
20. List.status | |||||
Definition | Indicates the current state of this list. | ||||
Short | current | retired | entered-in-error | ||||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ListStatus (required to http://hl7.org/fhir/ValueSet/list-status )The current state of the list | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
22. 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. | ||||
Short | working | snapshot | changes | ||||
Comments | shall be ‘working’ | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ListMode (required to http://hl7.org/fhir/ValueSet/list-mode )The processing mode that applies to this list | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Lists are used in various ways, and it must be known in what way it is safe to use them. | ||||
Fixed Value | working | ||||
24. List.title | |||||
Definition | A label for the list assigned by the author. | ||||
Short | Descriptive name for the list | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows customization beyond just the code identifying the kind of list. | ||||
Example | <br/><b>General</b>:Dr. Jane's Patients | ||||
26. List.code | |||||
Definition | This code defines the purpose of the list - why it was created. | ||||
Short | What the purpose of this list is | ||||
Comments | code.coding is [0..*] so may contain many. | ||||
Control | 1..1 | ||||
Binding | For example codes, see Example Use Codes for List (example to http://hl7.org/fhir/ValueSet/list-example-codes )What the purpose of a list is | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. | ||||
28. List.subject | |||||
Definition | The common subject (or patient) of the resources that are in the list, if there is one. | ||||
Short | If all resources have the same subject | ||||
Comments | URL Points to an existing Patient resource representing Affinity Domain Patient. | ||||
Control | 1..1 | ||||
Type | Reference(Patient) | ||||
Summary | true | ||||
Requirements | The primary purpose of listing the subject explicitly is to help with finding the right list. | ||||
30. List.encounter | |||||
Definition | The encounter that is the context in which this list was created. | ||||
Short | Context in which list created | ||||
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. | ||||
Control | 0..0 | ||||
Type | Reference(Encounter) | ||||
32. List.date | |||||
Definition | The date that the list was prepared. | ||||
Short | When the list was prepared | ||||
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. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Identifies how current the list is which affects relevance. | ||||
34. 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. | ||||
Short | Who and/or what defined the list contents (aka Author) | ||||
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. | ||||
Control | 0..0 | ||||
Type | Reference(Practitioner, Patient, Device) | ||||
Summary | true | ||||
Requirements | Allows follow-up as well as context. | ||||
Alternate Names | Author | ||||
36. List.orderedBy | |||||
Definition | What order applies to the items in the list. | ||||
Short | What order the list has | ||||
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. | ||||
Control | 0..0 | ||||
Binding | The codes SHOULD be taken from List Order Codes (preferred to http://hl7.org/fhir/ValueSet/list-order )What order applies to the items in a list | ||||
Type | CodeableConcept | ||||
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. | ||||
38. List.note | |||||
Definition | Comments that apply to the overall list. | ||||
Short | Comments about the list | ||||
Control | 0..* | ||||
Type | Annotation | ||||
40. List.entry | |||||
Definition | Entries in this list. | ||||
Short | Entries in the list | ||||
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. | ||||
Control | 0..* This element is affected by the following invariants: lst-1 | ||||
Type | BackboneElement | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) | ||||
42. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
44. List.entry.extension | |||||
Definition | 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
46. 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 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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
48. List.entry.flag | |||||
Definition | The flag allows the system constructing the list to indicate the role and significance of the item in the list. | ||||
Short | Status/Workflow information about this item | ||||
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. | ||||
Control | 0..0 | ||||
Binding | For example codes, see Patient Medicine Change Types (example to http://hl7.org/fhir/ValueSet/list-item-flag )Codes that provide further information about the reason and meaning of the item in the list | ||||
Type | CodeableConcept | ||||
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. | ||||
50. List.entry.deleted | |||||
Definition | True if this item is marked as deleted in the list. | ||||
Short | If this item is actually marked as deleted | ||||
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. | ||||
Control | 0..0 This element is affected by the following invariants: lst-2 | ||||
Type | boolean | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
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". | ||||
Default Value | false | ||||
52. List.entry.date | |||||
Definition | When this item was added to the list. | ||||
Short | When item added to list | ||||
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. | ||||
Control | 0..0 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Requirements | The date may be significant for understanding the meaning of items in a working list. | ||||
54. List.entry.item | |||||
Definition | A reference to the actual resource from which data was derived. | ||||
Short | Actual entry | ||||
Control | 1..1 | ||||
Type | Reference(Resource) | ||||
56. List.emptyReason | |||||
Definition | If the list is empty, why the list is empty. | ||||
Short | Why list is empty | ||||
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. | ||||
Control | 0..0 This element is affected by the following invariants: lst-1 | ||||
Binding | The codes SHOULD be taken from List Empty Reasons (preferred to http://hl7.org/fhir/ValueSet/list-empty-reason )If a list is empty, why it is empty | ||||
Type | CodeableConcept | ||||
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |