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
Official URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelStudyFamily | Version: 0.1.0 | |||
Draft as of 2024-11-25 | Computable Name: CdmStudyFamily |
The Shared Data Model for Study Family
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelStudyFamily | 0..* | Base | Shared Data Model for Study Family Instances of this logical model are not marked to be the target of a Reference | |
familyID | 1..1 | string | Unique study family identifier. System identifier used for internal references. | |
externalID | 0..* | string | Study family identifier. System identifier used for external references. | |
familyType | 0..1 | code | Describes the 'type' of study family, eg, trio. | |
description | 0..1 | string | Free text describing the study family, such as potential inheritance or details about consanguinity | |
consanguinity | 0..1 | code | Is there known or suspected consanguinity in this study family? | |
studyFamilyFocus | 0..1 | code | What is this study family investigating? EG, a specific condition | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelStudyFamily | 0..* | Base | Shared Data Model for Study Family Instances of this logical model are not marked to be the target of a Reference | |
familyID | 1..1 | string | Unique study family identifier. System identifier used for internal references. | |
externalID | 0..* | string | Study family identifier. System identifier used for external references. | |
familyType | 0..1 | code | Describes the 'type' of study family, eg, trio. | |
description | 0..1 | string | Free text describing the study family, such as potential inheritance or details about consanguinity | |
consanguinity | 0..1 | code | Is there known or suspected consanguinity in this study family? | |
studyFamilyFocus | 0..1 | code | What is this study family investigating? EG, a specific condition | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelStudyFamily | 0..* | Base | Shared Data Model for Study Family Instances of this logical model are not marked to be the target of a Reference | |
familyID | 1..1 | string | Unique study family identifier. System identifier used for internal references. | |
externalID | 0..* | string | Study family identifier. System identifier used for external references. | |
familyType | 0..1 | code | Describes the 'type' of study family, eg, trio. | |
description | 0..1 | string | Free text describing the study family, such as potential inheritance or details about consanguinity | |
consanguinity | 0..1 | code | Is there known or suspected consanguinity in this study family? | |
studyFamilyFocus | 0..1 | code | What is this study family investigating? EG, a specific condition | |
Documentation for this format |
This structure is derived from Base
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelStudyFamily | 0..* | Base | Shared Data Model for Study Family Instances of this logical model are not marked to be the target of a Reference | |
familyID | 1..1 | string | Unique study family identifier. System identifier used for internal references. | |
externalID | 0..* | string | Study family identifier. System identifier used for external references. | |
familyType | 0..1 | code | Describes the 'type' of study family, eg, trio. | |
description | 0..1 | string | Free text describing the study family, such as potential inheritance or details about consanguinity | |
consanguinity | 0..1 | code | Is there known or suspected consanguinity in this study family? | |
studyFamilyFocus | 0..1 | code | What is this study family investigating? EG, a specific condition | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelStudyFamily | 0..* | Base | Shared Data Model for Study Family Instances of this logical model are not marked to be the target of a Reference | |
familyID | 1..1 | string | Unique study family identifier. System identifier used for internal references. | |
externalID | 0..* | string | Study family identifier. System identifier used for external references. | |
familyType | 0..1 | code | Describes the 'type' of study family, eg, trio. | |
description | 0..1 | string | Free text describing the study family, such as potential inheritance or details about consanguinity | |
consanguinity | 0..1 | code | Is there known or suspected consanguinity in this study family? | |
studyFamilyFocus | 0..1 | code | What is this study family investigating? EG, a specific condition | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelStudyFamily | 0..* | Base | Shared Data Model for Study Family Instances of this logical model are not marked to be the target of a Reference | |
familyID | 1..1 | string | Unique study family identifier. System identifier used for internal references. | |
externalID | 0..* | string | Study family identifier. System identifier used for external references. | |
familyType | 0..1 | code | Describes the 'type' of study family, eg, trio. | |
description | 0..1 | string | Free text describing the study family, such as potential inheritance or details about consanguinity | |
consanguinity | 0..1 | code | Is there known or suspected consanguinity in this study family? | |
studyFamilyFocus | 0..1 | code | What is this study family investigating? EG, a specific condition | |
Documentation for this format |
This structure is derived from Base