This page is part of the FHIR Specification (v3.3.0: R4 Ballot 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 R3
(No assigned work group) | Maturity Level: 1 | Informative | Use Context: Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/observation-genetics
Describes how the observation resource is used to report structured genetic test results
This profile was published on Mon, Mar 14, 2016 00:00+1100 as a draft by Health Level Seven International (Clinical Genomics).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Observation.
Summary
Extensions
This structure refers to these extensions:
This structure is derived from Observation.
<!-- Observation-genetics --> <Observation xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- 0..* Identifier Business Identifier for observation --></identifier> <basedOn><!-- 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(MedicationAdministration) Part of referenced event --></partOf> <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended + --> <category><!-- 0..* CodeableConcept Classification of type of observation --></category> <code><!-- 1..1 CodeableConcept Type of observation (code / type) --></code> <subject><!-- 0..1 Reference(Patient) Who and/or what this is about --></subject> <focus><!-- 0..1 Reference(Resource) The "focal point" of the observation --></focus> <context><!-- 0..1 Reference(Encounter) Healthcare event during which this observation is made --></context> <effective[x]><!-- 0..1 dateTime|Period|Timing Clinically relevant time/time-period for observation --></effective[x]> <issued value="[instant]"/><!-- 0..1 Date/Time this version was made available --> <performer><!-- 0..* Reference(Practitioner) Who is responsible for the observation --></performer> <value[x]><!-- 0..1 Quantity|CodeableConcept|string|boolean|integer| Range|Ratio|SampledData|time|dateTime|Period Actual result --></value[x]> <dataAbsentReason><!-- 0..1 CodeableConcept Why the result is missing --></dataAbsentReason> <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc. --></interpretation> <comment value="[string]"/><!-- 0..1 Comments about result --> <bodySite><!-- 0..1 CodeableConcept Observed body part --></bodySite> <method><!-- 0..1 CodeableConcept How it was done --></method> <specimen><!-- 0..1 Reference(Specimen) Specimen used for this observation --></specimen> <device><!-- 0..1 Reference(Device) (Measurement) Device --></device> <referenceRange> 0..* BackboneElement <!-- 0..* Provides guide for interpretation --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <low><!-- 0..1 Quantity Low Range, if relevant --></low> <high><!-- 0..1 Quantity High Range, if relevant --></high> <type><!-- 0..1 CodeableConcept Reference range qualifier --></type> <appliesTo><!-- 0..* CodeableConcept Reference range population --></appliesTo> <age><!-- 0..1 Range Applicable age range, if relevant --></age> <text value="[string]"/><!-- 0..1 Text based reference range in an observation --> </referenceRange> <hasMember><!-- 0..* Reference(Observation) Related resource that belongs to the Observation group --></hasMember> <derivedFrom><!-- 0..* Reference(DocumentReference) Related measurements the observation is made from --></derivedFrom> <component> 0..* BackboneElement <!-- 0..* Component results --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <code><!-- 1..1 CodeableConcept Type of component observation (code / type) --></code> <value[x]><!-- 0..1 Quantity|CodeableConcept|string| boolean|integer|Range|Ratio|SampledData|time|dateTime|Period Actual component result --></value[x]> <dataAbsentReason><!-- 0..1 CodeableConcept Why the component result is missing --></dataAbsentReason> <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc. --></interpretation> <referenceRange><!-- See #Observation.referenceRange Provides guide for interpretation of component result --></referenceRange> </component> </Observation>
{ // Observation-genetics // from Element: extension "meta" : { Meta }, //Metadata about the resource "implicitRules" : "<uri>", //A set of rules under which this content was created "language" : "<code>", //Language of the resource content "text" : { Narrative }, //Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "extension" : [ // sliced by value:url in the specified order, Open { // HGNC gene symbol // C? // from Element: extension }, { // DNA region name // C? // from Element: extension }, { // Copy number variation // C? // from Element: extension }, { // Genomic source class // C? // from Element: extension }, { // Clinical interpretations for variant // C? // from Element: extension }, { // Variant // C? // from Element: extension }, { // AminoAcidChange // C? // from Element: extension }, { // Allele // C? // from Element: extension }, { // Ancestry // C? // from Element: extension }, { // Phase set // C? // from Element: extension } ], "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored "identifier" : [{ Identifier }], //Business Identifier for observation "basedOn" : [{ Reference(CarePlan) }], //Fulfills plan, proposal or order "partOf" : [{ Reference(MedicationAdministration) }], //Part of referenced event "status" : "<code>", // R! registered | preliminary | final | amended + "category" : [{ CodeableConcept }], //Classification of type of observation "code" : { CodeableConcept }, // R! Type of observation (code / type) "subject" : { Reference(Patient) }, //Who and/or what this is about "focus" : { Reference(Resource) }, //The "focal point" of the observation "context" : { Reference(Encounter) }, //Healthcare event during which this observation is made // value[x]: Clinically relevant time/time-period for observation. One of these 3: "effectiveDateTime" : "<dateTime>", //Clinically relevant time/time-period for observation "effectivePeriod" : { Period }, //Clinically relevant time/time-period for observation "effectiveTiming" : { Timing }, //Clinically relevant time/time-period for observation "issued" : "<instant>", //Date/Time this version was made available "performer" : [{ Reference(Practitioner) }], //Who is responsible for the observation // value[x]: Actual result. One of these 11: "valueQuantity" : { Quantity }, //Actual result "valueCodeableConcept" : { CodeableConcept }, //Actual result "valueString" : "<string>", //Actual result "valueBoolean" : <boolean>, //Actual result "valueInteger" : <integer>, //Actual result "valueRange" : { Range }, //Actual result "valueRatio" : { Ratio }, //Actual result "valueSampledData" : { SampledData }, //Actual result "valueTime" : "<time>", //Actual result "valueDateTime" : "<dateTime>", //Actual result "valuePeriod" : { Period }, //Actual result "dataAbsentReason" : { CodeableConcept }, //Why the result is missing "interpretation" : { CodeableConcept }, //High, low, normal, etc. "comment" : "<string>", //Comments about result "bodySite" : { CodeableConcept }, //Observed body part "method" : { CodeableConcept }, //How it was done "specimen" : { Reference(Specimen) }, //Specimen used for this observation "device" : { Reference(Device) }, //(Measurement) Device "referenceRange" : [{ BackboneElement }], // C?Provides guide for interpretation "hasMember" : [{ Reference(Observation) }] //Related resource that belongs to the Observation group "derivedFrom" : [{ Reference(DocumentReference) }], //Related measurements the observation is made from "component" : [{ BackboneElement }], // C?Component results }
This structure is derived from Observation.
Summary
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Observation.
Snapshot View
XML Template
<!-- Observation-genetics --> <Observation xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- 0..* Identifier Business Identifier for observation --></identifier> <basedOn><!-- 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(MedicationAdministration) Part of referenced event --></partOf> <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended + --> <category><!-- 0..* CodeableConcept Classification of type of observation --></category> <code><!-- 1..1 CodeableConcept Type of observation (code / type) --></code> <subject><!-- 0..1 Reference(Patient) Who and/or what this is about --></subject> <focus><!-- 0..1 Reference(Resource) The "focal point" of the observation --></focus> <context><!-- 0..1 Reference(Encounter) Healthcare event during which this observation is made --></context> <effective[x]><!-- 0..1 dateTime|Period|Timing Clinically relevant time/time-period for observation --></effective[x]> <issued value="[instant]"/><!-- 0..1 Date/Time this version was made available --> <performer><!-- 0..* Reference(Practitioner) Who is responsible for the observation --></performer> <value[x]><!-- 0..1 Quantity|CodeableConcept|string|boolean|integer| Range|Ratio|SampledData|time|dateTime|Period Actual result --></value[x]> <dataAbsentReason><!-- 0..1 CodeableConcept Why the result is missing --></dataAbsentReason> <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc. --></interpretation> <comment value="[string]"/><!-- 0..1 Comments about result --> <bodySite><!-- 0..1 CodeableConcept Observed body part --></bodySite> <method><!-- 0..1 CodeableConcept How it was done --></method> <specimen><!-- 0..1 Reference(Specimen) Specimen used for this observation --></specimen> <device><!-- 0..1 Reference(Device) (Measurement) Device --></device> <referenceRange> 0..* BackboneElement <!-- 0..* Provides guide for interpretation --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <low><!-- 0..1 Quantity Low Range, if relevant --></low> <high><!-- 0..1 Quantity High Range, if relevant --></high> <type><!-- 0..1 CodeableConcept Reference range qualifier --></type> <appliesTo><!-- 0..* CodeableConcept Reference range population --></appliesTo> <age><!-- 0..1 Range Applicable age range, if relevant --></age> <text value="[string]"/><!-- 0..1 Text based reference range in an observation --> </referenceRange> <hasMember><!-- 0..* Reference(Observation) Related resource that belongs to the Observation group --></hasMember> <derivedFrom><!-- 0..* Reference(DocumentReference) Related measurements the observation is made from --></derivedFrom> <component> 0..* BackboneElement <!-- 0..* Component results --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <code><!-- 1..1 CodeableConcept Type of component observation (code / type) --></code> <value[x]><!-- 0..1 Quantity|CodeableConcept|string| boolean|integer|Range|Ratio|SampledData|time|dateTime|Period Actual component result --></value[x]> <dataAbsentReason><!-- 0..1 CodeableConcept Why the component result is missing --></dataAbsentReason> <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc. --></interpretation> <referenceRange><!-- See #Observation.referenceRange Provides guide for interpretation of component result --></referenceRange> </component> </Observation>
JSON Template
{ // Observation-genetics // from Element: extension "meta" : { Meta }, //Metadata about the resource "implicitRules" : "<uri>", //A set of rules under which this content was created "language" : "<code>", //Language of the resource content "text" : { Narrative }, //Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "extension" : [ // sliced by value:url in the specified order, Open { // HGNC gene symbol // C? // from Element: extension }, { // DNA region name // C? // from Element: extension }, { // Copy number variation // C? // from Element: extension }, { // Genomic source class // C? // from Element: extension }, { // Clinical interpretations for variant // C? // from Element: extension }, { // Variant // C? // from Element: extension }, { // AminoAcidChange // C? // from Element: extension }, { // Allele // C? // from Element: extension }, { // Ancestry // C? // from Element: extension }, { // Phase set // C? // from Element: extension } ], "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored "identifier" : [{ Identifier }], //Business Identifier for observation "basedOn" : [{ Reference(CarePlan) }], //Fulfills plan, proposal or order "partOf" : [{ Reference(MedicationAdministration) }], //Part of referenced event "status" : "<code>", // R! registered | preliminary | final | amended + "category" : [{ CodeableConcept }], //Classification of type of observation "code" : { CodeableConcept }, // R! Type of observation (code / type) "subject" : { Reference(Patient) }, //Who and/or what this is about "focus" : { Reference(Resource) }, //The "focal point" of the observation "context" : { Reference(Encounter) }, //Healthcare event during which this observation is made // value[x]: Clinically relevant time/time-period for observation. One of these 3: "effectiveDateTime" : "<dateTime>", //Clinically relevant time/time-period for observation "effectivePeriod" : { Period }, //Clinically relevant time/time-period for observation "effectiveTiming" : { Timing }, //Clinically relevant time/time-period for observation "issued" : "<instant>", //Date/Time this version was made available "performer" : [{ Reference(Practitioner) }], //Who is responsible for the observation // value[x]: Actual result. One of these 11: "valueQuantity" : { Quantity }, //Actual result "valueCodeableConcept" : { CodeableConcept }, //Actual result "valueString" : "<string>", //Actual result "valueBoolean" : <boolean>, //Actual result "valueInteger" : <integer>, //Actual result "valueRange" : { Range }, //Actual result "valueRatio" : { Ratio }, //Actual result "valueSampledData" : { SampledData }, //Actual result "valueTime" : "<time>", //Actual result "valueDateTime" : "<dateTime>", //Actual result "valuePeriod" : { Period }, //Actual result "dataAbsentReason" : { CodeableConcept }, //Why the result is missing "interpretation" : { CodeableConcept }, //High, low, normal, etc. "comment" : "<string>", //Comments about result "bodySite" : { CodeableConcept }, //Observed body part "method" : { CodeableConcept }, //How it was done "specimen" : { Reference(Specimen) }, //Specimen used for this observation "device" : { Reference(Device) }, //(Measurement) Device "referenceRange" : [{ BackboneElement }], // C?Provides guide for interpretation "hasMember" : [{ Reference(Observation) }] //Related resource that belongs to the Observation group "derivedFrom" : [{ Reference(DocumentReference) }], //Related measurements the observation is made from "component" : [{ BackboneElement }], // C?Component results }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
Observation.language | Common Languages | extensible | Common Languages |
Observation.status | ObservationStatus | required | ObservationStatus |
Observation.category | Observation Category Codes | preferred | Observation Category Codes |
Observation.code | LOINC Codes | example | LOINC Codes |
Observation.dataAbsentReason | DataAbsentReason | extensible | DataAbsentReason |
Observation.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
Observation.bodySite | SNOMED CT Body Structures | example | SNOMED CT Body Structures |
Observation.method | Observation Methods | example | Observation Methods |
Observation.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
Observation.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
Observation.component.code | LOINC Codes | example | LOINC Codes |
Observation.component.dataAbsentReason | DataAbsentReason | extensible | DataAbsentReason |
Observation.component.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
Id | Path | Details | Requirements |
obs-3 | Observation.referenceRange | Must have at least a low or a high or text Expression : low.exists() or high.exists() or text.exists() |