FHIR Release 3 (STU) 5 Preview #3
This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 4.0.1 . For a full list of available versions, see the Directory of published versions

Extension: sibling

Patient Care Work Group   Maturity Level : 1 Informative Use 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.

Comment :

Some cases may have complex inner-pedigree-tree relationship. For instance, double cousin relationship need two extra link with In pedigree tree itself. This can't be revealed by relationship to subject.

Context of Use: Use on element: Element ID FamilyMemberHistory

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension sibling 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling
sibling: Identifies a sibling of the relative.


Use on element: Element ID FamilyMemberHistory
. . . type 1..1 CodeableConcept Distinguishes between different types of sibling relationships with varying granularity to support capturing the relationship "to the degree known".

. . . reference 1..1 Reference ( FamilyMemberHistory ) Points to the FamilyMemberHistory record of the relation who is the sibling of this relation.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling
sibling: Identifies a sibling of the relative.


Use on element: Element ID FamilyMemberHistory
. . . extension I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... extension:type I 1..1 Extension sibling | brother | sister | etc.
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
.... url 1..1 uri "type"
. . . . valueCodeableConcept value[x] I 0..1 1..1 CodeableConcept Value of extension
Binding: Sibling Relationship Codes ( required )
. . . extension extension:reference I 1..1 Extension Link to sibling relative(s)
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
... . url 1..1 uri "reference"
. . . valueReference . value[x] 0..1 I 1..1 Reference ( FamilyMemberHistory ) Value of extension
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
.... valueBoolean boolean
.... valueCanonical canonical (Any)
.... valueCode code
.... valueDate date
.... valueDateTime dateTime
.... valueDecimal decimal
.... valueId id
.... valueInstant instant
.... valueInteger integer
.... valueInteger64 integer64
.... valueMarkdown markdown
.... valueOid oid
.... 0)"> valuePositiveInt style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> href=datatypes.html#positiveInt> positiveInt style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
.... valueString string
.... valueTime time
.... = 0)"> valueUnsignedInt style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> href=datatypes.html#unsignedInt> unsignedInt style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
.... valueUri uri
.... valueUrl url
.... valueUuid uuid
.... valueAddress Address
.... valueAge Age
.... valueAnnotation Annotation
.... valueAttachment Attachment
.... valueCodeableConcept CodeableConcept
.... valueCoding Coding
.... valueContactPoint ContactPoint
.... valueCount Count
.... valueDistance Distance
.... valueDuration Duration
.... valueHumanName HumanName
.... valueIdentifier Identifier
.... valueMoney Money
.... valuePeriod Period
.... valueQuantity Quantity
.... valueRange Range
.... valueRatio Ratio
.... valueReference Reference (Any)
.... valueSampledData SampledData
.... valueSignature Signature
.... valueTiming Timing
.... valueContactDetail ContactDetail
.... valueContributor Contributor
.... valueDataRequirement DataRequirement
.... valueExpression Expression
.... valueParameterDefinition ParameterDefinition
.... valueRelatedArtifact RelatedArtifact
.... valueTriggerDefinition TriggerDefinition
.... valueUsageContext UsageContext
.... valueDosage Dosage
.... valueMeta Meta

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-->
 <
  <</valueCodeableConcept>

 <extension url="type"> ?? 1..1 Extension  <!-- ?? 1..1 sibling | brother | sister | etc. -->
  <valueCodeableConcept><!-- ?? 1..1 CodeableConcept Value of extension --></valueCodeableConcept>

 </extension>
 <
  <
      Value of extension</valueReference>

 <extension url="reference"> ?? 1..1 Extension  <!-- ?? 1..1 Link to sibling relative(s) -->
  <valueReference><!-- ?? 1..1 Reference(FamilyMemberHistory) Value of extension --></valueReference>

 </extension>
</extension>

JSON Template

