RIVO-Noord Zorgviewer Implementation Guide
1.22.0 - CI build

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.22.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: LaboratoryTestResult - Detailed Descriptions

Active as of 2026-01-12

Definitions for the LaboratoryTestResult resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Observation
Definition | A laboratory result describes the result of a laboratory analysis. These are specimen-oriented tests as performed in laboratories such as Clinical Chemistry, Serology, Microbiology, etc. In addition to the results of tests with a singular result, this concept can also contain the results of more complex tests with multiple results or a ‘panel’. This is the base resource type for everything.
Short | LaboratoryTestResultBase Resource
Comments | This profile is used for two concepts of the HCIM LaboratoryTestResult at the same time: the root concept (NL-CM:13.1.1) and the LaboratoryTest concept (NL-CM:13.1.3). A LaboratoryTestResult can consist of just one LaboratoryTest or can be a panel of multiple LaboratoryTests. If there's just one LaboratoryTest, a single instance of this profile may be used to represent both concepts, but if there are multiple LaboratoryTests, there should be one parent instance representing the LaboratoryTestResult that uses `Observation.related` to link child instances representing individual LaboratoryTests. Note that the `Observation.related` field in is also used for a third case where there are multiple related LaboratoryTestResults (RelatedResult, NL-CM:13.1.33). The list below summarizes the different situations: 1. Single LaboratoryTestResult with single LaboratoryTest: * single instance of this profile * `.code` represents the HCIM concept TestCode (NL-CM:13.1.8) 2. Single LaboratoryTestResult with multiple LaboratoryTests * parent instance with child instances in `.related.target` * `.code` of parent represents the HCIM concept PanelOrBattery (NL-CM:13.1.4) * `.code` of child represents the HCIM concept TestCode (NL-CM:13.1.8) * `.related.type` of parent set to "has-member" 3. Multiple related LaboratoryTestResults * multiple instances representing the root concept * `.code` represents the HCIM concept TestCode (NL-CM:13.1.8) * `.related.target` references the related instances * `.related.type` set to whichever value is appropriate Also note that there is the additional profile zib-LaboratoryTestResult-DiagnosticReport, which is used for (textual) reports on individual (panels of) observations, like conclusions. The DiagnosticReport contains references to instances of this profile and can be used in all three the situations described above.
Control | 0..*
Alternate Names | Vital Signs, Measurement, Results, Tests, LaboratoriumUitslag
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (`contained.text.empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (`contained.where(('#'+id in %resource.descendants().reference).not()).empty()`) obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present (`value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()`) obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present (`dataAbsentReason.empty() or value.empty()`)
2. Observation.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Control | 0..1
Type | uri
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
4. Observation.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Alternate Names | extensions, user content
6. Observation.status
Definition | The status of the test result of this test. If the laboratory test is an panel/cluster, the overall status is given in the status of the panel/cluster. The status of the result value.
Short | TestUitslagStatusregistered | preliminary | final | amended +
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from ObservationStatus http://hl7.org/fhir/ValueSet/observation-status|3.0.2 (required to `http://hl7.org/fhir/ValueSet/observation-status` ) Codes providing the status of an observation.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to track the status of individual results. Some results are finalized before the whole report is finalized.
Alternate Names | TestUitslagStatus
8. Observation.status.extension:TestResultStatus
Slice Name | TestResultStatus
Definition | Provides the specific HCIM code for TestResultStatus or ResultStatus. The status of the laboratory test result. If the laboratory test is an panel/cluster, this status reflects the status of the whole panel/cluster. If the status item per subtest is used too, this status must be in accordance with these status values.
Short | TestResultStatus
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept)
Alternate Names | extensions, user content, Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet., TestUitslagStatus
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
10. Observation.status.extension:TestResultStatus.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.status.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. Observation.status.extension:TestResultStatus.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `http://nictiz.nl/fhir/StructureDefinition/code-specification`
14. Observation.status.extension:TestResultStatus.value[x]:valueCodeableConcept
Slice Name | valueCodeableConcept
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Short | Value of extension
Control | 10..1
Binding | Unless not suitable, these codes SHALL be taken from For codes, see ResultaatStatusCodelijst (extensible to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.8--20171231000000` ) TestResultStatusCodelist
Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
16. Observation.category
Definition | A code that classifies the general type of observation being made.
Short | Classification of type of observation
Comments | 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.
Control | 10..*
Binding | The codes SHOULD be taken from Observation Category Codes http://hl7.org/fhir/ValueSet/observation-category|3.0.2 (preferred to `http://hl7.org/fhir/ValueSet/observation-category` ) Codes for high level observation categories.
Type | CodeableConcept
Requirements | Used for filtering what observations are retrieved and displayed.
Slicing | This element introduces a set of slices on `Observation.category`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ $this
18. Observation.category:LaboratoryTestResultCode
Slice Name | LaboratoryTestResultCode
Definition | A code that classifies the general type of observation being made.
Short | LaboratoryTestResultCodeClassification of type of observation
Comments | 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.
Control | 10..1*
Binding | The codes SHOULD be taken from Observation Category Codes http://hl7.org/fhir/ValueSet/observation-category|3.0.2 (preferred to `http://hl7.org/fhir/ValueSet/observation-category` ) Codes for high level observation categories.
Type | CodeableConcept
Requirements | Used for filtering what observations are retrieved and displayed.
Pattern Value | `{ "coding" : [{ "system" : "http://snomed.info/sct", "code" : "49581000146104" }] }`
20. Observation.category:ResultType
Slice Name | ResultType
Definition | The type of result defines the laboratory specialty under which the test is categorized. A code that classifies the general type of observation being made.
Short | ResultTypeClassification of type of observation
Comments | 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.
Control | 0..1*
Binding | The codes SHALL be taken from The codes SHOULD be taken from ResultaatTypeCodelijst http://hl7.org/fhir/ValueSet/observation-category|3.0.2 (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.1--20171231000000` ) ResultaatTypeCodelijst Codes for high level observation categories.
Type | CodeableConcept
Requirements | Used for filtering what observations are retrieved and displayed.
Alternate Names | ResultaatType
22. Observation.code
Definition | The name and code of the executed test or for laboratory tests comprising multiple subtests and often requested together as a whole, this concept contains the name of the compound request (often indicated as a ‘panel’, ‘battery’ or ‘cluster’). Examples include: blood gases and EBV serology. Describes what was observed. Sometimes this is called the observation "name".
Short | TestCode or PanelOrBatteryType of observation (code / type)
Comments | This can either be the HCIM concept PanelOrBattery (NL-CM:13.1.4) or TestCode (NL-CM:13.1.8) depending on the use case. See the documentation on the root of this profile for guidance on implementing the different uses cases.
Control | 1..1
Binding | For example codes, see LOINC Codes http://hl7.org/fhir/ValueSet/observation-codes|3.0.2 (example to `http://hl7.org/fhir/ValueSet/observation-codes` ) Codes identifying names of simple observations.
Type | CodeableConcept
Summary | true
Requirements | Knowing what kind of observation is being made is essential to understanding the observation.
Alternate Names | Name, TestCode, Onderzoek
24. Observation.code.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | 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.
Control | 0..*
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
26. Observation.code.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
28. Observation.code.text
Definition | A 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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | 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.
30. Observation.subject
Definition | The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
Short | PatientWho and/or what this is about
Comments | One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. If the target of the observation is different than the subject, the general extension observation-focal-subject. may be used. However, the distinction between the patient's own value for an observation versus that of the fetus, or the donor or blood product unit, etc., are often specified in the observation code.
Control | 10..1
Type | Reference(Group, Device, nl-core-location, nl-core-patient, Patient, Location)
Summary | true
Requirements | Observations have no value if you don't know who or what they're about.
Alternate Names | Patiënt
32. Observation.effective[x]
Definition | The date and if possible the time at which the test was carried out. The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
Short | TestDateTimeClinically relevant time/time-period for observation
Comments | At least a date should be present unless this observation is a historical report.
Control | 0..1
Type | dateTime, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends.
Alternate Names | Occurrence, TestDatumTijd
Slicing | This element introduces a set of slices on `Observation.effective[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
34. Observation.effective[x]:effectiveDateTime
Slice Name | effectiveDateTime
Definition | The date and if possible the time at which the test was carried out. The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
Short | TestDateTimeClinically relevant time/time-period for observation
Comments | At least a date should be present unless this observation is a historical report.
Control | 0..1
Type | dateTime, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends.
Alternate Names | Occurrence, TestDatumTijd
36. Observation.value[x]
Definition | The test result. Depending on the type of test, the result will consist of a value with a unit or a coded value (ordinal or nominal). The information determined as a result of making the observation, if the information has a simple value.
Short | TestResultActual result
Comments | Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is "'value' + the type name" with a capital on the first letter of the type). If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For further discussion and examples see the notes section below.
Control | 0..1 This element is affected by the following invariants: obs-7
Type | Quantity, dateTime, boolean, string, SampledData, Period, Ratio, Attachment, time, Range, CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Summary | true
Requirements | An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations.
Alternate Names | TestUitslag
Slicing | This element introduces a set of slices on `Observation.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
38. Observation.value[x]:valueQuantity
Slice Name | valueQuantity
Definition | The test result. Depending on the type of test, the result will consist of a value with a unit or a coded value (ordinal or nominal). The information determined as a result of making the observation, if the information has a simple value.
Short | TestResultActual result
Comments | Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is "'value' + the type name" with a capital on the first letter of the type). If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For further discussion and examples see the notes section below.
Control | 0..1 This element is affected by the following invariants: obs-7
Type | Quantity, dateTime, boolean, string, SampledData, Period, Ratio, Attachment, time, Range, CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Summary | true
Requirements | An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations.
Alternate Names | TestUitslag
40. Observation.value[x]:valueQuantity.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
42. Observation.value[x]:valueQuantity.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.
Control | 0..1
Binding | The codes SHALL be taken from QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|3.0.2 (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|3.0.2` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
44. Observation.value[x]:valueQuantity.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
46. Observation.interpretation
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
Short | High, low, normal, etc.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Observation Interpretation Codes http://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2 (extensible to `http://hl7.org/fhir/ValueSet/observation-interpretation` ) Codes identifying interpretations of observations.
Type | CodeableConcept
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
Alternate Names | Abnormal Flag
48. Observation.interpretation.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | 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.
Control | 10..*
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Invariants | zib-LaboratoryTestResult-Observation-1: If a value from the HCIM ValueSet 'InterpretatieVlaggenCodelijst' is present a mapped code from the FHIR ValueSet 'Observation Interpretation Codes' is also expected. A ConceptMap is available that maps the HCIM values to the FHIR values. (`coding.where(system = 'http://snomed.info/sct' and (code = '281302008' or '281300000' or '11896004' or '30714006' or '131196009') ).exists() implies coding.where(system = 'http://hl7.org/fhir/v2/0078').exists()`)
Slicing | This element introduces a set of slices on `Observation.interpretation.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
50. Observation.interpretation.coding.code
Definition | A 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).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
52. Observation.interpretation.coding:ObservationInterpretation
Slice Name | ObservationInterpretation
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | 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.
Control | 0..*
Binding | The codes SHALL be taken from For codes, see Observation Interpretation Codes (required to `http://hl7.org/fhir/ValueSet/observation-interpretation` ) Observation Interpretation Codes
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
54. Observation.interpretation.coding:ObservationInterpretation.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously.
Control | 10..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://hl7.org/fhir/v2/0078`
56. Observation.interpretation.coding:ObservationInterpretation.code
Definition | A 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).
Short | Symbol in syntax defined by the system
Control | 10..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
58. Observation.interpretation.coding:InterpretatieVlaggenCodelijst
Slice Name | InterpretatieVlaggenCodelijst
Definition | Attention codes indicating whether the result is above or below certain reference values or interpreting the result otherwise. (Resistent) A reference to a code defined by a terminology system.
Short | ResultFlagsCode defined by a terminology system
Comments | This slice binds the ValueSet from the HCIM, which overlaps the ValueSet from the core FHIR Observation. To satisfy the FHIR profiling rules, the code from the core FHIR ValueSet SHOULD be included as well if a code from this ValueSet is included. A ConceptMap (https://simplifier.net/resolve?canonical=http://nictiz.nl/fhir/ConceptMap/InterpretatieVlaggenCodelijst-to-observation-interpretation) is available that explains the relationship between the FHIR observation-interpretation value set and the HCIM ResultFlagsCodelist. 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.
Control | 0..*
Binding | The codes SHALL be taken from For codes, see InterpretatieVlaggenCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.7--20171231000000` ) InterpretatieVlaggenCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Alternate Names | InterpretatieVlaggen
60. Observation.interpretation.coding:InterpretatieVlaggenCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously.
Control | 10..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://snomed.info/sct`
62. Observation.interpretation.coding:InterpretatieVlaggenCodelijst.code
Definition | A 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).
Short | Symbol in syntax defined by the system
Control | 10..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
64. Observation.interpretation.text
Definition | A 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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | 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.
66. Observation.specimen
Definition | The specimen that was used when this observation was made.
Short | SpecimenSpecimen used for this observation
Comments | Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).
Control | 0..1
Type | Reference(Specimen, Specimen)
Must Support | true
Alternate Names | Monster
68. Observation.referenceRange
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range.
Short | ReferenceProvides guide for interpretation
Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
Control | 0..*
Type | BackboneElement
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.
Alternate Names | Referentie
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) obs-3: Must have at least a low or a high or text (`low.exists() or high.exists() or text.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) obs-3: Must have at least a low or a high or text (low.exists() or high.exists() or text.exists())
70. Observation.referenceRange.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
72. Observation.referenceRange.low
Definition | The lower reference limit for the patient of the value measured with the test. The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
Short | ReferenceRangeLowerLimitLow Range, if relevant
Control | 0..1 This element is affected by the following invariants: obs-3
Type | Quantity(SimpleQuantity)
Alternate Names | ReferentieOndergrens
74. Observation.referenceRange.low.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
76. Observation.referenceRange.low.comparator
Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.
Control | 0..01
Binding | The codes SHALL be taken from QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|3.0.2 (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|3.0.2` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
78. Observation.referenceRange.low.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | Added:true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
80. Observation.referenceRange.high
Definition | The upper reference limit for the patient of the value measured in the test. The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
Short | ReferenceRangeUpperLimitHigh Range, if relevant
Control | 0..1 This element is affected by the following invariants: obs-3
Type | Quantity(SimpleQuantity)
Alternate Names | ReferentieBovengrens
82. Observation.referenceRange.high.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
84. Observation.referenceRange.high.comparator
Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.
Control | 0..01
Binding | The codes SHALL be taken from QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|3.0.2 (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|3.0.2` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
86. Observation.referenceRange.high.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | Added:true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Guidance on how to interpret the contents of this table can be foundhere

0. Observation
2. Observation.status
Must Support | true
4. Observation.code
6. Observation.code.coding
8. Observation.code.coding.display
Must Support | true
10. Observation.code.text
Must Support | true
12. Observation.effectiveDateTime
Must Support | true
14. Observation.valueQuantity
Must Support | true
16. Observation.valueQuantity.value
Must Support | true
Added: 18. Observation.valueQuantity.code
Must Support | true
20. Observation.interpretation
Removed:--. Observation.valueQuantity.unit
Must Support | true
22. Observation.interpretation.coding
24. Observation.interpretation.coding.code
Must Support | true
Added: 26. Observation.interpretation.text
Must Support | true
28. Observation.specimen
Type | Reference(Specimen)
Must Support | true
30. Observation.referenceRange
32. Observation.referenceRange.low
34. Observation.referenceRange.low.value
Must Support | true
Added: 36. Observation.referenceRange.low.code
Must Support | true
38. Observation.referenceRange.high
Added: 40. Observation.referenceRange.high.value
Must Support | true
Added: 42. Observation.referenceRange.high.code
Must Support | true
Removed:--. Observation.referenceRange.low.unit
Must Support | true
Removed:--. Observation.referenceRange.high.unit
Must Support | true

Guidance on how to interpret the contents of this table can be foundhere

0. Observation
Definition | A laboratory result describes the result of a laboratory analysis. These are specimen-oriented tests as performed in laboratories such as Clinical Chemistry, Serology, Microbiology, etc. In addition to the results of tests with a singular result, this concept can also contain the results of more complex tests with multiple results or a ‘panel’.
Short | LaboratoryTestResult
Comments | This profile is used for two concepts of the HCIM LaboratoryTestResult at the same time: the root concept (NL-CM:13.1.1) and the LaboratoryTest concept (NL-CM:13.1.3). A LaboratoryTestResult can consist of just one LaboratoryTest or can be a panel of multiple LaboratoryTests. If there's just one LaboratoryTest, a single instance of this profile may be used to represent both concepts, but if there are multiple LaboratoryTests, there should be one parent instance representing the LaboratoryTestResult that uses `Observation.related` to link child instances representing individual LaboratoryTests. Note that the `Observation.related` field in is also used for a third case where there are multiple related LaboratoryTestResults (RelatedResult, NL-CM:13.1.33). The list below summarizes the different situations: 1. Single LaboratoryTestResult with single LaboratoryTest: * single instance of this profile * `.code` represents the HCIM concept TestCode (NL-CM:13.1.8) 2. Single LaboratoryTestResult with multiple LaboratoryTests * parent instance with child instances in `.related.target` * `.code` of parent represents the HCIM concept PanelOrBattery (NL-CM:13.1.4) * `.code` of child represents the HCIM concept TestCode (NL-CM:13.1.8) * `.related.type` of parent set to "has-member" 3. Multiple related LaboratoryTestResults * multiple instances representing the root concept * `.code` represents the HCIM concept TestCode (NL-CM:13.1.8) * `.related.target` references the related instances * `.related.type` set to whichever value is appropriate Also note that there is the additional profile zib-LaboratoryTestResult-DiagnosticReport, which is used for (textual) reports on individual (panels of) observations, like conclusions. The DiagnosticReport contains references to instances of this profile and can be used in all three the situations described above.
Control | 0..*
Alternate Names | Vital Signs, Measurement, Results, Tests, LaboratoriumUitslag
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (`contained.text.empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (`contained.where(('#'+id in %resource.descendants().reference).not()).empty()`) obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present (`value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()`) obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present (`dataAbsentReason.empty() or value.empty()`)
2. Observation.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
4. Observation.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Summary | true
6. Observation.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Control | 0..1
Type | uri
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
8. Observation.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
All Languages | Max Binding
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. Observation.text
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Control | 0..1 This element is affected by the following invariants: dom-1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
12. Observation.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
14. Observation.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
16. Observation.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Alternate Names | extensions, user content
18. Observation.identifier
Definition | A unique identifier assigned to this observation.
Short | Identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Summary | true
Requirements | Allows observations to be distinguished and referenced.
Alternate Names | Identificatie
20. Observation.basedOn
Definition | A plan, proposal or order that is fulfilled in whole or in part by this event.
Short | Fulfills plan, proposal or order including requester information.
Comments | Requester information should be captured and exchanged in the resource ProcedureRequest referenced by `basedOn`. Requester is the healthcare provider and/or organization where or by whom the LaboratoryTestResult was requested. There are a few required elements in ProcedureRequest: * `ProcedureRequest.status` (use fixed value active, unless you know what the actual value is) * `ProcedureRequest.intent` (use fixed value order, unless you know what the actual value is) * `ProcedureRequest.code` (use extension http://hl7.org/fhir/STU3/extension-iso21090-nullflavor.html with `valueCode` UNK, unless you know what the actual value is) * `ProcedureRequest.subject` (equal to `Observation.subject`) * `ProcedureRequest.requester.agent` (contains the requesting HealthProfessional)
Control | 0..*
Type | Reference(CarePlan, DeviceRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ProcedureRequest, ReferralRequest)
Summary | true
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.
Alternate Names | Fulfills, Aanvrager
22. Observation.status
Definition | The status of the test result of this test. If the laboratory test is an panel/cluster, the overall status is given in the status of the panel/cluster.
Short | TestUitslagStatus
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from ObservationStatus (required to `http://hl7.org/fhir/ValueSet/observation-status` ) Codes providing the status of an observation.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to track the status of individual results. Some results are finalized before the whole report is finalized.
Alternate Names | TestUitslagStatus
24. Observation.status.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
26. Observation.status.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.status.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
28. Observation.status.extension:TestResultStatus
Slice Name | TestResultStatus
Definition | Provides the specific HCIM code for TestResultStatus or ResultStatus. The status of the laboratory test result. If the laboratory test is an panel/cluster, this status reflects the status of the whole panel/cluster. If the status item per subtest is used too, this status must be in accordance with these status values.
Short | TestResultStatus
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept)
Alternate Names | extensions, user content, Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet., TestUitslagStatus
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
30. Observation.status.extension:TestResultStatus.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
32. Observation.status.extension:TestResultStatus.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.status.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
34. Observation.status.extension:TestResultStatus.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `http://nictiz.nl/fhir/StructureDefinition/code-specification`
36. Observation.status.extension:TestResultStatus.value[x]:valueCodeableConcept
Slice Name | valueCodeableConcept
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Short | Value of extension
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ResultaatStatusCodelijst (extensible to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.8--20171231000000` ) TestResultStatusCodelist
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
38. Observation.status.value
Definition | Primitive value for code
Short | Primitive value for code
Control | 0..1
Type | code
XML Format | In the XML format, this property is represented as an attribute.
40. Observation.category
Definition | A code that classifies the general type of observation being made.
Short | Classification of type of observation
Comments | 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.
Control | 1..*
Binding | The codes SHOULD be taken from Observation Category Codes (preferred to `http://hl7.org/fhir/ValueSet/observation-category` ) Codes for high level observation categories.
Type | CodeableConcept
Requirements | Used for filtering what observations are retrieved and displayed.
Slicing | This element introduces a set of slices on `Observation.category`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ $this
42. Observation.category:LaboratoryTestResultCode
Slice Name | LaboratoryTestResultCode
Definition | A code that classifies the general type of observation being made.
Short | LaboratoryTestResultCode
Comments | 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.
Control | 1..1
Binding | The codes SHOULD be taken from Observation Category Codes (preferred to `http://hl7.org/fhir/ValueSet/observation-category` ) Codes for high level observation categories.
Type | CodeableConcept
Requirements | Used for filtering what observations are retrieved and displayed.
Pattern Value | `{ "coding" : [{ "system" : "http://snomed.info/sct", "code" : "49581000146104" }] }`
44. Observation.category:LaboratoryTestResultCode.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
46. Observation.category:LaboratoryTestResultCode.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.category.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
48. Observation.category:LaboratoryTestResultCode.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | 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.
Control | 0..*
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
50. Observation.category:LaboratoryTestResultCode.coding.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
52. Observation.category:LaboratoryTestResultCode.coding.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.category.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
54. Observation.category:LaboratoryTestResultCode.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously.
Control | 0..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
56. Observation.category:LaboratoryTestResultCode.coding.version
Definition | The 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.
Short | Version of the system - if relevant
Comments | 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.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
58. Observation.category:LaboratoryTestResultCode.coding.code
Definition | A 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).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
60. Observation.category:LaboratoryTestResultCode.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Default Value | `Laboratory test finding (finding)`
62. Observation.category:LaboratoryTestResultCode.coding.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | 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.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
64. Observation.category:LaboratoryTestResultCode.text
Definition | A 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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
66. Observation.category:ResultType
Slice Name | ResultType
Definition | The type of result defines the laboratory specialty under which the test is categorized.
Short | ResultType
Comments | 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.
Control | 0..1
Binding | The codes SHALL be taken from ResultaatTypeCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.1--20171231000000` ) ResultaatTypeCodelijst
Type | CodeableConcept
Requirements | Used for filtering what observations are retrieved and displayed.
Alternate Names | ResultaatType
68. Observation.code
Definition | The name and code of the executed test or for laboratory tests comprising multiple subtests and often requested together as a whole, this concept contains the name of the compound request (often indicated as a ‘panel’, ‘battery’ or ‘cluster’). Examples include: blood gases and EBV serology.
Short | TestCode or PanelOrBattery
Comments | This can either be the HCIM concept PanelOrBattery (NL-CM:13.1.4) or TestCode (NL-CM:13.1.8) depending on the use case. See the documentation on the root of this profile for guidance on implementing the different uses cases.
Control | 1..1
Binding | For example codes, see LOINC Codes (example to `http://hl7.org/fhir/ValueSet/observation-codes` ) Codes identifying names of simple observations.
Type | CodeableConcept
Summary | true
Requirements | Knowing what kind of observation is being made is essential to understanding the observation.
Alternate Names | Name, TestCode, Onderzoek
70. Observation.code.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
72. Observation.code.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.code.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
74. Observation.code.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | 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.
Control | 0..*
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
76. Observation.code.coding.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
78. Observation.code.coding.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.code.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
80. Observation.code.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously.
Control | 0..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
82. Observation.code.coding.version
Definition | The 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.
Short | Version of the system - if relevant
Comments | 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.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
84. Observation.code.coding.code
Definition | A 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).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
86. Observation.code.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
88. Observation.code.coding.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | 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.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
90. Observation.code.text
Definition | A 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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | 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.
92. Observation.subject
Definition | The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
Short | Patient
Comments | One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. If the target of the observation is different than the subject, the general extension observation-focal-subject. may be used. However, the distinction between the patient's own value for an observation versus that of the fetus, or the donor or blood product unit, etc., are often specified in the observation code.
Control | 1..1
Type | Reference(Group, Device, nl-core-location, nl-core-patient)
Summary | true
Requirements | Observations have no value if you don't know who or what they're about.
Alternate Names | Patiënt
94. Observation.context
Definition | The encounter during which this journal entry was made.
Short | Encounter during which this observation is made
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests).
Control | 0..1
Type | Reference(nl-core-episodeofcare, HCIM Encounter, gp-Encounter)
Requirements | For some observations it may be important to know the link between an observation and a particular encounter.
Alternate Names | Encounter
96. Observation.effective[x]
Definition | The date and if possible the time at which the test was carried out.
Short | TestDateTime
Comments | At least a date should be present unless this observation is a historical report.
Control | 0..1
Type | dateTime
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends.
Alternate Names | Occurrence, TestDatumTijd
Slicing | This element introduces a set of slices on `Observation.effective[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
98. Observation.effective[x]:effectiveDateTime
Slice Name | effectiveDateTime
Definition | The date and if possible the time at which the test was carried out.
Short | TestDateTime
Comments | At least a date should be present unless this observation is a historical report.
Control | 0..1
Type | dateTime
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends.
Alternate Names | Occurrence, TestDatumTijd
100. Observation.issued
Definition | The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
Short | Date/Time this was made available
Comments | Updated when the result is updated.
Control | 0..1
Type | instant
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
102. Observation.performer
Definition | Who was responsible for asserting the observed value as "true".
Short | Who is responsible for the observation
Control | 0..*
Type | Reference(nl-core-organization, nl-core-patient, nl-core-practitioner, nl-core-relatedperson)
Summary | true
Requirements | May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.
104. Observation.performer.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
106. Observation.performer.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.performer.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
108. Observation.performer.extension:practitionerRole
Slice Name | practitionerRole
Definition | Optional Extension Element - found in all resources.
Short | Optional Extensions Element
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PractitionerRole Reference) (Extension Type: Reference)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
110. Observation.performer.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
112. Observation.performer.identifier
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Summary | true
114. Observation.performer.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
116. Observation.value[x]
Definition | The test result. Depending on the type of test, the result will consist of a value with a unit or a coded value (ordinal or nominal).
Short | TestResult
Comments | Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is "'value' + the type name" with a capital on the first letter of the type). If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For further discussion and examples see the notes section below.
Control | 0..1 This element is affected by the following invariants: obs-7
Type | Quantity
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Summary | true
Requirements | An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations.
Alternate Names | TestUitslag
Slicing | This element introduces a set of slices on `Observation.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
118. Observation.value[x]:valueQuantity
Slice Name | valueQuantity
Definition | The test result. Depending on the type of test, the result will consist of a value with a unit or a coded value (ordinal or nominal).
Short | TestResult
Comments | Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is "'value' + the type name" with a capital on the first letter of the type). If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For further discussion and examples see the notes section below.
Control | 0..1 This element is affected by the following invariants: obs-7
Type | Quantity
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Summary | true
Requirements | An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations.
Alternate Names | TestUitslag
120. Observation.value[x]:valueQuantity.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
122. Observation.value[x]:valueQuantity.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.value[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
124. Observation.value[x]:valueQuantity.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
126. Observation.value[x]:valueQuantity.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.
Control | 0..1
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|3.0.2` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
128. Observation.value[x]:valueQuantity.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
130. Observation.value[x]:valueQuantity.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
132. Observation.value[x]:valueQuantity.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
134. Observation.dataAbsentReason
Definition | Provides a reason why the expected value in the element Observation.value[x] is missing.
Short | Why the result is missing
Comments | Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.
Control | 0..1 This element is affected by the following invariants: obs-6
Binding | Unless not suitable, these codes SHALL be taken from Observation Value Absent Reason (extensible to `http://hl7.org/fhir/ValueSet/observation-valueabsentreason` ) Codes specifying why the result (Observation.value[x]) is missing.
Type | CodeableConcept
Requirements | For many results it is necessary to handle exceptional values in measurements.
136. Observation.interpretation
Definition | The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
Short | High, low, normal, etc.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Observation Interpretation Codes (extensible to `http://hl7.org/fhir/ValueSet/observation-interpretation` ) Codes identifying interpretations of observations.
Type | CodeableConcept
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
Alternate Names | Abnormal Flag
138. Observation.interpretation.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
140. Observation.interpretation.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.interpretation.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
142. Observation.interpretation.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | 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.
Control | 1..*
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Invariants | zib-LaboratoryTestResult-Observation-1: If a value from the HCIM ValueSet 'InterpretatieVlaggenCodelijst' is present a mapped code from the FHIR ValueSet 'Observation Interpretation Codes' is also expected. A ConceptMap is available that maps the HCIM values to the FHIR values. (`coding.where(system = 'http://snomed.info/sct' and (code = '281302008' or '281300000' or '11896004' or '30714006' or '131196009') ).exists() implies coding.where(system = 'http://hl7.org/fhir/v2/0078').exists()`)
Slicing | This element introduces a set of slices on `Observation.interpretation.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
144. Observation.interpretation.coding.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
146. Observation.interpretation.coding.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.interpretation.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
148. Observation.interpretation.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously.
Control | 0..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
150. Observation.interpretation.coding.version
Definition | The 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.
Short | Version of the system - if relevant
Comments | 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.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
152. Observation.interpretation.coding.code
Definition | A 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).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
154. Observation.interpretation.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
156. Observation.interpretation.coding.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | 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.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
158. Observation.interpretation.coding:ObservationInterpretation
Slice Name | ObservationInterpretation
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | 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.
Control | 0..*
Binding | The codes SHALL be taken from Observation Interpretation Codes (required to `http://hl7.org/fhir/ValueSet/observation-interpretation` ) Observation Interpretation Codes
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
160. Observation.interpretation.coding:ObservationInterpretation.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
162. Observation.interpretation.coding:ObservationInterpretation.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.interpretation.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
164. Observation.interpretation.coding:ObservationInterpretation.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://hl7.org/fhir/v2/0078`
166. Observation.interpretation.coding:ObservationInterpretation.version
Definition | The 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.
Short | Version of the system - if relevant
Comments | 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.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
168. Observation.interpretation.coding:ObservationInterpretation.code
Definition | A 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).
Short | Symbol in syntax defined by the system
Control | 1..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
170. Observation.interpretation.coding:ObservationInterpretation.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
172. Observation.interpretation.coding:ObservationInterpretation.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | 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.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
174. Observation.interpretation.coding:InterpretatieVlaggenCodelijst
Slice Name | InterpretatieVlaggenCodelijst
Definition | Attention codes indicating whether the result is above or below certain reference values or interpreting the result otherwise. (Resistent)
Short | ResultFlags
Comments | This slice binds the ValueSet from the HCIM, which overlaps the ValueSet from the core FHIR Observation. To satisfy the FHIR profiling rules, the code from the core FHIR ValueSet SHOULD be included as well if a code from this ValueSet is included. A ConceptMap (https://simplifier.net/resolve?canonical=http://nictiz.nl/fhir/ConceptMap/InterpretatieVlaggenCodelijst-to-observation-interpretation) is available that explains the relationship between the FHIR observation-interpretation value set and the HCIM ResultFlagsCodelist.
Control | 0..*
Binding | The codes SHALL be taken from InterpretatieVlaggenCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.7--20171231000000` ) InterpretatieVlaggenCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Alternate Names | InterpretatieVlaggen
176. Observation.interpretation.coding:InterpretatieVlaggenCodelijst.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
178. Observation.interpretation.coding:InterpretatieVlaggenCodelijst.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.interpretation.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
180. Observation.interpretation.coding:InterpretatieVlaggenCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://snomed.info/sct`
182. Observation.interpretation.coding:InterpretatieVlaggenCodelijst.version
Definition | The 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.
Short | Version of the system - if relevant
Comments | 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.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
184. Observation.interpretation.coding:InterpretatieVlaggenCodelijst.code
Definition | A 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).
Short | Symbol in syntax defined by the system
Control | 1..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
186. Observation.interpretation.coding:InterpretatieVlaggenCodelijst.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
188. Observation.interpretation.coding:InterpretatieVlaggenCodelijst.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | 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.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
190. Observation.interpretation.text
Definition | A 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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | 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.
192. Observation.comment
Definition | Comments, such as a textual interpretation or advice accompanying the result, for example or a comment of the laboratory specialist regarding the interpretation of the results.
Short | Comment or ResultInterpretation
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Requirements | Need to be able to provide free text additional information.
Alternate Names | Toelichting, UitslagInterpretatie
194. Observation.bodySite
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site).
Short | Observed body part
Comments | Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension body-site-instance.
Control | 0..1
Binding | For example codes, see SNOMED CT Body Structures (example to `http://hl7.org/fhir/ValueSet/body-site` ) Codes describing anatomical locations. May include laterality.
Type | CodeableConcept
196. Observation.method
Definition | The test method used to obtain the result.
Short | TestMethod
Comments | Only used if not implicit in code for Observation.code.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from TestmethodeCodelijst (extensible to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.4--20171231000000` ) SNOMED CT (2.16.840.1.113883.6.96): All values
Type | CodeableConcept
Requirements | In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.
Alternate Names | Testmethode
198. Observation.specimen
Definition | The specimen that was used when this observation was made.
Short | Specimen
Comments | Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).
Control | 0..1
Type | Reference(Specimen)
Must Support | true
Alternate Names | Monster
200. Observation.device
Definition | The device used to generate the observation data.
Short | (Measurement) Device
Comments | An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either an extension or through the Observation.related element.
Control | 0..1
Type | Reference(HCIM MedicalDevice Product)
202. Observation.referenceRange
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range.
Short | Reference
Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
Control | 0..*
Type | BackboneElement
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.
Alternate Names | Referentie
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) obs-3: Must have at least a low or a high or text (`low.exists() or high.exists() or text.exists()`)
204. Observation.referenceRange.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
206. Observation.referenceRange.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
208. Observation.referenceRange.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
210. Observation.referenceRange.low
Definition | The lower reference limit for the patient of the value measured with the test.
Short | ReferenceRangeLowerLimit
Control | 0..1 This element is affected by the following invariants: obs-3
Type | Quantity(SimpleQuantity)
Alternate Names | ReferentieOndergrens
212. Observation.referenceRange.low.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
214. Observation.referenceRange.low.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.referenceRange.low.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
216. Observation.referenceRange.low.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
218. Observation.referenceRange.low.comparator
Definition | Not allowed to be used in this context
Short | < | <= | >= | > - how to understand the value
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.
Control | 0..0
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|3.0.2` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
220. Observation.referenceRange.low.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | Removed: true
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
222. Observation.referenceRange.low.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
224. Observation.referenceRange.low.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | Added:true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
226. Observation.referenceRange.high
Definition | The upper reference limit for the patient of the value measured in the test.
Short | ReferenceRangeUpperLimit
Control | 0..1 This element is affected by the following invariants: obs-3
Type | Quantity(SimpleQuantity)
Alternate Names | ReferentieBovengrens
228. Observation.referenceRange.high.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
230. Observation.referenceRange.high.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Observation.referenceRange.high.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
232. Observation.referenceRange.high.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
234. Observation.referenceRange.high.comparator
Definition | Not allowed to be used in this context
Short | < | <= | >= | > - how to understand the value
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.
Control | 0..0
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|3.0.2` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
236. Observation.referenceRange.high.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | Removed: true
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
238. Observation.referenceRange.high.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
240. Observation.referenceRange.high.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | Added:true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
242. Observation.referenceRange.type
Definition | Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
Short | Reference range qualifier
Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Observation Reference Range Meaning Codes (extensible to `http://hl7.org/fhir/ValueSet/referencerange-meaning` ) Code for the meaning of a reference range.
Type | CodeableConcept
Requirements | Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc, - for proper interpretation.
244. Observation.referenceRange.appliesTo
Definition | Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race.
Short | Reference range population
Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.
Control | 0..*
Binding | For example codes, see Observation Reference Range Applies To Codes (example to `http://hl7.org/fhir/ValueSet/referencerange-appliesto` ) Codes identifying the population the reference range applies to.
Type | CodeableConcept
Requirements | Need to be able to identify the target population for proper interpretation.
246. Observation.referenceRange.age
Definition | The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.
Short | Applicable age range, if relevant
Control | 0..1
Type | Range
Requirements | Some analytes vary greatly over age.
248. Observation.referenceRange.text
Definition | Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of 'normals'.
Short | Text based reference range in an observation
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
250. Observation.related
Definition | Reference to related LaboratoryTestResult instances, or to the LaboratoryTest concept if this is a grouping Observation.
Short | RelatedResults
Comments | The `Observation.related` field is used for two different HCIM use cases: 1. The LaboratoryTestResult can reference other, related LaboratoryTestResults (RelatedResult, NL-CM:13.1.33). 2. The LaboratoryTestResult can consist of multiple LaboratoryTest concepts (NL-CM:13.1.3) See the documentation on the root if this profile for guidance on implementing these use cases.
Control | 0..*
Type | BackboneElement
Summary | true
Requirements | Normally, an observation will have either a value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and a set of related observations or sometimes a QuestionnaireResponse from which the measure is derived.
Alternate Names | GerelateerdeUitslag, LaboratoriumTest
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
252. Observation.related.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
254. Observation.related.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
256. Observation.related.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
258. Observation.related.type
Definition | A code specifying the kind of relationship that exists with the target resource.
Short | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Comments | The "derived-from" type is the only logical choice when referencing the QuestionnaireAnswer resource.
Control | 0..1
Binding | The codes SHALL be taken from ObservationRelationshipType (required to `http://hl7.org/fhir/ValueSet/observation-relationshiptypes` ) Codes specifying how two observations are related.
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Requirements | A relationship type SHOULD be provided.
260. Observation.related.target
Definition | A reference to the observation or QuestionnaireResponse resource that is related to this observation.
Short | Resource that is related to this one
Control | 1..1
Type | Reference(QuestionnaireResponse, Sequence, HCIM LaboratoryTestResult Observation)
262. Observation.component
Definition | Container of the LaboratoryTest concept. This container contains all data elements of the LaboratoryTest concept.
Short | LaboratoryTest
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below.
Control | 0..*
Type | BackboneElement
Summary | true
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.
Alternate Names | LaboratoriumTest
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
264. Observation.component.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
266. Observation.component.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
268. Observation.component.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
270. Observation.component.code
Definition | The TestCode is the name of the executed test.
Short | TestCode
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from TestCodeCodelijst (extensible to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.3--20171231000000` ) LOINC (2.16.840.1.113883.6.1): All values
Type | CodeableConcept
Summary | true
Requirements | Knowing what kind of observation is being made is essential to understanding the observation.
Alternate Names | TestCode
272. Observation.component.value[x]
Definition | The test result. Depending on the type of test, the result will consist of a value with a unit or a coded value (ordinal or nominal).
Short | TestResult
Comments | Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from <http://hl7.org/fhir/ValueSet/v2-0136> (these "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (the name format is "'value' + the type name" with a capital on the first letter of the type).
Control | 0..1
Type | Choice of: Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations.
Alternate Names | TestUitslag
274. Observation.component.dataAbsentReason
Definition | Provides a reason why the expected value in the element Observation.value[x] is missing.
Short | Why the component result is missing
Comments | "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.
Control | 0..1 This element is affected by the following invariants: obs-6
Binding | Unless not suitable, these codes SHALL be taken from Observation Value Absent Reason (extensible to `http://hl7.org/fhir/ValueSet/observation-valueabsentreason` ) Codes specifying why the result (Observation.value[x]) is missing.
Type | CodeableConcept
Requirements | For many results it is necessary to handle exceptional values in measurements.
276. Observation.component.interpretation
Definition | Attention codes indicating whether the result is above or below certain reference values or interpreting the result otherwise. (Resistent)
Short | ResultFlags
Comments | A ConceptMap (https://simplifier.net/resolve?canonical=http://nictiz.nl/fhir/ConceptMap/InterpretatieVlaggenCodelijst-to-observation-interpretation) is available that maps ResultFlagsCodelist to the observation-interpretation value set.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from InterpretatieVlaggenCodelijst (extensible to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.7--20171231000000` ) InterpretatieVlaggenCodelijst
Type | CodeableConcept
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
Alternate Names | Abnormal Flag, InterpretatieVlaggen
278. Observation.component.referenceRange
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range.
Short | Provides guide for interpretation of component result
Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.