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
Resource Profile: NCPI Research Collection
| Official URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-research-collection | Version: 0.1.0 | |||
| Draft as of 2024-03-21 | Computable Name: NcpiResearchCollection | |||
Collections of research data including, but not limited, to Consortia, Programs, adhoc collections of Studies and datasets among other types of collections.
Basic Definition
The collection element allows for high level organization of objects into various related groups. One common type of collection is a consortium, but other collections can also be established. Items in a collection can include studies, datasets, or other collections (for example, if consortium A becomes a member of consortium B, the collection that represents consortium A can be added as an item in the collection representing consortium B).
Primary Profile Restrictions and Enhancements
- title must be defined in order for users to understand the purpose of the collection.
- code must be defined and should be one of the codes from the CodeSystem, CollectionType, when possible.
- note should contain a meaningful description whenever possible.
- there must be one or more entries referencing the “contained” resources.
- When possible, a website should be provided. For Consortium, programs and other entities with formal websites, this should be the one that provides the best overview of the group. For adhoc collections, or those collections that are less formally defined, an online document may be sufficient.
Usage:
- Examples for this Resource Profile: List/ncpi-research-collection-cmg, List/ncpi-research-collection-kfx01 and List/ncpi-research-collection-pbta
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  List | 0..* | List | A list is a curated collection of resources | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 website | 0..1 | url | 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. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/research-web-Link | |
| label | 0..* | (Complex) | Alias such as acronym and alternate names. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/label-extension | |
 title | 1..1 | string | The collection's title. | |
| code | 1..1 | CodeableConcept | The type of collection being described. Binding: Collection Type (extensible) | |
| note | 0..* | Annotation | The description of the collection. | |
 entry | 1..* | BackboneElement | List of references to items included in the list. | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| List.code | extensible | CollectionTypeVS (a valid code from Collection Type)https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/collection-type-vsfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | C | 0..* | List | A list is a curated collection of resources lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| website | 0..1 | url | 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. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/research-web-Link | |
| label | 0..* | (Complex) | Alias such as acronym and alternate names. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/label-extension | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. |
| mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. |
| title | Σ | 1..1 | string | The collection's title. Example General: Dr. Jane's Patients |
 code | Σ | 1..1 | CodeableConcept | The type of collection being described. Binding: Collection Type (extensible) |
| note | 0..* | Annotation | The description of the collection. | |
 entry | C | 1..* | BackboneElement | List of references to items included in the list. |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted |
 item | 1..1 | Reference(Resource) | Actual entry | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|4.3.0from the FHIR Standard | |
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | |
| List.code | extensible | CollectionTypeVS (a valid code from Collection Type)https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/collection-type-vsfrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | List | 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 | error | List | 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 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | List | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List | C | 0..* | List | A list is a curated collection of resources lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| website | 0..1 | url | 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. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/research-web-Link | |||||
| label | 0..* | (Complex) | Alias such as acronym and alternate names. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/label-extension | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | Business identifier | |||||
| status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. | ||||
| mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
| title | Σ | 1..1 | string | The collection's title. Example General: Dr. Jane's Patients | ||||
| code | Σ | 1..1 | CodeableConcept | The type of collection being described. Binding: Collection Type (extensible) | ||||
| subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject | ||||
| encounter | 0..1 | Reference(Encounter) | Context in which list created | |||||
| date | Σ | 0..1 | dateTime | When the list was prepared | ||||
| source | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | ||||
| orderedBy | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
| note | 0..* | Annotation | The description of the collection. | |||||
 entry | C | 1..* | BackboneElement | List of references to items included in the list. | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| flag | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | |||||
| deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date | 0..1 | dateTime | When item added to list | |||||
| item | 1..1 | Reference(Resource) | Actual entry | |||||
| emptyReason | C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| List.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|4.3.0from the FHIR Standard | ||||
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| List.code | extensible | CollectionTypeVS (a valid code from Collection Type)https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/collection-type-vsfrom this IG | ||||
| List.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| List.entry.flag | example | PatientMedicineChangeTypeshttp://hl7.org/fhir/ValueSet/list-item-flagfrom the FHIR Standard | ||||
| List.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | List | 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 | error | List | 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 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | List | A resource should have narrative for robust management : text.`div`.exists() | |
| dom-r4b | warning | List.contained | 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) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() |
This structure is derived from List
Differential View
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | 0..* | List | A list is a curated collection of resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| website | 0..1 | url | 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. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/research-web-Link | |
| label | 0..* | (Complex) | Alias such as acronym and alternate names. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/label-extension | |
| title | 1..1 | string | The collection's title. | |
| code | 1..1 | CodeableConcept | The type of collection being described. Binding: Collection Type (extensible) | |
| note | 0..* | Annotation | The description of the collection. | |
| entry | 1..* | BackboneElement | List of references to items included in the list. | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| List.code | extensible | CollectionTypeVS (a valid code from Collection Type)https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/collection-type-vsfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | C | 0..* | List | A list is a curated collection of resources lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| website | 0..1 | url | 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. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/research-web-Link | |
| label | 0..* | (Complex) | Alias such as acronym and alternate names. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/label-extension | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. |
| mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. |
| title | Σ | 1..1 | string | The collection's title. Example General: Dr. Jane's Patients |
| code | Σ | 1..1 | CodeableConcept | The type of collection being described. Binding: Collection Type (extensible) |
| note | 0..* | Annotation | The description of the collection. | |
| entry | C | 1..* | BackboneElement | List of references to items included in the list. |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted |
| item | 1..1 | Reference(Resource) | Actual entry | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|4.3.0from the FHIR Standard | |
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | |
| List.code | extensible | CollectionTypeVS (a valid code from Collection Type)https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/collection-type-vsfrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | List | 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 | error | List | 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 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | List | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List | C | 0..* | List | A list is a curated collection of resources lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| website | 0..1 | url | 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. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/research-web-Link | |||||
| label | 0..* | (Complex) | Alias such as acronym and alternate names. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/label-extension | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | Business identifier | |||||
| status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. | ||||
| mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
| title | Σ | 1..1 | string | The collection's title. Example General: Dr. Jane's Patients | ||||
| code | Σ | 1..1 | CodeableConcept | The type of collection being described. Binding: Collection Type (extensible) | ||||
| subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject | ||||
| encounter | 0..1 | Reference(Encounter) | Context in which list created | |||||
| date | Σ | 0..1 | dateTime | When the list was prepared | ||||
| source | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | ||||
| orderedBy | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
| note | 0..* | Annotation | The description of the collection. | |||||
| entry | C | 1..* | BackboneElement | List of references to items included in the list. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| flag | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | |||||
| deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date | 0..1 | dateTime | When item added to list | |||||
| item | 1..1 | Reference(Resource) | Actual entry | |||||
| emptyReason | C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| List.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|4.3.0from the FHIR Standard | ||||
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| List.code | extensible | CollectionTypeVS (a valid code from Collection Type)https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/collection-type-vsfrom this IG | ||||
| List.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| List.entry.flag | example | PatientMedicineChangeTypeshttp://hl7.org/fhir/ValueSet/list-item-flagfrom the FHIR Standard | ||||
| List.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | List | 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 | error | List | 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 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | List | A resource should have narrative for robust management : text.`div`.exists() | |
| dom-r4b | warning | List.contained | 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) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() |
This structure is derived from List
Other representations of profile: CSV, Excel, Schematron