R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: (v3.5.0: R4 Ballot 2). #2). 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

Extension: Ancestry

Orders and Observations Work Group   Maturity Level : 1 Informative Use 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

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension Ancestry 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry
Ancestry: Ancestry information.


Use on Element ID Observation
. . . Name 1..1 CodeableConcept A definition that describes the geographical origin of a patient.

. . . Percentage 0..1 decimal The ratio of this ancestry to all of the patient's ancestry.

. . . Source 0..1 CodeableConcept In what way the ancestry is reported (e.g. Patient reported, Genetic test, Other, Unknown).


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry
Ancestry: Ancestry information.


Use on Element ID Observation
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension Ancestry name
. . . . extension 0..0
. . . . url 1..1 uri "Name"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
. . . extension 0..1 Extension Ancestry percentage
. . . . extension 0..0
. . . . url 1..1 uri "Percentage"
. . . . valueDecimal 0..1 decimal Value of extension
. . . extension 0..1 Extension Source of ancestry report
. . . . extension 0..0
. . . . url 1..1 uri "Source"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry"
. . . value[x] 0 .. 0

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><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="Percentage"> 0..1 Extension  <!-- 0..1 Ancestry percentage -->
  <valueDecimal value="[decimal]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="Source"> 0..1 Extension  <!-- 0..1 Source of ancestry report -->
  <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" : { CodeableConcept } //Value of extension
      },
      { // Ancestry percentage //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Percentage", // R! 
        "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" : { CodeableConcept } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry", // R! 


// value[x]: Value of extension. One of these 49:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension Ancestry 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry
Ancestry: Ancestry information.


Use on Element ID Observation
. . . Name 1..1 CodeableConcept A definition that describes the geographical origin of a patient.

. . . Percentage 0..1 decimal The ratio of this ancestry to all of the patient's ancestry.

. . . Source 0..1 CodeableConcept In what way the ancestry is reported (e.g. Patient reported, Genetic test, Other, Unknown).


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry
Ancestry: Ancestry information.


Use on Element ID Observation
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension Ancestry name
. . . . extension 0..0
. . . . url 1..1 uri "Name"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
. . . extension 0..1 Extension Ancestry percentage
. . . . extension 0..0
. . . . url 1..1 uri "Percentage"
. . . . valueDecimal 0..1 decimal Value of extension
. . . extension 0..1 Extension Source of ancestry report
. . . . extension 0..0
. . . . url 1..1 uri "Source"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry"
. . . value[x] 0 .. 0

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><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="Percentage"> 0..1 Extension  <!-- 0..1 Ancestry percentage -->
  <valueDecimal value="[decimal]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="Source"> 0..1 Extension  <!-- 0..1 Source of ancestry report -->
  <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" : { CodeableConcept } //Value of extension
      },
      { // Ancestry percentage //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Percentage", // R! 
        "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" : { CodeableConcept } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry", // R! 


// value[x]: Value of extension. One of these 49:
  }

 

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