FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: sibling

Patient Care Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling

Status: draft. Extension maintained by: Health Level Seven International (Clinical Genomics)

Identifies a sibling of the relative.

Context of Use: Use on element: FamilyMemberHistory

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling
sibling: Identifies a sibling of the relative.
Use on element: FamilyMemberHistory
... type1..1CodeableConceptDistinguishes between different types of sibling relationships with varying granularity to support capturing the relationship "to the degree known".
... reference1..1Reference(FamilyMemberHistory)Points to the FamilyMemberHistory record of the relation who is the sibling of this relation.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling
sibling: Identifies a sibling of the relative.
Use on element: FamilyMemberHistory
... extension 1..1Extensionsibling | brother | sister | etc.
.... url 1..1uri"type"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Sibling Relationship Codes (required)
... extension 1..1ExtensionLink to sibling relative(s)
.... url 1..1uri"reference"
.... valueReference 0..1Reference(FamilyMemberHistory)Value of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- sibling -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="type"> 1..1 Extension  <!-- 1..1 sibling | brother | sister | etc. -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="reference"> 1..1 Extension  <!-- 1..1 Link to sibling relative(s) -->
  <valueReference><!-- 0..1 Reference(FamilyMemberHistory) 
      Value of extension --></valueReference>
 </extension>
</extension>

JSON Template

{ // sibling
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // sibling | brother | sister | etc. // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Link to sibling relative(s) // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "reference", // R! 
        "valueReference" : { Reference(FamilyMemberHistory) } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling
sibling: Identifies a sibling of the relative.
Use on element: FamilyMemberHistory
... type1..1CodeableConceptDistinguishes between different types of sibling relationships with varying granularity to support capturing the relationship "to the degree known".
... reference1..1Reference(FamilyMemberHistory)Points to the FamilyMemberHistory record of the relation who is the sibling of this relation.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling
sibling: Identifies a sibling of the relative.
Use on element: FamilyMemberHistory
... extension 1..1Extensionsibling | brother | sister | etc.
.... url 1..1uri"type"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Sibling Relationship Codes (required)
... extension 1..1ExtensionLink to sibling relative(s)
.... url 1..1uri"reference"
.... valueReference 0..1Reference(FamilyMemberHistory)Value of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- sibling -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="type"> 1..1 Extension  <!-- 1..1 sibling | brother | sister | etc. -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="reference"> 1..1 Extension  <!-- 1..1 Link to sibling relative(s) -->
  <valueReference><!-- 0..1 Reference(FamilyMemberHistory) 
      Value of extension --></valueReference>
 </extension>
</extension>

JSON Template

{ // sibling
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // sibling | brother | sister | etc. // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Link to sibling relative(s) // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "reference", // R! 
        "valueReference" : { Reference(FamilyMemberHistory) } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))