NCPI FHIR Implementation Guide v2
0.1.0 - ci-build
NCPI FHIR Implementation Guide v2 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2024-11-25 |
Definitions for the ncpi-research-collection resource profile.
Guidance on how to interpret the contents of this table can be found here
0. List | |
2. List.extension | |
Slicing | This element introduces a set of slices on List.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. List.extension:website | |
Slice Name | website |
Short | URL describing the research collection, this can include a formal website, such as the Consortium or Program's website, or to an online document describing the collection. |
Control | 0..1 |
Type | Extension(Research Web Link) (Extension Type: url) |
6. List.extension:label | |
Slice Name | label |
Short | Alias such as acronym and alternate names. |
Control | 0..* |
Type | Extension(Label) (Complex Extension) |
8. List.title | |
Short | The collection's title. |
Control | 1..? |
10. List.code | |
Short | The type of collection being described. |
Control | 1..? |
Binding | Unless not suitable, these codes SHALL be taken from Collection Type (extensible to https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/collection-type-vs ) |
12. List.note | |
Short | The description of the collection. |
14. List.entry | |
Short | List of references to items included in the list. |
Control | 1..? |
Guidance on how to interpret the contents of this table can be found here
0. List | |
Definition | A list is a curated collection of resources. |
Short | A list is a curated collection of resources |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
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-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.exists() and ('#'+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(uri) = '#').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()) |
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
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. 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. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. List.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional 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 |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on List.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. List.extension:website | |
Slice Name | website |
Definition | A URL pointing to a either a research study's website, an online document or other research related site or document. |
Short | URL describing the research collection, this can include a formal website, such as the Consortium or Program's website, or to an online document describing the collection. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Research Web Link) (Extension Type: url) |
Is Modifier | false |
Must Support | false |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )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()) |
8. List.extension:label | |
Slice Name | label |
Definition | A text label accompanied by a code indicating the label type (such as Acronym, subtitle, etc) |
Short | Alias such as acronym and alternate names. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Label) (Complex Extension) |
Is Modifier | false |
Must Support | false |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
10. 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). |
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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | false |
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. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
12. 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|4.3.0 (required to http://hl7.org/fhir/ValueSet/list-status|4.3.0 )The current state of the list. |
Type | code |
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. 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 | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. |
Control | 1..1 |
Binding | The codes SHALL be taken from ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0 (required to http://hl7.org/fhir/ValueSet/list-mode|4.3.0 )The processing mode that applies to this list. |
Type | code |
Is Modifier | true because If set to "changes", the list is considered incomplete, while the other two codes indicate the list is complete, which changes the understanding of the elements listed |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Lists are used in various ways, and it must be known in what way it is safe to use them. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. List.title | |
Definition | A label for the list assigned by the author. |
Short | The collection's title.Descriptive name for the list |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Allows customization beyond just the code identifying the kind of list. |
Example | <br/><b>General</b>:Dr. Jane's Patients |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. List.code | |
Definition | This code defines the purpose of the list - why it was created. |
Short | The type of collection being described.What the purpose of this list is |
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. |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see Collection Typehttp://hl7.org/fhir/ValueSet/list-example-codes (extensible to https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/collection-type-vs ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. List.note | |
Definition | Comments that apply to the overall list. |
Short | The description of the collection.Comments about the list |
Control | 0..* |
Type | Annotation |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. List.entry | |
Definition | Entries in this list. |
Short | List of references to items included in the list.Entries in the list |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Control | 10..* This element is affected by the following invariants: lst-1 |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters) |
24. 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
26. 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 | 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. |
Control | 0..1 This element is affected by the following invariants: lst-2 |
Type | boolean |
Is Modifier | true because If deleted is true, then the item included in the list isn't actually part of the list anymore |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
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". |
Meaning if 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' |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. List.entry.item | |
Definition | A reference to the actual resource from which data was derived. |
Short | Actual entry |
Control | 1..1 |
Type | Reference(Resource) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. List | |||||
Definition | A list is a curated collection of resources. | ||||
Short | A list is a curated collection of resources | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
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-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.exists() and ('#'+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(uri) = '#').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() ) | ||||
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 | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | true | ||||
4. 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. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
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. 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
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 | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )IETF language tag
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
10. 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. | ||||
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 information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
Invariants | dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) ) | ||||
14. List.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on List.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
16. List.extension:website | |||||
Slice Name | website | ||||
Definition | A URL pointing to a either a research study's website, an online document or other research related site or document. | ||||
Short | URL describing the research collection, this can include a formal website, such as the Consortium or Program's website, or to an online document describing the collection. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Research Web Link) (Extension Type: url) | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
18. List.extension:label | |||||
Slice Name | label | ||||
Definition | A text label accompanied by a code indicating the label type (such as Acronym, subtitle, etc) | ||||
Short | Alias such as acronym and alternate names. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Label) (Complex Extension) | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
20. 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). | ||||
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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Must Support | false | ||||
Summary | false | ||||
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. | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
22. List.identifier | |||||
Definition | Identifier for the List assigned for business purposes outside the context of FHIR. | ||||
Short | Business identifier | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. 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|4.3.0 )The current state of the list. | ||||
Type | code | ||||
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
26. 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 | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ListMode (required to http://hl7.org/fhir/ValueSet/list-mode|4.3.0 )The processing mode that applies to this list. | ||||
Type | code | ||||
Is Modifier | true because If set to "changes", the list is considered incomplete, while the other two codes indicate the list is complete, which changes the understanding of the elements listed | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | false | ||||
Summary | true | ||||
Requirements | Lists are used in various ways, and it must be known in what way it is safe to use them. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. List.title | |||||
Definition | A label for the list assigned by the author. | ||||
Short | The collection's title. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | false | ||||
Summary | true | ||||
Requirements | Allows customization beyond just the code identifying the kind of list. | ||||
Example | <br/><b>General</b>:Dr. Jane's Patients | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
30. List.code | |||||
Definition | This code defines the purpose of the list - why it was created. | ||||
Short | The type of collection being described. | ||||
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. | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Collection Type (extensible to https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/collection-type-vs ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | true | ||||
Requirements | Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. 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 | Some purely arbitrary lists do not have a common subject, so this is optional. | ||||
Control | 0..1 | ||||
Type | Reference(Patient, Group, Device, Location) | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | true | ||||
Requirements | The primary purpose of listing the subject explicitly is to help with finding the right list. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
34. List.encounter | |||||
Definition | The encounter that is the context in which this list was created. | ||||
Short | Context in which list created | ||||
Control | 0..1 | ||||
Type | Reference(Encounter) | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
36. 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 | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | false | ||||
Summary | true | ||||
Requirements | Identifies how current the list is which affects relevance. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
38. 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 | The primary source is the entity that made the decisions what items are in the list. This may be software or user. | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner, PractitionerRole, Patient, Device) | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | true | ||||
Requirements | Allows follow-up as well as context. | ||||
Alternate Names | Author | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
40. List.orderedBy | |||||
Definition | What order applies to the items in the list. | ||||
Short | What order the list has | ||||
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. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to http://hl7.org/fhir/ValueSet/list-order )What order applies to the items in a list. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. List.note | |||||
Definition | Comments that apply to the overall list. | ||||
Short | The description of the collection. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. List.entry | |||||
Definition | Entries in this list. | ||||
Short | List of references to items included in the list. | ||||
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. | ||||
Control | 1..* This element is affected by the following invariants: lst-1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters ) | ||||
46. 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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
48. 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. | ||||
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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
50. 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). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
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. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
52. 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 | 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". | ||||
Control | 0..1 | ||||
Binding | For example codes, see PatientMedicineChangeTypes (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 | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. 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 | 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. | ||||
Control | 0..1 This element is affected by the following invariants: lst-2 | ||||
Type | boolean | ||||
Is Modifier | true because If deleted is true, then the item included in the list isn't actually part of the list anymore | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | false | ||||
Summary | false | ||||
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". | ||||
Meaning if 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' | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. List.entry.date | |||||
Definition | When this item was added to the list. | ||||
Short | When item added to list | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | false | ||||
Summary | false | ||||
Requirements | The date may be significant for understanding the meaning of items in a working list. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. List.entry.item | |||||
Definition | A reference to the actual resource from which data was derived. | ||||
Short | Actual entry | ||||
Control | 1..1 | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
60. List.emptyReason | |||||
Definition | If the list is empty, why the list is empty. | ||||
Short | Why list is empty | ||||
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. | ||||
Control | 0..1 This element is affected by the following invariants: lst-1 | ||||
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to http://hl7.org/fhir/ValueSet/list-empty-reason )If a list is empty, why it is empty. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |