FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Orders and Observations icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ObservationDefinition resource.

ObservationDefinition
Element IdObservationDefinition
Definition

Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

Short DisplayDefinition of an observation
Cardinality0..*
TypeMetadataResource
Requirements

In a catalog of health-related services that use or produce observations and measurements, this resource describes the expected characteristics of these observation / measurements.

Summaryfalse
Comments

An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.

Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
ObservationDefinition.url
Element IdObservationDefinition.url
Definition

An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.

Short DisplayLogical canonical URL to reference this ObservationDefinition (globally unique)
Cardinality0..1
Typeuri
Requirements

Allows the ObservationDefinition to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.

ObservationDefinition.identifier
Element IdObservationDefinition.identifier
Definition

Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

Short DisplayBusiness identifier of the ObservationDefinition
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..1
TypeIdentifier
Requirements

Allows identification of the ObservationDefinition as it is known by various participating systems and in a way that remains consistent across servers.

Summarytrue
Comments

This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.

ObservationDefinition.version
Element IdObservationDefinition.version
Definition

The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.

Short DisplayBusiness version of the ObservationDefinition
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be multiple different instances of a ObservationDefinition that have the same identifier but different versions.

ObservationDefinition.versionAlgorithm[x]
Element IdObservationDefinition.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

ObservationDefinition.name
Element IdObservationDefinition.name
Definition

A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Short DisplayName for this ObservationDefinition (computer friendly)
Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
ObservationDefinition.title
Element IdObservationDefinition.title
Definition

A short, descriptive, user-friendly title for the ObservationDefinition.

Short DisplayName for this ObservationDefinition (human friendly)
Cardinality0..1
Typestring
Summarytrue
ObservationDefinition.status
Element IdObservationDefinition.status
Definition

The current state of the ObservationDefinition.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: Not known why this is labelled a modifier)
Summarytrue
Comments

A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

ObservationDefinition.experimental
Element IdObservationDefinition.experimental
Definition

A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Short DisplayIf for testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Summarytrue
Comments

Allows filtering of ObservationDefinition that are appropriate for use vs. not.

ObservationDefinition.date
Element IdObservationDefinition.date
Definition

The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate Namesrevision date
Summarytrue
Comments

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the ObservationDefinition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

ObservationDefinition.publisher
Element IdObservationDefinition.publisher
Definition

Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.

Short DisplayThe name of the individual or organization that published the ObservationDefinition
Cardinality0..1
Typestring
Requirements

Usually an organization, but may be an individual. The publisher (or steward) of the ObservationDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the ObservationDefinition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the ObservationDefinition. This item SHOULD be populated unless the information is available from context.

Summarytrue
ObservationDefinition.contact
Element IdObservationDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

ObservationDefinition.description
Element IdObservationDefinition.description
Definition

A free text natural language description of the ObservationDefinition from the consumer's perspective.

Short DisplayNatural language description of the ObservationDefinition
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.

ObservationDefinition.useContext
Element IdObservationDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances.

Short DisplayContent intends to support these contexts
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

ObservationDefinition.jurisdiction
Element IdObservationDefinition.jurisdiction
Definition

A jurisdiction in which the ObservationDefinition is intended to be used.