{ // sibling
    "
      { //  

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // sibling | brother | sister | etc. // C? R! 

        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "type", // R! 
        "

        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension

      },
      { //  

      { // Link to sibling relative(s) // C? R! 

        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "reference", // R! 
        "

        "valueReference" : { Reference(FamilyMemberHistory) } // C? R! Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling", // R! 
// value[x]: Value of extension. One of these 51:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension sibling 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling
sibling: Identifies a sibling of the relative.


Use on element: Element ID FamilyMemberHistory
. . . type 1..1 CodeableConcept Distinguishes between different types of sibling relationships with varying granularity to support capturing the relationship "to the degree known".

. . . reference 1..1 Reference ( FamilyMemberHistory ) Points to the FamilyMemberHistory record of the relation who is the sibling of this relation.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling
sibling: Identifies a sibling of the relative.


Use on element: Element ID FamilyMemberHistory
. . . extension I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... extension:type I 1..1 Extension sibling | brother | sister | etc.
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
.... url 1..1 uri "type"
. . . . valueCodeableConcept value[x] I 0..1 1..1 CodeableConcept Value of extension
Binding: Sibling Relationship Codes ( required )
. . . extension extension:reference I 1..1 Extension Link to sibling relative(s)
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
... . url 1..1 uri "reference"
. . . valueReference . value[x] 0..1 I 1..1 Reference ( FamilyMemberHistory ) Value of extension
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
.... valueBoolean boolean
.... valueCanonical canonical (Any)
.... valueCode code
.... valueDate date
.... valueDateTime dateTime
.... valueDecimal decimal
.... valueId id
.... valueInstant instant
.... valueInteger integer
.... valueInteger64 integer64
.... valueMarkdown markdown
.... valueOid oid
.... 0)"> valuePositiveInt style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> href=datatypes.html#positiveInt> positiveInt style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
.... valueString string
.... valueTime time
.... = 0)"> valueUnsignedInt style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> href=datatypes.html#unsignedInt> unsignedInt style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
.... valueUri uri
.... valueUrl url
.... valueUuid uuid
.... valueAddress Address
.... valueAge Age
.... valueAnnotation Annotation
.... valueAttachment Attachment
.... valueCodeableConcept CodeableConcept
.... valueCoding Coding
.... valueContactPoint ContactPoint
.... valueCount Count
.... valueDistance Distance
.... valueDuration Duration
.... valueHumanName HumanName
.... valueIdentifier Identifier
.... valueMoney Money
.... valuePeriod Period
.... valueQuantity Quantity
.... valueRange Range
.... valueRatio Ratio
.... valueReference Reference (Any)
.... valueSampledData SampledData
.... valueSignature Signature
.... valueTiming Timing
.... valueContactDetail ContactDetail
.... valueContributor Contributor
.... valueDataRequirement DataRequirement
.... valueExpression Expression
.... valueParameterDefinition ParameterDefinition
.... valueRelatedArtifact RelatedArtifact
.... valueTriggerDefinition TriggerDefinition
.... valueUsageContext UsageContext
.... valueDosage Dosage
.... valueMeta Meta

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-->
 <
  <</valueCodeableConcept>

 <extension url="type"> ?? 1..1 Extension  <!-- ?? 1..1 sibling | brother | sister | etc. -->
  <valueCodeableConcept><!-- ?? 1..1 CodeableConcept Value of extension --></valueCodeableConcept>

 </extension>
 <
  <
      Value of extension</valueReference>

 <extension url="reference"> ?? 1..1 Extension  <!-- ?? 1..1 Link to sibling relative(s) -->
  <valueReference><!-- ?? 1..1 Reference(FamilyMemberHistory) Value of extension --></valueReference>

 </extension>
</extension>

JSON Template

{ // sibling
    "
      { //  

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // sibling | brother | sister | etc. // C? R! 

        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "type", // R! 
        "

        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension

      },
      { //  

      { // Link to sibling relative(s) // C? R! 

        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "reference", // R! 
        "

        "valueReference" : { Reference(FamilyMemberHistory) } // C? R! Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling", // R! 
// value[x]: Value of extension. One of these 51:
  }

 

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