type: resource-definitionsresource: ObservationDefinition

ObservationDefinition Definitions

ObservationDefinition

Definition of an observation

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

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.

Cardinality: 0..*

Constraints: cnl-0 | warning | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('^A-Z{1,254}$'); obd-0 | error | If permittedUnit exists, then permittedDataType=Quantity must exist. | permittedUnit.exists() implies permittedDataType.exists(value = 'Quantity')

Mappings: workflow=Definition; v2=OM2 OM3 OMC; rim=Observation[classCode=OBS, moodCode=DEF]; w5=clinical.diagnostics

ObservationDefinition.url

Logical canonical URL to reference this ObservationDefinition (globally unique)

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.

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.

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

Cardinality: 0..1

Type: uri

Summary: true

Mappings: workflow=Definition.url

ObservationDefinition.identifier

Business identifier of the ObservationDefinition

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.

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.

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

Cardinality: 0..1

Type: Identifier

Summary: true

Mappings: workflow=Definition.identifier

ObservationDefinition.version

Business version of the ObservationDefinition

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.

Comments: There may be multiple different instances of an observationDefinition that have the same identifier but different versions.

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.version

ObservationDefinition.versionAlgorithm[x]

How to compare versions

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

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.

Cardinality: 0..1

Type: string, Coding

Binding: extensible:version-algorithm

Summary: true

Mappings: workflow=Definition.versionAlgorithm[x]

ObservationDefinition.name

Name for this ObservationDefinition (computer friendly)

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.

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.

Requirements: Support human navigation and code generation.

Conditions: cnl-0

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.name

ObservationDefinition.title

Name for this ObservationDefinition (human friendly)

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

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.title

ObservationDefinition.status

draft | active | retired | unknown

Definition: The current state of the ObservationDefinition.

Comments: A nominal state-transition diagram can be found in the 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.

See guidance around (not) making local changes to elements here.

Cardinality: 1..1

Type: code

Binding: required:publication-status

Summary: true

Is Modifier: true (Reason: Not known why this is labelled a modifier)

Mappings: workflow=Definition.status

ObservationDefinition.experimental

If For testing only - never for real usage

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.

Comments: Allows filtering of ObservationDefinition that are appropriate for use vs. not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc

Meaning if Missing: If absent, this resource is treated as though it is not experimental.

Cardinality: 0..1

Type: boolean

Summary: true

Mappings: workflow=Definition.experimental

ObservationDefinition.date

Date last changed

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.

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.

See guidance around (not) making local changes to elements here.

Aliases: revision date

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: workflow=Definition.date

ObservationDefinition.publisher

The name of the individual or organization that published the ObservationDefinition

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

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.

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.publisher

ObservationDefinition.contact

Contact details for the publisher

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

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

See guidance around (not) making local changes to elements here.

Cardinality: 0..*

Type: ContactDetail

Summary: true

Mappings: workflow=Definition.contact

ObservationDefinition.description

Natural language description of the ObservationDefinition

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

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.

Cardinality: 0..1

Type: markdown

Mappings: workflow=Definition.description

ObservationDefinition.useContext

Content intends to support these contexts

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.

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

Requirements: Assist in searching for appropriate content.

Cardinality: 0..*

Type: UsageContext

Summary: true

Mappings: workflow=Definition.useContext

ObservationDefinition.jurisdiction

Jurisdiction of the authority that maintains the this ObservationDefinition (if applicable)

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

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

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:jurisdiction

Summary: true

Mappings: workflow=Definition.jurisdiction

ObservationDefinition.purpose

Why this ObservationDefinition is defined

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

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.

Cardinality: 0..1

Type: markdown

Mappings: workflow=Definition.purpose

ObservationDefinition.copyright

Notice about intellectual property ownership, can include restrictions on use

Definition: Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the ObservationDefinition.

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

Aliases: License, Restrictions

Cardinality: 0..1

Type: markdown

Mappings: workflow=Definition.copyright

ObservationDefinition.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 restricted. (e.g. 'All rights reserved', 'Some rights reserved').

Comments: The copyright symbol and the '(c)' textual representation 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.

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

Cardinality: 0..1

Type: string

Mappings: workflow=Definition.coyprightLabel

ObservationDefinition.approvalDate

When ObservationDefinition was approved by publisher

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

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

See guidance around (not) making local changes to elements here.

Cardinality: 0..1

Type: date

Mappings: workflow=Definition.approvalDate

ObservationDefinition.lastReviewDate

Date on which the asset content was last reviewed by the publisher

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

Comments: If specified, this is usually after the approval date.

See guidance around (not) making local changes to elements here.

Cardinality: 0..1

Type: date

Mappings: workflow=Definition.lastReviewDate

ObservationDefinition.effectivePeriod

The effective date range for the ObservationDefinition

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

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 definition intended to be used for the year 2021 might be published in 2020.

See guidance around (not) making local changes to elements here.

Cardinality: 0..1

Type: Period

Summary: true

Mappings: workflow=Definition.effectivePeriod

ObservationDefinition.derivedFromCanonical

Based on FHIR definition of another observation

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

Cardinality: 0..*

Type: canonical

Summary: true

Mappings: workflow=Definition.derivedFromCanonical

ObservationDefinition.derivedFromUri

Based on external definition

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.

Requirements: Observation definitions may be refinements of other definitions.

Cardinality: 0..*

Type: uri

Summary: true

Mappings: workflow=Definition.derivedFromUri

ObservationDefinition.subject

Type of subject for the defined observation

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

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

Cardinality: 0..*

Type: CodeableConcept

