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
Extension: Study Family Focus
| Official URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-role | Version: 0.1.0 | |||
| Draft as of 2024-11-25 | Computable Name: FamilyRole | |||
Extension containing Family Role
Context of Use
This extension may be used on the following element(s):
- Element ID Group.member.entity
Usage info
Usage:
- Use this Extension: NCPI Study Family
- Examples for this Extension: Group/cbtn-study-family and Group/gregor-study-family
Formal Views of Extension Content
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension |
0..* | Extension | Study Family Focus | |
  extension |
0..0 | |||
| url |
1..1 | uri | "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-role" | |
  value[x] |
0..1 | CodeableConcept | The role this individual has in the family, specifically with respect to a proband or index participant Binding: FamilyMember (extensible) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Study Family Focus | |
 id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-role" | |
| value[x] |
0..1 | CodeableConcept | The role this individual has in the family, specifically with respect to a proband or index participant Binding: FamilyMember (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 |
|---|---|---|---|---|
| Extension |
0..* | Extension | Study Family Focus | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-role" | |
| value[x] |
0..1 | CodeableConcept | The role this individual has in the family, specifically with respect to a proband or index participant Binding: FamilyMember (extensible) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Study Family Focus | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-role" | |
| value[x] |
0..1 | CodeableConcept | The role this individual has in the family, specifically with respect to a proband or index participant Binding: FamilyMember (extensible) | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Extension.value[x] | extensible | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |