Genomics Reporting Implementation Guide
3.0.0 - release International flag

Genomics Reporting Implementation Guide, published by HL7 International / Clinical Genomics. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/genomics-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: Genomic Implication ( Abstract )

Official URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/implication Version: 3.0.0
Active as of 2024-11-24 Computable Name: GenomicImplication

Copyright/Legal: This material contains content from LOINC (http://loinc.org). LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.

Properties common to genomic implications expressed as computable discrete elements.

The Genomic Implication profile is an abstract profile for therapeutic and diagnostic implications and molecular consequences. Implications are relevant information which are derived from the presence of a haplotype, genotype, variant or molecular biomarker. This portion of the implementation guide relies on the content in the General Genomic Reporting and Variant Reporting portions of this implementation guide.

At the heart of many genomic reports are findings (variants, haplotypes, genotypes, biomarkers) and annotations derived from those findings (diagnostic implications, therapeutic implications, predicted molecular consequences), as shown in the following figure:

generalGuidance

This profile defines a common set of elements for other Implications:

  • derivedFrom is a required field that provides an explicit reference from an implication to the variant(s) / haplotype(s) / genotype(s) / molecular biomarker(s) from which the implication is derived.
  • workflow-relatedArtifact (base extension) supports conveying references to citations, supporting documentation and other information relevant to the asserted implication, such as documentation which applies to the full implication Observation
  • workflow-relatedArtifactComponent (component level extension) supports conveying references to citations, supporting documentation and other information specific to the component's code and value, such as documentation supporting a specific clinical significance or evidence level value
  • evidence-level (component) indicates the strength of the evidence behind the asserted implication
  • clinical-significance (component) indicates the clinical impact of an implication

evidence-level versus clinical-significance

evidence-level: The amount of observed support for the association between an implication and a variant / haplotype / genotype / biomarker. There are dozens if not hundreds of evidence-level value sets, generally providing an ordinal range of codes from low evidence (e.g. 'predicted', 'case report', '1-star') to high evidence (e.g. 'professional society guideline', 'expert panel consensus', '1A').

clinical-significance: The clinical impact of an implication on a person's health. There are dozens if not hundreds of clinical-significance value sets, generally providing an ordinal range of codes from low significance (e.g. 'benign') to high significance (e.g. 'pathogenic', 'oncogenic','predictive of drug response').

While evidence and significance are orthogonal concepts, some codes conflate the two (e.g. 'expert panel consensus of strong efficacy', 'strong evidence refutes the clinical utility of this drug', 'case report evidence of pathogenicity'). In general, using discrete evidence and significance codes allow for a more precise characterization of an implication. Where an implementation is using a conflated code, we recommend communicating that code in the evidence-level field.

Examples of other code sets for evidence-level and clinical-significance:

Differentiating AND vs OR

There are several cases where it is necessary to differentiate 'AND' conditions (e.g. both drug X AND drug Y, in combination, are indicated in the presence of a variant) vs. 'OR' conditions (e.g., either drug X OR drug Y are indicated in the presence of a variant). This situation is not unique to genomic implications, and arises elsewhere within FHIR (e.g. FHIR Search) and outside of FHIR (e.g., ClinVar submission API condition set). To be consistent with other precedents:

Where implications have fields with cardinality > 1, the inclusion of multiple values within a field SHALL indicate an 'AND' condition. An 'OR' condition SHALL be represented by multiple observation instances.

Implication fields affected by this guidance include:

Molecular consequences: derivedFrom, evidence-level, feature-consequence.

Therapeutic implications: derivedFrom, evidence-level, therapeutic-implication, phenotypic-treatment-context, medication-assessed, therapy-assessed.

Diagnostic implications: derivedFrom, evidence-level, predicted-phenotype, genomic-risk-assessment.

Here are examples of these rules with DiagnosticImplication (but the principles would apply to any Implication):

Use Case Description Visual
Variant X is pathogenic for Disease Y AND Disease Z (in combination) One DiagnosticImplication with two predicted-phenotype instances for Disease Y and Disease Z that is derivedFrom one Variant for VariantX
Variant X might be pathogenic for Disease Y alone, or Disease Z alone Two DiagnosticImplications, one with predicted-phenotype for DiseaseY, second with predicted-phenotype for DiseaseZ, and both are derivedFrom the same Variant for VariantX
Variant X AND Variant Y (in combination) are pathogenic for Disease Z One DiagnosticImplications with predicted-phenotype for DiseaseZ that is derivedFrom the two Variants (VariantX and VariantY)
Variant X OR Variant Y might be pathogenic for Disease Z Two DiagnosticImplications, each with predicted-phenotype for DiseaseZ, one that is derivedFrom a Variant for VariantX, the other that is derivedFrom a Variant for VariantY

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from GenomicBase

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* GenomicBase This is an abstractprofile. Childprofiles: DiagnosticImplication, MolecularConsequence, TherapeuticImplication
Measurements and simple assertions
... Slices for extension Content/Rules for all slices
.... workflow-relatedArtifact 0..* RelatedArtifact Documentation relevant to the 'parent' resource
URL: http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact
... value[x] 0..0
... derivedFrom 1..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
.... derivedFrom:variant 0..* Reference(Variant) Variant the implication is derived from
.... derivedFrom:genotype 0..* Reference(Genotype) Genotype the implication is derived from
.... derivedFrom:haplotype 0..* Reference(Haplotype) Haplotype the implication is derived from
.... derivedFrom:biomarker 0..* Reference(Molecular Biomarker) MolecularBiomarker the implication is derived from
... component 0..* BackboneElement Component results
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
... Slices for component Content/Rules for all slices
.... component:evidence-level 0..* BackboneElement Level of Evidence
..... code 1..1 CodeableConcept 93044-6
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93044-6
..... value[x] 1..1 CodeableConcept 1A | 1B | 2A | 2B | 3 | 4 | 4-star | 3-star | 2-star | 1-star | no-star
Binding: Evidence Level Examples (example): PharmGKB or ClinVar

.... component:clinical-significance 0..1 BackboneElement Clinical significance
..... Slices for extension Content/Rules for all slices
...... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
..... code 1..1 CodeableConcept 53037-8
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 53037-8
..... value[x] 1..1 CodeableConcept Pathogenic | Likely pathogenic | Uncertain significance | Likely benign | Benign
Binding: LOINC Answer List LL4034-6 (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.component:evidence-level.value[x]exampleEvidenceLevelExampleVS
http://hl7.org/fhir/uv/genomics-reporting/ValueSet/evidence-level-example-vs
from this IG
Observation.component:clinical-significance.value[x]exampleLOINC LL4034-6
http://loinc.org/vs/LL4034-6
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* GenomicBase This is an abstractprofile. Childprofiles: DiagnosticImplication, MolecularConsequence, TherapeuticImplication
Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... secondary-finding 0..1 CodeableConcept Secondary findings are genetic test results that provide information about variants in a gene unrelated to the primary purpose for the testing, most often discovered when [Whole Exome Sequencing (WES)](https://en.wikipedia.org/wiki/Exome_sequencing) or [Whole Genome Sequencing (WGS)](https://en.wikipedia.org/wiki/Whole_genome_sequencing) is performed. This extension should be used to denote when a genetic finding is being shared as a secondary finding, and ideally refer to a corresponding guideline or policy statement. For more detail, please see: https://ghr.nlm.nih.gov/primer/testing/secondaryfindings
URL: http://hl7.org/fhir/StructureDefinition/observation-secondaryFinding
Binding: GeneticObservationSecondaryFindings (extensible): Codes to denote a guideline or policy statement when a genetic test result is being shared as a secondary finding.


.... body-structure 0..1 Reference(BodyStructure) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
.... workflow-relatedArtifact 0..* RelatedArtifact Documentation relevant to the 'parent' resource
URL: http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for category 2..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:coding
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:labCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
.... category:geCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: GE
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... Slices for derivedFrom Σ 1..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
Slice: Unordered, Open by profile:resolve()
.... derivedFrom:variant Σ 0..* Reference(Variant) Variant the implication is derived from
.... derivedFrom:genotype Σ 0..* Reference(Genotype) Genotype the implication is derived from
.... derivedFrom:haplotype Σ 0..* Reference(Haplotype) Haplotype the implication is derived from
.... derivedFrom:biomarker Σ 0..* Reference(Molecular Biomarker) MolecularBiomarker the implication is derived from
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... component:conclusion-string Σ 0..1 BackboneElement Clinical Conclusion
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept conclusion-string
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/genomics-reporting/CodeSystem/tbd-codes-cs
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: conclusion-string
.... component:evidence-level Σ 0..* BackboneElement Level of Evidence
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept 93044-6
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93044-6
..... value[x] Σ 1..1 CodeableConcept 1A | 1B | 2A | 2B | 3 | 4 | 4-star | 3-star | 2-star | 1-star | no-star
Binding: Evidence Level Examples (example): PharmGKB or ClinVar

.... component:clinical-significance Σ 0..1 BackboneElement Clinical significance
..... Slices for extension Content/Rules for all slices
...... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept 53037-8
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 53037-8
..... value[x] Σ 1..1 CodeableConcept Pathogenic | Likely pathogenic | Uncertain significance | Likely benign | Benign
Binding: LOINC Answer List LL4034-6 (example)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:labCategorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:geCategorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:conclusion-string.codeexamplePattern: conclusion-string
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:evidence-level.codeexamplePattern: LOINC Code 93044-6
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:evidence-level.value[x]exampleEvidenceLevelExampleVS
http://hl7.org/fhir/uv/genomics-reporting/ValueSet/evidence-level-example-vs
from this IG
Observation.component:clinical-significance.codeexamplePattern: LOINC Code 53037-8
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:clinical-significance.value[x]exampleLOINC LL4034-6
http://loinc.org/vs/LL4034-6

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* GenomicBase This is an abstractprofile. Childprofiles: DiagnosticImplication, MolecularConsequence, TherapeuticImplication
Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... secondary-finding 0..1 CodeableConcept Secondary findings are genetic test results that provide information about variants in a gene unrelated to the primary purpose for the testing, most often discovered when [Whole Exome Sequencing (WES)](https://en.wikipedia.org/wiki/Exome_sequencing) or [Whole Genome Sequencing (WGS)](https://en.wikipedia.org/wiki/Whole_genome_sequencing) is performed. This extension should be used to denote when a genetic finding is being shared as a secondary finding, and ideally refer to a corresponding guideline or policy statement. For more detail, please see: https://ghr.nlm.nih.gov/primer/testing/secondaryfindings
URL: http://hl7.org/fhir/StructureDefinition/observation-secondaryFinding
Binding: GeneticObservationSecondaryFindings (extensible): Codes to denote a guideline or policy statement when a genetic test result is being shared as a secondary finding.


.... body-structure 0..1 Reference(BodyStructure) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
.... workflow-relatedArtifact 0..* RelatedArtifact Documentation relevant to the 'parent' resource
URL: http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | Genomic Study) Part of referenced event
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 2..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:coding
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:labCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... category:geCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: GE
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... subject Σ 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] Σ 0..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..* CodedAnnotation Comments about the Observation that also contain a coded type
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... Slices for derivedFrom Σ 1..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
Slice: Unordered, Open by profile:resolve()
.... derivedFrom:variant Σ 0..* Reference(Variant) Variant the implication is derived from
.... derivedFrom:genotype Σ 0..* Reference(Genotype) Genotype the implication is derived from
.... derivedFrom:haplotype Σ 0..* Reference(Haplotype) Haplotype the implication is derived from
.... derivedFrom:biomarker Σ 0..* Reference(Molecular Biomarker) MolecularBiomarker the implication is derived from
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:conclusion-string Σ 0..1 BackboneElement Clinical Conclusion
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept conclusion-string
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/genomics-reporting/CodeSystem/tbd-codes-cs
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: conclusion-string
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 string Summary conclusion (interpretation/impression)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:evidence-level Σ 0..* BackboneElement Level of Evidence
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept 93044-6
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93044-6
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 1..1 CodeableConcept 1A | 1B | 2A | 2B | 3 | 4 | 4-star | 3-star | 2-star | 1-star | no-star
Binding: Evidence Level Examples (example): PharmGKB or ClinVar

..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:clinical-significance Σ 0..1 BackboneElement Clinical significance
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept 53037-8
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 53037-8
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 1..1 CodeableConcept Pathogenic | Likely pathogenic | Uncertain significance | Likely benign | Benign
Binding: LOINC Answer List LL4034-6 (example)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:labCategorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:geCategorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:conclusion-string.codeexamplePattern: conclusion-string
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:conclusion-string.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:conclusion-string.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:evidence-level.codeexamplePattern: LOINC Code 93044-6
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:evidence-level.value[x]exampleEvidenceLevelExampleVS
http://hl7.org/fhir/uv/genomics-reporting/ValueSet/evidence-level-example-vs
from this IG
Observation.component:evidence-level.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:evidence-level.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:clinical-significance.codeexamplePattern: LOINC Code 53037-8
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:clinical-significance.value[x]exampleLOINC LL4034-6
http://loinc.org/vs/LL4034-6
Observation.component:clinical-significance.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:clinical-significance.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

This structure is derived from GenomicBase

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* GenomicBase This is an abstractprofile. Childprofiles: DiagnosticImplication, MolecularConsequence, TherapeuticImplication
Measurements and simple assertions
... Slices for extension Content/Rules for all slices
.... workflow-relatedArtifact 0..* RelatedArtifact Documentation relevant to the 'parent' resource
URL: http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact
... value[x] 0..0
... derivedFrom 1..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
.... derivedFrom:variant 0..* Reference(Variant) Variant the implication is derived from
.... derivedFrom:genotype 0..* Reference(Genotype) Genotype the implication is derived from
.... derivedFrom:haplotype 0..* Reference(Haplotype) Haplotype the implication is derived from
.... derivedFrom:biomarker 0..* Reference(Molecular Biomarker) MolecularBiomarker the implication is derived from
... component 0..* BackboneElement Component results
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
... Slices for component Content/Rules for all slices
.... component:evidence-level 0..* BackboneElement Level of Evidence
..... code 1..1 CodeableConcept 93044-6
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93044-6
..... value[x] 1..1 CodeableConcept 1A | 1B | 2A | 2B | 3 | 4 | 4-star | 3-star | 2-star | 1-star | no-star
Binding: Evidence Level Examples (example): PharmGKB or ClinVar

.... component:clinical-significance 0..1 BackboneElement Clinical significance
..... Slices for extension Content/Rules for all slices
...... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
..... code 1..1 CodeableConcept 53037-8
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 53037-8
..... value[x] 1..1 CodeableConcept Pathogenic | Likely pathogenic | Uncertain significance | Likely benign | Benign
Binding: LOINC Answer List LL4034-6 (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.component:evidence-level.value[x]exampleEvidenceLevelExampleVS
http://hl7.org/fhir/uv/genomics-reporting/ValueSet/evidence-level-example-vs
from this IG
Observation.component:clinical-significance.value[x]exampleLOINC LL4034-6
http://loinc.org/vs/LL4034-6

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* GenomicBase This is an abstractprofile. Childprofiles: DiagnosticImplication, MolecularConsequence, TherapeuticImplication
Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... secondary-finding 0..1 CodeableConcept Secondary findings are genetic test results that provide information about variants in a gene unrelated to the primary purpose for the testing, most often discovered when [Whole Exome Sequencing (WES)](https://en.wikipedia.org/wiki/Exome_sequencing) or [Whole Genome Sequencing (WGS)](https://en.wikipedia.org/wiki/Whole_genome_sequencing) is performed. This extension should be used to denote when a genetic finding is being shared as a secondary finding, and ideally refer to a corresponding guideline or policy statement. For more detail, please see: https://ghr.nlm.nih.gov/primer/testing/secondaryfindings
URL: http://hl7.org/fhir/StructureDefinition/observation-secondaryFinding
Binding: GeneticObservationSecondaryFindings (extensible): Codes to denote a guideline or policy statement when a genetic test result is being shared as a secondary finding.


.... body-structure 0..1 Reference(BodyStructure) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
.... workflow-relatedArtifact 0..* RelatedArtifact Documentation relevant to the 'parent' resource
URL: http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for category 2..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:coding
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:labCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
.... category:geCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: GE
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... Slices for derivedFrom Σ 1..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
Slice: Unordered, Open by profile:resolve()
.... derivedFrom:variant Σ 0..* Reference(Variant) Variant the implication is derived from
.... derivedFrom:genotype Σ 0..* Reference(Genotype) Genotype the implication is derived from
.... derivedFrom:haplotype Σ 0..* Reference(Haplotype) Haplotype the implication is derived from
.... derivedFrom:biomarker Σ 0..* Reference(Molecular Biomarker) MolecularBiomarker the implication is derived from
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... component:conclusion-string Σ 0..1 BackboneElement Clinical Conclusion
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept conclusion-string
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/genomics-reporting/CodeSystem/tbd-codes-cs
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: conclusion-string
.... component:evidence-level Σ 0..* BackboneElement Level of Evidence
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept 93044-6
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93044-6
..... value[x] Σ 1..1 CodeableConcept 1A | 1B | 2A | 2B | 3 | 4 | 4-star | 3-star | 2-star | 1-star | no-star
Binding: Evidence Level Examples (example): PharmGKB or ClinVar

.... component:clinical-significance Σ 0..1 BackboneElement Clinical significance
..... Slices for extension Content/Rules for all slices
...... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept 53037-8
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 53037-8
..... value[x] Σ 1..1 CodeableConcept Pathogenic | Likely pathogenic | Uncertain significance | Likely benign | Benign
Binding: LOINC Answer List LL4034-6 (example)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:labCategorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:geCategorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:conclusion-string.codeexamplePattern: conclusion-string
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:evidence-level.codeexamplePattern: LOINC Code 93044-6
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:evidence-level.value[x]exampleEvidenceLevelExampleVS
http://hl7.org/fhir/uv/genomics-reporting/ValueSet/evidence-level-example-vs
from this IG
Observation.component:clinical-significance.codeexamplePattern: LOINC Code 53037-8
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:clinical-significance.value[x]exampleLOINC LL4034-6
http://loinc.org/vs/LL4034-6

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* GenomicBase This is an abstractprofile. Childprofiles: DiagnosticImplication, MolecularConsequence, TherapeuticImplication
Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... secondary-finding 0..1 CodeableConcept Secondary findings are genetic test results that provide information about variants in a gene unrelated to the primary purpose for the testing, most often discovered when [Whole Exome Sequencing (WES)](https://en.wikipedia.org/wiki/Exome_sequencing) or [Whole Genome Sequencing (WGS)](https://en.wikipedia.org/wiki/Whole_genome_sequencing) is performed. This extension should be used to denote when a genetic finding is being shared as a secondary finding, and ideally refer to a corresponding guideline or policy statement. For more detail, please see: https://ghr.nlm.nih.gov/primer/testing/secondaryfindings
URL: http://hl7.org/fhir/StructureDefinition/observation-secondaryFinding
Binding: GeneticObservationSecondaryFindings (extensible): Codes to denote a guideline or policy statement when a genetic test result is being shared as a secondary finding.


.... body-structure 0..1 Reference(BodyStructure) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
.... workflow-relatedArtifact 0..* RelatedArtifact Documentation relevant to the 'parent' resource
URL: http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | Genomic Study) Part of referenced event
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 2..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:coding
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:labCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... category:geCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: GE
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... subject Σ 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] Σ 0..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..* CodedAnnotation Comments about the Observation that also contain a coded type
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... Slices for derivedFrom Σ 1..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
Slice: Unordered, Open by profile:resolve()
.... derivedFrom:variant Σ 0..* Reference(Variant) Variant the implication is derived from
.... derivedFrom:genotype Σ 0..* Reference(Genotype) Genotype the implication is derived from
.... derivedFrom:haplotype Σ 0..* Reference(Haplotype) Haplotype the implication is derived from
.... derivedFrom:biomarker Σ 0..* Reference(Molecular Biomarker) MolecularBiomarker the implication is derived from
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... workflow-relatedArtifactComponent 0..* RelatedArtifact Related Artifact for Observation component
URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/workflow-relatedArtifactComponent
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:conclusion-string Σ 0..1 BackboneElement Clinical Conclusion
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept conclusion-string
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/genomics-reporting/CodeSystem/tbd-codes-cs
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: conclusion-string
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 string Summary conclusion (interpretation/impression)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:evidence-level Σ 0..* BackboneElement Level of Evidence
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept 93044-6
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org