Short DisplayIntended jurisdiction for this ObservationDefinition (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the ObservationDefinition to be used in jurisdictions other than those for which it was originally designed or intended.

ObservationDefinition.purpose
Element IdObservationDefinition.purpose
Definition

Explains why this ObservationDefinition is needed and why it has been designed as it has.

Short DisplayWhy this ObservationDefinition is defined
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This element does not describe the usage of the ObservationDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this ObservationDefinition.

ObservationDefinition.copyright
Element IdObservationDefinition.copyright
Definition

Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers of the ObservationDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content.

Alternate NamesLicense; Restrictions
Summaryfalse
ObservationDefinition.copyrightLabel
Element IdObservationDefinition.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summaryfalse
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

ObservationDefinition.approvalDate
Element IdObservationDefinition.approvalDate
Definition

The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Short DisplayWhen ObservationDefinition was approved by publisher
Cardinality0..1
Typedate
Summaryfalse
Comments

The date may be more recent than the approval date because of minor changes / editorial corrections.

ObservationDefinition.lastReviewDate
Element IdObservationDefinition.lastReviewDate
Definition

The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

Short DisplayDate on which the asset content was last reviewed
Cardinality0..1
Typedate
Summaryfalse
Comments

If specified, this is usually after the approval date.

ObservationDefinition.effectivePeriod
Element IdObservationDefinition.effectivePeriod
Definition

The period during which the ObservationDefinition content was or is planned to be effective.

Short DisplayThe effective date range for the ObservationDefinition
Cardinality0..1
TypePeriod
Summarytrue
Comments

The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation intended to be used for the year 2021 might be published in 2020.

ObservationDefinition.derivedFromCanonical
Element IdObservationDefinition.derivedFromCanonical
Definition

The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.

Short DisplayBased on FHIR definition of another observation
Cardinality0..*
Typecanonical(ObservationDefinition)
Summarytrue
ObservationDefinition.derivedFromUri
Element IdObservationDefinition.derivedFromUri
Definition

The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.

Short DisplayBased on external definition
Cardinality0..*
Typeuri
Requirements

Observation definitions may be refinements of other definitions.

Summarytrue
ObservationDefinition.subject
Element IdObservationDefinition.subject
Definition

A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition.

Short DisplayType of subject for the defined observation
Cardinality0..*
TypeCodeableConcept
Summarytrue
Comments

Examples: person, animal, device, air, surface ….

ObservationDefinition.performerType
Element IdObservationDefinition.performerType
Definition

The type of individual/organization/device that is expected to act upon instances of this definition.

Short DisplayDesired kind of performer for such kind of observation
Cardinality0..1
TypeCodeableConcept
Summarytrue
ObservationDefinition.category
Element IdObservationDefinition.category
Definition

A code that classifies the general type of observation.

Short DisplayGeneral type of observation
Cardinality0..*
Terminology BindingObservation Category Codes (Example)
TypeCodeableConcept
Requirements

Used for filtering what kinds of observations are retrieved and displayed.

Alternate NamesClass of observation
Summarytrue
Comments

This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set.

ObservationDefinition.code
Element IdObservationDefinition.code
Definition

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

Short DisplayType of observation
Cardinality1..1
Terminology BindingLOINC Codes (Example)
TypeCodeableConcept
Summarytrue
ObservationDefinition.permittedDataType
Element IdObservationDefinition.permittedDataType
Definition

The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.

Short DisplayQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Cardinality0..*
Terminology BindingObservationDataType (Required)
Typecode
Summaryfalse
ObservationDefinition.multipleResultsAllowed
Element IdObservationDefinition.multipleResultsAllowed
Definition

Multiple results allowed for observations conforming to this ObservationDefinition.

Short DisplayMultiple results allowed for conforming observations
Cardinality0..1
Typeboolean
Summaryfalse
Comments

An example of observation allowing multiple results is "bacteria identified by culture". Conversely, the measurement of a potassium level allows a single result.

ObservationDefinition.bodySite
Element IdObservationDefinition.bodySite
Definition

The site on the subject's body where the observation is to be made.

Short DisplayBody part to be observed
Cardinality0..1
Terminology BindingSNOMED CT Body Structures (Example)
TypeCodeableConcept
Summaryfalse
Comments

Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations. Example: 14975008 |Forearm structure|.

ObservationDefinition.method
Element IdObservationDefinition.method
Definition

The method or technique used to perform the observation.

Short DisplayMethod used to produce the observation
Cardinality0..1
Terminology BindingObservation Methods (Example)
TypeCodeableConcept
Requirements

In some cases, method can impact results.

Summaryfalse
Comments

Only used if not implicit in observation code Example: 702659008 |Automated count technique|.

ObservationDefinition.specimen
Element IdObservationDefinition.specimen
Definition

The kind of specimen that this type of observation is produced on.

Short DisplayKind of specimen used by this type of observation
Cardinality0..*
TypeReference(SpecimenDefinition)
Summaryfalse
Comments

Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation.

ObservationDefinition.device
Element IdObservationDefinition.device
Definition

The measurement model of device or actual device used to produce observations of this type.

Short DisplayMeasurement device or model of device
Cardinality0..*
TypeReference(DeviceDefinition | Device)
Summaryfalse
Comments

When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation.

ObservationDefinition.preferredReportName
Element IdObservationDefinition.preferredReportName
Definition

The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.

Short DisplayThe preferred name to be used when reporting the observation results
Cardinality0..1
Typestring
Summaryfalse
ObservationDefinition.quantitativeDetails
Element IdObservationDefinition.quantitativeDetails
Definition

Characteristics for quantitative results of observations conforming to this ObservationDefinition.

Short DisplayCharacteristics of quantitative results
Cardinality0..1
Summaryfalse
ObservationDefinition.quantitativeDetails.unit
Element IdObservationDefinition.quantitativeDetails.unit
Definition

Primary unit used to report quantitative results of observations conforming to this ObservationDefinition.

Short DisplayPrimary unit for quantitative results
Cardinality0..1
Terminology BindingUCUM Codes (Extensible)
TypeCodeableConcept
Summaryfalse
ObservationDefinition.quantitativeDetails.customaryUnit
Element IdObservationDefinition.quantitativeDetails.customaryUnit
Definition

Secondary unit used to report quantitative results of observations conforming to this ObservationDefinition.

Short DisplayCustomary (secondary) unit for quantitative results
Cardinality0..1
Terminology BindingUCUM Codes (Extensible)
TypeCodeableConcept
Summaryfalse
ObservationDefinition.quantitativeDetails.conversionFactor
Element IdObservationDefinition.quantitativeDetails.conversionFactor
Definition

Factor for converting value expressed with primary unit to value expressed with secondary unit.

Short DisplayPrimary to secondary unit conversion factor
Cardinality0..1
Typedecimal
Summaryfalse
ObservationDefinition.quantitativeDetails.decimalPrecision
Element IdObservationDefinition.quantitativeDetails.decimalPrecision
Definition

Number of digits after decimal separator when the results of such observations are of type Quantity.

Short DisplayDecimal precision of observation quantitative results
Cardinality0..1
Typeinteger
Summaryfalse
ObservationDefinition.qualifiedValue
Element IdObservationDefinition.qualifiedValue
Definition

A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.

Short DisplaySet of qualified values for observation results
Cardinality0..*
Summaryfalse
ObservationDefinition.qualifiedValue.context
Element IdObservationDefinition.qualifiedValue.context
Definition

A concept defining the context for this set of qualified values.

Short DisplayContext qualifier for the set of qualified values
Cardinality0..1
Terminology BindingObservation Reference Range Meaning Codes (Extensible)
TypeCodeableConcept
Summaryfalse
ObservationDefinition.qualifiedValue.appliesTo
Element IdObservationDefinition.qualifiedValue.appliesTo
Definition

The target population this set of qualified values applies to.

Short DisplayTargetted population for the set of qualified values
Cardinality0..*
Terminology BindingObservation Reference Range Applies To Codes (Example)
TypeCodeableConcept
Summaryfalse
Comments

If this element is not present then the global population is assumed.

ObservationDefinition.qualifiedValue.gender
Element IdObservationDefinition.qualifiedValue.gender
Definition

The gender this set of qualified values applies to.

Short Displaymale | female | other | unknown
Cardinality0..1
Terminology BindingAdministrativeGender (Required)
Typecode
Summaryfalse
ObservationDefinition.qualifiedValue.age
Element IdObservationDefinition.qualifiedValue.age
Definition

The age range this set of qualified values applies to.

Short DisplayApplicable age range for the set of qualified values
Cardinality0..1
TypeRange
Summaryfalse
Comments

Some analytes vary greatly over age.

ObservationDefinition.qualifiedValue.gestationalAge
Element IdObservationDefinition.qualifiedValue.gestationalAge
Definition

The gestational age this set of qualified values applies to.

Short DisplayApplicable gestational age range for the set of qualified values
Cardinality0..1
TypeRange
Summaryfalse
ObservationDefinition.qualifiedValue.condition
Element IdObservationDefinition.qualifiedValue.condition
Definition

Text based condition for which the the set of qualified values is valid.

Short DisplayCondition associated with the set of qualified values
Cardinality0..1
Typestring
Summaryfalse
ObservationDefinition.qualifiedValue.rangeCategory
Element IdObservationDefinition.qualifiedValue.rangeCategory
Definition

The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values.

Short Displayreference | critical | absolute
Cardinality0..1
Terminology BindingObservationRangeCategory (Required)
Typecode
Summaryfalse
ObservationDefinition.qualifiedValue.range
Element IdObservationDefinition.qualifiedValue.range
Definition

The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values.

Short DisplayThe range for continuous or ordinal observations
Cardinality0..1
TypeRange
Requirements

The unit may be not relevant for ordinal values. In case it is there, it is the same as quantitativeDetails.unit.

Summaryfalse
ObservationDefinition.qualifiedValue.validCodedValueSet
Element IdObservationDefinition.qualifiedValue.validCodedValueSet
Definition

The set of valid coded results for qualitative observations that match the criteria of this set of qualified values.

Short DisplayValue set of valid coded values as part of this set of qualified values
Cardinality0..1
Typecanonical(ValueSet)
Summaryfalse
ObservationDefinition.qualifiedValue.normalCodedValueSet
Element IdObservationDefinition.qualifiedValue.normalCodedValueSet
Definition

The set of normal coded results for qualitative observations that match the criteria of this set of qualified values.

Short DisplayValue set of normal coded values as part of this set of qualified values
Cardinality0..1
Typecanonical(ValueSet)
Summaryfalse
ObservationDefinition.qualifiedValue.abnormalCodedValueSet
Element IdObservationDefinition.qualifiedValue.abnormalCodedValueSet
Definition

The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified values.

Short DisplayValue set of abnormal coded values as part of this set of qualified values
Cardinality0..1
Typecanonical(ValueSet)
Summaryfalse
ObservationDefinition.qualifiedValue.criticalCodedValueSet
Element IdObservationDefinition.qualifiedValue.criticalCodedValueSet
Definition

The set of critical coded results for qualitative observations that match the criteria of this set of qualified values.

Short DisplayValue set of critical coded values as part of this set of qualified values
Cardinality0..1
Typecanonical(ValueSet)
Summaryfalse
ObservationDefinition.hasMember
Element IdObservationDefinition.hasMember
Definition

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

Short DisplayDefinitions of related resources belonging to this kind of observation group
Cardinality0..*
TypeReference(ObservationDefinition | Questionnaire)
Summaryfalse
ObservationDefinition.component
Element IdObservationDefinition.component
Definition

Some observations have multiple component observations, expressed as separate code value pairs.

Short DisplayComponent results
Cardinality0..*
Requirements

Component observations share the same attributes as the primary observation and are always treated as a part of it (they are not separable).

Summaryfalse
ObservationDefinition.component.code
Element IdObservationDefinition.component.code
Definition

Describes what will be observed.

Short DisplayType of observation
Cardinality1..1
Terminology BindingLOINC Codes (Example)
TypeCodeableConcept
Summaryfalse
ObservationDefinition.component.permittedDataType
Element IdObservationDefinition.component.permittedDataType
Definition

The data types allowed for the value element of the instance of this component observations.

Short DisplayQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Cardinality0..*
Terminology BindingObservationDataType (Required)
Typecode
Summaryfalse
ObservationDefinition.component.quantitativeDetails
Element IdObservationDefinition.component.quantitativeDetails
Definition

Characteristics for quantitative results of this observation.

Short DisplayCharacteristics of quantitative results
Cardinality0..1
TypeSee ObservationDefinition.quantitativeDetails
Summaryfalse
ObservationDefinition.component.qualifiedValue
Element IdObservationDefinition.component.qualifiedValue
Definition

A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.

Short DisplaySet of qualified values for observation results
Cardinality0..*
TypeSee ObservationDefinition.qualifiedValue
Summaryfalse