Release 4B Ballot #1

This page is part of the FHIR Specification (v4.1.0: Release 4B Ballot #1). 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 R2

Extension: parent

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

URL for this extension:

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

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

Identifies a parent of the relative.

Comment:

Some individuals may have more than two parents (e.g. genetic vs. adoptive parents). Even non-genetic relationships can be relevant in terms of genetic exposure.

Context of Use: Use on Element ID FamilyMemberHistory

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. parent0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent
parent: Identifies a parent of the relative.


Use on Element ID FamilyMemberHistory
... type1..1CodeableConceptDistinguishes between different types of parental 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 parent of this relation.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent
parent: Identifies a parent of the relative.


Use on Element ID FamilyMemberHistory
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:type 1..1Extensionmother | father | adoptive mother | etc.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Parent Relationship Codes (required): Parental relationship types.

... extension:reference 1..1ExtensionLink to parent relative(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"reference"
.... value[x] 1..1Reference(FamilyMemberHistory)Value of extension
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- parent -->doco

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

JSON Template

{ // parent
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // mother | father | adoptive mother | 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 parent 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-parent", // R! 
// value[x]: Value of extension. One of these 50:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. parent0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent
parent: Identifies a parent of the relative.


Use on Element ID FamilyMemberHistory
... type1..1CodeableConceptDistinguishes between different types of parental 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 parent of this relation.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent
parent: Identifies a parent of the relative.


Use on Element ID FamilyMemberHistory
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:type 1..1Extensionmother | father | adoptive mother | etc.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Parent Relationship Codes (required): Parental relationship types.

... extension:reference 1..1ExtensionLink to parent relative(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"reference"
.... value[x] 1..1Reference(FamilyMemberHistory)Value of extension
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- parent -->doco

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

JSON Template

{ // parent
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // mother | father | adoptive mother | 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 parent 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-parent", // R! 
// value[x]: Value of extension. One of these 50:
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters)
  • 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)