DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 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

4.20.21.3.4 StructureDefinition: Genetics

Definitions for the observation-genetics-cg-prf-1a-genetics Profile.

Observation(Genetics)
Definition

Measurements and simple assertions made about a patient, device or other subject.

Control1..1
TypeObservation
Requirements

Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.

Alternate NamesVital Signs, Measurement, Results, Tests
Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as Lab reports, etc.

InvariantsDefined on this element
obs-6: Shall only be present if Observation.value[x] is not present (xpath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')]))))
Observation.id
Definition

The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Observation.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Observation.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Observation.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource

Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Observation.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Observation.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Observation.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Observation.extension(GenomeBuild)
Definition

The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'. Version number must be included if a versioned release of a primary build was used.

Control0..1
TypeExtension
Observation.extension(Chromosome)
Definition

The chromosome containing the genetic finding - values should be 1-23, X, Y, mitochondrial, viral, bacterial.

Control0..1
TypeExtension
Observation.extension(GenomicReferenceSequenceId)
Definition

The genomic reference sequence identifier is included, to support testing using alternative reference sequences.

Control0..1
TypeExtension
Observation.extension(GenomicStart)
Definition

Nucleotide location for start of genomic finding on the positive (+) genomics strand.

Control0..1
TypeExtension
Observation.extension(GenomicStop)
Definition

Nucleotide location for end of genomic finding on the positive (+) genomic strand.

Control0..1
TypeExtension
Observation.extension(ReferenceAllele)
Definition

Nucleotide(s) from genomic start to genomic stop on the positive (+) strand of the genomic reference sequence. Use '-' for insertions.

Control0..1
TypeExtension
Observation.extension(ObservedAllele)
Definition

Oserved nucleotides from genomic start to genomic stop on the positive (+) genomic strand. Use '-' for delections.

Control0..1
TypeExtension
Observation.extension(GeneId)
Definition

HGNC gene symbol and identifier from HUGO Gene Nomenclature Committee at: http://www.genenames.org/.

Control0..1
TypeExtension
Observation.extension(TranscriptReferenceSequenseId)
Definition

Reference identifier for cDNA transcript, with version, from NCBI's RefSeq or ENSEMBL.

Control0..1
TypeExtension
Observation.extension(DNASequenceVariation)
Definition

cDNA variant following HGVS nomenclature on the given TranscriptReferenceSequenceId.

Control0..1
TypeExtension
Observation.extension(VariationId)
Definition

Identifier for variant. If a germline variant, ClinVar or dbSNP identifier should be used. If ClinVar is used, the identifier should be prefixed with 'ClinVar:' (e.g. ClinVar:17661). dbSNP ids are start with 'rs' (rs28897672) and COSMIC id's start with 'COSM' (e.g. COSM12979). Note, dbSNP id's are not unique to a variant but a location, so nucleotide change and germline/somatic classification are needed to resolve. If a somatic variant, COSMIC identifier should be used, unless in ClinVar then either maybe used.

Control0..1
TypeExtension
Observation.extension(DNARegionName)
Definition

Details of exonic location of variant (e.g. Exon 1).

Control0..1
TypeExtension
Observation.extension(DNASequenceVariationType)
Definition

Codified type for associated DNA Sequence Variation. DNA Sequence Variations use the HGVS notation which implies the DNA Sequence Variation Type, but the concurrent use of this code will allow a standard and explicit type for technical and display convenience. LOINC Answer List values 48019-4 or Sequence Ontology vaues.

Control0..1
TypeExtension
Observation.extension(ProteinReferenceSequenceId)
Definition

Reference identifier for protein transcript, with version, from NCBI's RefSeq or ENSEMBL.

Control0..1
TypeExtension
Observation.extension(AminoAcidChange)
Definition

Protein variant following HGVS nomenclature on the given ProteinReferenceSequenceId.

Control0..1
TypeExtension
Observation.extension(AminoAcidChangeType)
Definition

Type of variation expressed using Sequence Ontology or LOINC answer list 48006-1.

Control0..1
TypeExtension
Observation.extension(AlleleName)
Definition

Common name for variant or gene allele.

Control0..1
TypeExtension
Observation.extension(GenomicSourceClass)
Definition

The genomic class of the variant: Germline for inherited genome, somatic for cancer genome (e.g. DNA from tumor cells), and prenatal for fetal genome. Associated with LOINC answer list: 48002-0.

Control0..1
TypeExtension
Observation.extension(AllelicState)
Definition

The level of occurrence of a DNA Sequence Variation. Heterozygous: present in one of the two genes of homologous chromosomes, while Homozygous means it's present in both genes. Hemizygous: Variation in the only single copy of a gene in a non-homologous chromosome (i.e. male X and Y chromosome). Homoplasmic: Variation is present in all of the copies of mitochondrial DNA while Hemiplasmic is present in only some copies. LOINC Answer List values 53034-5.

Control0..1
TypeExtension
Observation.extension(Species)
Definition

supports testing of human, viruses, and bacteria.

Control0..1
TypeExtension
Observation.extension(CIGAR)
Definition

A sequence of of base lengths and the associated operation, used to indicate which bases align (either a match/mismatch) with the reference, are deleted from the reference, and are insertions that are not in the reference. string of observed nucleotides. Observed nucleotides matching the reference are in capital letters. Observed nucleotides not matching the reference are in lower case letters. Use '-' a dash for deleted/missing nucleotides in the observed sequence. Allowable characters are A,T,C,G, a,t,c,g and -.

Control0..1
TypeExtension
Observation.extension(AssessedCondition)
Definition

Used to denote condition context for genetic testing, which may influence reported variants and interpretation for large genomic testing panels e.g. lung cancer or familial breast cancer.

Control0..1
TypeExtension
Observation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Observation.code
Definition

Describes what was observed. Sometimes this is called the observation "code".

Control1..1
BindingCodes identifying types of simple observations
For example codes, see LOINC Codes
TypeCodeableConcept
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Observation.value[x]
Definition

The information determined as a result of making the observation, if the information has a simple value.

Control0..1
BindingCodes identifying atomic results of observations when value is type codeableConcept
For example codes, see SNOMED CT Codes
TypeChoice of: Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period
Requirements

An observation exists to have a value, though it may not if it is in error, or it represents a group of observations.

Comments

Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from <http://hl7.org/fhir/v2/vs/0136> (These "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (The name format is "'value' + the type name" with a capital on the first letter of the type).

Observation.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.value[x] is missing.

Control0..1 This element is affected by the following invariants: obs-6
BindingCodes specifying why the result (Observation.value[x]) is missing
The codes SHALL be taken from Observation Value Absent Reason; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

"Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

Observation.interpretation
Definition

The assessment made based on the result of the observation.

Control0..1
BindingCodes identifying interpretations of observations
The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Observation.comments
Definition

May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.

Control0..1
Typestring
Requirements

Need to be able to provide free text additional information.

Observation.applies[x]
Definition

The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

Control0..1
TypeChoice of: dateTime, Period
Requirements

Knowing when an observation was deemed true is important to its relevance as well as determining trends.

Comments

At least a date should be present unless this observation is a historical report.

Observation.issued
Definition

The date and time this observation was made available.

Control0..1
Typeinstant
Comments

Updated when the result is updated.

Observation.status
Definition

The status of the result value.

Control1..1
BindingCodes providing the status of an observation
The codes SHALL be taken from ObservationStatus
Typecode
Is Modifiertrue
Requirements

Need to track the status of individual results - some results are finalised before the whole report is finalised.

Observation.reliability
Definition

An estimate of the degree to which quality issues have impacted on the value reported.

Control0..1
BindingCodes that provide an estimate of the degree to which quality issues have impacted on the value of an observation
The codes SHALL be taken from ObservationReliability
Typecode
Is Modifiertrue
Requirements

Not all results are completely reliable, and some are still reported anyway.

Comments

Note that in most contexts, unreliable results are not recorded, deleted, or otherwise excluded, but it's not always possible to exclude them from the record. If the reliability indicator is present, interpreters of a result, whether human or machine, should always either be aware of the status or prevented from using the observation without being unaware that the reliability is not "ok".

Observation.bodySite[x]
Definition

Indicates the site on the subject's body where the observation was made ( i.e. the target site).

Control0..1
BindingCodes describing anatomical locations. May include laterality
For example codes, see SNOMED CT Body Structures
TypeChoice of: CodeableConcept, Reference (BodySite))
Requirements

Knowing where the observation is made is important for tracking if multiple sites are possible.

Comments

Only used if not implicit in code found in Observation.code.

Observation.method
Definition

Indicates the mechanism used to perform the observation.

Control0..1
BindingMethods for simple observations
For example codes, see Observation Methods
TypeCodeableConcept
Requirements

In some cases, method can impact results and is thus for determining whether results can be compared or determining significance of results.

Comments

Only used if not implicit in code for Observation.code.

Observation.identifier
Definition

A unique identifier for the simple observation.

Control0..*
TypeIdentifier
Requirements

Allows observations to be distinguished and referenced.

Observation.subject
Definition

The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, other observer (for example a relative or EMT), or any observation made about the subject.

Control0..1
TypeChoice of: Reference (Patient)), Reference (Group)), Reference (Device)), Reference (Location))
Requirements

Observations have no value if you don't know who or what they're about.

Comments

One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. If the target of the observation is different than the subject, the general extension (http://hl7.org/fhir/StructureDefinition/indirectTarget) can be used.

Observation.specimen
Definition

The specimen that was used when this observation was made.

Control0..1
TypeReference (Specimen))
Comments

Observations are not made on specimens themselves; they are made on a subject, but usually by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources are often used in contexts that track the specimen explicitly (e.g. Diagnostic Report).

