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
Extension: Family Type Extension
| Official URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-type | Version: 0.2.0 | |||
| Draft as of 2025-12-03 | Computable Name: FamilyType | |||
Extension containing Family Type
Context of Use
-
Element ID:
Group
This extension may be used on the following element(s)
Usage info
Usages:
- Use this Extension: NCPI Study Family
- Examples for this Extension: Group/cbtn-study-family and Group/gregor-study-family
You can also check for usages in the FHIR IG Statistics
Formal Views of Extension Content
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Family Type Extension | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-type" | |
  value[x] |
0..1 | CodeableConcept | Describes the 'type' of study family, eg, trio. Binding: Family Types Codes (extensible) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Family Type Extension | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-type" | |
| value[x] |
0..1 | CodeableConcept | Describes the 'type' of study family, eg, trio. Binding: Family Types Codes (extensible) | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Family Type Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-type" | |
| value[x] |
0..1 | CodeableConcept | Describes the 'type' of study family, eg, trio. Binding: Family Types Codes (extensible) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Family Type Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-type" | |
| value[x] |
0..1 | CodeableConcept | Describes the 'type' of study family, eg, trio. Binding: Family Types Codes (extensible) | |
| Documentation for this format | ||||
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x] | Base | extensible | Family Types Codes | 📦0.2.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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()
|