Summary: true

Mappings: workflow=Definition.subject

ObservationDefinition.performerType

Desired kind of performer for such kind of observation

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

Cardinality: 0..1

Type: CodeableConcept

Summary: true

Mappings: workflow=Definition.performerType

ObservationDefinition.category

General type of observation

Definition: A code that classifies the general type of observation.

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.

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

Aliases: Class of observation

Cardinality: 0..*

Type: CodeableConcept

Binding: example:observation-category

Summary: true

Mappings: w5=FiveWs.class; rim=.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="DEF"].code

ObservationDefinition.code

Type of observation

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

Cardinality: 1..1

Type: CodeableConcept

Binding: example:observation-codes-observationorboth

Summary: true

Mappings: w5=FiveWs.what[x]; v2=OM1-2 OMC-4; rim=code; workflow=Definition.code

ObservationDefinition.permittedDataType

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

Conditions: obd-0

Cardinality: 0..*

Type: code

Binding: required:permitted-data-type

Mappings: v2=OM1-3

ObservationDefinition.multipleResultsAllowed

Multiple results allowed for conforming observations

Definition: Multiple results allowed for observations conforming to this ObservationDefinition.

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

Cardinality: 0..1

Type: boolean

ObservationDefinition.bodyStructure

Body structure to be observed

Definition: The body structure on the subject's body where the observation is to be made.

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

Cardinality: 0..1

Type: CodeableReference

Binding: example:body-site

Mappings: rim=targetSiteCode

ObservationDefinition.method

Method used to produce the observation

Definition: The method or technique used to perform the observation.

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

Requirements: In some cases, method can impact results.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:observation-methods

Mappings: v2=OM1-14; rim=methodCode

ObservationDefinition.specimen

Kind of specimen used by this type of observation

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

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.

Cardinality: 0..*

Type: Reference(SpecimenDefinition)

Mappings: rim=participation[typeCode=SPC].specimen

ObservationDefinition.device[x]

Measurement device or model of device

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

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.

Cardinality: 0..1

Type: Reference(Device), canonical

ObservationDefinition.preferredReportName

The preferred name to be used when reporting the observation results

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

Cardinality: 0..1

Type: string

Mappings: v2=OM1-9

ObservationDefinition.permittedUnit

Unit for quantitative results

Definition: Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition.

Conditions: obd-0

Cardinality: 0..*

Type: Coding

Binding: preferred:ucum-units

Mappings: v2=OM2-4

ObservationDefinition.qualifiedValue

Set of qualified values for observation results

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.

Cardinality: 0..*

Type: BackboneElement

ObservationDefinition.qualifiedValue.context

Context qualifier for the set of qualified values

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

Cardinality: 0..1

Type: CodeableConcept

Binding: extensible:referencerange-meaning

ObservationDefinition.qualifiedValue.appliesTo

Targetted population for the set of qualified values

Definition: The target population this set of qualified values applies to.

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

Cardinality: 0..*

Type: CodeableConcept

Binding: example:referencerange-appliesto

ObservationDefinition.qualifiedValue.sexParameterForClinicalUse

male | female | other | unknown

Definition: The sex parameter for clinical use this set of qualified values applies to.

Cardinality: 0..1

Type: code

Binding: required:administrative-gender

ObservationDefinition.qualifiedValue.age

Applicable age range for the set of qualified values

Definition: The age range this set of qualified values applies to.

Comments: Some analytes vary greatly over age.

Cardinality: 0..1

Type: Range

ObservationDefinition.qualifiedValue.gestationalAge

Applicable gestational age range for the set of qualified values

Definition: The gestational age this set of qualified values applies to.

Cardinality: 0..1

Type: Range

ObservationDefinition.qualifiedValue.condition

Validity criterion for the qualified value

Definition: Description of the criterion for which the qualified value is valid.

Cardinality: 0..1

Type: string

ObservationDefinition.qualifiedValue.rangeCategory

reference | critical | absolute

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

Cardinality: 0..1

Type: code

Binding: required:observation-range-category

ObservationDefinition.qualifiedValue.range

The range for continuous or ordinal observations

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

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

Cardinality: 0..1

Type: Range

ObservationDefinition.qualifiedValue.validCodedValueSet

Value set of valid coded values as part of this set of qualified values

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

Cardinality: 0..1

Type: canonical

ObservationDefinition.qualifiedValue.normalCodedValueSet

Value set of normal coded values as part of this set of qualified values

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

Cardinality: 0..1

Type: canonical

ObservationDefinition.qualifiedValue.abnormalCodedValueSet

Value set of abnormal coded values as part of this set of qualified values

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

Cardinality: 0..1

Type: canonical

ObservationDefinition.qualifiedValue.criticalCodedValueSet

Value set of critical coded values as part of this set of qualified values

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

Cardinality: 0..1

Type: canonical

ObservationDefinition.qualifiedValue.interpretation

Expected coded interpretation values

Definition: The expected coded interpretation values of an observation that matches this qualified interval. For example, high, low, normal.

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:observation-interpretation

ObservationDefinition.hasMember

Definitions of related resources belonging to this kind of observation group

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.

Cardinality: 0..*

Type: Reference(ObservationDefinition, Questionnaire)

ObservationDefinition.component

Component results

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

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

Cardinality: 0..*

Type: BackboneElement

Constraints: obd-1 | error | If permittedUnit exists, then permittedDataType=Quantity must exist. | permittedUnit.exists() implies permittedDataType.exists(value = 'Quantity')

Mappings: rim=outBoundRelationship[typeCode=COMP]