Finnish Base Profiles
0.3.0 - ci-build Finland flag

Finnish Base Profiles - Local Development build (v0.3.0). See the Directory of published versions

Resource Profile: FIPHRSDBloodglucose - Detailed Descriptions

Draft as of 2021-11-23

Definitions for the fiphr-sd-bloodglucose resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Observation
Definition

Finnish PHR profile for Observation used in blood glucose measurements. The profile is based on the Finnish PHR observation profile.

The FHIR Vitals Signs profile sets minimum expectations for the Observation Resource to record, search and fetch the vital signs associated with a patient.

Comments

.

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

InvariantsDefined on this element
PHR-1: Resource SHALL contain code '15074-8' or '14743-9' or '14745-4' (: (code.coding.where(code='15074-8').exists()) or (code.coding.where(code='14743-9').exists()) or (code.coding.where(code='14745-4').exists()))
PHR-2: When using code '15074-8' also code '14743-9' SHALL be used (: code.coding.where(code='15074-8').exists() implies code.coding.where(code='14743-9').exists())
PHR-3: When using code '14743-9' also code '15074-8' SHALL be used (: code.coding.where(code='14743-9').exists() implies code.coding.where(code='15074-8').exists())
2. Observation.meta
3. Observation.meta.profile
4. Observation.meta.profile:fiphrProfile
SliceNamefiphrProfile
Fixed Valuehttp://phr.kanta.fi/StructureDefinition/fiphr-sd-bloodglucose
5. Observation.extension
SlicingThis element introduces a set of slices on Observation.extension. The slices are and , and can be differentiated using the following discriminators:
  • @
6. Observation.extension:hoursAfterMeal
SliceNamehoursAfterMeal
Definition

Meal context, how many hours after meal measurement is done.

Control0..1
TypeExtension(FIPHREXTUnsignedInt) (Extension Type: unsignedInt)
Requirements

Meal context needed for result interpretation.

7. Observation.code
Control0..?
8. Observation.code.coding
Definition

This code SHALL be used with CGM readings.

Control1..?
Comments

This code SHALL be used with CGM readings. Ordering of codings is undefined and SHALL NOT be used to infer meaning.

InvariantsDefined on this element
PHR-1: When using code '15074-8' or '14743-9' or '14745-4' system http://loinc.org SHALL be used (: (where(code='15074-8').exists()) or (where(code='14743-9').exists()) or (where(code='14745-4').exists()) implies where(system="http://loinc.org").exists())
SlicingThis element introduces a set of slices on Observation.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
  • value @ code,
9. Observation.code.coding:GlucoseInBlood
SliceNameGlucoseInBlood
Control0..1
10. Observation.code.coding:GlucoseInBlood.system
Control1..?
Fixed Valuehttp://loinc.org
11. Observation.code.coding:GlucoseInBlood.code
Control1..?
Fixed Value15074-8
12. Observation.code.coding:GlucoseInBlood.display
Control1..?
13. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer
SliceNameGlucoseInCapillaryBloodByGlucometer
Control0..1
14. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.system
Control1..?
Fixed Valuehttp://loinc.org
15. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.code
Control1..?
Fixed Value14743-9
16. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.display
Control1..?
17. Observation.code.coding:GlucoseInBodyFluid
SliceNameGlucoseInBodyFluid
Control0..1
18. Observation.code.coding:GlucoseInBodyFluid.system
Control1..?
Fixed Valuehttp://loinc.org
19. Observation.code.coding:GlucoseInBodyFluid.code
Control1..?
Fixed Value14745-4
20. Observation.code.coding:GlucoseInBodyFluid.display
Control1..?
21. Observation.effective[x]
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Observation.effective[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
22. Observation.effective[x]:effectiveDateTime
SliceNameeffectiveDateTime
Control0..?
[x] NoteSee Choice of Data Types for further information about how to use [x]
23. Observation.value[x]
Definition

FinnishPHR: Glucose in blood

Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

TypeChoice of: , dateTime, boolean, string, SampledData, Period, Ratio, integer, time, Range, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
24. Observation.value[x].extension
Control0..?
SlicingThis element introduces a set of slices on Observation.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
25. Observation.value[x].extension:alternativeQuantity
SliceNamealternativeQuantity
Control0..1
TypeExtension(FIPHREXTPqTranslation) (Extension Type: Quantity)
26. Observation.value[x].extension:alternativeQuantity.value[x]
Control0..?
[x] NoteSee Choice of Data Types for further information about how to use [x]
27. Observation.value[x].extension:alternativeQuantity.value[x].system
Control0..?
Fixed Valuehttp://unitsofmeasure.org
28. Observation.value[x].value
Control1..?
29. Observation.value[x].unit
Control1..?
Fixed Valuemmol/l
30. Observation.value[x].system
Control1..?
Fixed Valuehttp://unitsofmeasure.org
31. Observation.value[x].code
Control1..?
Fixed Valuemmol/L
32. Observation.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.value[x] is missing. Finnish PHR: Codes 'astext' and 'error' are allowed, no other codes.

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

Comments

Finnish PHR: Code 'error' SHALL be used when a device has been actively trying to measure the blood glucose but has failed for some reason. Code 'astext' SHALL be used when the measured value cannot be stored using the valueQuantity structure (with the comparator). In this case, the value SHALL be presented in the resource narrative. No other codes are allowed.

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.

33. Observation.dataAbsentReason.coding
Control10..1
34. Observation.dataAbsentReason.coding.code
Control0..?
Comments

Note that FHIR strings may not exceed 1MB in size. Finnish PHR: Code 'error' SHALL be used when a device has been actively trying to measure the blood glucose but has failed for some reason. Code 'astext' SHALL be used when the measured value cannot be stored using the valueQuantity structure (with the comparator). In this case, the value SHALL be presented in the resource narrative. No other codes are allowed.

35. Observation.component
Control0..0*

Guidance on how to interpret the contents of this table can be found here.

1. Observation
Definition

Finnish PHR profile for Observation used in blood glucose measurements. The profile is based on the Finnish PHR observation profile.

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

Control0..*
Alternate NamesVital Signs, Measurement, Results, Tests
Comments

.

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

InvariantsDefined on this element
PHR-1: Resource SHALL contain code '15074-8' or '14743-9' or '14745-4' (: (code.coding.where(code='15074-8').exists()) or (code.coding.where(code='14743-9').exists()) or (code.coding.where(code='14745-4').exists()))
PHR-2: When using code '15074-8' also code '14743-9' SHALL be used (: code.coding.where(code='15074-8').exists() implies code.coding.where(code='14743-9').exists())
PHR-3: When using code '14743-9' also code '15074-8' SHALL be used (: code.coding.where(code='14743-9').exists() implies code.coding.where(code='15074-8').exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present (: dataAbsentReason.empty() or value.empty())
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present (: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty())
vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present. (: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()))
2. Observation.meta
Definition

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

Control10..1 This element is affected by the following invariants: ele-1
TypeMeta
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. Observation.meta.profile
Definition

FinnishPHR: Profile required. The URL is a reference to StructureDefinition.url.

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control10..* This element is affected by the following invariants: ele-1
Typecanonical(StructureDefinition)
Summarytrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
4. Observation.meta.profile:fiphrProfile
SliceNamefiphrProfile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control10..1* This element is affected by the following invariants: ele-1
Typecanonical(StructureDefinition)
Summarytrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Fixed Valuehttp://phr.kanta.fi/StructureDefinition/fiphr-sd-bloodglucose
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Observation.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1 This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Observation.language
Definition

The base language in which the resource is written.

Control10..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from CommonLanguagesThe codes SHOULD be taken from CommonLanguages

Finnish PHR: A code of human language.

A human language.

Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Observation.text
Definition

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

Control10..1 This element is affected by the following invariants: ele-1
TypeNarrative
Standards StatusNormative (from Trial Use)
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Observation.extension
Definition

An Extension

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Observation.extension:creatingApplication
SliceNamecreatingApplication
Definition

Application identification information. SHALL have same values that has been registered for application in PHR application catalog.

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

Control This element is affected by the following invariants: ele-1
TypeExtension(FIPHREXTCreatingApplication) (Complex Extension)
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
InvariantsDefined on this element
ele-1: (: )
ext-1: (: )
10. Observation.extension:hoursAfterMeal
SliceNamehoursAfterMeal
Definition

Meal context, how many hours after meal measurement is done.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(FIPHREXTUnsignedInt) (Extension Type: unsignedInt)
Requirements

Meal context needed for result interpretation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue
Standards StatusNormative (from Trial Use)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
12. Observation.identifier
Definition

A unique identifier assigned to this observation. Finnish PHR: At least one of the identifiers SHALL be globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).

A unique identifier assigned to this observation.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..* This element is affected by the following invariants: ele-1
TypeIdentifier
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows observations to be distinguished and referenced.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Observation.identifier.use
Definition

The purpose of this identifier. Finnish PHR: The code 'official' SHALL be only used if the given identifier value is truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).

The purpose of this identifier.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Observation.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Must Supporttrue
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Observation.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1 This element is affected by the following invariants: ele-1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
General:urn:ietf:rfc:3986
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Observation.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system. Finnish PHR: At least one of the identifiers SHALL be truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Observation.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..01 This element is affected by the following invariants: ele-1
TypeReference(Organization)
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
18. Observation.basedOn
Definition

A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

Control0..0* This element is affected by the following invariants: ele-1
TypeReference(CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder|ServiceRequest)
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Alternate NamesFulfills
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
19. Observation.partOf
Definition

A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

Control0..0* This element is affected by the following invariants: ele-1
TypeReference(MedicationAdministration|MedicationDispense|MedicationStatement|Procedure|Immunization|ImagingStudy)
Standards StatusNormative (from Trial Use)
Summarytrue
Alternate NamesContainer
Comments

To link an Observation to an Encounter use encounter. See the Notes below for guidance on referencing another Observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
20. Observation.status
Definition

Finnish PHR: The status of the result value.

The status of the result value.

Control1..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ObservationStatus

Codes providing the status of an observation.

Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
Requirements

Finnish PHR: Need to track the status of individual results. Erronous observation may not be stored in FinnishPHR.

Need to track the status of individual results. Some results are finalized before the whole report is finalized.

Comments

Finnish PHR: Only status 'final' shall be used in FinnishPHR.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Fixed Valuefinal
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Observation.category
Definition

Classification of type of observation.

A code that classifies the general type of observation being made.

Control10..* This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from ObservationCategoryCodes

Classification of type of observation.

Codes for high level observation categories.

TypeCodeableConcept
Must Supporttrue
Standards StatusNormative (from Trial Use)
Requirements

All resources all vital signs observations.

Used for filtering what observations are retrieved and displayed.

Comments

FinnishPHR: Vital-sign code SHALL be used. Additional codes MAY be used. (defined by the value set). More fine-grained filtering can be performed using the Observation.code.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.category. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ coding.code
  • value @ coding.code,
22. Observation.category:VSCat
SliceNameVSCat
Definition

A code that classifies the general type of observation being made.

Control10..1* This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ObservationCategoryCodesThe codes SHOULD be taken from ObservationCategoryCodes

Codes for high level observation categories.

TypeCodeableConcept
Must Supporttrue
Standards StatusNormative (from Trial Use)
Requirements

Used for filtering what observations are retrieved and displayed.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Observation.category:VSCat.coding
Definition

A reference to a code defined by a terminology system.

