This page is part of the Genetic Reporting Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR v3.3.0. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
Definitions for the obs-described-variant Profile.
Observation | |
Definition | Details about a set of changes in the tested sample compared to a reference sequence. |
Control | 0..* |
Alternate Names | Vital Signs, Measurement, Results, Tests |
Comments | This can be a simple/discrete (relatively short) or structural (potentially very large) variant. |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If 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.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())) dom-4: If 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()) obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present (: dataAbsentReason.empty() or value.empty()) obs-7: If Observation.code is the same as a Observation.component.code then the value element associated with the code SHALL NOT be present (: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()) |
Observation.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
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. |
Observation.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Observation.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
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 can 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline 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 |
Control | 0..* |
Type | Extension |
Observation.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/body-structure]]) | |
Definition | Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Reference(BodyStructure)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
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. 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.identifier | |
Definition | A unique identifier assigned to this observation. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows observations to be distinguished and referenced. |
Observation.basedOn | |
Definition | A plan, proposal or order that is fulfilled in whole or in part by this event. |
Control | 0..* |
Type | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) |
Must Support | true |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
Alternate Names | Fulfills |
Observation.partOf | |
Definition | A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
Control | 0..* |
Type | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) |
Alternate Names | Container |
Comments | To link an Observation to an Encounter use |
Observation.status | |
Definition | The status of the result value. |
Control | 1..1 |
Binding | Codes providing the status of an observation. The codes SHALL be taken from ObservationStatus |
Type | code |
Is Modifier | true |
Must Support | true |
Requirements | Need to track the status of individual results. Some results are finalized before the whole report is finalized. |
Comments | … This should generally be 'completed' or 'revised'. |
Observation.category | |
Definition | A code that classifies the general type of observation being made. |
Control | 1..* |
Binding | Codes for high level observation categories. The codes SHOULD be taken from Observation Category Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Used for filtering what observations are retrieved and displayed. |
Comments | … This should be populated with 'lab'. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/observation-category"/> <code value="laboratory"/> </coding> </valueCodeableConcept> |
Observation.code | |
Definition | Where testing scenarios are intended to assess the prescence or absence of a known set of DNA variants (e.g. tumor profiling using genotyping technology), then the Genetic Variant Assessment is used in conjunction with answer list supports structured communication of these findings. Of note, 'No Call' is different from 'Absent', because 'No Call' did not result in the determination of the marker's presents or absents. This may be due to test failure or specimen specific context which renders the test ineffective. |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Alternate Names | Name |
Comments | All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="TBD-Described"/> </coding> </valueCodeableConcept> |
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, donor, other observer (for example a relative or EMT), or any observation made about the subject. |
Control | 0..1 |
Type | Reference(Patient | Group | Location) |
Must Support | true |
Requirements | Observations have no value if you don't know who or what they're about. |
Comments | … This must be the same patient as on the DiagnosticReport unless combining data from multiple fetuses or family members in a single report. |
Observation.focus | |
Definition | The actual focus of an observation when it is not the patient of record. The focus is point of attention when the observation representing something or someone associated with the patient. It could be a spouse or parent, a fetus or donor. The focus of an observation could be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
Control | 0..1 |
Type | Reference(Resource) |
Comments | Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use |
Observation.context | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
Control | 0..1 |
Type | Reference(Encounter | EpisodeOfCare) |
Requirements | For some observations it may be important to know the link between an observation and a particular encounter. |
Alternate Names | Encounter |
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter or episode but still be tied to the context of the encounter or episode (e.g. pre-admission laboratory tests). |
Observation.effective[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. |
Control | 0..1 |
Type | Choice of: dateTime, Period, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. |
Alternate Names | Occurrence |
Comments | At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. |
Observation.issued | |
Definition | The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. |
Control | 0..1 |
Type | instant |
Must Support | true |
Comments | For Observations that don’t require review and verification, it may be the same as the |
Observation.performer | |
Definition | Summary of all genes, drugs and/or conditions tested for for which there were no significant/reported findings. Allows indication of what was tested for in a relatively efficient manner. |
Control | 0..1 |
Type | Reference(Practitioner | Organization | Patient | RelatedPerson) |
Must Support | true |
Requirements | May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. |
Observation.value[x] | |
Definition | Indicates whether the indicated variation was found or not. |
Control | 1..1 This element is affected by the following invariants: obs-7 |
Binding | Genetic Variant Assessment The codes SHALL be taken from http://loinc.org/vs/LL1971-2 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | If not searching for specific variations and merely reporting what's found, this element should be set to "Present". |
Observation.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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 "specimen unsatisfactory". 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. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. |
Observation.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Observation.comment | |
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. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to provide free text additional information. |
Observation.bodySite | |
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). |
Control | 0..1 |
Binding | Codes describing anatomical locations. May include laterality. For example codes, see SNOMED CT Body Structures |
Type | CodeableConcept |
Comments | Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension body-structure. |
Observation.method | |
Definition | Indicates the method of variant analysis. |
Control | 0..1 |
Binding | Variant analysis method type The codes SHALL be taken from http://loinc.org/vs/LL4048-6 |
Type | CodeableConcept |
Must Support | true |
Requirements | In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. |
Comments | Only used if not implicit in code for Observation.code. |
Observation.specimen | |
Definition | The specimen examined to determine genetic information. |
Control | 1..1 |
Type | Reference(Specimen) |
Must Support | true |
Comments | Should only be used if not implicit in code found in |
Observation.device | |
Definition | The device used to generate the observation data. |
Control | 0..1 |
Type | Reference(Device | DeviceComponent | 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 an extension or the Provenance resource. (e.g., a device gateway such as a smart phone). |
Observation.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | BackboneElement |
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 might 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) obs-3: Must have at least a low or a high or text (: low.exists() or high.exists() or text.exists()) |
Observation.referenceRange.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.referenceRange.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). |
Control | 0..1 This element is affected by the following invariants: obs-3 |
Type | Quantity(SimpleQuantity) |
Observation.referenceRange.high | |
Definition | The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). |
Control | 0..1 This element is affected by the following invariants: obs-3 |
Type | Quantity(SimpleQuantity) |
Observation.referenceRange.type | |
Definition | Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. |
Control | 0..1 |
Binding | Code for the meaning of a reference range. The codes SHALL be taken from Observation Reference Range Meaning Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. |
Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. |
Observation.referenceRange.appliesTo | |
Definition | Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. |
Control | 0..* |
Binding | Codes identifying the population the reference range applies to. For example codes, see Observation Reference Range Applies To Codes |
Type | CodeableConcept |
Requirements | Need to be able to identify the target population for proper interpretation. |
Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. |
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. |
Control | 0..1 |
Type | Range |
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". |
Control | 0..1 |
Type | string |
Observation.hasMember | |
Definition | This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
Control | 0..* |
Type | Reference(Observation | QuestionnaireResponse | Sequence) |
Comments | When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see Notes below. |
Observation.derivedFrom | |
Definition | The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
Control | 0..* |
Type | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | Sequence) |
Must Support | true |
Comments | All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. |
Observation.derivedFrom(sequence) | |
Definition | Sequence that supports the finding. |
Control | 0..* |
Type | Reference(Definitional Sequence) |
Must Support | true |
Comments | All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. |
Observation.component | |
Definition | Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. |
Control | 0..* |
Type | BackboneElement |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 0..1 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(gene-studied) | |
Definition | HUGO Gene Nomenclature Committee (HGNC) identifier for a gene. List the gene(s) examined in full or in part by the study. If the study addresses multiple genes, these can be recorded in one OBX as a list seperated by repeat delimiters or in mulltiple OBX's with one gene per OBX. The recommended coding system will use the HGNC gene symbol as the display text and HGNC gene ID as the code. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="48018-6"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Binding not yet defined |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(chromosome-location) | |
Definition | Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="48001-2"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Binding not yet defined |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(dna-region-name) | |
Definition | This term is used to report a narrative description of the range(s) of DNA sequences examined in this sequencing study. Genetic test reports only rarely include explicit numeric ranges (which would be reported using [LOINC: 51959-5] ) beause they are often proprietary, and more often describe the regions examined in narrative. For example, "all coding regions and appropriate flanking regions." To report the region of interest (e.g., in terms of introns and exons) rather than the specific DNA sequences examined, [LOINC: 47999-8] may be used. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="81293-3"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Binding not yet defined |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(dna-chg) | |
Definition | Human Genome Variation Society (HGVS) nomenclature for a single DNA marker. The use of the nomenclature must be extended to describe non-variations (aka. wild types) see samples for wild type examples. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="48004-6"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Binding not yet defined |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(dna-chg-type) | |
Definition | Codified type for associated DNA Marker. DNA Marker's use the HGVS notation which implies the DNA Marker Type, but the concurrent use of this code will allow a standard and explicit type for technical and display convenience. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="48019-4"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | Type of DNA variation reported. |
Control | 1..1 |
Binding | DNA change type values The codes SHALL be taken from http://loinc.org/vs/LL4033-8 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(variation-code) | |
Definition | This term is used to report the unique identifier of the simple variant found in this study. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | If this is present, the components can be omitted but they might be included to avoid a need to look up the information in a registry. Typically only one code would be present, though multiple codings expressing the variant in different code systems are possible. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="81252-9"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Binding not yet defined |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(dbSNP-id) | |
Definition | The unique identifier for the variant represented as a small nucleotide polymorphism (SNP). The dbSNP ID is used routinely as the base identifier in pharmacogenomics as well as arrCGH studies. For example, for the simple variant NM_014049.4(ACAD9):c.1249C>T (p.Arg417Cys), the dbSNP ID is 368949613. [http://www.ncbi.nlm.nih.gov/clinvar/variation/30880/]. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="81255-2"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Binding not yet defined |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(genomic-dna-chg) | |
Definition | The name of a structural variant reported using HGVS nomenclature. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="81290-9"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Binding not yet defined |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(genomic-source-class) | |
Definition | The genomic class of the specimen being analyzed: Germline for inherited genome, somatic for cancer genome, and prenatal for fetal genome. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="48002-0"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | MG_2_Genetic variant source. |
Control | 1..1 |
Binding | Genomic source class values The codes SHALL be taken from http://loinc.org/vs/LL378-1 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(amino-acid-chg) | |
Definition | Human Genome Variation Society (HGVS) nomenclature for an amino acid sequence. This value is derivable from the DNA Marker value if available. It is provided for convenience. The use of the nomenclature must be extended to describe non-variations (aka. wild types) see samples for wild type examples. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="48005-3"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Binding not yet defined |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(amino-acid-chg-type) | |
Definition | Codified type for associated Amino Acid Marker. Amino Acid Marker's use the HGVS notation which implies the Amino Acid Marker Type, but the concurrent use of this code will allow a standard and explicit type for technical and display convenience. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="48006-1"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | MG_4_Amino acid change type. |
Control | 1..1 |
Binding | Amino acid change type values The codes SHALL be taken from http://loinc.org/vs/LL380-7 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(transcript-ref-seq) | |
Definition | This field carries the ID for the transcribed reference sequence, which is the part of the genomic reference sequence that is converted to messenger RNA (i.e., after the introns are removed). |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | Only needed if the transcript sequence or genomic reference sequence versions don't indicate the version. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="51958-7"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Binding not yet defined |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(genomic-ref-seq) | |
Definition | This field carries the ID for the genomic reference sequence. The genomic reference sequence is a contiguous stretch of chromosome DNA that spans all of the exons of the gene and includes transcribed and non transcribed stretches. For this ID use either the NCBI genomic nucleotide RefSeq IDs with their version number (see: NCBI.NLM.NIH.Gov/RefSeq) or use the LRG identifiers, without transcript (t or p) extensions -- when they become available. (See- Report sponsored by GEN2PHEN at the European Bioinformatics Institute at Hinxton UK April 24-25, 2008). The NCI RefSeq genomic IDs are distinguished by a prefix of"NG" for genes from the nuclear chromosomes and prefix of "NC" for genes from mitochondria. The LRG Identifiers have a prefix of "LRG_" Mitochondrial genes are not in the scope of LRG. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="48013-7"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Binding not yet defined |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(allelic-frequency) | |
Definition | Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | The allelic frequency is the relative frequency of a particular allele in the population, expressed as a number from 0 to 1. |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="81258-6"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Type | Quantity |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.value[x].value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 1..1 |
Type | decimal |
Must Support | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Observation.component.value[x].comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Control | 0..1 |
Binding | How the Quantity should be understood and represented. The codes SHALL be taken from QuantityComparator |
Type | code |
Is Modifier | true |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
Observation.component.value[x].unit | |
Definition | A human-readable form of the unit. |
Control | 0..1 |
Type | string |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Observation.component.value[x].system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 1..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Must Support | true |
Requirements | Need to know the system that defines the coded form of the unit. |
Fixed Value | http://unitsofmeasure.org |
Observation.component.value[x].code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Fixed Value | % |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(allelic-phase) | |
Definition | The period of stage of an allele. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="82120-7"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Allelic phase values The codes SHALL be taken from http://loinc.org/vs/LL4025-4 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(allelic-phase-basis) | |
Definition | The evidential basis on which the allelic phase and/or the allelic state was concluded. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="82309-6"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Allelic phase basis values The codes SHALL be taken from http://loinc.org/vs/LL4050-2 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(allelic-read-depth) | |
Definition | Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides. Different methods and purposes require different numbers of reads to be acceptable. Often >400, sometimes as few as 2-4. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="82121-5"/> </coding> </valueCodeableConcept> |
Observation.component.valueQuantity | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Type | Quantity(Count) |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Invariants | Defined on this element cnt-3: There SHALL be a code with a value of "1" if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM. If present, the value SHALL a whole number. (: (code.exists() or value.empty()) and (system.empty() or system = %ucum) and (code.empty() or code = '1') and (value.empty() or value.hasValue().not() or value.toString().contains('.').not())) qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists()) |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(allelic-state) | |
Definition | The level of occurrence of a single DNA Marker within a set of chromosomes. Heterozygous indicates the DNA Marker is only present in one of the two genes contained in homologous chromosomes. Homozygous indicates the DNA Marker is present in both genes contained in homologous chromosomes. Hemizygous indicates the DNA Marker exists in the only single copy of a gene in a non-homologous chromosome (The male X and Y chromosome are non-homologous). Hemiplasmic indicates that the DNA Marker is present in some but not all of the copies of mitochondrial DNA. Homoplasmic indicates that the DNA Maker is present in all of the copies of mitochondrial DNA. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="53034-5"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The relationship between the alleles found at the same locus on different chromosomes. |
Control | 1..1 |
Binding | Allelic state type values The codes SHALL be taken from http://loinc.org/vs/LL381-5 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(copy-number) | |
Definition | The copy number of the large variant. In HGVS, this is the numeric value following the “X”. It is a unit-less value. Note that a copy number of 1 implies a deletion. The copy number can usually be inferred from the HGVS or ISCN fields. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="82155-3"/> </coding> </valueCodeableConcept> |
Observation.component.valueQuantity | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Type | Quantity(Count) |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Invariants | Defined on this element cnt-3: There SHALL be a code with a value of "1" if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM. If present, the value SHALL a whole number. (: (code.exists() or value.empty()) and (system.empty() or system = %ucum) and (code.empty() or code = '1') and (value.empty() or value.hasValue().not() or value.toString().contains('.').not())) qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists()) |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(arrCGH-ratio) | |
Definition | todo. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="81299-0"/> </coding> </valueCodeableConcept> |
Observation.component.valueQuantity | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists()) sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty()) |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(ref-allele) | |
Definition | Reference values ("normal") examined within the Reference Sequence. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | This is used in a genotyping test to define the reference and variable nucleotide strings. That is if the sequence variation is an insertion, then Reference Nucleotide will be blank and Variable Nucleotide will contain the inserted nucleotides. In contrast, if the sequence variation is a deletion, then the Reference Nucleotide will contain the deleted nucliotieds, and the Variable Nucleotide will be blank. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="69547-8"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(alt-allele) | |
Definition | The genomic alternate allele is the contiguous segment of DNA in the test sample that differs from the reference allele at the same location and thus defines a variant. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="69551-0"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(coordinate-system) | |
Definition | Base number of coordinate system (0 for 0-based numbering or interbase coordinate system, inclusive start, exclusive end, 1 for 1-based numbering or base coordinate system, inclusive start, inclusive end). |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="TBD"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Binding | Base coordinate systems start and end measurements for variants The codes SHALL be taken from GeneticCoordinateSystem |
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(allele-start-end) | |
Definition | The genomic allele location is the first genomic position in the reference allele that contains a change from the reference allele. For example, for the simple variant NM_014049.4(ACAD9):c.1249C>T (p.Arg417Cys), the genomic allele location is Chr3: 128906220 on Assembly GRCh38. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="81254-5"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Type | Range |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.value[x].low | |
Definition | The low limit. The boundary is inclusive. |
Control | 1..1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Comments | If the low element is missing, the low boundary is not known. |
Observation.component.value[x].high | |
Definition | The high limit. The boundary is inclusive. |
Control | 1..1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Comments | If the high element is missing, the high boundary is not known. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(variant-length) | |
Definition | Length of the structural variant, which information may be ascertained in some but not all types of structural variants. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="81300-6"/> </coding> </valueCodeableConcept> |
Observation.component.valueQuantity | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Type | Quantity(Count) |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Invariants | Defined on this element cnt-3: There SHALL be a code with a value of "1" if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM. If present, the value SHALL a whole number. (: (code.exists() or value.empty()) and (system.empty() or system = %ucum) and (code.empty() or code = '1') and (value.empty() or value.hasValue().not() or value.toString().contains('.').not())) qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists()) |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(outer-start-end) | |
Definition | The genomic coordinates of the widest genomic range in which the structural variant might reside. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="81301-4"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Type | Range |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.value[x].low | |
Definition | The low limit. The boundary is inclusive. |
Control | 1..1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Comments | If the low element is missing, the low boundary is not known. |
Observation.component.value[x].high | |
Definition | The high limit. The boundary is inclusive. |
Control | 1..1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Comments | If the high element is missing, the high boundary is not known. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |
Observation.component(inner-start-end) | |
Definition | The genomic coordinates of the narrowest genomic range in which the structural variant might reside. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Control | 1..1 |
Binding | Codes identifying names of simple observations. For example codes, see LOINC Codes |
Type | CodeableConcept |
Must Support | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="81302-2"/> </coding> </valueCodeableConcept> |
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 |
Type | Range |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was 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 additional guidance, see the Notes section below. |
Observation.component.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Observation.component.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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.component.value[x].low | |
Definition | The low limit. The boundary is inclusive. |
Control | 1..1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Comments | If the low element is missing, the low boundary is not known. |
Observation.component.value[x].high | |
Definition | The high limit. The boundary is inclusive. |
Control | 1..1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Comments | If the high element is missing, the high boundary is not known. |
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Control | 0..1 This element is affected by the following invariants: obs-6 |
Binding | Codes specifying why the result (`Observation.value[x]`) is missing. The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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.component.interpretation | |
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. |
Control | 0..1 |
Binding | Codes identifying interpretations of observations. The codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | The component interpretation applies only to the individual component value. For an overall interpretation all components together use the Observation.interpretation element. |
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Control | 0..* |
Type | See Observation.referenceRange |
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 might 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. |