Current Build

Extension: Ancestry

Orders and Observations Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry

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

Ancestry information.

Context of Use: Use on Element ID Observation

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ancestry0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry
Ancestry: Ancestry information.


Use on Element ID Observation
... Name1..1CodeableConceptA definition that describes the geographical origin of a patient.

... Percentage0..1decimalThe ratio of this ancestry to all of the patient's ancestry.

... Source0..1CodeableConceptIn what way the ancestry is reported (e.g. Patient reported, Genetic test, Other, Unknown).


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry
Ancestry: Ancestry information.


Use on Element ID Observation
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:Name 1..1ExtensionAncestry name
.... extension 0..0
.... url 1..1url"Name"
.... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
... extension:Percentage 0..1ExtensionAncestry percentage
.... extension 0..0
.... url 1..1url"Percentage"
.... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueDecimal 0..1decimalValue of extension
... extension:Source 0..1ExtensionSource of ancestry report
.... extension 0..0
.... url 1..1url"Source"
.... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
... url 1..1url"http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical()
.... 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()
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- Ancestry -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="Name"> 1..1 Extension  <!-- 1..1 Ancestry name -->
  <-- valueCodeableConcept sliced by type:$this  in the specified orderClosed-->
  <valueCodeableConcept><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="Percentage"> 0..1 Extension  <!-- 0..1 Ancestry percentage -->
  <-- valueDecimal sliced by type:$this  in the specified orderClosed-->
  <valueDecimal value="[decimal]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="Source"> 0..1 Extension  <!-- 0..1 Source of ancestry report -->
  <-- valueCodeableConcept sliced by type:$this  in the specified orderClosed-->
  <valueCodeableConcept><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // Ancestry
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Ancestry name // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Name", // R! 
        "valueCodeableConcept" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Ancestry percentage //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Percentage", // R! 
        "valueDecimal" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueDecimal" : <decimal> //Value of extension
      },
      { // Source of ancestry report //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Source", // R! 
        "valueCodeableConcept" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry", // R! 
// value[x]: Value of extension. One of these 50:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ancestry0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry
Ancestry: Ancestry information.


Use on Element ID Observation
... Name1..1CodeableConceptA definition that describes the geographical origin of a patient.

... Percentage0..1decimalThe ratio of this ancestry to all of the patient's ancestry.

... Source0..1CodeableConceptIn what way the ancestry is reported (e.g. Patient reported, Genetic test, Other, Unknown).


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry
Ancestry: Ancestry information.


Use on Element ID Observation
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:Name 1..1ExtensionAncestry name
.... extension 0..0
.... url 1..1url"Name"
.... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
... extension:Percentage 0..1ExtensionAncestry percentage
.... extension 0..0
.... url 1..1url"Percentage"
.... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueDecimal 0..1decimalValue of extension
... extension:Source 0..1ExtensionSource of ancestry report
.... extension 0..0
.... url 1..1url"Source"
.... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
... url 1..1url"http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical()
.... 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()
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- Ancestry -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="Name"> 1..1 Extension  <!-- 1..1 Ancestry name -->
  <-- valueCodeableConcept sliced by type:$this  in the specified orderClosed-->
  <valueCodeableConcept><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="Percentage"> 0..1 Extension  <!-- 0..1 Ancestry percentage -->
  <-- valueDecimal sliced by type:$this  in the specified orderClosed-->
  <valueDecimal value="[decimal]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="Source"> 0..1 Extension  <!-- 0..1 Source of ancestry report -->
  <-- valueCodeableConcept sliced by type:$this  in the specified orderClosed-->
  <valueCodeableConcept><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // Ancestry
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Ancestry name // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Name", // R! 
        "valueCodeableConcept" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Ancestry percentage //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Percentage", // R! 
        "valueDecimal" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueDecimal" : <decimal> //Value of extension
      },
      { // Source of ancestry report //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Source", // R! 
        "valueCodeableConcept" : [ //  sliced by type:$this  in the specified order, Closed ]
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry", // R! 
// value[x]: Value of extension. One of these 50:
  }

 

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')]))