2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile U.S. Data Access Framework (DAF) Results Profile - Definitions

Todo

Definitions for the observation-daf-results-dafresultobservationcode Profile.

Observation(DAFResultObservationCode)
Definition

US Realm clinical coded laboratoyresults to ordering providers in the ambulatory care setting and "reportable" laboratory test results to local public health agencies.

Control1..1
Requirements

Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.

Alternate NamesVital Signs, Measurement, Results, Tests, Obs
Comments

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

InvariantsDefined on this element
obs-6: Shall only be present if Observation.value[x] is not present (xpath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')]))))
Observation.id
Definition

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

Control0..1
Typeid
Requirements
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Observation.meta
Definition

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

Control0..1
TypeMeta
Requirements
Comments
Observation.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Requirements
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Observation.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Requirements
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource

Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Observation.text
Definition

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

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Requirements
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Observation.contained
Definition

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

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

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Observation.extension
Definition

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

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

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

Observation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

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

Observation.code
Definition

The laboratory test that was performed.

Control1..1
BindingCodes identifying types of simple observations
For example codes, see LOINC Codes
TypeCodeableConcept
Must Supporttrue
Requirements

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

Alternate Namestest
Comments
InvariantsDefined on this element
inv-2: Must have a LOINC or a Local code or both. (xpath: exists(f:coding))
Observation.code.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Observation.code.extension
Definition

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

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

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

Observation.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: system
Observation.code.coding(USLabLOINCCoding)
Definition

LOINC coding if concept exists in LOINC.

Control0..1
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Alternate NamesLOINC code
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning.

Observation.code.coding.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Observation.code.coding.extension
Definition

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

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

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

Observation.code.coding.system
Definition

LOINC Coding System.

Control1..1
Typeuri
Must Supporttrue
Requirements

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

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
Observation.code.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control0..1
Typestring
Requirements
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Observation.code.coding.code
Definition

Logical Observation Identifiers Names and Codes (LOINC) is a database and universal standard for identifying medical laboratory observations.

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Comments
Observation.code.coding.display
Definition

The LOINC 'long common name' is preferred although the LOINC 'short name' or the LOINC 'fully-specified name can also be used. ( http://lionc.org.terms-of-use).

Control0..1
Typestring
Must Supporttrue
Requirements

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

Comments
Observation.code.coding.primary
Definition

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

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact code was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations.

Observation.code.coding.valueSet
Definition

The set of possible coded values this coding was chosen from or constrained by.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet))
Requirements

The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare.

Comments
Observation.code.coding(USLabLocalCoding)
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Alternate NamesLocal
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning.

Observation.code.coding.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Observation.code.coding.extension
Definition

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

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

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

Observation.code.coding.system
Definition

This is defined locally.

Control1..1
Typeuri
Must Supporttrue
Requirements

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

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Observation.code.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control0..1
Typestring
Requirements
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Observation.code.coding.code
Definition

Local Code.

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Comments
Observation.code.coding.display
Definition

This is defined locally.

Control0..1
Typestring
Must Supporttrue
Requirements

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

Comments
Observation.code.coding.primary
Definition

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

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact code was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations.

Observation.code.coding.valueSet
Definition

The set of possible coded values this coding was chosen from or constrained by.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet))
Requirements

The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare.

Comments
Observation.code.text
Definition

This is the laboratory defined display text for the lab test if different from the code display text(s).

Control0..1
Typestring
Must Supporttrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

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

Observation.value[x]
Definition

This is the actual coded result.

Control0..1
TypeChoice of: Quantity, CodeableConcept, Attachment, Ratio, dateTime, Period, SampledData, string, time
Must Supporttrue
Requirements

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

Alternate Namescoded result
Comments

Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, 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/v2/vs/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).

InvariantsDefined on this element
inv-3: Must have a SNOMED-CT code or a Local code or both. (xpath: exists(f:coding))
Observation.dataAbsentReason
Definition

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

Control0..1 This element is affected by the following invariants: obs-6
BindingUsed to specify why the normally expected content of the data element is missing
The codes SHALL be taken from DataAbsentReason
Typecode
Must Supporttrue
Requirements

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

Comments

"Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "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.

Exampleunknown
Observation.interpretation
Definition

The assessment made based on the result of the observation.

Control0..1
BindingCodes identifying interpretations of observations
The codes SHALL be taken from US Laboratory Observation Profile Interpretation Codes
TypeCodeableConcept
Must Supporttrue
Requirements

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

Comments
Observation.interpretation.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Observation.interpretation.extension
Definition

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

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

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

Observation.interpretation.coding
Definition

A reference to a code defined by a terminology system.

Control1..1
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning.

Observation.interpretation.coding.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Observation.interpretation.coding.extension
Definition

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

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

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

Observation.interpretation.coding.system
Definition

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

Control0..1
Typeuri
Requirements

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

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Observation.interpretation.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control0..1
Typestring
Requirements
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Observation.interpretation.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Comments
Observation.interpretation.coding.display
Definition

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

Control0..1
Typestring
Requirements

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

Comments
Observation.interpretation.coding.primary
Definition

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

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact code was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations.

Observation.interpretation.coding.valueSet
Definition

The set of possible coded values this coding was chosen from or constrained by.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet))
Requirements

The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare.

Comments
Observation.interpretation.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

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

Observation.comments
Definition

May 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.

Control0..1
Typestring
Requirements

Need to be able to provide free text additional information.

Comments
Observation.applies[x]
Definition

For lab tests this is the specimen collection date.

Control0..1
TypeChoice of: dateTime, Period
Must Supporttrue
Requirements

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

Comments

At least a date should be present unless this observation is a historical report.

InvariantsDefined on this element
inv-1: Datetime must be at least to day. (xpath: f:matches(appliesDateTime,/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/))
Observation.issued
Definition

The date and time this observation was made available.

Control0..1
Typeinstant
Must Supporttrue
Requirements
Comments

Updated when the result is updated.

Observation.status
Definition

The status of the result value.

Control1..1
BindingCodes providing the status of an observation
The codes SHALL be taken from ObservationStatus
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

Need to track the status of individual results - some results are finalised before the whole report is finalised.

Comments
Observation.reliability
Definition

An estimate of the degree to which quality issues have impacted on the value reported.

Control0..1
BindingCodes that provide an estimate of the degree to which quality issues have impacted on the value of an observation
The codes SHALL be taken from ObservationReliability
Typecode
Is Modifiertrue
Requirements

Not all results are completely reliable, and some are still reported anyway.

Comments

Note that in most contexts, unreliable results are not recorded, deleted, or otherwise excluded, but it's not always possible to exclude them from the record. If the reliability indicator is present, interpreters of a result, whether human or machine, should always either be aware of the status or prevented from using the observation without being unaware that the reliability is not "ok".

Observation.bodySite[x]
Definition

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

Control0..1
BindingCodes describing anatomical locations. May include laterality
For example codes, see SNOMED CT Body Structures
TypeChoice of: CodeableConcept, Reference(Profile = (Profile = http://hl7.org/fhir/Profile/BodySite))
Requirements

Knowing where the observation is made is important for tracking if multiple sites are possible.

Comments

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

Observation.method
Definition

Indicates the mechanism used to perform the observation.

Control0..1
BindingMethods for simple observations
For example codes, see Observation Methods
TypeCodeableConcept
Requirements

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

Comments

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

Observation.identifier
Definition

A unique identifier for the simple observation.

Control1..1
TypeIdentifier
Must Supporttrue
Requirements

Allows observations to be distinguished and referenced.

Comments
Observation.identifier.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Observation.identifier.extension
Definition

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

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

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

Observation.identifier.use
Definition

The purpose of this identifier.

Control1..1
BindingIdentifies the purpose for this identifier, if known
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

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

Comments

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

Fixed Valueofficial
Observation.identifier.label
Definition

A text string for the identifier that can be displayed to a human so they can recognize the identifier.

Control1..1
Typestring
Must Supporttrue
Requirements

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

Comments
Fixed ValueLab test result ID
Observation.identifier.system
Definition

The URI for the laboratory Issuing the report. This establishes the namespace in which set of possible id values is unique.

Control1..1
Typeuri
Must Supporttrue
Requirements

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

Comments
Examplehttp://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
Observation.identifier.value
Definition

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

Control1..1
Typestring
Must Supporttrue
Requirements
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.

Example123456
Observation.identifier.period
Definition

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

Control0..1
TypePeriod
Requirements
Comments
Observation.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization))
Requirements
Comments