Control10..* This element is affected by the following invariants: ele-1
TypeCoding
Must Supporttrue
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Observation.category:VSCat.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1 This element is affected by the following invariants: ele-1
Typeuri
Must Supporttrue
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/observation-category
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Observation.category:VSCat.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).

Control10..1 This element is affected by the following invariants: ele-1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Fixed Valuevital-signs
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Observation.code
Definition

Coded Responses from C-CDA Vital Sign Results.

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

Control1..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Value Set Finnish PHR Vital Signs; other codes may be used where these codes are not suitableFor example codes, see LOINCCodes

This identifies the vital sign result type.

Codes identifying names of simple observations.

TypeCodeableConcept
Must Supporttrue
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements
  1. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).

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

Alternate NamesName
Comments

Describes type of observation.

All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Observation.code.coding
Definition

This code SHALL be used with CGM readings.

A reference to a code defined by a terminology system.

Control10..*
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

This code SHALL be used with CGM readings. Ordering of codings is undefined and SHALL NOT be used to infer meaning.

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.

InvariantsDefined on this element
PHR-1: When using code '15074-8' or '14743-9' or '14745-4' system http://loinc.org SHALL be used (: (where(code='15074-8').exists()) or (where(code='14743-9').exists()) or (where(code='14745-4').exists()) implies where(system="http://loinc.org").exists())
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
  • value @ code,
28. Observation.code.coding:GlucoseInBlood
SliceNameGlucoseInBlood
Definition

A reference to a code defined by a terminology system.

Control0..1*
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Observation.code.coding:GlucoseInBlood.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Observation.code.coding:GlucoseInBlood.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).

Control10..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Value15074-8
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Observation.code.coding:GlucoseInBlood.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control10..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer
SliceNameGlucoseInCapillaryBloodByGlucometer
Definition

A reference to a code defined by a terminology system.

Control0..1*
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.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).

Control10..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Value14743-9
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control10..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Observation.code.coding:GlucoseInBodyFluid
SliceNameGlucoseInBodyFluid
Definition

A reference to a code defined by a terminology system.

Control0..1*
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Observation.code.coding:GlucoseInBodyFluid.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Observation.code.coding:GlucoseInBodyFluid.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).

Control10..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Value14745-4
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Observation.code.coding:GlucoseInBodyFluid.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control10..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Observation.subject
Definition

Finnish PHR: The patient described by the observation and into whose record the observation is placed.

The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

Control10..1 This element is affected by the following invariants: ele-1
TypeReference(FIPHRSDPatient|Patient|Group|Device|Location) : {r}
Must Supporttrue
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Finnish PHR: Observations have always known the Patient

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

Comments

Finnish PHR: Who this observation is about. Usually the same person as the application user, but if the user is storing observations on behalf of someone else, the subject is the person whose measurements or other observations are entered.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
41. Observation.subject.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.

Control10..1 This element is affected by the following invariants: ele-1, ref-1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Observation.focus
Definition

The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

Control0..0* This element is affected by the following invariants: ele-1
TypeReference(Resource)
Standards StatusTrial Use (from Trial Use)
Summarytrue
Comments

Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use specimen if a reference to a specimen is required. If a code is required instead of a resource use either bodysite for bodysites or the standard extension focusCode.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
43. Observation.encounter
Definition

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

Control0..01 This element is affected by the following invariants: ele-1
TypeReference(Encounter)
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Alternate NamesContext
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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
44. Observation.effective[x]
Definition

Often just a dateTime for Vital Signs.

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.

Control10..1 This element is affected by the following invariants: ele-1, vs-1
TypeChoice of: dateTime, Period, Timing, instant
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Summarytrue
Requirements

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

Alternate NamesOccurrence
Comments

At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day (: ($this as dateTime).toString().length() >= 8)
SlicingThis element introduces a set of slices on Observation.effective[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
45. Observation.effective[x]:effectiveDateTime
SliceNameeffectiveDateTime
Definition

Often just a dateTime for Vital Signs.

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.

Control10..1 This element is affected by the following invariants: ele-1, vs-1
TypeChoice of: dateTime, Period, Timing, instant
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Summarytrue
Requirements

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

Alternate NamesOccurrence
Comments

At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day (: ($this as dateTime).toString().length() >= 8)
46. Observation.issued
Definition

Finnish PHR: The date and time this observation is stored

The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

Control10..1 This element is affected by the following invariants: ele-1
Typeinstant
Summarytrue
Comments

Updated when the result is updated.

For Observations that don’t require review and verification, it may be the same as the lastUpdated time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the lastUpdated time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Observation.performer
Definition

FinnishPHR: Application user who was responsible for asserting the observed value as "true".

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

Control10..1* This element is affected by the following invariants: ele-1
TypeReference(FIPHRSDPatient|Practitioner|PractitionerRole|Organization|CareTeam|Patient|RelatedPerson) : {r}
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
48. 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.

Control10..1 This element is affected by the following invariants: ele-1, ref-1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Observation.value[x]
Definition

FinnishPHR: Glucose in blood

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

Control0..1 This element is affected by the following invariants: ele-1, obs-7, vs-2
TypeChoice of: Quantity, dateTime, boolean, string, SampledData, Period, Ratio, integer, time, Range, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Summarytrue
Requirements
  1. SHALL contain exactly one [1..1] value with @xsi:type="PQ" (CONF:7305).

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

Comments

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.

An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists())
50. Observation.value[x].extension
Definition

An Extension

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
51. Observation.value[x].extension:alternativeQuantity
SliceNamealternativeQuantity
Definition

Finnish PHR physical quantity translation extension to express an alternative representation of the same physical quantity expressed in a different unit from a different unit code system and possibly with a different value.

Control0..1
TypeExtension(FIPHREXTPqTranslation) (Extension Type: Quantity)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
52. Observation.value[x].extension:alternativeQuantity.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
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.

Fixed Valuehttp://phr.kanta.fi/StructureDefinition/fiphr-ext-pq-translation
53. Observation.value[x].value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control10..1
Typedecimal
Summarytrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Observation.value[x].comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1
BindingThe codes SHALL be taken from QuantityComparator

How the Quantity should be understood and represented.

Typecode
Is Modifiertrue
Summarytrue
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 MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. Observation.value[x].unit
Definition

A human-readable form of the unit.

Control10..1
Typestring
Summarytrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Fixed Valuemmol/l
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. Observation.value[x].system
Definition

The identification of the system that provides the coded form of the unit.

Control10..1 This element is affected by the following invariants: qty-3
Typeuri
Summarytrue
Requirements

Need to know the system that defines the coded form of the unit.

Fixed Valuehttp://unitsofmeasure.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. Observation.value[x].code
Definition

A computer processable form of the unit in some unit representation system.

Control10..1
Typecode
Summarytrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Fixed Valuemmol/L
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Observation.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.value[x] is missing. Finnish PHR: Codes 'astext' and 'error' are allowed, no other codes.

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

Control0..1 This element is affected by the following invariants: ele-1, obs-6, vs-2
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable

Codes specifying why the result (Observation.value[x]) is missing.

Codes specifying why the result (Observation.value[x]) is missing.

TypeCodeableConcept
Must Supporttrue
Requirements

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

Comments

Finnish PHR: Code 'error' SHALL be used when a device has been actively trying to measure the blood glucose but has failed for some reason. Code 'astext' SHALL be used when the measured value cannot be stored using the valueQuantity structure (with the comparator). In this case, the value SHALL be presented in the resource narrative. No other codes are allowed.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. Observation.dataAbsentReason.coding
Definition

A reference to a code defined by a terminology system.

Control10..1* This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.dataAbsentReason.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
60. Observation.dataAbsentReason.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).

Control0..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size. Finnish PHR: Code 'error' SHALL be used when a device has been actively trying to measure the blood glucose but has failed for some reason. Code 'astext' SHALL be used when the measured value cannot be stored using the valueQuantity structure (with the comparator). In this case, the value SHALL be presented in the resource narrative. No other codes are allowed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. Observation.dataAbsentReason.coding:fiphrDataAbsentReason
SliceNamefiphrDataAbsentReason
Definition

A reference to a code defined by a terminology system.

Control10..1* This element is affected by the following invariants: ele-1
TypeCoding
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. Observation.dataAbsentReason.coding:fiphrDataAbsentReason.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1 This element is affected by the following invariants: ele-1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/data-absent-reason
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. Observation.dataAbsentReason.coding:fiphrDataAbsentReason.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).

Control10..1 This element is affected by the following invariants: ele-1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. Observation.dataAbsentReason.coding:fiphrDataAbsentReason.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control10..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. Observation.interpretation
Definition

Finnish PHR: The assessment made based on the result of the observation. Intended as a simple compact code placed adjacent to the result value. Otherwise known as abnormal flag.

A categorical assessment of an observation value. For example, high, low, normal.

Control0..1* This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable

Finnish PHR: Codes identifying interpretations of observations.

Codes identifying interpretations of observations.

TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Requirements

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

Alternate NamesAbnormal Flag
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. Observation.interpretation.coding
Definition

A reference to a code defined by a terminology system.

Control10..* This element is affected by the following invariants: ele-1
TypeCoding
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.interpretation.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
67. Observation.interpretation.coding:fiphrInterpretation
SliceNamefiphrInterpretation
Definition

A reference to a code defined by a terminology system.

Control10..1* This element is affected by the following invariants: ele-1
TypeCoding
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. Observation.interpretation.coding:fiphrInterpretation.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1 This element is affected by the following invariants: ele-1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. Observation.interpretation.coding:fiphrInterpretation.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).

Control10..1 This element is affected by the following invariants: ele-1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
70. Observation.interpretation.coding:fiphrInterpretation.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control10..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. Observation.bodySite
Definition

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

Control0..01 This element is affected by the following invariants: ele-1
BindingFor example codes, see SNOMEDCTBodyStructures

Codes describing anatomical locations. May include laterality.

TypeCodeableConcept
Standards StatusNormative (from Trial Use)
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 bodySite.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. Observation.method
Definition

Indicates the mechanism used to perform the observation.

Control0..01 This element is affected by the following invariants: ele-1
BindingFor example codes, see ObservationMethods

Methods for simple observations.

TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. Observation.specimen
Definition

The specimen that was used when this observation was made.

Control0..01 This element is affected by the following invariants: ele-1
TypeReference(Specimen)
Standards StatusNormative (from Trial Use)
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
74. Observation.device
Definition

The device used to generate the observation data.

Control0..01 This element is affected by the following invariants: ele-1
TypeReference(Device|DeviceMetric)
Standards StatusNormative (from Trial Use)
Comments

Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
75. Observation.hasMember
Definition

Used when reporting vital signs panel components.

This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

Control0..0* This element is affected by the following invariants: ele-1
TypeReference(QuestionnaireResponse|observation-vitalsigns|Observation|MolecularSequence) : {r}
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see Notes below. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
76. Observation.derivedFrom
Definition

The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

Control0..0* This element is affected by the following invariants: ele-1
TypeReference(DocumentReference|ImagingStudy|Media|QuestionnaireResponse|MolecularSequence|observation-vitalsigns|Observation)
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
77. Observation.component
Definition

Used when reporting systolic and diastolic blood pressure.

Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

Control0..0* This element is affected by the following invariants: ele-1
TypeBackboneElement
Must Supporttrue
Summarytrue
Requirements

Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.

Comments

Profiled further in derived profiles that use components.

For a discussion on the ways Observations can be assembled in groups together see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
vs-3: If there is no a value a data absent reason must be present (: value.exists() or dataAbsentReason.exists())

Guidance on how to interpret the contents of this table can be found here.

1. Observation
Definition

Finnish PHR profile for Observation used in blood glucose measurements. The profile is based on the Finnish PHR observation profile.

Control0..*
Alternate NamesVital Signs, Measurement, Results, Tests
Comments

.

2. Observation.id
Definition

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

Control0..1
Typeid
Summarytrue
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.

3. Observation.meta
Definition

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

Control1..1 This element is affected by the following invariants: ele-1
TypeMeta
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Observation.meta.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
5. Observation.meta.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Observation.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
Summarytrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Observation.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1 This element is affected by the following invariants: ele-1
Typeinstant
Summarytrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Observation.meta.source
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Control0..1 This element is affected by the following invariants: ele-1
Typeuri
Summarytrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Observation.meta.profile
Definition

FinnishPHR: Profile required. The URL is a reference to StructureDefinition.url.

Control1..* This element is affected by the following invariants: ele-1
Typecanonical(StructureDefinition)
Summarytrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
10. Observation.meta.profile:fiphrProfile
SliceNamefiphrProfile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..1 This element is affected by the following invariants: ele-1
Typecanonical(StructureDefinition)
Summarytrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Fixed Valuehttp://phr.kanta.fi/StructureDefinition/fiphr-sd-bloodglucose
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Observation.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..* This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
TypeCoding
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Observation.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..* This element is affected by the following invariants: ele-1
BindingFor example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
TypeCoding
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Observation.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1 This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Observation.language
Definition

The base language in which the resource is written.

Control1..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from CommonLanguages Finnish PHR: A code of human language
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Observation.text
Definition

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

Control1..1 This element is affected by the following invariants: ele-1
TypeNarrative
Standards StatusNormative (from Trial Use)
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Observation.contained
Definition

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

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

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

17. Observation.extension
Definition

An Extension

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
18. Observation.extension:creatingApplication
SliceNamecreatingApplication
Definition

Application identification information. SHALL have same values that has been registered for application in PHR application catalog.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(FIPHREXTCreatingApplication) (Complex Extension)
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
19. Observation.extension:hoursAfterMeal
SliceNamehoursAfterMeal
Definition

Meal context, how many hours after meal measurement is done.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(FIPHREXTUnsignedInt) (Extension Type: unsignedInt)
Requirements

Meal context needed for result interpretation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
20. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue
Standards StatusNormative (from Trial Use)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
21. Observation.identifier
Definition

A unique identifier assigned to this observation. Finnish PHR: At least one of the identifiers SHALL be globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..* This element is affected by the following invariants: ele-1
TypeIdentifier
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows observations to be distinguished and referenced.

22. Observation.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
23. Observation.identifier.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. Observation.identifier.use
Definition

The purpose of this identifier. Finnish PHR: The code 'official' SHALL be only used if the given identifier value is truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Observation.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Must Supporttrue
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Observation.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1 This element is affected by the following invariants: ele-1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Example
General:http://www.acme.com/identifiers/patient
General:urn:ietf:rfc:3986
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Observation.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system. Finnish PHR: At least one of the identifiers SHALL be truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).

Control1..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Observation.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1 This element is affected by the following invariants: ele-1
TypePeriod
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (: start.hasValue().not() or end.hasValue().not() or (start <= end))
29. Observation.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(Organization)
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
30. Observation.basedOn
Definition

A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder|ServiceRequest)
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Alternate NamesFulfills
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
31. Observation.partOf
Definition

A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(MedicationAdministration|MedicationDispense|MedicationStatement|Procedure|Immunization|ImagingStudy)
Standards StatusNormative (from Trial Use)
Summarytrue
Alternate NamesContainer
Comments

To link an Observation to an Encounter use encounter. See the Notes below for guidance on referencing another Observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
32. Observation.status
Definition

Finnish PHR: The status of the result value.

Control1..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ObservationStatus Codes providing the status of an observation
Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
Requirements

Finnish PHR: Need to track the status of individual results. Erronous observation may not be stored in FinnishPHR.

Comments

Finnish PHR: Only status 'final' shall be used in FinnishPHR.

Fixed Valuefinal
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Observation.category
Definition

Classification of type of observation.

Control1..* This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from ObservationCategoryCodes Classification of type of observation
TypeCodeableConcept
Must Supporttrue
Standards StatusNormative (from Trial Use)
Requirements

All resources all vital signs observations.

Comments

FinnishPHR: Vital-sign code SHALL be used. Additional codes MAY be used. (defined by the value set). More fine-grained filtering can be performed using the Observation.code.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.category. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ coding.code
  • value @ coding.code,
34. Observation.category:VSCat
SliceNameVSCat
Definition

A code that classifies the general type of observation being made.

Control1..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ObservationCategoryCodes Codes for high level observation categories
TypeCodeableConcept
Must Supporttrue
Standards StatusNormative (from Trial Use)
Requirements

Used for filtering what observations are retrieved and displayed.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Observation.category:VSCat.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
36. Observation.category:VSCat.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.category.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
37. Observation.category:VSCat.coding
Definition

A reference to a code defined by a terminology system.

Control1..* This element is affected by the following invariants: ele-1
TypeCoding
Must Supporttrue
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Observation.category:VSCat.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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
39. Observation.category:VSCat.coding.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.category.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
40. Observation.category:VSCat.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1 This element is affected by the following invariants: ele-1
Typeuri
Must Supporttrue
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/observation-category
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Observation.category:VSCat.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Observation.category:VSCat.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).

Control1..1 This element is affected by the following invariants: ele-1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Fixed Valuevital-signs
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Observation.category:VSCat.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Observation.category:VSCat.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1 This element is affected by the following invariants: ele-1
Typeboolean
Summarytrue
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.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Observation.category:VSCat.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.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
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.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Observation.code
Definition

Coded Responses from C-CDA Vital Sign Results.

Control1..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Value Set Finnish PHR Vital Signs; other codes may be used where these codes are not suitable This identifies the vital sign result type
TypeCodeableConcept
Must Supporttrue
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements
  1. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).
Alternate NamesName
Comments

Describes type of observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
48. Observation.code.extension
Definition

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
49. Observation.code.coding
Definition

This code SHALL be used with CGM readings.

Control1..*
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

This code SHALL be used with CGM readings. Ordering of codings is undefined and SHALL NOT be used to infer meaning.

InvariantsDefined on this element
PHR-1: When using code '15074-8' or '14743-9' or '14745-4' system http://loinc.org SHALL be used (: (where(code='15074-8').exists()) or (where(code='14743-9').exists()) or (where(code='14745-4').exists()) implies where(system="http://loinc.org").exists())
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
  • value @ code,
50. Observation.code.coding:GlucoseInBlood
SliceNameGlucoseInBlood
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Observation.code.coding:GlucoseInBlood.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
52. Observation.code.coding:GlucoseInBlood.extension
Definition

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
53. Observation.code.coding:GlucoseInBlood.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Observation.code.coding:GlucoseInBlood.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. Observation.code.coding:GlucoseInBlood.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).

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Value15074-8
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. Observation.code.coding:GlucoseInBlood.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. Observation.code.coding:GlucoseInBlood.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
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.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer
SliceNameGlucoseInCapillaryBloodByGlucometer
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
60. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.extension
Definition

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
61. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.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).

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Value14743-9
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. Observation.code.coding:GlucoseInCapillaryBloodByGlucometer.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
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.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. Observation.code.coding:GlucoseInBodyFluid
SliceNameGlucoseInBodyFluid
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. Observation.code.coding:GlucoseInBodyFluid.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
68. Observation.code.coding:GlucoseInBodyFluid.extension
Definition

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
69. Observation.code.coding:GlucoseInBodyFluid.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
70. Observation.code.coding:GlucoseInBodyFluid.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. Observation.code.coding:GlucoseInBodyFluid.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).

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Value14745-4
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. Observation.code.coding:GlucoseInBodyFluid.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. Observation.code.coding:GlucoseInBodyFluid.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
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.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. 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.

Control0..1
Typestring
Summarytrue
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.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. Observation.subject
Definition

Finnish PHR: The patient described by the observation and into whose record the observation is placed.

Control1..1 This element is affected by the following invariants: ele-1
TypeReference(FIPHRSDPatient) : {r}
Must Supporttrue
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Finnish PHR: Observations have always known the Patient

Comments

Finnish PHR: Who this observation is about. Usually the same person as the application user, but if the user is storing observations on behalf of someone else, the subject is the person whose measurements or other observations are entered.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
76. Observation.subject.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
77. Observation.subject.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
78. Observation.subject.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.

Control1..1 This element is affected by the following invariants: ele-1, ref-1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. Observation.subject.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model)
Typeuri
Summarytrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
80. Observation.subject.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1 This element is affected by the following invariants: ele-1
TypeIdentifier
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
81. Observation.subject.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
82. Observation.subject.identifier.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.subject.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
83. Observation.subject.identifier.use
Definition

The purpose of this identifier.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
84. Observation.subject.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. Observation.subject.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1 This element is affected by the following invariants: ele-1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. Observation.subject.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. Observation.subject.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1 This element is affected by the following invariants: ele-1
TypePeriod
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (: start.hasValue().not() or end.hasValue().not() or (start <= end))
88. Observation.subject.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(Organization)
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
89. Observation.subject.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
90. Observation.focus
Definition

The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(Resource)
Standards StatusTrial Use (from Trial Use)
Summarytrue
Comments

Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use specimen if a reference to a specimen is required. If a code is required instead of a resource use either bodysite for bodysites or the standard extension focusCode.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
91. Observation.encounter
Definition

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

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(Encounter)
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Alternate NamesContext
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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
92. Observation.effective[x]
Definition

Often just a dateTime for Vital Signs.

Control1..1 This element is affected by the following invariants: ele-1, vs-1
TypedateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Summarytrue
Requirements

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

Alternate NamesOccurrence
Comments

At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day (: ($this as dateTime).toString().length() >= 8)
SlicingThis element introduces a set of slices on Observation.effective[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
93. Observation.effective[x]:effectiveDateTime
SliceNameeffectiveDateTime
Definition

Often just a dateTime for Vital Signs.

Control1..1 This element is affected by the following invariants: ele-1, vs-1
TypedateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Summarytrue
Requirements

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

Alternate NamesOccurrence
Comments

At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day (: ($this as dateTime).toString().length() >= 8)
94. Observation.issued
Definition

Finnish PHR: The date and time this observation is stored

Control1..1 This element is affected by the following invariants: ele-1
Typeinstant
Summarytrue
Comments

Updated when the result is updated.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
95. Observation.performer
Definition

FinnishPHR: Application user who was responsible for asserting the observed value as "true".

Control1..1 This element is affected by the following invariants: ele-1
TypeReference(FIPHRSDPatient) : {r}
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
96. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
97. Observation.performer.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.performer.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
98. 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.

Control1..1 This element is affected by the following invariants: ele-1, ref-1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
99. Observation.performer.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model)
Typeuri
Summarytrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
100. Observation.performer.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1 This element is affected by the following invariants: ele-1
TypeIdentifier
Standards StatusNormative (from Trial Use)
Summarytrue
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.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
101. Observation.performer.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
102. Observation.performer.identifier.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.performer.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
103. Observation.performer.identifier.use
Definition

The purpose of this identifier.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
104. Observation.performer.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
105. Observation.performer.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1 This element is affected by the following invariants: ele-1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
106. Observation.performer.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
107. Observation.performer.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1 This element is affected by the following invariants: ele-1
TypePeriod
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (: start.hasValue().not() or end.hasValue().not() or (start <= end))
108. Observation.performer.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(Organization)
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
109. Observation.performer.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
110. Observation.value[x]
Definition

FinnishPHR: Glucose in blood

Control0..1 This element is affected by the following invariants: ele-1, obs-7, vs-2
TypeQuantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Summarytrue
Requirements
  1. SHALL contain exactly one [1..1] value with @xsi:type="PQ" (CONF:7305).
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists())
111. Observation.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
112. Observation.value[x].extension
Definition

An Extension

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
113. Observation.value[x].extension:alternativeQuantity
SliceNamealternativeQuantity
Definition

Finnish PHR physical quantity translation extension to express an alternative representation of the same physical quantity expressed in a different unit from a different unit code system and possibly with a different value.

Control0..1
TypeExtension(FIPHREXTPqTranslation) (Extension Type: Quantity)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
114. Observation.value[x].extension:alternativeQuantity.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
115. Observation.value[x].extension:alternativeQuantity.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.value[x].extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
116. Observation.value[x].extension:alternativeQuantity.url
Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuehttp://phr.kanta.fi/StructureDefinition/fiphr-ext-pq-translation
117. Observation.value[x].extension:alternativeQuantity.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1 This element is affected by the following invariants: ele-1
TypeQuantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

A stream of bytes, base64 encoded

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
118. Observation.value[x].extension:alternativeQuantity.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
119. Observation.value[x].extension:alternativeQuantity.value[x].extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.value[x].extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
120. Observation.value[x].extension:alternativeQuantity.value[x].value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control1..1 This element is affected by the following invariants: ele-1
Typedecimal
Summarytrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
121. Observation.value[x].extension:alternativeQuantity.value[x].comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented
Typecode
Is Modifiertrue
Summarytrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning if MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
122. Observation.value[x].extension:alternativeQuantity.value[x].unit
Definition

A human-readable form of the unit.

Control1..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
123. Observation.value[x].extension:alternativeQuantity.value[x].system
Definition

The identification of the system that provides the coded form of the unit.

Control1..1 This element is affected by the following invariants: ele-1, qty-3
Typeuri
Summarytrue
Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Fixed Valuehttp://unitsofmeasure.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
124. Observation.value[x].extension:alternativeQuantity.value[x].code
Definition

A computer processable form of the unit in some unit representation system.

Control1..1 This element is affected by the following invariants: ele-1
Typecode
Summarytrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
125. Observation.value[x].value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control1..1
Typedecimal
Summarytrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
126. Observation.value[x].comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1
BindingThe codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented
Typecode
Is Modifiertrue
Summarytrue
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 MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
127. Observation.value[x].unit
Definition

A human-readable form of the unit.

Control1..1
Typestring
Summarytrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Fixed Valuemmol/l
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
128. Observation.value[x].system
Definition

The identification of the system that provides the coded form of the unit.

Control1..1 This element is affected by the following invariants: qty-3
Typeuri
Summarytrue
Requirements

Need to know the system that defines the coded form of the unit.

Fixed Valuehttp://unitsofmeasure.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
129. Observation.value[x].code
Definition

A computer processable form of the unit in some unit representation system.

Control1..1
Typecode
Summarytrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Fixed Valuemmol/L
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
130. Observation.dataAbsentReason
Definition

Provides a reason why the expected value in the element Observation.value[x] is missing. Finnish PHR: Codes 'astext' and 'error' are allowed, no other codes.

Control0..1 This element is affected by the following invariants: ele-1, obs-6, vs-2
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result (Observation.value[x]) is missing
TypeCodeableConcept
Must Supporttrue
Requirements

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

Comments

Finnish PHR: Code 'error' SHALL be used when a device has been actively trying to measure the blood glucose but has failed for some reason. Code 'astext' SHALL be used when the measured value cannot be stored using the valueQuantity structure (with the comparator). In this case, the value SHALL be presented in the resource narrative. No other codes are allowed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
131. Observation.dataAbsentReason.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
132. Observation.dataAbsentReason.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.dataAbsentReason.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
133. Observation.dataAbsentReason.coding
Definition

A reference to a code defined by a terminology system.

Control1..1 This element is affected by the following invariants: ele-1
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.dataAbsentReason.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
134. Observation.dataAbsentReason.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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
135. Observation.dataAbsentReason.coding.extension
Definition

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.dataAbsentReason.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
136. Observation.dataAbsentReason.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
137. Observation.dataAbsentReason.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
138. Observation.dataAbsentReason.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).

Control0..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size. Finnish PHR: Code 'error' SHALL be used when a device has been actively trying to measure the blood glucose but has failed for some reason. Code 'astext' SHALL be used when the measured value cannot be stored using the valueQuantity structure (with the comparator). In this case, the value SHALL be presented in the resource narrative. No other codes are allowed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
139. Observation.dataAbsentReason.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
140. Observation.dataAbsentReason.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
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.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
141. Observation.dataAbsentReason.coding:fiphrDataAbsentReason
SliceNamefiphrDataAbsentReason
Definition

A reference to a code defined by a terminology system.

Control1..1 This element is affected by the following invariants: ele-1
TypeCoding
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
142. Observation.dataAbsentReason.coding:fiphrDataAbsentReason.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
143. Observation.dataAbsentReason.coding:fiphrDataAbsentReason.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.dataAbsentReason.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
144. Observation.dataAbsentReason.coding:fiphrDataAbsentReason.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1 This element is affected by the following invariants: ele-1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/data-absent-reason
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
145. Observation.dataAbsentReason.coding:fiphrDataAbsentReason.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
146. Observation.dataAbsentReason.coding:fiphrDataAbsentReason.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).

Control1..1 This element is affected by the following invariants: ele-1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
147. Observation.dataAbsentReason.coding:fiphrDataAbsentReason.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
148. Observation.dataAbsentReason.coding:fiphrDataAbsentReason.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1 This element is affected by the following invariants: ele-1
Typeboolean
Summarytrue
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.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
149. Observation.dataAbsentReason.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.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
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.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
150. Observation.interpretation
Definition

Finnish PHR: The assessment made based on the result of the observation. Intended as a simple compact code placed adjacent to the result value. Otherwise known as abnormal flag.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Finnish PHR: Codes identifying interpretations of observations
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Requirements

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

Alternate NamesAbnormal Flag
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
151. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
152. Observation.interpretation.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.interpretation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
153. Observation.interpretation.coding
Definition

A reference to a code defined by a terminology system.

Control1..* This element is affected by the following invariants: ele-1
TypeCoding
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Observation.interpretation.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
154. Observation.interpretation.coding:fiphrInterpretation
SliceNamefiphrInterpretation
Definition

A reference to a code defined by a terminology system.

Control1..1 This element is affected by the following invariants: ele-1
TypeCoding
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
155. Observation.interpretation.coding:fiphrInterpretation.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
156. Observation.interpretation.coding:fiphrInterpretation.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.interpretation.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
157. Observation.interpretation.coding:fiphrInterpretation.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1 This element is affected by the following invariants: ele-1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

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 reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
158. Observation.interpretation.coding:fiphrInterpretation.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
159. Observation.interpretation.coding:fiphrInterpretation.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).

Control1..1 This element is affected by the following invariants: ele-1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
160. Observation.interpretation.coding:fiphrInterpretation.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
161. Observation.interpretation.coding:fiphrInterpretation.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1 This element is affected by the following invariants: ele-1
Typeboolean
Summarytrue
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.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
162. 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.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
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.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
163. Observation.note
Definition

Comments about the observation or the results.

Control0..* This element is affected by the following invariants: ele-1
TypeAnnotation
Standards StatusNormative (from Trial Use)
Requirements

Need to be able to provide free text additional information.

Comments

May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
164. Observation.note.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
165. Observation.note.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
166. Observation.note.author[x]
Definition

The individual responsible for making the annotation.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(FIPHRSDPatient)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Fixed Value<valueReference xmlns="http://hl7.org/fhir">
  <reference value="http://phr.kanta.fi/StructureDefinition/fiphr-sd-patient"/>
</valueReference>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
167. Observation.note.time
Definition

Indicates when this particular annotation was made.

Control0..1 This element is affected by the following invariants: ele-1
TypedateTime
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
168. Observation.note.text
Definition

The text of the annotation in markdown format.

Control1..1 This element is affected by the following invariants: ele-1
Typemarkdown
Summarytrue
Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
169. Observation.bodySite
Definition

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

Control0..0 This element is affected by the following invariants: ele-1
BindingFor example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
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 bodySite.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
170. Observation.method
Definition

Indicates the mechanism used to perform the observation.

Control0..0 This element is affected by the following invariants: ele-1
BindingFor example codes, see ObservationMethods Methods for simple observations
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
171. Observation.specimen
Definition

The specimen that was used when this observation was made.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(Specimen)
Standards StatusNormative (from Trial Use)
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
172. Observation.device
Definition

The device used to generate the observation data.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(Device|DeviceMetric)
Standards StatusNormative (from Trial Use)
Comments

Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
173. Observation.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two referenceRange elements would be used.

Control0..* This element is affected by the following invariants: ele-1
TypeBackboneElement
Standards StatusNormative (from Trial Use)
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (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())
174. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
175. Observation.referenceRange.extension
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.referenceRange.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
176. Observation.referenceRange.modifierExtension
Definition

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

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
177. Observation.referenceRange.low
Definition

The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).

Control0..1 This element is affected by the following invariants: ele-1, obs-3
TypeQuantity(SimpleQuantity)
Standards StatusNormative (from Trial Use)
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty())
178. Observation.referenceRange.high
Definition

The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

Control0..1 This element is affected by the following invariants: ele-1, obs-3
TypeQuantity(SimpleQuantity)
Standards StatusNormative (from Trial Use)
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty())
179. 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.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from ObservationReferenceRangeMeaningCodes Code for the meaning of a reference range
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Requirements

Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
180. 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. Multiple appliesTo are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

Control0..* This element is affected by the following invariants: ele-1
BindingFor example codes, see ObservationReferenceRangeAppliesToCodes Codes identifying the population the reference range applies to
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Requirements

Need to be able to identify the target population for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
181. Observation.referenceRange.age
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
TypeRange
Standards StatusNormative (from Trial Use)
Requirements

Some analytes vary greatly over age.

Comments

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
rng-2: If present, low SHALL have a lower value than high (: low.empty() or high.empty() or (low <= high))
182. Observation.referenceRange.text
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
183. Observation.hasMember
Definition

Used when reporting vital signs panel components.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(QuestionnaireResponse|observation-vitalsigns) : {r}
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see Notes below. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
184. Observation.derivedFrom
Definition

The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(DocumentReference|ImagingStudy|Media|QuestionnaireResponse|MolecularSequence|observation-vitalsigns)
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
185. Observation.component
Definition

Used when reporting systolic and diastolic blood pressure.

Control0..0 This element is affected by the following invariants: ele-1
TypeBackboneElement
Must Supporttrue
Summarytrue
Requirements

Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.

Comments

Profiled further in derived profiles that use components.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
vs-3: If there is no a value a data absent reason must be present (: value.exists() or dataAbsentReason.exists())