Release 4B

This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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

Summary

Name	Flags	Card.	Type
.. Ancestry	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry Ancestry: Ancestry information. Use on Element ID Observation
... Name	1..1	CodeableConcept	The material on this page will be removed in a future release. This content is deprecated and SHOULD NOT be used. Implementers are instead directed to the (Genomics Reporting Implementation Guide) for guidance. 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
.. extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry Ancestry: Ancestry information. Use on Element ID Observation
... Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
... extension:Name	1..1	Extension	Ancestry name
.... id	0..1	id	Unique id for inter-element referencing
.... extension	0..0
.... url	1..1	uri	"Name"
.... value[x]	1..1	CodeableConcept	Value of extension
... extension:Percentage	0..1	Extension	Ancestry percentage
.... id	0..1	id	Unique id for inter-element referencing
.... extension	0..0
.... url	1..1	uri	"Percentage"
.... value[x]	1..1	decimal	Value of extension
... extension:Source	0..1	Extension	Source of ancestry report
.... id	0..1	id	Unique id for inter-element referencing
.... extension	0..0
.... url	1..1	uri	"Source"
.... value[x]	1..1	CodeableConcept	Value of extension
... url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry"
... value[x]	0..0
.... valueBase64Binary	base64Binary
.... valueBoolean	boolean
.... valueCanonical	canonical(Any)
.... valueCode	code
.... valueDate	date
.... valueDateTime	dateTime
.... valueDecimal	decimal
.... valueId	id
.... valueInstant	instant
.... valueInteger	integer
.... valueMarkdown	markdown
.... valueOid	oid
.... valuePositiveInt	positiveInt
.... valueString	string
.... valueTime	time
.... valueUnsignedInt	unsignedInt
.... valueUri	uri
.... valueUrl	url
.... valueUuid	uuid
.... valueAddress	Address
.... valueAge	Age
.... valueAnnotation	Annotation
.... valueAttachment	Attachment
.... valueCodeableConcept	CodeableConcept
.... valueCodeableReference	CodeableReference
.... valueCoding	Coding
.... valueContactPoint	ContactPoint
.... valueCount	Count
.... valueDistance	Distance
.... valueDuration	Duration
.... valueHumanName	HumanName
.... valueIdentifier	Identifier
.... valueMoney	Money
.... valuePeriod	Period
.... valueQuantity	Quantity
.... valueRange	Range
.... valueRatio	Ratio
.... valueRatioRange	RatioRange
.... 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
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><!-- ?? 1..1 CodeableConcept  
 Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="Percentage"> ?? 0..1 Extension  <!-- ?? 0..1 Ancestry percentage -->
 <valueDecimal value="[decimal ]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="Source"> ?? 0..1 Extension  <!-- ?? 0..1 Source of ancestry report -->
 <valueCodeableConcept><!-- ?? 1..1 CodeableConcept  
 Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

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

Summary

Name	Flags	Card.	Type
.. Ancestry	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry Ancestry: Ancestry information. Use on Element ID Observation
... Name	1..1	CodeableConcept	The material on this page will be removed in a future release. This content is deprecated and SHOULD NOT be used. Implementers are instead directed to the (Genomics Reporting Implementation Guide) for guidance. 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
.. extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry Ancestry: Ancestry information. Use on Element ID Observation
... Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
... extension:Name	1..1	Extension	Ancestry name
.... id	0..1	id	Unique id for inter-element referencing
.... extension	0..0
.... url	1..1	uri	"Name"
.... value[x]	1..1	CodeableConcept	Value of extension
... extension:Percentage	0..1	Extension	Ancestry percentage
.... id	0..1	id	Unique id for inter-element referencing
.... extension	0..0
.... url	1..1	uri	"Percentage"
.... value[x]	1..1	decimal	Value of extension
... extension:Source	0..1	Extension	Source of ancestry report
.... id	0..1	id	Unique id for inter-element referencing
.... extension	0..0
.... url	1..1	uri	"Source"
.... value[x]	1..1	CodeableConcept	Value of extension
... url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry"
... value[x]	0..0
.... valueBase64Binary	base64Binary
.... valueBoolean	boolean
.... valueCanonical	canonical(Any)
.... valueCode	code
.... valueDate	date
.... valueDateTime	dateTime
.... valueDecimal	decimal
.... valueId	id
.... valueInstant	instant
.... valueInteger	integer
.... valueMarkdown	markdown
.... valueOid	oid
.... valuePositiveInt	positiveInt
.... valueString	string
.... valueTime	time
.... valueUnsignedInt	unsignedInt
.... valueUri	uri
.... valueUrl	url
.... valueUuid	uuid
.... valueAddress	Address
.... valueAge	Age
.... valueAnnotation	Annotation
.... valueAttachment	Attachment
.... valueCodeableConcept	CodeableConcept
.... valueCodeableReference	CodeableReference
.... valueCoding	Coding
.... valueContactPoint	ContactPoint
.... valueCount	Count
.... valueDistance	Distance
.... valueDuration	Duration
.... valueHumanName	HumanName
.... valueIdentifier	Identifier
.... valueMoney	Money
.... valuePeriod	Period
.... valueQuantity	Quantity
.... valueRange	Range
.... valueRatio	Ratio
.... valueRatioRange	RatioRange
.... 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
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><!-- ?? 1..1 CodeableConcept  
 Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="Percentage"> ?? 0..1 Extension  <!-- ?? 0..1 Ancestry percentage -->
 <valueDecimal value="[decimal ]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="Source"> ?? 0..1 Extension  <!-- ?? 0..1 Source of ancestry report -->
 <valueCodeableConcept><!-- ?? 1..1 CodeableConcept  
 Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

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

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.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)