NCPI FHIR Implementation Guide v2
0.2.0 - ci-build

NCPI FHIR Implementation Guide v2 - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Linkage for related samples

Official URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-specimen-NcpiSpecimenCollection Version: 0.2.0
Draft as of 2025-12-03 Computable Name: NcpiSpecimenCollection

Linkage for related samples

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List A list is a curated collection of resources
Constraints: lst-1, lst-2, lst-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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.
... subject Σ 0..1 Reference(Patient | Group | Device | Location) Reference to any subjects or other samples related to a subject

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.status Base required ListStatus 📍4.0.1 FHIR Std.
List.mode Base required ListMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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(canonical) = '#').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()

This structure is derived from List

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List 0..* List A list is a curated collection of resources
... subject 0..1 Reference(Patient | Group | Device | Location) Reference to any subjects or other samples related to a subject

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List A list is a curated collection of resources
Constraints: lst-1, lst-2, lst-3
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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 Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code Σ 0..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.
... subject Σ 0..1 Reference(Patient | Group | Device | Location) Reference to any subjects or other samples related to a 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 Comments about the list
... entry C 0..* BackboneElement Entries 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.language Base preferred Common Languages 📍4.0.1 FHIR Std.
List.status Base required ListStatus 📍4.0.1 FHIR Std.
List.mode Base required ListMode 📍4.0.1 FHIR Std.
List.code Base example Example Use Codes for List 📍4.0.1 FHIR Std.
List.orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
List.entry.flag Base example Patient Medicine Change Types 📍4.0.1 FHIR Std.
List.emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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(canonical) = '#').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()

This structure is derived from List

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List A list is a curated collection of resources
Constraints: lst-1, lst-2, lst-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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.
... subject Σ 0..1 Reference(Patient | Group | Device | Location) Reference to any subjects or other samples related to a subject

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.status Base required ListStatus 📍4.0.1 FHIR Std.
List.mode Base required ListMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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(canonical) = '#').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()

Differential View

This structure is derived from List

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List 0..* List A list is a curated collection of resources
... subject 0..1 Reference(Patient | Group | Device | Location) Reference to any subjects or other samples related to a subject

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List A list is a curated collection of resources
Constraints: lst-1, lst-2, lst-3
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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 Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code Σ 0..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.
... subject Σ 0..1 Reference(Patient | Group | Device | Location) Reference to any subjects or other samples related to a 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 Comments about the list
... entry C 0..* BackboneElement Entries 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.language Base preferred Common Languages 📍4.0.1 FHIR Std.
List.status Base required ListStatus 📍4.0.1 FHIR Std.
List.mode Base required ListMode 📍4.0.1 FHIR Std.
List.code Base example Example Use Codes for List 📍4.0.1 FHIR Std.
List.orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
List.entry.flag Base example Patient Medicine Change Types 📍4.0.1 FHIR Std.
List.emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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(canonical) = '#').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()

This structure is derived from List

Summary

 

Other representations of profile: CSV, Excel, Schematron