The reference may be just a text description of the assigner.

Observation.subject
Definition

The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, other observer (for example a relative or EMT), or any observation made about the subject.

Control1..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/patient-daf-dafpatient))
Must Supporttrue
Requirements

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

Comments

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 (http://hl7.org/fhir/ExtensionDefinition/indirectTarget) can be used.

Observation.specimen
Definition

The specimen that was used when this observation was made.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Specimen))
Requirements
Comments

Observations are not made on specimens themselves; they are made on a subject, but usually by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources are often used in contexts that track the specimen explicitly (e.g. Diagnostic Report).

Observation.performer
Definition

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

Control0..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson))
Requirements

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

Comments
Observation.device
Definition

The device used to generate the observation data.

Control0..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Device)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/DeviceMetric))
Requirements
Comments

An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either extension or through the Observation.related element.

Observation.encounter
Definition

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

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/encounter-daf-dafencounter))
Must Supporttrue
Requirements

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

Comments
Observation.referenceRange
Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Control0..*
Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g. specific to the patient's age, gender, weight and other factors), but this 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.

InvariantsDefined on this element
obs-3: Must have at least a low or a high or text (xpath: (exists(f:low) or exists(f:high)or exists(f:text)))
Observation.referenceRange.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Observation.referenceRange.extension
Definition

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

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

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

Observation.referenceRange.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers
Comments

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

Observation.referenceRange.low
Definition

The value of the low bound of the reference range. If this element is omitted, the low bound of the reference range is assumed to be meaningless. (e.g. reference range is <2.3) If the low.comparator element is missing, it is assumed to be '>'.

Control0..1 This element is affected by the following invariants: obs-3, obs-4
TypeQuantity
Requirements
Comments
InvariantsDefined on this element
obs-4: Low range comparators can only be '>' or '>=' or empty (xpath: not(exists(f:comparator)) or boolean(f:comparator/@value = '<') or boolean(f:comparator/@value = '<='))
Observation.referenceRange.high
Definition

The value of the high bound of the reference range. If this element is omitted, the high bound of the reference range is assumed to be meaningless. (e.g. reference range is > 5) If the low.comparator element is missing , it is assumed to be '<'.

Control0..1 This element is affected by the following invariants: obs-3, obs-5
TypeQuantity
Requirements
Comments
InvariantsDefined on this element
obs-5: High range comparators can only be '<' or '<=' or empty (xpath: not(exists(f:comparator)) or boolean(f:comparator/@value = '>') or boolean(f:comparator/@value = '>='))
Observation.referenceRange.meaning
Definition

Code for the meaning of the reference range.

Control0..1
BindingCode for the meaning of a reference range
For example codes, see Observation Reference Range Meaning Codes
TypeCodeableConcept
Requirements

Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, or perhaps what state this reference range applies to (i.e. age, hormonal cycles, etc.).

Comments

This SHOULD be populated if there is more than one range.

Observation.referenceRange.age
Definition

The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

Control0..1
TypeRange
Requirements

Some analytes vary greatly over age.

Comments
Observation.referenceRange.text
Definition

Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of 'normals'.

Control0..1
Typestring
Requirements
Comments
Observation.related
Definition

Related observations - either components, or previous observations, or statements of derivation.

Control0..*
Requirements

Some observations have important relationships to other observations (e.g Blood Pressure = systolic + diastolic), or are derived from other observations (e.g. calculated apgar score).

Comments

Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived).

Observation.related.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Observation.related.extension
Definition

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

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

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

Observation.related.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers
Comments

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

Observation.related.type
Definition

A code specifying the kind of relationship that exists with the target observation.

Control0..1
BindingCodes specifying how two observations are related
The codes SHALL be taken from ObservationRelationshipType
Typecode
Requirements

May need to indicate whether this observation is composed of others, or merely derived from them.

Comments

A relationship type SHOULD be provided. If the relationship type is "COMP" (composed), then the observation should not be displayed/interpreted in the absence of the related observations.

Observation.related.target
Definition

A reference to the observation that is related to this observation.

Control1..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Observation))
Requirements
Comments