Phd Coded Enumeration Observation Profile
The Coded Enumeration Observation Profile is used when the PHD metric measurement contains one of the following attributes:
Attribute | Value | Additional Information |
---|---|---|
Enum-Observed-Value-Simple-OID | 16-bit term code | The partition is obtained from the Type attribute or the Enum-Observed-Value-Partition attribute |
Enum-Observed-Value | 16-bit term code when an OID | The partition is obtained from the Type attribute or the Enum-Observed-Value-Partition attribute |
The Enum-Observed-Value-Simple-OID attribute is used when the measurement is itself an MDC code. This type of measurement is most common when reporting the context of another measurement, for example the meal context of a glucose measurement and/or the current state of health. Enumeration measurements are used when there is a finite set of fixed possibilities for the measurement to take. The attribute contains only the 16-bit term code. The partition typcially comes from the Type attribute or, in special cases, the Enum-Observed-Value-Partition attribute.
The Enum-Observed-Value attribute is a complex attribute and can be any one of the three possible enumeration measurements. There is an element in the structure which indicates which type of enumeration it is. If it is an 'OID' type it has an MDC term code. The attribute also has its own metric-id value telling what it is and status value. The metric-id value replaces the term code given by the Type attribute for the type of measurement (not the measurement!) and the status value replaces the Measurement-Status attribute.
The structure definition for this profile is
Observation | I | Observation | Element idObservation Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionThe PhdCodedEnumerationObservation reports PHD measurements that contain a Enum-Observed-Value-Simple-OID attribute. This type of measurement is used when the Personal Health Device reports a measurement as an IEEE 11073 10101 code. An example would be the most recent meal context associated with a glucose measurement such as 'breakfast', 'fasting', 'snack', etc. The list of codes for these meal options is finite. Observation Constraints
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idObservation.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. id Constraints
|
meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idObservation.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Meta Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.meta.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.meta.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idObservation.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. 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. id Constraints
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idObservation.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. 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. instant Constraints
|
profile | Σ | 1..* | uri | Element idObservation.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. 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. uri Sliced:Unordered, Open, by PhdCodedEnumerationObservation(Value) Constraints
|
phdProfile | Σ | 1..1 | uriFixed Value | Element idObservation.meta.profile:phdProfile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. 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. uri Constraints
PhdCodedEnumerationObservation
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idObservation.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. 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. Coding BindingSecurity Labels from the Healthcare Privacy and Security Classification System. ?? (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idObservation.meta.tag Tags applied to this resource DefinitionTags 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. 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. Coding BindingCodes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" ?? (example)Constraints
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idObservation.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. uri Constraints
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idObservation.language Language of the resource content DefinitionThe base language in which the resource is written. 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). code BindingA human language. ?? (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idObservation.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. Narrative Constraints
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idObservation.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Resource Mappings
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | Element idObservation.identifier Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced. For Phd Observations that require conditional creates the create selection criteria will be based upon the information placed in an identifier element. The information will uniquely represent the measurement content. How that information is generated is dependent upon the Phd Observation Profile. Identifier Sliced:Ordered, Open, by value(Value) Constraints
|
conditionalCreateIdentifier | Σ | 0..1 | Identifier | Element idObservation.identifier:conditionalCreateIdentifier Unique identifier of this measurment for a given patient and device DefinitionAn identifier created from a combination of the measurement parameters like sensor time stamp, type code, enumeration OID code, patient and device identifiers, and selected elements of any facet component elements. Allows observations to be distinguished in a selective enough manner to prevent resource duplication. This value is used in the conditional create to prevent data duplication. PHDs will often re-send already sent data for a variety of reasons. This element is required unless the metric measurement contains no time stamp or is a measurement containing a time stamp that is real time. By real time the time stamp reported by the PHD must be later than the current time reported by the PHD before any measurements are received. Temporarily stored data from IEEE 11073 20601 devices, which are required to delete the data after sending, can also be considered real time. Temporarily stored data from Bluetooth Low Energy Health devices may be resent so these cannot be considered as real time. Identifier Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.identifier:conditionalCreateIdentifier.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.identifier:conditionalCreateIdentifier.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idObservation.identifier:conditionalCreateIdentifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. 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. code BindingIdentifies the purpose for this identifier, if known . ?? (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.identifier:conditionalCreateIdentifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. CodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ?? (extensible)Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idObservation.identifier:conditionalCreateIdentifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. see http://en.wikipedia.org/wiki/Uniform_resource_identifier uri Constraints
General http://www.acme.com/identifiers/patient Mappings
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idObservation.identifier:conditionalCreateIdentifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. string Constraints
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idObservation.identifier:conditionalCreateIdentifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration. Period Constraints
|
assigner | Σ I | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element idObservation.identifier:conditionalCreateIdentifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(http://hl7.org/fhir/StructureDefinition/Organization) Constraints
|
basedOn | Σ I | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/CarePlan | http://hl7.org/fhir/StructureDefinition/DeviceRequest | http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation | http://hl7.org/fhir/StructureDefinition/MedicationRequest | http://hl7.org/fhir/StructureDefinition/NutritionOrder | http://hl7.org/fhir/StructureDefinition/ProcedureRequest | http://hl7.org/fhir/StructureDefinition/ReferralRequest) | There are no (further) constraints on this element Element idObservation.basedOn Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/CarePlan | http://hl7.org/fhir/StructureDefinition/DeviceRequest | http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation | http://hl7.org/fhir/StructureDefinition/MedicationRequest | http://hl7.org/fhir/StructureDefinition/NutritionOrder | http://hl7.org/fhir/StructureDefinition/ProcedureRequest | http://hl7.org/fhir/StructureDefinition/ReferralRequest) Constraints
|
status | Σ ?! | 1..1 | codeBinding | Element idObservation.status registered | preliminary | final | amended + DefinitionThe status of the result value. Either 'final' or 'preliminary' Need to track the status of individual results. Some results are finalized before the whole report is finalized. The value shall be set to 'final' unless a Measurement-Status attribute or Enum-Observed-Value attribute, representing an OID, status field indicates that the measurement is preliminary. In that case this field shall be set to 'preliminary' code BindingCodes providing the status of an observation. ?? (required)Constraints
|
category | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.category Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. CodeableConcept BindingCodes for high level observation categories. ?? (preferred)Constraints
| |
code | Σ | 1..1 | CodeableConcept | Element idObservation.code Type of observation (code / type) Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. For Enumeration OID measurements, none will fall into the category of vital signs so a LOINC encoding is never necessary in this profile. CodeableConcept BindingCodes identifying names of simple observations. ?? (example)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.code.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.code.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | There are no (further) constraints on this element Element idObservation.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Sliced:Ordered, Open, by system(Value) Constraints
|
11073Type | Σ | 1..1 | Coding | Element idObservation.code.coding:11073Type The 11073-10101 code for the measurement DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. For 11073-20601 metric enumeration measurements, this code is obtained from one or more of the Type, Metric-Id, Enum-Observed-Value.metric, and Metric-Id-Partition attributes. The algorithm to get the 16-bit partition and 16-bit term code is as follows:
It is this value that is placed in the code.coding.code element for this 11073Type slice Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.code.coding:11073Type.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.code.coding:11073Type.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.code.coding:11073Type.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
urn:iso:std:iso:11073:10101
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.code.coding:11073Type.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idObservation.code.coding:11073Type.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.code.coding:11073Type.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idObservation.code.coding:11073Type.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
LoincCoding | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idObservation.code.coding:LoincCoding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. If the measurement is one of the magic vital signs, the Magic LOINC code for that vital sign as specified by FHIR appears here. When it occurs It shall be second after the MDC code. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.code.coding:LoincCoding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.code.coding:LoincCoding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.code.coding:LoincCoding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
http://loinc.org
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.code.coding:LoincCoding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idObservation.code.coding:LoincCoding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Required if the measurement is a vital sign code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.code.coding:LoincCoding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idObservation.code.coding:LoincCoding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
subject | Σ I | 1..1 | Reference(http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/Group | http://hl7.org/fhir/StructureDefinition/Device | http://hl7.org/fhir/StructureDefinition/Location) | There are no (further) constraints on this element Element idObservation.subject Who and/or what this is about DefinitionThe patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject. Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. If the target of the observation is different than the subject, the general extension observation-focal-subject. may be used. However, the distinction between the patient's own value for an observation versus that of the fetus, or the donor or blood product unit, etc., are often specified in the observation code. Reference(http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/Group | http://hl7.org/fhir/StructureDefinition/Device | http://hl7.org/fhir/StructureDefinition/Location) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.subject.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.subject.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element idObservation.subject.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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. string Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idObservation.subject.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. 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. Identifier Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.subject.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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. string Constraints
|
context | I | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Encounter | http://hl7.org/fhir/StructureDefinition/EpisodeOfCare) | There are no (further) constraints on this element Element idObservation.context Healthcare event during which this observation is made Alternate namesEncounter DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests). Reference(http://hl7.org/fhir/StructureDefinition/Encounter | http://hl7.org/fhir/StructureDefinition/EpisodeOfCare) Constraints
|
effectivePeriod | Σ | 1..1 | Period | There are no (further) constraints on this element Element idObservation.effective[x]:effectivePeriod Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe time period when there is a Measure-Active-Period attribute. The difference between the end and start fields is the value of the Measure-Active-Period. Knowing when an observation was deemed true is important to its relevance as well as determining trends. At least a date should be present unless this observation is a historical report. Period Sliced:Unordered, Open, by start(Exists) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.effective[x]:effectivePeriod.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.effective[x]:effectivePeriod.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
start | Σ I | 1..1 | dateTime | There are no (further) constraints on this element Element idObservation.effective[x]:effectivePeriod.start Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. dateTime Constraints
|
end | Σ I | 1..1 | dateTime | There are no (further) constraints on this element Element idObservation.effective[x]:effectivePeriod.end End time with inclusive boundary, if not ongoing DefinitionThe end of the period. It will be the value of the Measure-Active-Period plus the start time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing dateTime Constraints
|
dateTimeEffective | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idObservation.effective[x]:dateTimeEffective Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. Knowing when an observation was deemed true is important to its relevance as well as determining trends. A date and time shall always be present. dateTime Constraints
|
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element idObservation.issued Date/Time this was made available DefinitionThe date and time this observation was made available to providers, typically after the results have been reviewed and verified. Updated when the result is updated. instant Constraints
|
performer | Σ I | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Organization | http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson) | There are no (further) constraints on this element Element idObservation.performer Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Organization | http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson) Constraints
|
valueCodeableConcept | Σ I | 1..1 | CodeableConcept | Element idObservation.value[x]:valueCodeableConcept Actual result DefinitionThe information determined as a result of making the observation, if the information is a code. An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations. Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is "'value' + the type name" with a capital on the first letter of the type). If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For further discussion and examples see the notes section below. CodeableConcept Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.value[x]:valueCodeableConcept.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.value[x]:valueCodeableConcept.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idObservation.value[x]:valueCodeableConcept.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Sliced:Ordered, Open, by system(Value) Constraints
|
11073Value | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idObservation.value[x]:valueCodeableConcept.coding:11073Value Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.value[x]:valueCodeableConcept.coding:11073Value.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.value[x]:valueCodeableConcept.coding:11073Value.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | Element idObservation.valueCodeableConcept.coding:11073Value.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
urn:iso:std:iso:11073:10101
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.value[x]:valueCodeableConcept.coding:11073Value.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idObservation.valueCodeableConcept.coding:11073Value.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.value[x]:valueCodeableConcept.coding:11073Value.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idObservation.value[x]:valueCodeableConcept.coding:11073Value.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.value[x]:valueCodeableConcept.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
dataAbsentReason | I | 0..1 | CodeableConceptBinding | Element idObservation.dataAbsentReason Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.valueCodeableConcept is missing. This would be an error condition indicated by the Measurement-Status attribute. For many results it is necessary to handle exceptional values in measurements. The current values in the http://hl7.org/fhir/data-absent-reason system do not provide the same detailed set of options reported in the Measurement-Status. In those cases one uses the generic 'error' code if the error is 'fatal'. The measurementStatusComponent can be used to report more specific information. CodeableConcept BindingCodes specifying why the result (Observation.value[x]) is missing. ?? (extensible)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.dataAbsentReason.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.dataAbsentReason.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idObservation.dataAbsentReason.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.dataAbsentReason.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.dataAbsentReason.coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idObservation.dataAbsentReason.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.dataAbsentReason.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idObservation.dataAbsentReason.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.dataAbsentReason.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idObservation.dataAbsentReason.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.dataAbsentReason.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
interpretation | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept BindingCodes identifying interpretations of observations. ?? (extensible)Constraints
| |
comment | 0..1 | string | There are no (further) constraints on this element Element idObservation.comment Comments about result DefinitionMay include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result. Need to be able to provide free text additional information. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
bodySite | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension body-site-instance. CodeableConcept BindingCodes describing anatomical locations. May include laterality. ?? (example)Constraints
| |
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.method How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. CodeableConcept BindingMethods for simple observations. ?? (example)Constraints
| |
specimen | I | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Specimen) | There are no (further) constraints on this element Element idObservation.specimen Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in Reference(http://hl7.org/fhir/StructureDefinition/Specimen) Constraints
|
device | I | 1..1 | Reference(http://hl7.org/fhir/StructureDefinition/Device | http://hl7.org/fhir/StructureDefinition/DeviceMetric) | There are no (further) constraints on this element Element idObservation.device (Measurement) Device DefinitionThe device used to generate the observation data. This field will reference the DeviceComponent when the updated fixes are in place. In the meantime it will reference the DeviceMetric Reference(http://hl7.org/fhir/StructureDefinition/Device | http://hl7.org/fhir/StructureDefinition/DeviceMetric) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.device.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.device.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element idObservation.device.reference Reference to the device responsible for the measurement DefinitionReference to the device-related resources that describe the sensor device taking the measurement and the gateway that handled it. This element will point to a DeviceComponent resource following the Phd Parent DeviceComponent Profile. This reference points to the DeviceComponent resource containing information about the sensor device that took the measurement and gateway (if any) that handled it. string Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idObservation.device.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. 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. Identifier Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.device.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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. string Constraints
|
referenceRange | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idObservation.referenceRange Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. BackboneElement Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.referenceRange.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.referenceRange.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.referenceRange.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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. Extension Constraints
|
low | I | 0..1 | http://hl7.org/fhir/StructureDefinition/SimpleQuantity | There are no (further) constraints on this element Element idObservation.referenceRange.low Low Range, if relevant DefinitionThe value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. http://hl7.org/fhir/StructureDefinition/SimpleQuantity Constraints
|
high | I | 0..1 | http://hl7.org/fhir/StructureDefinition/SimpleQuantity | There are no (further) constraints on this element Element idObservation.referenceRange.high High Range, if relevant DefinitionThe value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. http://hl7.org/fhir/StructureDefinition/SimpleQuantity Constraints
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.referenceRange.type Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc, - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. CodeableConcept BindingCode for the meaning of a reference range. ?? (extensible)Constraints
| |
appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element idObservation.referenceRange.appliesTo Reference range population DefinitionCodes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. CodeableConcept BindingCodes identifying the population the reference range applies to. ?? (example)Constraints
| |
age | I | 0..1 | Range | There are no (further) constraints on this element Element idObservation.referenceRange.age Applicable age range, if relevant DefinitionThe age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3. Range Constraints
|
text | 0..1 | string | There are no (further) constraints on this element Element idObservation.referenceRange.text Text based reference range in an observation DefinitionText based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of 'normals'. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
related | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idObservation.related Resource related to this observation DefinitionA reference to another resource (usually another Observation) whose relationship is defined by the relationship type code. Normally, an observation will have either a value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and a set of related observations or sometimes a QuestionnaireResponse from which the measure is derived. For a discussion on the ways Observations can assembled in groups together see Notes below. BackboneElement Sliced:Ordered, Open, by target.reference(Value) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.related.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.related.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.related.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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. Extension Constraints
|
type | 0..1 | codeBinding | There are no (further) constraints on this element Element idObservation.related.type has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by DefinitionA code specifying the kind of relationship that exists with the target resource. A relationship type SHOULD be provided. The "derived-from" type is the only logical choice when referencing the QuestionnaireAnswer resource. code BindingCodes specifying how two observations are related. ?? (required)Constraints
| |
target | I | 1..1 | Reference(http://hl7.org/fhir/StructureDefinition/Observation | http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse | http://hl7.org/fhir/StructureDefinition/Sequence) | There are no (further) constraints on this element Element idObservation.related.target Resource that is related to this one DefinitionA reference to the observation or QuestionnaireResponse resource that is related to this observation. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/Observation | http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse | http://hl7.org/fhir/StructureDefinition/Sequence) Constraints
|
coincidentTimeStampRelated | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated Pointer to the Coincident Time Stamp DefinitionA reference to the Coincident Time Stamp observation. The Coincident Time Stamp indicates how the time stamps from the PHD are corrected, if at all. This Observation allows one to re-create the original time stamp generated by the PHD should it have been modified by the PHG. This reference shall be present if the PHD reports a time stamp. The reference shall point to the Coincident Time Stamp observation. The Coincident Time Stamp Observation provides an audit of the time stamp. Whether or not the gateway corrected the time stamp can be determined from the elements in this Observation. If the timestamps were corrected, the elements of the Observation can be used to obtain the actual time stamps reported by the PHD. There is no reference to a Coincident Time Stamp Observation when the PHD does not report a time stamp. BackboneElement Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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. Extension Constraints
|
type | 0..1 | codeBinding | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated.type has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by DefinitionA code specifying the kind of relationship that exists with the target resource. A relationship type SHOULD be provided. The "derived-from" type is the only logical choice when referencing the QuestionnaireAnswer resource. code BindingCodes specifying how two observations are related. ?? (required)Constraints
| |
target | I | 1..1 | Reference(http://hl7.org/fhir/StructureDefinition/Observation | http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse | http://hl7.org/fhir/StructureDefinition/Sequence) | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated.target Resource that is related to this one DefinitionA reference to the observation or QuestionnaireResponse resource that is related to this observation. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/Observation | http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse | http://hl7.org/fhir/StructureDefinition/Sequence) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated.target.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated.target.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated.target.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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. string Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated.target.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. 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. Identifier Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.related:coincidentTimeStampRelated.target.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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. string Constraints
|
SourceHandleReferenceRelated | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated Resource related to this observation DefinitionA reference to another resource (usually another Observation) whose relationship is defined by the relationship type code. Points to a measurement that this measurement is related to or dependent upon, for example a BMI which is calculated from a weight and height measurement or a heart rate taken during a running session. A measurement may have one or more source handle references which point to measurements that this measurement is related to in some way. When one of these attributes are present in the measurement, these values point to other measurements. In this case these measurements will be previously generated Observation resources which are then referenced here. Note that the previously received measurement must be received in the same connection as the current measurement. The application does not need to keep record of all measurements from the given device! BackboneElement Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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. Extension Constraints
|
type | 0..1 | codeBinding | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated.type has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by DefinitionA code specifying the kind of relationship that exists with the target resource. A relationship type SHOULD be provided. The "derived-from" type is the only logical choice when referencing the QuestionnaireAnswer resource. code BindingCodes specifying how two observations are related. ?? (required)Constraints
| |
target | I | 1..1 | Reference(http://hl7.org/fhir/StructureDefinition/Observation | http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse | http://hl7.org/fhir/StructureDefinition/Sequence) | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated.target Resource that is related to this one DefinitionA reference to the observation or QuestionnaireResponse resource that is related to this observation. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/Observation | http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse | http://hl7.org/fhir/StructureDefinition/Sequence) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated.target.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated.target.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated.target.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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. string Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated.target.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. 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. Identifier Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.related:SourceHandleReferenceRelated.target.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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. string Constraints
|
component | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idObservation.component Component results DefinitionSome observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. For a discussion on the ways Observations can be assembled in groups together see Notes below. BackboneElement Sliced:Unordered, Open, by code.coding.code(Value) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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. Extension Constraints
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept BindingCodes identifying names of simple observations. ?? (example)Constraints
|
value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations. Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from http://hl7.org/fhir/ValueSet/v2-0136 (these "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (the name format is "'value' + the type name" with a capital on the first letter of the type).
| |
valueQuantity | Quantity | There are no (further) constraints on this element Data type Quantity | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type CodeableConcept | ||
valueString | string | There are no (further) constraints on this element Data type string | ||
valueRange | Range | There are no (further) constraints on this element Data type Range | ||
valueRatio | Ratio | There are no (further) constraints on this element Data type Ratio | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data type SampledData | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type Attachment | ||
valueTime | time | There are no (further) constraints on this element Data type time | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type dateTime | ||
valuePeriod | Period | There are no (further) constraints on this element Data type Period | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. CodeableConcept BindingCodes specifying why the result (Observation.value[x]) is missing. ?? (extensible)Constraints
|
interpretation | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. The component interpretation applies only to the individual component value. For an overall interpretation all components together use thes Observation.interpretation element. CodeableConcept BindingCodes identifying interpretations of observations. ?? (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
| |
supplementalTypesComponent | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent Component results DefinitionFor each paritition:term code pair contained in the Supplemental-Types attribute, a separate supplementalTypesComponent element is generated. The component is not generated if the attribute is absent or empty. The component shall be generated otherwise. 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. A PHD may send a Supplemental-Types attribute as part of the measurement. This attribute consists of a set of MDC nomenclature codes as partition:term code pairs. Each pair is a code describing something additional about the measurement, such as MDC_MODALITY_SPOT in the pulse oximeter which indicates that the provided meausrement is a stable average. An MDC_MODALITY_FAST would indicate that a short averaging is used and the result reported regardless of stability. BackboneElement Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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. Extension Constraints
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept BindingCodes identifying names of simple observations. ?? (example)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Sliced:Ordered, Open, by system(Value) Constraints
|
11073Type | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.coding:11073Type Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.coding:11073Type.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.coding:11073Type.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.coding:11073Type.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
urn:iso:std:iso:11073:10101
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.coding:11073Type.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | codeFixed Value | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.coding:11073Type.code Symbol in syntax defined by the system Definition68193 is the 32-bit nomenclature code indicating a 'Supplemental-Types' value Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
68193
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.coding:11073Type.display Representation defined by the system DefinitionIt is recommended to display at least the reference identifier for the Supplemental-Types which is MDC_ATTR_SUPPLEMENTAL_TYPES Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.coding:11073Type.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
valueCodeableConcept | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept Actual component result DefinitionThe information determined as a result of making the observation, if the information is a code. An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations. Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from http://hl7.org/fhir/ValueSet/v2-0136 (these "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (the name format is "'value' + the type name" with a capital on the first letter of the type). CodeableConcept Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Sliced:Ordered, Open, by system(Value) Constraints
|
11073Value | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.coding:11073Value Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.coding:11073Value.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.coding:11073Value.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.coding:11073Value.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
urn:iso:std:iso:11073:10101
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.coding:11073Value.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.coding:11073Value.code Symbol in syntax defined by the system DefinitionFor the given Supplemental-Types entry the code here is given by: partition * 2**16 + term code Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.coding:11073Value.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.coding:11073Value.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.value[x]:valueCodeableConcept.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
dataAbsentReason | I | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. CodeableConcept BindingCodes specifying why the result (Observation.value[x]) is missing. ?? (extensible)Constraints
|
interpretation | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. The component interpretation applies only to the individual component value. For an overall interpretation all components together use thes Observation.interpretation element. CodeableConcept BindingCodes identifying interpretations of observations. ?? (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:supplementalTypesComponent.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
| |
relativeTimeComponent | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent Component results DefinitionThis component shall be present if the measurement contains a Relative-Time-Stamp. 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. Relative time stamps are converted to wall clock time by the PHG through the Coincident Time Stamp Observation. The original relative time value shall be provided here in order to recover the data sent by the sensor device. The Relative-Time-Stamp is a 32-bit unsigned integer in units of 1/8th ms. BackboneElement Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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. Extension Constraints
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept BindingCodes identifying names of simple observations. ?? (example)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Sliced:Ordered, Open, by code(Value) Constraints
|
11073Type | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.coding:11073Type Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.coding:11073Type.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.coding:11073Type.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.coding:11073Type.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
urn:iso:std:iso:11073:10101
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.coding:11073Type.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | codeFixed Value | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.coding:11073Type.code Symbol in syntax defined by the system DefinitionThe MDC code of the Relative-Time-Stamp attribute Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
67985
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.coding:11073Type.display Representation defined by the system DefinitionThe reference identifier should be included in the description. For a Relative-Time-Stamp the ref id is MDC_ATTR_TIME_STAMP_REL Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.coding:11073Type.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
valueQuantity | Σ | 1..1 | Quantity | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations. Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from http://hl7.org/fhir/ValueSet/v2-0136 (these "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (the name format is "'value' + the type name" with a capital on the first letter of the type). Quantity Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.value[x]:valueQuantity.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.value[x]:valueQuantity.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.value[x]:valueQuantity.value Numerical value (with implicit precision) DefinitionThe value of the relative time attribute which is in units of 1/8th milliseconds scaled to microseconds. Precision is handled implicitly in almost all cases of measurement. The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). decimal Constraints
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. If there is no comparator, then there is no modification of the value code BindingHow the Quantity should be understood and represented. ?? (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit which in this case is recommended to be the UCUM code for microseconds (us) There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings may not exceed 1MB in size string Constraints
|
system | Σ I | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe unit code shall use the MDC system Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier uri Constraints
urn:iso:std:iso:11073:10101
|
code | Σ | 1..1 | codeFixed Value | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.value[x]:valueQuantity.code Coded form of the unit DefinitionThe MDC code for microseconds is 264339 Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. code Constraints
264339
|
dataAbsentReason | I | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. CodeableConcept BindingCodes specifying why the result (Observation.value[x]) is missing. ?? (extensible)Constraints
|
interpretation | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. The component interpretation applies only to the individual component value. For an overall interpretation all components together use thes Observation.interpretation element. CodeableConcept BindingCodes identifying interpretations of observations. ?? (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:relativeTimeComponent.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
| |
hiresRelativeTimeComponent | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent Component results DefinitionThis component shall be present if the measurement contains Hi-Res-Relative-Time-Stamp. 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. Hi Res Relative time stamps are converted to wall clock time by the PHG through the Coincident Time Stamp Observation. The original relative time value shall be provided here in order to recover the data sent by the sensor device. The Hi-Res-Relative-Time-Stamp is a 64-bit unsigned interger in units of microseconds. BackboneElement Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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. Extension Constraints
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept BindingCodes identifying names of simple observations. ?? (example)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Sliced:Ordered, Open, by code(Value) Constraints
|
11073Type | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.coding:11073Type Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.coding:11073Type.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.coding:11073Type.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.coding:11073Type.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
urn:iso:std:iso:11073:10101
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.coding:11073Type.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | codeFixed Value | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.coding:11073Type.code Symbol in syntax defined by the system DefinitionThe MDC code for the Hi-Res-Relative-Time-Stamp attribute Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
68073
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.coding:11073Type.display Representation defined by the system DefinitionThe reference identifier should be included in the description. For a Hi-Res-Relative-Time-Stamp the ref id is MDC_ATTR_TIME_STAMP_REL_HI_RES Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.coding:11073Type.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
valueQuantity | Σ | 1..1 | Quantity | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.value[x]:valueQuantity Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations. Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from http://hl7.org/fhir/ValueSet/v2-0136 (these "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (the name format is "'value' + the type name" with a capital on the first letter of the type). Quantity Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.value[x]:valueQuantity.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.value[x]:valueQuantity.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.value[x]:valueQuantity.value Numerical value DefinitionThe value of the hi res relative time attribute (already in microseconds). Precision is handled implicitly in almost all cases of measurement. The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). decimal Constraints
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.value[x]:valueQuantity.comparator < | <= | >= | > - how to understand the value DefinitionHow the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. If there is no comparator, then there is no modification of the value code BindingHow the Quantity should be understood and represented. ?? (required)Constraints
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.value[x]:valueQuantity.unit Unit representation DefinitionA human-readable form of the unit which in this case is recommended to be the UCUM code for microseconds (us) There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings may not exceed 1MB in size string Constraints
|
system | Σ I | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.value[x]:valueQuantity.system System that defines coded unit form DefinitionThe unit code shall use the MDC system Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier uri Constraints
urn:iso:std:iso:11073:10101
|
code | Σ | 1..1 | codeFixed Value | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.value[x]:valueQuantity.code Coded form of the unit DefinitionThe MDC code for microseconds is 264339 Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. code Constraints
264339
|
dataAbsentReason | I | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. CodeableConcept BindingCodes specifying why the result (Observation.value[x]) is missing. ?? (extensible)Constraints
|
interpretation | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. The component interpretation applies only to the individual component value. For an overall interpretation all components together use thes Observation.interpretation element. CodeableConcept BindingCodes identifying interpretations of observations. ?? (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:hiresRelativeTimeComponent.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
| |
measurementStatusComponent | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent Component results DefinitionThis component gives one of the settings reported in the Measurement-Status attribute that are not reported in the Observation.dataAbsentReason or Observation.status element. The settings that ARE reported in the dataAbsentReason and status elements are 'invalid', 'questionable', 'not-available', and 'early-indication'. It is optional to report any of the other settings UNLESS MDER-BITs 14 or 15 are set. It is optional to report any defined cleared setting; these are all events. This component indicates a Measurement-Status setting. When MDER-BITs 14 and 15 are set, these are special uses cases by the Pulse Oximeter and Continuous Glucose specialization. MDER-BIT 14 indicates that a threshold set up in other attributes has been crossed. MDER-BIT 15 indicates that the alert mechanism has been turned off. There will be one measurementStatusComponent entry for every setting reported. BackboneElement Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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. Extension Constraints
|
code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept BindingCodes identifying names of simple observations. ?? (example)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Normally alternative coding systems are allowed but in this case the value is intimately tied to the code. The code represents the feature indicated by a bit settin in the attribute value. which is either cleared (0) or set (1). Thus the value for this entry is itself a binary 'Y' or 'N' code from http://hl7.org/fhir/v2/0136 Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
http://hl7.org/fhir/IEEE.ASN1
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.coding.code Symbol in syntax defined by the system DefinitionThis code, which is an alpha-numeric string, is generated by the attribute MDC code, which is 133447 for the Measurement-Status, followed by a dot (.) followed by the MDER-bit that was set. Need to refer to a particular code in the system. Note that this code is an alpha-numeric string and not a decimal number. Think of it like a very-limited OID. MDER-BITs 14 and 15 shall be reported if set. code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
valueCodeableConcept | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x] Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations. Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from http://hl7.org/fhir/ValueSet/v2-0136 (these "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (the name format is "'value' + the type name" with a capital on the first letter of the type). CodeableConcept Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].coding.system Identity of the terminology system DefinitionThis coding system contains only two entries, 'Y' (yes) and 'N' (no) Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
http://hl7.org/fhir/v2/0136
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].coding.code Symbol in syntax defined by the system DefinitionIf the MDER-Bit is set, the code value is 'Y' otherwise it is 'N' Need to refer to a particular code in the system. Recall that when the value is 'Y' the alarm or alert is turned off code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.value[x].text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
dataAbsentReason | I | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.dataAbsentReason Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. CodeableConcept BindingCodes specifying why the result (Observation.value[x]) is missing. ?? (extensible)Constraints
|
interpretation | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.interpretation High, low, normal, etc. Alternate namesAbnormal Flag DefinitionThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. The component interpretation applies only to the individual component value. For an overall interpretation all components together use thes Observation.interpretation element. CodeableConcept BindingCodes identifying interpretations of observations. ?? (extensible)Constraints
| |
referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component:measurementStatusComponent.referenceRange Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
|
Mapping Coded Enumerations to FHIR
The following table shows how the coded enumeration attributes are mapped to FHIR.
Attribute | FHIR coding |
---|---|
Enum-Observed-Value-Simple-OID.value | Observation.valueCodeableConcept.coding.code |
Enum-Observed-Value.value Enum-Observed-Value.metric-id Enum-Observed-Value.status |
Observation.valueCodeableConcept.coding.code effects Observation.code see Obtaining the Observation.code see Measurement Status in Phd Base Observation Profile |
Conditional Create Identifier Generation
For a general description of the PHD Profile Identifier see the "PHD Profile Identifier" section in Phd Base Profile. The table below lists the items that make up the identifier.
Entry | value | Additional information |
---|---|---|
device | "Phd Device.identifier.value" | This value is the PHD IEEE EUI-64 system identifier |
patient | "Patient.identifier.value-Patient.identifier.system" or provided logical id |
The dashes are part of the identifier. When the service provider gives the PHG a pre-determined patient logical id the PHG creates no Patient resource and has no patient information. In that special case the provided logical id is used |
type | "Observation.code.coding.code" | See Obtaining the Observation.code |
value | "Observation.valueCodeableConcept.coding.code" or "Observation.dataAbsentReason.coding.code" |
The enumeration 32-bit MDC code of the measurement or the data absent reason code if there is no value |
reported PHD timestamp | "timestamp" | See Generating the PHD Reported Time Stamp |
supplemental types | "Supplemental-Types.N-" | A sequence of 32-bit MDC codes separated by a dash |
The final identifier is made by concatenating the entries above as follows:
- "device-patient-type-value-reported PHD timestamp-supplemental types"
Additional Enumeration Measurement Information
There are no additional descriptive attributes that are unique to the Enumeration type of measurement.
Phd Coded Enumeration Observation JSON Example
The following JSON example is from a Glucose Monitor. The context measurement is in regard to the meal status at the time of the measurement. The measurement itself is an MDC code. In the future this measurement will contain a second related element due to a Source-Handle-Reference attribute pointing to the Glucose Concentration measurement. It has been added by hand below. In a real case the logical id of the Observation would be known.
{ "resourceType": "Observation", "meta": { "profile": ["http://pchalliance.org/phdfhir/StructureDefinition/PhdCodedEnumerationObservation"] }, "identifier": [{ "value": "sisansarahId-urn:oid:1.2.3.4.5.6.7.8.10-01040302f4000000-8417864-20171214103752-8417868" }], "status": "final", "code": { "coding": [{ "system": "urn:iso:std:iso:11073:10101", "code": "8417864", "display": "MDC_CTXT_GLU_MEAL" }] }, "subject": { "reference": "Patient/PatientId-sisansarahId" }, "effectiveDateTime": "2017-12-14T10:37:50-05:00", "performer": [{ "reference": "Patient/PatientId-sisansarahId" }], "valueCodeableConcept": { "coding": [{ "system": "urn:iso:std:iso:11073:10101", "code": "8417868", "display": "MDC_CTXT_GLU_MEAL_PREPRANDIAL" }] }, "device": { "reference": "DeviceComponent/SysId-01040302f4000000" }, "related": [{ "id": "coincidentTimeStampRelated", "type": "qualified-by", "target": { "reference": "urn:oid:3.14159.20171214103753" }, { "id": "SourceHandleReferenceRelated", "type": "qualified-by", "target": { "reference": "Observation/logical-id of Glucose concentration measurement" } }] }