Finnish Base Profiles
0.2.0 - ci-build
Finnish Base Profiles - Local Development build (v0.2.0). See the Directory of published versions
Draft as of 2021-02-22 |
Definitions for the fiphr-sd-moderatetovigorouspatime resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Observation | |
Definition | The PHR Fitness profile for collecting patient's time spent in moderate to vigorous physical activity (MET over 2.9) over the measured period. Measurements and simple assertions made about a patient, device or other subject. |
2. Observation.meta | |
3. Observation.meta.profile | |
4. Observation.meta.profile:fiphrProfile | |
SliceName | fiphrProfile |
Fixed Value | http://phr.kanta.fi/StructureDefinition/fiphr-sd-moderatetovigorouspatime |
5. Observation.code | |
Control | 0..? |
6. Observation.code.coding | |
Slicing | This element introduces a set of slices on Observation.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
7. Observation.code.coding:moderateToVigorousWeeklyMinutes | |
SliceName | moderateToVigorousWeeklyMinutes |
Definition | Measurement of physically active time in minutes, MET >= 3 during a week. |
Control | 0..1 |
8. Observation.code.coding:moderateToVigorousWeeklyMinutes.system | |
Control | 0..? |
Fixed Value | http://loinc.org |
9. Observation.code.coding:moderateToVigorousWeeklyMinutes.code | |
Control | 0..? |
Fixed Value | 82290-8 |
10. Observation.code.coding:moderateToVigorousPA24h | |
SliceName | moderateToVigorousPA24h |
Definition | Measurement of physically active time in minutes, MET >= 3 during a 24 hour period. |
Control | 0..1 |
11. Observation.code.coding:moderateToVigorousPA24h.system | |
Control | 0..? |
Fixed Value | http://phr.kanta.fi/fiphr-cs-moderatetovigorouspa |
12. Observation.code.coding:moderateToVigorousPA24h.code | |
Control | 0..? |
Fixed Value | 82290-8-24h |
13. Observation.value[x] | |
Control | 10..1 |
[x] Note | See Choice of Data Types for further information about how to use [x] |
14. Observation.value[x].value | |
Control | 1..? |
15. Observation.value[x].unit | |
Control | 1..? |
Fixed Value | min |
16. Observation.value[x].system | |
Control | 1..? |
Fixed Value | http://unitsofmeasure.org |
17. Observation.value[x].code | |
Control | 1..? |
Fixed Value | min |
18. Observation.component | |
Control | 0..0* |
Guidance on how to interpret the contents of this table can be found here.
1. Observation | |
Definition | The PHR Fitness profile for collecting patient's time spent in moderate to vigorous physical activity (MET over 2.9) over the measured period. Measurements and simple assertions made about a patient, device or other subject. |
Control | 0..* |
Alternate Names | Vital 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. |
Invariants | Defined on this element 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()) |
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. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | Meta |
Summary | true |
Invariants | Defined 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: fiphrProfile SHALL be used. Other profiles MAY be used. 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. |
Control | 10..* This element is affected by the following invariants: ele-1 |
Type | canonical(StructureDefinition) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. Observation.meta.profile:fiphrProfile | |
SliceName | fiphrProfile |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 10..1* This element is affected by the following invariants: ele-1 |
Type | canonical(StructureDefinition) |
Summary | true |
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 Value | http://phr.kanta.fi/StructureDefinition/fiphr-sd-moderatetovigorouspatime |
Invariants | Defined 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Is Modifier | true |
Summary | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined 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. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from CommonLanguagesThe codes SHOULD be taken from CommonLanguages Finnish PHR: A code of human language. A human language. |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants | Defined 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. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | Narrative |
Standards Status | Normative (from Normative) |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
8. Observation.extension:creatingApplication | |
SliceName | creatingApplication |
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 |
Type | Extension(FIPHREXTCreatingApplication) (Complex Extension) |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Invariants | Defined on this element ele-1: (: ) ext-1: (: ) |
9. 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). |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Is Modifier | true |
Standards Status | Normative (from Normative) |
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 Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
10. 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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..* This element is affected by the following invariants: ele-1 |
Type | Identifier |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | Allows observations to be distinguished and referenced. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. Observation.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. 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. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. Observation.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | Reference(Organization) |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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'))) |
15. 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. |
Control | 0..0* This element is affected by the following invariants: ele-1 |
Type | Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder|ServiceRequest) |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
Alternate Names | Fulfills |
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. |
Invariants | Defined 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'))) |
16. Observation.partOf | |
Definition | A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
Control | 0..0* This element is affected by the following invariants: ele-1 |
Type | Reference(MedicationAdministration|MedicationDispense|MedicationStatement|Procedure|Immunization|ImagingStudy) |
Standards Status | Normative (from Normative) |
Summary | true |
Alternate Names | Container |
Comments | To link an Observation to an Encounter use |
Invariants | Defined 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'))) |
17. Observation.status | |
Definition | Finnish PHR: The status of the result value. The status of the result value. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from ObservationStatus Codes providing the status of an observation. |
Type | code |
Is Modifier | true |
Summary | true |
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 Value | final |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. Observation.category | |
Definition | Classification of type of observation. A code that classifies the general type of observation being made. |
Control | 10..1* This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from Value Set Finnish PHR Fitness Category; other codes may be used where these codes are not suitableThe codes SHOULD be taken from ObservationCategoryCodes Finnish PHR: Codes for high level observation categories. Codes for high level observation categories. |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Requirements | All resources are fitness (physical activity) observations. Used for filtering what observations are retrieved and displayed. |
Comments | FinnishPHR: Only value fitness valid in FinnishPHR (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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. Observation.category.coding | |
Definition | FinnishPHR: fiphrCategory SHALL be used. Other categories MAY be used. A reference to a code defined by a terminology system. A reference to a code defined by a terminology system. |
Control | 10..* This element is affected by the following invariants: ele-1 |
Type | Coding |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
20. Observation.category.coding:fiphrCategory | |
SliceName | fiphrCategory |
Definition | A reference to a code defined by a terminology system. |
Control | 10..1* This element is affected by the following invariants: ele-1 |
Type | Coding |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. Observation.category.coding:fiphrCategory.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 Value | http://phr.kanta.fi/fiphr-cs-fitnesscategory |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. Observation.category.coding:fiphrCategory.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). |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Fixed Value | fitness |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
23. Observation.code | |
Definition | Describes what was observed. Sometimes this is called the observation "name". |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from Value Set Finnish PHR Fitness Results; other codes may be used where these codes are not suitableFor example codes, see LOINCCodes Codes identifying names of simple observations. |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Alternate Names | Name |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. Observation.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* This element is affected by the following invariants: ele-1 |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
25. Observation.code.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. Observation.code.coding.code | |
Definition | A symbol in syntax defined by the system. 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). |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. Observation.code.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. Observation.code.coding:moderateToVigorousWeeklyMinutes | |
SliceName | moderateToVigorousWeeklyMinutes |
Definition | Measurement of physically active time in minutes, MET >= 3 during a week. A reference to a code defined by a terminology system. |
Control | 0..1* This element is affected by the following invariants: ele-1 |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. Observation.code.coding:moderateToVigorousWeeklyMinutes.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. Observation.code.coding:moderateToVigorousWeeklyMinutes.code | |
Definition | A symbol in syntax defined by the system. 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). |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Fixed Value | 82290-8 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. Observation.code.coding:moderateToVigorousWeeklyMinutes.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
32. Observation.code.coding:moderateToVigorousPA24h | |
SliceName | moderateToVigorousPA24h |
Definition | Measurement of physically active time in minutes, MET >= 3 during a 24 hour period. A reference to a code defined by a terminology system. |
Control | 0..1* This element is affected by the following invariants: ele-1 |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. Observation.code.coding:moderateToVigorousPA24h.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 Value | http://phr.kanta.fi/fiphr-cs-moderatetovigorouspa |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. Observation.code.coding:moderateToVigorousPA24h.code | |
Definition | A symbol in syntax defined by the system. 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). |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Fixed Value | 82290-8-24h |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. Observation.code.coding:moderateToVigorousPA24h.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
36. 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 |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | Reference(FIPHRSDPatient|Patient|Group|Device|Location) : {r} |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | Finnish PHR: Observations have always known 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. |
Invariants | Defined 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'))) |
37. 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. |
Control | 10..1 This element is affected by the following invariants: ele-1, ref-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
38. 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. |
Control | 0..0* This element is affected by the following invariants: ele-1 |
Type | Reference(Resource) |
Standards Status | Trial Use (from Normative) |
Summary | true |
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 |
Invariants | Defined 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'))) |
39. Observation.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | Reference(Encounter) |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | For some observations it may be important to know the link between an observation and a particular encounter. |
Alternate Names | Context |
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). |
Invariants | Defined 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'))) |
40. Observation.effective[x] | |
Definition | The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | Choice of: dateTime, Period, Timing, instant |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. |
Alternate Names | Occurrence |
Comments | At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
41. 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. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | instant |
Summary | true |
Comments | For Observations that don’t require review and verification, it may be the same as the |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
42. 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". |
Control | 10..1* This element is affected by the following invariants: ele-1 |
Type | Reference(FIPHRSDPatient|Practitioner|PractitionerRole|Organization|CareTeam|Patient|RelatedPerson) : {r} |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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.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. |
Control | 10..1 This element is affected by the following invariants: ele-1, ref-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
44. Observation.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 10..1 This element is affected by the following invariants: ele-1, obs-7 |
Type | Choice of: Quantity, dateTime, boolean, string, SampledData, Period, Ratio, integer, time, Range, CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | 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. |
Invariants | Defined 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()) |
45. Observation.value[x].value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 10..1 |
Type | decimal |
Summary | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
46. 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented. |
Type | code |
Is Modifier | true |
Summary | true |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
47. Observation.value[x].unit | |
Definition | A human-readable form of the unit. |
Control | 10..1 |
Type | string |
Summary | true |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Fixed Value | min |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
48. Observation.value[x].system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 10..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Summary | true |
Requirements | Need to know the system that defines the coded form of the unit. |
Fixed Value | http://unitsofmeasure.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
49. Observation.value[x].code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Fixed Value | min |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
50. Observation.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.value[x] is missing. |
Control | 0..01 This element is affected by the following invariants: ele-1, obs-6 |
Binding | The codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable Codes specifying why the result ( |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Requirements | For many results it is necessary to handle exceptional values in measurements. |
Comments | Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
51. Observation.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..1* This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations. |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
52. Observation.interpretation.coding | |
Definition | FinnishPHR: fiphrInterpretation SHALL be used. Other interpretations MAY be used. A reference to a code defined by a terminology system. A reference to a code defined by a terminology system. |
Control | 10..* This element is affected by the following invariants: ele-1 |
Type | Coding |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.interpretation.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
53. Observation.interpretation.coding:fiphrInterpretation | |
SliceName | fiphrInterpretation |
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 reference to a code defined by a terminology system. |
Control | 10..1* This element is affected by the following invariants: ele-1 |
Type | Coding |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
54. Observation.interpretation.coding:fiphrInterpretation.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 Value | http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
55. 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). |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
56. Observation.interpretation.coding:fiphrInterpretation.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
57. Observation.bodySite | |
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality. |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
58. Observation.method | |
Definition | Indicates the mechanism used to perform the observation. |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see ObservationMethods Methods for simple observations. |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
59. Observation.specimen | |
Definition | The specimen that was used when this observation was made. |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | Reference(Specimen) |
Standards Status | Normative (from Normative) |
Comments | Should only be used if not implicit in code found in |
Invariants | Defined 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'))) |
60. Observation.device | |
Definition | The device used to generate the observation data. |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | Reference(Device|DeviceMetric) |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined 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'))) |
61. Observation.hasMember | |
Definition | This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
Control | 0..1* This element is affected by the following invariants: ele-1 |
Type | Reference(Observation|QuestionnaireResponse|MolecularSequence) : {r} |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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'))) |
62. Observation.hasMember.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. |
Control | 0..1 This element is affected by the following invariants: ele-1, ref-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
63. Observation.derivedFrom | |
Definition | The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
Control | 0..0* This element is affected by the following invariants: ele-1 |
Type | Reference(DocumentReference|ImagingStudy|Media|QuestionnaireResponse|Observation|MolecularSequence) |
Standards Status | Normative (from Normative) |
Summary | true |
Comments | All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. |
Invariants | Defined 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'))) |
64. Observation.component | |
Definition | Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. |
Control | 0..0* This element is affected by the following invariants: ele-1 |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
1. Observation | |
Definition | The PHR Fitness profile for collecting patient's time spent in moderate to vigorous physical activity (MET over 2.9) over the measured period. |
Control | 0..* |
Alternate Names | Vital 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. |
Control | 0..1 |
Type | id |
Summary | true |
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. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Meta |
Summary | true |
Invariants | Defined 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. |
Control | 0..1 |
Type | string |
XML Representation | In 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Summary | true |
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. |
Invariants | Defined 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | instant |
Summary | true |
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. |
Invariants | Defined 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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. |
Invariants | Defined 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: fiphrProfile SHALL be used. Other profiles MAY be used. The URL is a reference to StructureDefinition.url. |
Control | 1..* This element is affected by the following invariants: ele-1 |
Type | canonical(StructureDefinition) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
10. Observation.meta.profile:fiphrProfile | |
SliceName | fiphrProfile |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | canonical(StructureDefinition) |
Summary | true |
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 Value | http://phr.kanta.fi/StructureDefinition/fiphr-sd-moderatetovigorouspatime |
Invariants | Defined 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | The 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 |
Type | Coding |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
Type | Coding |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Is Modifier | true |
Summary | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined 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. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from CommonLanguages Finnish PHR: A code of human language |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants | Defined 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. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Narrative |
Standards Status | Normative (from Normative) |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants | Defined 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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
17. Observation.extension | |
Definition | 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 | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
18. Observation.extension:creatingApplication | |
SliceName | creatingApplication |
Definition | Application identification information. SHALL have same values that has been registered for application in PHR application catalog. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(FIPHREXTCreatingApplication) (Complex Extension) |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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.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). |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Is Modifier | true |
Standards Status | Normative (from Normative) |
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 Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
20. 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). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* This element is affected by the following invariants: ele-1 |
Type | Identifier |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | Allows observations to be distinguished and referenced. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
22. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
23. 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). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known |
Type | code |
Is Modifier | true |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. Observation.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The 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 |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. Observation.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. 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). |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. Observation.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Period |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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)) |
28. Observation.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(Organization) |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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'))) |
29. 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. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder|ServiceRequest) |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
Alternate Names | Fulfills |
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. |
Invariants | Defined 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.partOf | |
Definition | A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(MedicationAdministration|MedicationDispense|MedicationStatement|Procedure|Immunization|ImagingStudy) |
Standards Status | Normative (from Normative) |
Summary | true |
Alternate Names | Container |
Comments | To link an Observation to an Encounter use |
Invariants | Defined 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.status | |
Definition | Finnish PHR: The status of the result value. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from ObservationStatus Codes providing the status of an observation |
Type | code |
Is Modifier | true |
Summary | true |
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 Value | final |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
32. Observation.category | |
Definition | Classification of type of observation. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from Value Set Finnish PHR Fitness Category; other codes may be used where these codes are not suitable Finnish PHR: Codes for high level observation categories |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Requirements | All resources are fitness (physical activity) observations. |
Comments | FinnishPHR: Only value fitness valid in FinnishPHR (defined by the value set). More fine-grained filtering can be performed using the Observation.code. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. Observation.category.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
34. Observation.category.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.category.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
35. Observation.category.coding | |
Definition | FinnishPHR: fiphrCategory SHALL be used. Other categories MAY be used. A reference to a code defined by a terminology system. |
Control | 1..* This element is affected by the following invariants: ele-1 |
Type | Coding |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
36. Observation.category.coding:fiphrCategory | |
SliceName | fiphrCategory |
Definition | A reference to a code defined by a terminology system. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Coding |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
37. Observation.category.coding:fiphrCategory.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
38. Observation.category.coding:fiphrCategory.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This 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:
|
39. Observation.category.coding:fiphrCategory.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 Value | http://phr.kanta.fi/fiphr-cs-fitnesscategory |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
40. Observation.category.coding:fiphrCategory.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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
41. Observation.category.coding:fiphrCategory.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). |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Fixed Value | fitness |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
42. Observation.category.coding:fiphrCategory.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
43. Observation.category.coding:fiphrCategory.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | boolean |
Summary | true |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
44. Observation.category.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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
45. Observation.code | |
Definition | Describes what was observed. Sometimes this is called the observation "name". |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from Value Set Finnish PHR Fitness Results; other codes may be used where these codes are not suitable Codes identifying names of simple observations |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Alternate Names | Name |
Comments | Describes type of observation. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
46. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
47. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
48. Observation.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 1..* This element is affected by the following invariants: ele-1 |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
49. Observation.code.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
50. Observation.code.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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This 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:
|
51. Observation.code.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
52. Observation.code.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
53. Observation.code.coding.code | |
Definition | A symbol in syntax defined by the system. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
54. Observation.code.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
55. Observation.code.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). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | boolean |
Summary | true |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
56. Observation.code.coding:moderateToVigorousWeeklyMinutes | |
SliceName | moderateToVigorousWeeklyMinutes |
Definition | Measurement of physically active time in minutes, MET >= 3 during a week. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
57. Observation.code.coding:moderateToVigorousWeeklyMinutes.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
58. Observation.code.coding:moderateToVigorousWeeklyMinutes.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This 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:
|
59. Observation.code.coding:moderateToVigorousWeeklyMinutes.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 Value | http://loinc.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
60. Observation.code.coding:moderateToVigorousWeeklyMinutes.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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
61. Observation.code.coding:moderateToVigorousWeeklyMinutes.code | |
Definition | A symbol in syntax defined by the system. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Fixed Value | 82290-8 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
62. Observation.code.coding:moderateToVigorousWeeklyMinutes.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
63. Observation.code.coding:moderateToVigorousWeeklyMinutes.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | boolean |
Summary | true |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
64. Observation.code.coding:moderateToVigorousPA24h | |
SliceName | moderateToVigorousPA24h |
Definition | Measurement of physically active time in minutes, MET >= 3 during a 24 hour period. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Coding |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
65. Observation.code.coding:moderateToVigorousPA24h.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
66. Observation.code.coding:moderateToVigorousPA24h.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This 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:
|
67. Observation.code.coding:moderateToVigorousPA24h.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 Value | http://phr.kanta.fi/fiphr-cs-moderatetovigorouspa |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
68. Observation.code.coding:moderateToVigorousPA24h.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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
69. Observation.code.coding:moderateToVigorousPA24h.code | |
Definition | A symbol in syntax defined by the system. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Fixed Value | 82290-8-24h |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
70. Observation.code.coding:moderateToVigorousPA24h.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
71. Observation.code.coding:moderateToVigorousPA24h.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | boolean |
Summary | true |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
72. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
73. Observation.subject | |
Definition | Finnish PHR: The patient described by the observation and into whose record the observation is placed. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Reference(FIPHRSDPatient) : {r} |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | Finnish PHR: Observations have always known 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. |
Invariants | Defined 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.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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
75. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
76. 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. |
Control | 1..1 This element is affected by the following invariants: ele-1, ref-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
77. 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). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The 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) |
Type | uri |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
78. 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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Identifier |
Standards Status | Normative (from Normative) |
Summary | true |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
79. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
80. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This 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:
|
81. Observation.subject.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known |
Type | code |
Is Modifier | true |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
82. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The 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 |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
83. Observation.subject.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
84. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
85. Observation.subject.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Period |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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)) |
86. Observation.subject.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(Organization) |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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'))) |
87. Observation.subject.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
88. 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. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(Resource) |
Standards Status | Trial Use (from Normative) |
Summary | true |
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 |
Invariants | Defined 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.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(Encounter) |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | For some observations it may be important to know the link between an observation and a particular encounter. |
Alternate Names | Context |
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). |
Invariants | Defined 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'))) |
90. Observation.effective[x] | |
Definition | The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Choice of: dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. |
Alternate Names | Occurrence |
Comments | At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
91. Observation.issued | |
Definition | Finnish PHR: The date and time this observation is stored. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | instant |
Summary | true |
Comments | For Observations that don’t require review and verification, it may be the same as the |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
92. Observation.performer | |
Definition | FinnishPHR: Application user who was responsible for asserting the observed value as "true". |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Reference(FIPHRSDPatient) : {r} |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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'))) |
93. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
94. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.performer.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
95. 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. |
Control | 1..1 This element is affected by the following invariants: ele-1, ref-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
96. 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). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The 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) |
Type | uri |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
97. 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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Identifier |
Standards Status | Normative (from Normative) |
Summary | true |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
98. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
99. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This 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:
|
100. Observation.performer.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known |
Type | code |
Is Modifier | true |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
101. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The 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 |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
102. Observation.performer.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
103. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
104. Observation.performer.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Period |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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)) |
105. Observation.performer.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(Organization) |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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'))) |
106. Observation.performer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
107. Observation.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Control | 1..1 This element is affected by the following invariants: ele-1, obs-7 |
Type | Quantity |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | 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. |
Invariants | Defined 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()) |
108. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
109. Observation.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This 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:
|
110. Observation.value[x].value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 1..1 |
Type | decimal |
Summary | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
111. 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented |
Type | code |
Is Modifier | true |
Summary | true |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
112. Observation.value[x].unit | |
Definition | A human-readable form of the unit. |
Control | 1..1 |
Type | string |
Summary | true |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Fixed Value | min |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
113. Observation.value[x].system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 1..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Summary | true |
Requirements | Need to know the system that defines the coded form of the unit. |
Fixed Value | http://unitsofmeasure.org |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
114. Observation.value[x].code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 1..1 |
Type | code |
Summary | true |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Fixed Value | min |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
115. Observation.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.value[x] is missing. |
Control | 0..0 This element is affected by the following invariants: ele-1, obs-6 |
Binding | The 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
|
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Requirements | For many results it is necessary to handle exceptional values in measurements. |
Comments | Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
116. Observation.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from ObservationInterpretationCodes; other codes may be used where these codes are not suitable Codes identifying interpretations of observations |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Alternate Names | Abnormal Flag |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
117. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
118. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.interpretation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
119. Observation.interpretation.coding | |
Definition | FinnishPHR: fiphrInterpretation SHALL be used. Other interpretations MAY be used. A reference to a code defined by a terminology system. |
Control | 1..* This element is affected by the following invariants: ele-1 |
Type | Coding |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Observation.interpretation.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
120. Observation.interpretation.coding:fiphrInterpretation | |
SliceName | fiphrInterpretation |
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. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Coding |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
121. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
122. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This 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:
|
123. Observation.interpretation.coding:fiphrInterpretation.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 Value | http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
124. 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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
125. 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). |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
126. Observation.interpretation.coding:fiphrInterpretation.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
127. 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). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | boolean |
Summary | true |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
128. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
129. Observation.note | |
Definition | Comments about the observation or the results. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Annotation |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
130. 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
131. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
132. Observation.note.author[x] | |
Definition | The individual responsible for making the annotation. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Choice of: Reference(Practitioner|Patient|RelatedPerson|Organization) : {r}, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Standards Status | Normative (from Normative) |
Summary | true |
Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
Invariants | Defined 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'))) |
133. Observation.note.time | |
Definition | Indicates when this particular annotation was made. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | dateTime |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
134. Observation.note.text | |
Definition | The text of the annotation in markdown format. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | markdown |
Summary | true |
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/ |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
135. Observation.bodySite | |
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
136. Observation.method | |
Definition | Indicates the mechanism used to perform the observation. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see ObservationMethods Methods for simple observations |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
137. Observation.specimen | |
Definition | The specimen that was used when this observation was made. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(Specimen) |
Standards Status | Normative (from Normative) |
Comments | Should only be used if not implicit in code found in |
Invariants | Defined 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'))) |
138. Observation.device | |
Definition | The device used to generate the observation data. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(Device|DeviceMetric) |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined 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'))) |
139. 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 |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | BackboneElement |
Standards Status | Normative (from Normative) |
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. |
Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() 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()) |
140. Observation.referenceRange.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
141. Observation.referenceRange.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.referenceRange.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
142. 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). |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Is Modifier | true |
Standards Status | Normative (from Normative) |
Summary | true |
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 Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
143. Observation.referenceRange.low | |
Definition | The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). |
Control | 0..1 This element is affected by the following invariants: ele-1, obs-3 |
Type | Quantity(SimpleQuantity) |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined 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()) |
144. Observation.referenceRange.high | |
Definition | The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). |
Control | 0..1 This element is affected by the following invariants: ele-1, obs-3 |
Type | Quantity(SimpleQuantity) |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined 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()) |
145. Observation.referenceRange.type | |
Definition | Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHOULD be taken from ObservationReferenceRangeMeaningCodes Code for the meaning of a reference range |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
146. 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 |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | For example codes, see ObservationReferenceRangeAppliesToCodes Codes identifying the population the reference range applies to |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
147. Observation.referenceRange.age | |
Definition | The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Range |
Standards Status | Normative (from Normative) |
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. |
Invariants | Defined 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)) |
148. Observation.referenceRange.text | |
Definition | Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals". |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
149. Observation.hasMember | |
Definition | This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Reference(Observation|QuestionnaireResponse) : {r} |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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'))) |
150. Observation.hasMember.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
151. Observation.hasMember.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.hasMember.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
152. Observation.hasMember.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. |
Control | 0..1 This element is affected by the following invariants: ele-1, ref-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
153. Observation.hasMember.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). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The 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) |
Type | uri |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
154. Observation.hasMember.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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Identifier |
Standards Status | Normative (from Normative) |
Summary | true |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
155. Observation.hasMember.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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
156. Observation.hasMember.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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Observation.hasMember.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
157. Observation.hasMember.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known |
Type | code |
Is Modifier | true |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
158. Observation.hasMember.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The 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 |
Type | CodeableConcept |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
159. Observation.hasMember.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
160. Observation.hasMember.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
161. Observation.hasMember.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Period |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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)) |
162. Observation.hasMember.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(Organization) |
Standards Status | Normative (from Normative) |
Summary | true |
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. |
Invariants | Defined 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'))) |
163. Observation.hasMember.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
164. Observation.derivedFrom | |
Definition | The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(DocumentReference|ImagingStudy|Media|QuestionnaireResponse|Observation|MolecularSequence) |
Standards Status | Normative (from Normative) |
Summary | true |
Comments | All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. |
Invariants | Defined 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'))) |
165. Observation.component | |
Definition | Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | BackboneElement |
Summary | true |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | Profiled further in derived profiles that use components. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |