VitalParameter
Innerhalb der Deutschen Basisprofile werden Profile für den Ressourcen-Typ 'Observation' spezifiziert welche genutzt werden können um Vitalparameter und Körpermaße zu kodieren.
Diese Profile sind angelehnt an die Internationlen VitalSign Profile enthalten jedoch technische Korrekturen (Verbessertes Slicing und korrigierte FHIRPath-Expressions) oder Einschränkungen auf in Deutschland gebräuchliche Maßeinheiten.
Folgende Observation-Profile wurden in diesem Zusammenhang abgestimmt:
Weitere Details sind der jeweiligen verlinkten Unterseite zu entnehmen.
Kompatibilität zu den internationalen Vitalparameter Profilen
Im folgenden wird die Kompatibilität zu den internationalen VitalSign Profilen fein granuliert erläutert.
Bedeutung der Kompatibilität
Abwärtskompatibel: International VitalSigns -> Vitalparameter Basisprofil
Aufwärtskompatibel: Vitalparameter Basisprofil -> International Vitalsigns
Kopfumfang
- Unterschied: Binding von
valueQuantity.code
auf 'http://fhir.de/ValueSet/VitalSignDE_Body_Length_UCUM' anstatt 'http://hl7.org/fhir/ValueSet/ucum-bodylength'- Erklärung: Dieses Binding beschränkt den Code auf die in Deutschland üblicherweise verwendete Maßeinheit 'cm'
- Abwärtskompatibel: Nicht abwärtskompatibel bei Verwendung der Maßeinheit '[in_i]'
- Aufwärtskompatibel: Ja
Körpergewicht
- Unterschied: Binding von
Observation.code
auf 'http://fhir.de/ValueSet/VitalSignDE_Body_Weight_Loinc' anstatt fixed value 'http://loinc.org|29463-7'- Erklärung: Dieses geänderte Binding und das Eliminieren des fixed values ermöglicht es, auch das Gewicht bei der Geburt spezifisch zu erfassen
- Abwärtskompatibel: Nur bei Verwendung des LOINC Codes '29463-7'
- Aufwärtskompatibel: Ja
- Unterschied: Binding von
Observation.valueQuantity.code
auf 'http://fhir.de/ValueSet/VitalSignDE_Body_Weigth_UCUM'- Erklärung: Dieses Binding beschränkt die Codes auf die in Deutschland üblicherweise verwendeten Maßeinheiten 'kg' und 'g'
- Abwärtskompatibel: Nur bei Verwendung der Codes 'kg' oder 'g'
- Aufwärtskompatibel: Ja
Körperlänge/Körpergröße
- Unterschied: Binding von
Observation.code.coding:loinc
auf 'http://fhir.de/ValueSet/VitalSignDE_Body_Height_Loinc' anstatt fixed value 'http://loinc.org|8302-2'- Erklärung: Dieses geänderte Binding und das Eliminieren des fixed values ermöglicht es, auch die Größe bei der Geburt spezifisch zu erfassen
- Abwärtskompatibel: Ja
- Aufwärtskompatibel: Nur bei Verwendung des Codes '8302-2'
- Unterschied: Binding von
Observation.valueQuantity.code
auf 'http://fhir.de/ValueSet/VitalSignDE_Body_Length_UCUM'- Erklärung: Dieses Binding beschränkt die Codes auf die in Deutschland üblicherweise verwendeten Maßeinheiten 'cm' und 'm'
- Abwärtskompatibel: Nur bei Verwendung der Codes 'cm' oder 'm'
- Aufwärtskompatibel: Ja
Körpertemperatur
- Unterschied: Pattern anstatt fixed value auf
Observation.code.coding:loinc
- Erklärung: Dies erlaubt Extensions auf dem Element
- Abwärtskompatibel: Ja
- Aufwärtskompatibel: Ja, falls keine Extension verwendet wurde
- Unterschied: Pattern 'cel' auf
Observation.valueQuantity.code
- Erklärung: Dies lässt nur die in Deutschland üblicherweise verwendete Einheit Celsius zu
- Abwärtskompatibel: Nur bei Verwendung des Codes 'cel'
- Aufwärtskompatibel: Ja
Blutdruck
- Unterschied: Pattern anstatt fixed values auf alle fixed values des Diffs
- Erklärung: Dies erlaubt Extensions auf den Elementen
- Abwärtskompatibel: Ja
- Aufwärtskompatibel: Ja, falls keine Extension verwendet wurde
- Unterschied: Zusätzlicher Slice
component:meanB
für den durchschnittlichen Blutdruck- Erklärung: Erlaubt das Erfassen des durchschnittlichen Blutdrucks, stellt aber keine Inkompatibilität zum internationalen Profil dar da der Slice nicht verpflichtend ist
- Abwärtskompatibel: Ja
- Aufwärtskompatibel: Ja
Periphere Arterielle Sauerstoffsättigung
- Unterschied: Pattern anstatt fixed values auf
Observation.code.coding
sowieObservation.valueQuantity
- Erklärung: Dies erlaubt Extensions auf den Elementen
- Abwärtskompatibel: Ja
- Aufwärtskompatibel: Ja, falls keine Extension verwendet wurde
Atemfrequenz
- Unterschied: Pattern anstatt fixed values auf
Observation.code.coding
sowieObservation.valueQuantity
- Erklärung: Dies erlaubt Extensions auf den Elementen
- Abwärtskompatibel: Ja
- Aufwärtskompatibel: Ja, falls keine Extension verwendet wurde
Herzfrequenz
- Unterschied: Pattern anstatt fixed values auf
Observation.code.coding
sowieObservation.valueQuantity
- Erklärung: Dies erlaubt Extensions auf den Elementen
- Abwärtskompatibel: Ja
- Aufwärtskompatibel: Ja, falls keine Extension verwendet wurde
Kopfumfang
Name: VitalSignDE_Kopfumfang (Simplifier Projekt Link)
Canonical: http://fhir.de/StructureDefinition/observation-de-vitalsign-kopfumfang
Observation | I | Observation | There are no (further) constraints on this element Element IdObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element IdObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element IdObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. ObservationStatus (required)Constraints
|
category | 1..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Unordered, Open, by $this(Pattern) BindingCodes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
| |
vs-cat | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category:vs-cat Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] }
| |
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. 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. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
coding | Σ | 1..* | Coding | Element IdObservation.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "9843-4" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | Σ I | 1..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element IdObservation.subject Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also 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. 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
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
|
effective[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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. Unordered, Open, by $this(Type) Constraints
| |
effectivePeriod | Period | There are no (further) constraints on this element Data Type | ||
effectiveTiming | Timing | There are no (further) constraints on this element Data Type | ||
effectiveInstant | instant | There are no (further) constraints on this element Data Type | ||
effectiveDateTime | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdObservation.effective[x]:effectiveDateTime Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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.
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element IdObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ I | 0..1 | QuantityBinding | Element IdObservation.value[x]:valueQuantity Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. VitalSignDE_Body_Length_UCUM (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. 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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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 bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (example)Constraints
| |
specimen | I | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element IdObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element IdObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two 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. 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.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.low Low Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.high High Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdObservation.referenceRange.appliesTo Reference range population DefinitionCodes 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. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element IdObservation.referenceRange.age Applicable age range, if relevant DefinitionThe 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. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element IdObservation.referenceRange.text Text based reference range in an observation DefinitionText 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". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.hasMember Related resource that belongs to the Observation group DefinitionThis 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. 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. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.derivedFrom Related measurements the observation is made from DefinitionThe 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. 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. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.component Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Σ | 0..1 | QuantityBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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 xmlns="http://hl7.org/fhir"> <id value="Example-observation-kopfumfang" /> <meta> <profile value="http://hl7.org/fhir/StructureDefinition/headcircum" /> <profile value="http://fhir.de/StructureDefinition/observation-de-vitalsign-kopfumfang" /> </meta> <status value="final" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/observation-category" /> <code value="vital-signs" /> <display value="Vital Signs" /> </coding> <text value="Vital Signs" /> </category> <code> <coding> <system value="http://loinc.org" /> <code value="9843-4" /> <display value="Head Occipital-frontal circumference" /> </coding> <text value="Kopfumfang" /> </code> <subject> <reference value="Patient/example" /> </subject> <effectiveDateTime value="2019-07-02" /> <valueQuantity> <value value="38" /> <unit value="Centimeter" /> <system value="http://unitsofmeasure.org" /> <code value="cm" /> </valueQuantity> </Observation>
Körpergewicht
Name: VitalSignDE_Koerpergewicht (Simplifier Projekt Link
Canonical: http://fhir.de/StructureDefinition/observation-de-vitalsign-koerpergewicht
Observation | I | Observation | There are no (further) constraints on this element Element IdObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element IdObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element IdObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. ObservationStatus (required)Constraints
|
category | 1..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Unordered, Open, by $this(Pattern) BindingCodes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
| |
vs-cat | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category:vs-cat Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] }
| |
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. 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. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
coding | Σ | 1..* | Coding | Element IdObservation.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | CodingBinding | Element IdObservation.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. VitalSignDE_Body_Weight_Loinc (required) Constraints
|
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.code.coding:loinc.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.coding:loinc.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.code.coding:loinc.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.coding:loinc.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdObservation.code.coding:loinc.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | Σ I | 1..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element IdObservation.subject Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also 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. 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
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
|
effective[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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. Unordered, Open, by $this(Type) Constraints
| |
effectivePeriod | Period | There are no (further) constraints on this element Data Type | ||
effectiveTiming | Timing | There are no (further) constraints on this element Data Type | ||
effectiveInstant | instant | There are no (further) constraints on this element Data Type | ||
effectiveDateTime | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdObservation.effective[x]:effectiveDateTime Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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.
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element IdObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ I | 0..1 | QuantityBinding | Element IdObservation.value[x]:valueQuantity Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. VitalSignDE_Body_Weigth_UCUM (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. 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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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 bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (example)Constraints
| |
specimen | I | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element IdObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element IdObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two 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. 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.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.low Low Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.high High Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdObservation.referenceRange.appliesTo Reference range population DefinitionCodes 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. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element IdObservation.referenceRange.age Applicable age range, if relevant DefinitionThe 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. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element IdObservation.referenceRange.text Text based reference range in an observation DefinitionText 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". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.hasMember Related resource that belongs to the Observation group DefinitionThis 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. 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. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.derivedFrom Related measurements the observation is made from DefinitionThe 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. 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. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.component Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Σ | 0..1 | QuantityBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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 xmlns="http://hl7.org/fhir"> <id value="Example-observation-koerpergewicht" /> <meta> <profile value="http://fhir.de/StructureDefinition/observation-de-vitalsign-koerpergewicht" /> <profile value="http://hl7.org/fhir/StructureDefinition/bodyweight" /> </meta> <status value="final" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/observation-category" /> <code value="vital-signs" /> </coding> </category> <code> <coding> <system value="http://loinc.org" /> <code value="29463-7" /> <display value="Body weight" /> </coding> <coding> <system value="http://snomed.info/sct" /> <code value="27113001" /> <display value="Body weight" /> </coding> <text value="Körpergewicht" /> </code> <subject> <reference value="Patient/example" /> </subject> <effectiveDateTime value="2020-10-11" /> <valueQuantity> <value value="79" /> <unit value="kilogram" /> <system value="http://unitsofmeasure.org" /> <code value="kg" /> </valueQuantity> </Observation>
Körperlänge/Körpergröße
Name: VitalSignDE_Koerpergroesse (Simplifier Projekt Link
Canonical: http://fhir.de/StructureDefinition/observation-de-vitalsign-koerpergroesse
Observation | I | Observation | There are no (further) constraints on this element Element IdObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element IdObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element IdObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. ObservationStatus (required)Constraints
|
category | 1..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Unordered, Open, by $this(Pattern) BindingCodes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
| |
vs-cat | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category:vs-cat Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] }
| |
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. 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. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
coding | Σ | 1..* | Coding | Element IdObservation.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | CodingBinding | Element IdObservation.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. ValueSetVitalSignDE_Body_Height_Loinc (required) Constraints
|
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.code.coding:loinc.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.coding:loinc.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.code.coding:loinc.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.coding:loinc.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdObservation.code.coding:loinc.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | Σ I | 1..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element IdObservation.subject Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also 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. 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
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
|
effective[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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. Unordered, Open, by $this(Type) Constraints
| |
effectivePeriod | Period | There are no (further) constraints on this element Data Type | ||
effectiveTiming | Timing | There are no (further) constraints on this element Data Type | ||
effectiveInstant | instant | There are no (further) constraints on this element Data Type | ||
effectiveDateTime | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdObservation.effective[x]:effectiveDateTime Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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.
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element IdObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ I | 0..1 | QuantityBinding | Element IdObservation.value[x]:valueQuantity Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. VitalSignDE_Body_Length_UCUM (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. 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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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 bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (example)Constraints
| |
specimen | I | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element IdObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element IdObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two 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. 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.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.low Low Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.high High Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdObservation.referenceRange.appliesTo Reference range population DefinitionCodes 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. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element IdObservation.referenceRange.age Applicable age range, if relevant DefinitionThe 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. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element IdObservation.referenceRange.text Text based reference range in an observation DefinitionText 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". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.hasMember Related resource that belongs to the Observation group DefinitionThis 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. 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. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.derivedFrom Related measurements the observation is made from DefinitionThe 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. 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. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.component Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Σ | 0..1 | QuantityBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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 xmlns="http://hl7.org/fhir"> <id value="Example-observation-koerpergroesse" /> <meta> <profile value="http://fhir.de/StructureDefinition/observation-de-vitalsign-koerpergroesse" /> <profile value="http://hl7.org/fhir/StructureDefinition/bodyheight" /> </meta> <status value="final" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/observation-category" /> <code value="vital-signs" /> </coding> </category> <code> <coding> <system value="http://loinc.org" /> <code value="8302-2" /> <display value="Body height" /> </coding> <coding> <system value="http://snomed.info/sct" /> <code value="50373000" /> <display value="Body height measure" /> </coding> <text value="Körpergröße" /> </code> <subject> <reference value="Patient/example" /> </subject> <effectiveDateTime value="2020-10-11" /> <valueQuantity> <value value="174" /> <unit value="centimeter" /> <system value="http://unitsofmeasure.org" /> <code value="cm" /> </valueQuantity> </Observation>
Körpertemperatur
Name: VitalSignDE_Koerpertemperatur (Simplifier Projekt Link)
Canonical: http://fhir.de/StructureDefinition/observation-de-vitalsign-koerpertemperatur
Observation | I | Observation | There are no (further) constraints on this element Element IdObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element IdObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element IdObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. ObservationStatus (required)Constraints
|
category | 1..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Unordered, Open, by $this(Pattern) BindingCodes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
| |
vs-cat | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category:vs-cat Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] }
| |
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. 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. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
coding | Σ | 1..* | Coding | Element IdObservation.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "8310-5" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | Σ I | 1..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element IdObservation.subject Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also 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. 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
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
|
effective[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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. Unordered, Open, by $this(Type) Constraints
| |
effectivePeriod | Period | There are no (further) constraints on this element Data Type | ||
effectiveTiming | Timing | There are no (further) constraints on this element Data Type | ||
effectiveInstant | instant | There are no (further) constraints on this element Data Type | ||
effectiveDateTime | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdObservation.effective[x]:effectiveDateTime Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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.
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element IdObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ I | 0..1 | QuantityBinding | Element IdObservation.value[x]:valueQuantity Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "Cel" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. 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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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 bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (example)Constraints
| |
specimen | I | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element IdObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element IdObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two 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. 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.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.low Low Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.high High Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdObservation.referenceRange.appliesTo Reference range population DefinitionCodes 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. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element IdObservation.referenceRange.age Applicable age range, if relevant DefinitionThe 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. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element IdObservation.referenceRange.text Text based reference range in an observation DefinitionText 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". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.hasMember Related resource that belongs to the Observation group DefinitionThis 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. 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. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.derivedFrom Related measurements the observation is made from DefinitionThe 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. 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. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.component Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Σ | 0..1 | QuantityBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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 xmlns="http://hl7.org/fhir"> <id value="Example-observation-koerpertemperatur" /> <meta> <profile value="http://fhir.de/StructureDefinition/observation-de-vitalsign-koerpertemperatur" /> <profile value="http://hl7.org/fhir/StructureDefinition/bodytemp" /> </meta> <status value="final" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/observation-category" /> <code value="vital-signs" /> </coding> </category> <code> <coding> <system value="http://loinc.org" /> <code value="8310-5" /> <display value="Body temperature" /> </coding> <coding> <system value="http://snomed.info/sct" /> <code value="386725007" /> <display value="Body temperature (observable entity)" /> </coding> <text value="Körpertemperatur" /> </code> <subject> <reference value="Patient/example" /> </subject> <effectiveDateTime value="2020-10-11" /> <valueQuantity> <value value="36.8" /> <unit value="°C" /> <system value="http://unitsofmeasure.org" /> <code value="Cel" /> </valueQuantity> </Observation>
Blutdruck
Name: VitalSignDE_Blutdruck (Simplifier Projekt Link)
Canonical: http://fhir.de/StructureDefinition/observation-de-vitalsign-blutdruck
Observation | I | Observation | There are no (further) constraints on this element Element IdObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element IdObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element IdObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. ObservationStatus (required)Constraints
|
category | 1..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Unordered, Open, by $this(Pattern) BindingCodes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
| |
vs-cat | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category:vs-cat Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] }
| |
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. 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. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
coding | Σ | 1..* | Coding | Element IdObservation.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "85354-9" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | Σ I | 1..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element IdObservation.subject Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also 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. 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
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
|
effective[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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. Unordered, Open, by $this(Type) Constraints
| |
effectivePeriod | Period | There are no (further) constraints on this element Data Type | ||
effectiveTiming | Timing | There are no (further) constraints on this element Data Type | ||
effectiveInstant | instant | There are no (further) constraints on this element Data Type | ||
effectiveDateTime | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdObservation.effective[x]:effectiveDateTime Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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.
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 0..0 | There are no (further) constraints on this element Element IdObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. Unordered, Open, by $this(Type) Constraints
| |
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. 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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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 bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (example)Constraints
| |
specimen | I | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element IdObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element IdObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two 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. 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.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.low Low Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.high High Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdObservation.referenceRange.appliesTo Reference range population DefinitionCodes 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. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element IdObservation.referenceRange.age Applicable age range, if relevant DefinitionThe 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. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element IdObservation.referenceRange.text Text based reference range in an observation DefinitionText 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". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.hasMember Related resource that belongs to the Observation group DefinitionThis 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. 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. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.derivedFrom Related measurements the observation is made from DefinitionThe 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. 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. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ I | 2..* | BackboneElement | Element IdObservation.component Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below. Unordered, Open, by code(Pattern) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Σ | 0..1 | QuantityBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
SystolicBP | Σ I | 1..1 | BackboneElement | There are no (further) constraints on this element Element IdObservation.component:SystolicBP Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | Element IdObservation.component:SystolicBP.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
{ "coding": [ { "system": "http://loinc.org", "code": "8480-6" } ] }
|
coding | Σ | 1..* | Coding | Element IdObservation.component:SystolicBP.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.component:SystolicBP.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "8480-6" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.component:SystolicBP.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component:SystolicBP.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityBinding | Element IdObservation.component:SystolicBP.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "mm[Hg]" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component:SystolicBP.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component:SystolicBP.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component:SystolicBP.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component:SystolicBP.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component:SystolicBP.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:SystolicBP.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:SystolicBP.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component:SystolicBP.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
DiastolicBP | Σ I | 1..1 | BackboneElement | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | Element IdObservation.component:DiastolicBP.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
{ "coding": [ { "system": "http://loinc.org", "code": "8462-4" } ] }
|
coding | Σ | 1..* | Coding | Element IdObservation.component:DiastolicBP.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.component:DiastolicBP.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "8462-4" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityBinding | Element IdObservation.component:DiastolicBP.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "mm[Hg]" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component:DiastolicBP.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
meanBP | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdObservation.component:meanBP Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | Element IdObservation.component:meanBP.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
{ "coding": [ { "system": "http://loinc.org", "code": "8478-0" } ] }
|
coding | Σ | 1..* | Coding | Element IdObservation.component:meanBP.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.component:meanBP.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "8478-0" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.component:meanBP.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component:meanBP.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityBinding | Element IdObservation.component:meanBP.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "mm[Hg]" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component:meanBP.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component:meanBP.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component:meanBP.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component:meanBP.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component:meanBP.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:meanBP.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:meanBP.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component:meanBP.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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 xmlns="http://hl7.org/fhir"> <id value="Example-observation-blutdruck" /> <meta> <profile value="http://hl7.org/fhir/StructureDefinition/vitalsigns" /> <profile value="http://fhir.de/StructureDefinition/observation-de-vitalsign-blutdruck" /> </meta> <status value="final" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/observation-category" /> <code value="vital-signs" /> <display value="Vital Signs" /> </coding> </category> <code> <coding> <system value="http://loinc.org" /> <code value="85354-9" /> <display value="Blood pressure panel with all children optional" /> </coding> <text value="Systolischer und Diastolischer Blutdruck" /> </code> <subject> <reference value="Patient/example" /> </subject> <effectiveDateTime value="2012-09-17" /> <performer> <reference value="Practitioner/example" /> </performer> <interpretation> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation" /> <code value="L" /> <display value="low" /> </coding> <text value="Below low normal" /> </interpretation> <bodySite> <coding> <system value="http://snomed.info/sct" /> <code value="368209003" /> <display value="Right arm" /> </coding> </bodySite> <component> <code> <coding> <system value="http://loinc.org" /> <code value="8480-6" /> <display value="Systolic blood pressure" /> </coding> </code> <valueQuantity> <value value="107" /> <unit value="mmHg" /> <system value="http://unitsofmeasure.org" /> <code value="mm[Hg]" /> </valueQuantity> </component> <component> <code> <coding> <system value="http://loinc.org" /> <code value="8462-4" /> <display value="Diastolic blood pressure" /> </coding> </code> <valueQuantity> <value value="60" /> <unit value="mmHg" /> <system value="http://unitsofmeasure.org" /> <code value="mm[Hg]" /> </valueQuantity> </component> </Observation>
Periphere Artierielle Sauerstoffsättigung
Name: VitalSignDE_Periphere_Artierielle_Sauerstoffsaettigung (Simplifier Projekt Link)
Canonical: http://fhir.de/StructureDefinition/observation-de-vitalsign-sauerstoffsaettigung
Observation | I | Observation | There are no (further) constraints on this element Element IdObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element IdObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element IdObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. ObservationStatus (required)Constraints
|
category | 1..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Unordered, Open, by $this(Pattern) BindingCodes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
| |
vs-cat | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category:vs-cat Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] }
| |
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. 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. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
coding | Σ | 1..* | Coding | Element IdObservation.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "2708-6" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | Σ I | 1..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element IdObservation.subject Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also 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. 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
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
|
effective[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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. Unordered, Open, by $this(Type) Constraints
| |
effectivePeriod | Period | There are no (further) constraints on this element Data Type | ||
effectiveTiming | Timing | There are no (further) constraints on this element Data Type | ||
effectiveInstant | instant | There are no (further) constraints on this element Data Type | ||
effectiveDateTime | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdObservation.effective[x]:effectiveDateTime Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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.
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element IdObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ I | 0..1 | QuantityBinding | Element IdObservation.value[x]:valueQuantity Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "%" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. 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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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 bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (example)Constraints
| |
specimen | I | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element IdObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element IdObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two 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. 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.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.low Low Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.high High Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdObservation.referenceRange.appliesTo Reference range population DefinitionCodes 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. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element IdObservation.referenceRange.age Applicable age range, if relevant DefinitionThe 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. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element IdObservation.referenceRange.text Text based reference range in an observation DefinitionText 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". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.hasMember Related resource that belongs to the Observation group DefinitionThis 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. 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. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.derivedFrom Related measurements the observation is made from DefinitionThe 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. 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. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.component Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Σ | 0..1 | QuantityBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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 xmlns="http://hl7.org/fhir"> <id value="Example-observation-sauerstoffsaettigung" /> <meta> <profile value="http://fhir.de/StructureDefinition/observation-de-vitalsign-sauerstoffsaettigung" /> </meta> <status value="final" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/observation-category" /> <code value="vital-signs" /> </coding> </category> <code> <coding> <system value="http://loinc.org" /> <code value="2708-6" /> <display value="Oxygen saturation in Arterial blood" /> </coding> <coding> <system value="http://snomed.info/sct" /> <code value="442476006" /> <display value="Arterial oxygen saturation" /> </coding> <coding> <system value="http://loinc.org" /> <code value="59408-5" /> <display value="Oxygen saturation in Arterial blood by Pulse oximetry" /> </coding> <text value="Pulsoximetrische Sauerstoffsättigung" /> </code> <subject> <reference value="Patient/example" /> </subject> <effectiveDateTime value="2020-10-11" /> <valueQuantity> <value value="98" /> <unit value="%" /> <system value="http://unitsofmeasure.org" /> <code value="%" /> </valueQuantity> <component> <code> <coding> <system value="http://loinc.org" /> <code value="3151-8" /> <display value="Inhaled oxygen flow rate" /> </coding> <coding> <system value="http://snomed.info/sct" /> <code value="427081008" /> <display value="Delivered oxygen flow rate" /> </coding> <text value="Sauerstoffflussrate" /> </code> <valueQuantity> <value value="2" /> <unit value="Liter pro Minute" /> <system value="http://unitsofmeasure.org" /> <code value="L/min" /> </valueQuantity> </component> <component> <code> <coding> <system value="http://loinc.org" /> <code value="3150-0" /> <display value="Inhaled oxygen concentration" /> </coding> <coding> <system value="http://snomed.info/sct" /> <code value="250774007" /> <display value="Inspired oxygen concentration" /> </coding> <text value="Inspiratorische Sauerstoffkonzentration" /> </code> <valueQuantity> <value value="50" /> <unit value="%" /> <system value="http://unitsofmeasure.org" /> <code value="%" /> </valueQuantity> </component> </Observation>
Atemfrequenz
Name: VitalSignDE_Atemfrequenz (Simplifier Projekt Link)
Canonical: http://fhir.de/StructureDefinition/observation-de-vitalsign-atemfrequenz
Observation | I | Observation | There are no (further) constraints on this element Element IdObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element IdObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element IdObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. ObservationStatus (required)Constraints
|
category | 1..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Unordered, Open, by $this(Pattern) BindingCodes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
| |
vs-cat | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category:vs-cat Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] }
| |
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. 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. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
coding | Σ | 1..* | Coding | Element IdObservation.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "9279-1" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | Σ I | 1..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element IdObservation.subject Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also 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. 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
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
|
effective[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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. Unordered, Open, by $this(Type) Constraints
| |
effectivePeriod | Period | There are no (further) constraints on this element Data Type | ||
effectiveTiming | Timing | There are no (further) constraints on this element Data Type | ||
effectiveInstant | instant | There are no (further) constraints on this element Data Type | ||
effectiveDateTime | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdObservation.effective[x]:effectiveDateTime Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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.
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element IdObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ I | 0..1 | QuantityBinding | Element IdObservation.value[x]:valueQuantity Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "/min" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. 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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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 bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (example)Constraints
| |
specimen | I | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element IdObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element IdObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two 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. 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.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.low Low Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.high High Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdObservation.referenceRange.appliesTo Reference range population DefinitionCodes 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. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element IdObservation.referenceRange.age Applicable age range, if relevant DefinitionThe 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. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element IdObservation.referenceRange.text Text based reference range in an observation DefinitionText 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". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.hasMember Related resource that belongs to the Observation group DefinitionThis 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. 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. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.derivedFrom Related measurements the observation is made from DefinitionThe 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. 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. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.component Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Σ | 0..1 | QuantityBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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 xmlns="http://hl7.org/fhir"> <id value="Example-observation-atemfrequenz" /> <meta> <profile value="http://hl7.org/fhir/StructureDefinition/resprate" /> <profile value="http://fhir.de/StructureDefinition/observation-de-vitalsign-atemfrequenz" /> </meta> <status value="final" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/observation-category" /> <code value="vital-signs" /> <display value="Vital Signs" /> </coding> <text value="Vital Signs" /> </category> <code> <coding> <system value="http://loinc.org" /> <code value="9279-1" /> <display value="Respiratory rate" /> </coding> <text value="Atemfrequenz" /> </code> <subject> <reference value="Patient/example" /> </subject> <effectiveDateTime value="2019-07-02" /> <valueQuantity> <value value="26" /> <unit value="Atemzüge pro Minute" /> <system value="http://unitsofmeasure.org" /> <code value="/min" /> </valueQuantity> </Observation>
Herzfrequenz
Name: VitalSignDE_Herzfrequenz (Simplifier Projekt Link)
Canonical: http://fhir.de/StructureDefinition/observation-de-vitalsign-herzfrequenz
Observation | I | Observation | There are no (further) constraints on this element Element IdObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element IdObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element IdObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. ObservationStatus (required)Constraints
|
category | 1..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Unordered, Open, by $this(Pattern) BindingCodes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
| |
vs-cat | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category:vs-cat Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] }
| |
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. 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. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
coding | Σ | 1..* | Coding | Element IdObservation.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "8867-4" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | Σ I | 1..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element IdObservation.subject Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also 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. 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
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
|
effective[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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. Unordered, Open, by $this(Type) Constraints
| |
effectivePeriod | Period | There are no (further) constraints on this element Data Type | ||
effectiveTiming | Timing | There are no (further) constraints on this element Data Type | ||
effectiveInstant | instant | There are no (further) constraints on this element Data Type | ||
effectiveDateTime | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdObservation.effective[x]:effectiveDateTime Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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.
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element IdObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ I | 0..1 | QuantityBinding | Element IdObservation.value[x]:valueQuantity Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "/min" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. 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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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 bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (example)Constraints
| |
specimen | I | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element IdObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element IdObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two 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. 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.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.low Low Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.high High Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdObservation.referenceRange.appliesTo Reference range population DefinitionCodes 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. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element IdObservation.referenceRange.age Applicable age range, if relevant DefinitionThe 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. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element IdObservation.referenceRange.text Text based reference range in an observation DefinitionText 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". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.hasMember Related resource that belongs to the Observation group DefinitionThis 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. 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. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.derivedFrom Related measurements the observation is made from DefinitionThe 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. 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. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.component Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Σ | 0..1 | QuantityBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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 xmlns="http://hl7.org/fhir"> <id value="Example-observation-herzfrequenz" /> <meta> <profile value="http://fhir.de/StructureDefinition/observation-de-vitalsign-herzfrequenz" /> <profile value="http://hl7.org/fhir/StructureDefinition/heartrate" /> </meta> <status value="final" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/observation-category" /> <code value="vital-signs" /> </coding> </category> <code> <coding> <system value="http://loinc.org" /> <code value="8867-4" /> <display value="Heart rate" /> </coding> <coding> <system value="http://snomed.info/sct" /> <code value="364075005" /> <display value="Heart rate (observable entity)" /> </coding> <text value="Herzfrequenz" /> </code> <subject> <reference value="Patient/example" /> </subject> <effectiveDateTime value="2020-10-11" /> <valueQuantity> <value value="63" /> <unit value="per minute" /> <system value="http://unitsofmeasure.org" /> <code value="/min" /> </valueQuantity> </Observation>
Glasgow Coma Scale
Hinweis | Standard Level: Draft! |
---|---|
Der nachfolgende Abschnitt des Implementierungsleitfadens wird als nicht vollständig genug oder nicht ausreichend geprüft angesehen, um ausschließen zu können, dass zukünftige Versionen rückwärtskompatibel bleiben. Im Anschluss an eine Ballotierung wird der Status in der Regel auf "Trial-Use" angehoben. Wir bitten hierzu um Meinungen und Vorschläge aus der Community. |
Name: VitalSignDE_GCS (Simplifier Projekt Link)
Canonical: http://fhir.de/StructureDefinition/observation-de-vitalsign-gcs
Observation | I | Observation | There are no (further) constraints on this element Element IdObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced.
|
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element IdObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | There are no (further) constraints on this element Element IdObservation.partOf Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. ObservationStatus (required)Constraints
|
category | 1..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Unordered, Open, by $this(Pattern) BindingCodes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
| |
vs-cat | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.category:vs-cat Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred)Constraints
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] }
| |
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. 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. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
coding | Σ | 1..* | Coding | Element IdObservation.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "9269-2" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | Σ I | 1..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element IdObservation.subject Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdObservation.focus What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also 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. 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
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdObservation.encounter Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
|
effective[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.effective[x] Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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. Unordered, Open, by $this(Type) Constraints
| |
effectivePeriod | Period | There are no (further) constraints on this element Data Type | ||
effectiveTiming | Timing | There are no (further) constraints on this element Data Type | ||
effectiveInstant | instant | There are no (further) constraints on this element Data Type | ||
effectiveDateTime | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdObservation.effective[x]:effectiveDateTime Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe 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. Knowing when an observation was deemed true is important to its relevance as well as determining trends. 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.
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdObservation.issued Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Constraints
|
value[x] | Σ I | 1..1 | There are no (further) constraints on this element Element IdObservation.value[x] Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ I | 1..1 | QuantityBinding | Element IdObservation.value[x]:valueQuantity Actual result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "1" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. 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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdObservation.note Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.
| |
bodySite | 0..0 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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 bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (example)Constraints
| |
specimen | I | 0..0 | Reference(Specimen) | There are no (further) constraints on this element Element IdObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in
|
device | I | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element IdObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two 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. 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.
|
low | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.low Low Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
high | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdObservation.referenceRange.high High Range, if relevant DefinitionThe 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). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdObservation.referenceRange.appliesTo Reference range population DefinitionCodes 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. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element IdObservation.referenceRange.age Applicable age range, if relevant DefinitionThe 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. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
text | 0..1 | string | There are no (further) constraints on this element Element IdObservation.referenceRange.text Text based reference range in an observation DefinitionText 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". Note that FHIR strings SHALL NOT exceed 1MB in size
| |
hasMember | Σ I | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.hasMember Related resource that belongs to the Observation group DefinitionThis 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. 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. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(Observation | QuestionnaireResponse | MolecularSequence) Constraints
|
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | There are no (further) constraints on this element Element IdObservation.derivedFrom Related measurements the observation is made from DefinitionThe 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. 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. Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Constraints
|
component | Σ I | 3..* | BackboneElement | Element IdObservation.component Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below. Unordered, Open, by code(Pattern) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Σ | 0..1 | QuantityBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
Eye | Σ I | 1..1 | BackboneElement | There are no (further) constraints on this element Element IdObservation.component:Eye Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | Element IdObservation.component:Eye.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
{ "coding": [ { "system": "http://loinc.org", "code": "9267-6" } ] }
|
coding | Σ | 1..* | Coding | Element IdObservation.component:Eye.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.component:Eye.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "9267-6" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.component:Eye.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.component:Eye.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityBinding | Element IdObservation.component:Eye.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "1" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component:Eye.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component:Eye.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component:Eye.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component:Eye.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component:Eye.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:Eye.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:Eye.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component:Eye.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
Motor | Σ I | 1..1 | BackboneElement | There are no (further) constraints on this element Element IdObservation.component:Motor Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | Element IdObservation.component:Motor.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
{ "coding": [ { "system": "http://loinc.org", "code": "9268-4" } ] }
|
coding | Σ | 1..* | Coding | Element IdObservation.component:Motor.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.component:Motor.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "9268-4" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.component:Motor.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.component:Motor.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityBinding | Element IdObservation.component:Motor.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "1" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component:Motor.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component:Motor.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component:Motor.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component:Motor.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component:Motor.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:Motor.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:Motor.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component:Motor.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
| |
Verbal | Σ I | 1..1 | BackboneElement | There are no (further) constraints on this element Element IdObservation.component:Verbal Component results DefinitionSome 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. 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. For a discussion on the ways Observations can be assembled in groups together see Notes below.
|
code | Σ | 1..1 | CodeableConcept | Element IdObservation.component:Verbal.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. Codes identifying names of simple observations. LOINCCodes (example)Constraints
{ "coding": [ { "system": "http://loinc.org", "code": "9270-0" } ] }
|
coding | Σ | 1..* | Coding | Element IdObservation.component:Verbal.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
loinc | Σ | 1..1 | Coding | Element IdObservation.component:Verbal.code.coding:loinc Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://loinc.org", "code": "9270-0" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdObservation.component:Verbal.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element IdObservation.component:Verbal.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. Unordered, Open, by $this(Type) Constraints
| |
valueQuantity | Σ | 0..1 | QuantityBinding | Element IdObservation.component:Verbal.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. 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. UCUM_Vitals_Common_DE (required) Constraints
{ "system": "http://unitsofmeasure.org", "code": "1" }
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element IdObservation.component:Verbal.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdObservation.component:Verbal.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size How the Quantity should be understood and represented. QuantityComparator (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element IdObservation.component:Verbal.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | Σ I | 1..1 | uri | There are no (further) constraints on this element Element IdObservation.component:Verbal.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdObservation.component:Verbal.value[x]:valueQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:Verbal.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "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. Codes specifying why the result (`Observation.value[x]`) is missing. DataAbsentReason (extensible)Constraints
|
interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdObservation.component:Verbal.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element IdObservation.component:Verbal.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. 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. 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.
|
{ "resourceType": "Observation", "id": "Example-observation-gcs", "meta": { "profile": [ "http://fhir.de/StructureDefinition/observation-de-vitalsign-gcs" ] }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] } ], "code": { "coding": [ { "code": "9269-2", "system": "http://loinc.org", "display": "Glasgow coma score total" } ] }, "component": [ { "code": { "coding": [ { "code": "9270-0", "system": "http://loinc.org", "display": "Glasgow coma score verbal" } ] }, "valueQuantity": { "system": "http://unitsofmeasure.org", "value": 4, "code": "1", "unit": "Punktwert" } }, { "code": { "coding": [ { "code": "9268-4", "system": "http://loinc.org", "display": "Glasgow coma score motor" } ] }, "valueQuantity": { "system": "http://unitsofmeasure.org", "value": 4, "code": "1", "unit": "Punktwert" } }, { "code": { "coding": [ { "code": "9267-6", "system": "http://loinc.org", "display": "Glasgow coma score eye opening" } ] }, "valueQuantity": { "system": "http://unitsofmeasure.org", "value": 3, "code": "1", "unit": "Punktwert" } } ], "valueQuantity": { "system": "http://unitsofmeasure.org", "value": 11, "code": "1", "unit": "Punktwert" }, "status": "final", "subject": { "reference": "https://server/Patient/example" }, "effectiveDateTime": "2020-10-11" }