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

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 2025-03-24 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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
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
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension: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
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
ext-1: Must have either extensions or value[x], not both
.... extension:label 0..* (Complex) Alias such as acronym and alternate names.
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/label-extension
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


ele-1: All FHIR elements must have a @value or children
... title Σ 1..1 string The collection's title.
ele-1: All FHIR elements must have a @value or children
Example General: Dr. Jane's Patients
... code Σ 1..1 CodeableConcept The type of collection being described.
Binding: Collection Type (extensible)
ele-1: All FHIR elements must have a @value or children
... note 0..* Annotation The description of the collection.
ele-1: All FHIR elements must have a @value or children
... entry C 1..* BackboneElement List of references to items included in the list.
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... deleted ?!C 0..1 boolean If this item is actually marked as deleted
ele-1: All FHIR elements must have a @value or children
.... item 1..1 Reference(Resource) Actual entry
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
List.statusrequiredListStatus
http://hl7.org/fhir/ValueSet/list-status|4.3.0
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.3.0
from the FHIR Standard
List.codeextensibleCollectionTypeVS (a valid code from Collection Type)
https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/collection-type-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()

 

Other representations of profile: CSV, Excel, Schematron