Observation.performer
Definition

Who was responsible for asserting the observed value as "true".

Control0..*
TypeChoice of: Reference (Practitioner)), Reference (Organization)), Reference (Patient)), Reference (RelatedPerson))
Requirements

May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.

Observation.device
Definition

The device used to generate the observation data.

Control0..1
TypeChoice of: Reference (Device)), Reference (DeviceMetric))
Comments

An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either extension or through the Observation.related element.

Observation.encounter
Definition

The healthcare event ( e.g. a patient and healthcare provider interaction ) during which this observation is made.

Control0..1
TypeReference (Encounter))
Requirements

For some observations it may be important to know the link between an observation and a particular encounter.

Observation.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
Typenull
Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g. specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.

InvariantsDefined on this element
obs-3: Must have at least a low or a high or text (xpath: (exists(f:low) or exists(f:high)or exists(f:text)))
Observation.referenceRange.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Observation.referenceRange.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Observation.referenceRange.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Observation.referenceRange.low
Definition

The value of the low bound of the reference range. If this element is omitted, the low bound of the reference range is assumed to be meaningless. (e.g. reference range is <2.3) If the low.comparator element is missing, it is assumed to be '>'.

Control0..1 This element is affected by the following invariants: obs-3, obs-4
TypeQuantity
InvariantsDefined on this element
obs-4: Low range comparators can only be '>' or '>=' or empty (xpath: not(exists(f:comparator)) or boolean(f:comparator/@value = '<') or boolean(f:comparator/@value = '<='))
Observation.referenceRange.high
Definition

The value of the high bound of the reference range. If this element is omitted, the high bound of the reference range is assumed to be meaningless. (e.g. reference range is > 5) If the low.comparator element is missing , it is assumed to be '<'.

Control0..1 This element is affected by the following invariants: obs-3, obs-5
TypeQuantity
InvariantsDefined on this element
obs-5: High range comparators can only be '<' or '<=' or empty (xpath: not(exists(f:comparator)) or boolean(f:comparator/@value = '>') or boolean(f:comparator/@value = '>='))
Observation.referenceRange.meaning
Definition

Code for the meaning of the reference range.

Control0..1
BindingCode for the meaning of a reference range
For example codes, see Observation Reference Range Meaning Codes
TypeCodeableConcept
Requirements

Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, or perhaps what state this reference range applies to (i.e. age, hormonal cycles, etc.).

Comments

This SHOULD be populated if there is more than one range.

Observation.referenceRange.age
Definition

The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

Control0..1
TypeRange
Requirements

Some analytes vary greatly over age.

Observation.referenceRange.text
Definition

Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of 'normals'.

Control0..1
Typestring
Observation.related
Definition

Related observations - either components, or previous observations, or statements of derivation.

Control0..*
Typenull
Requirements

Some observations have important relationships to other observations (e.g Blood Pressure = systolic + diastolic), or are derived from other observations (e.g. calculated apgar score).

Comments

Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived).

Observation.related.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Observation.related.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Observation.related.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Observation.related.type
Definition

A code specifying the kind of relationship that exists with the target observation.

Control0..1
BindingCodes specifying how two observations are related
The codes SHALL be taken from ObservationRelationshipType
Typecode
Requirements

May need to indicate whether this observation is composed of others, or merely derived from them.

Comments

A relationship type SHOULD be provided. If the relationship type is "COMP" (composed), then the observation should not be displayed/interpreted in the absence of the related observations.

Observation.related.target
Definition

A reference to the observation that is related to this observation.

Control1..1
TypeReference (Observation))