This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Orders and Observations Work Group | Maturity Level: 1 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
An instance of ObservationDefinition represents the definitional aspects of a kind of observation. This resource is used in a catalog of products or services for healthcare. It provides the definition of observations, which are used as input or produced as outcome of these products and services. The focus of the definitional aspects of ObservationDefinition is not on the action of performing observations of that kind. Rather, it is on the outcome of the observations. An instance of ObservationDefinition represents a set of constraints applicable to the value produced by observations of this kind. This set of constraints may have two utilities: 1) It guides the entry of the result of an observation of the kind defined. 2) It helps the consumer of the results of observations of that kind, to interpret properly these results.
For instance, in a catalog of laboratory in vitro diagnostic services, the ObservationDefinition resources describe the observations that should be provided by the orderer alongside with an ordered service (questions asked at order entry or at specimen collection, prior results) as well as the observations that will be reported once the service has been performed.
In a catalog of medications, ObservationDefinition resources can be used to describe observations the result thereof need to be checked against the prescription of a particular medicinal product (therapeutic range, units ...)
In the catalog of tests of an in vitro diagnostic device, ObservationDefinition resources can be used to characterize (absolute range, unit, decimal precision, critical values ...) the observations that will be produced by the IVD tests performed by the device.
ObservationDefinition may be used to characterize observations from any discipline.
An ObservationDefinition resource provides the definitional characteristics for a certain kind of observation. Each time that kind of observation is collected and recorded it is instantiated as an Observation resource, which conforms to these definitional characteristics. Thus, there is a relationship between ObservationDefinition and Observation: The latter may instantiate the former.
When an Observation instantiates an ObservationDefinition, the elements of the Observation resource are expected to inherit their content from the corresponding definitional elements declared in the ObservationDefinition resource:
ObservationDefinition enables to express some Quantity results in two distinct units of measure: the primary or SI one, represented by element unit, and a converted one, provided for accommodation of some actors, represented by element customaryUnit. Observation may pick only the primary unit, or may express its result in both units, in two component results.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ObservationDefinition | TU | DomainResource | Definition of an observation + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
url | Σ | 0..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) |
identifier | Σ | 0..1 | Identifier | Business identifier of the ObservationDefinition |
version | Σ | 0..1 | string | Business version of the ObservationDefinition |
name | ΣC | 0..1 | string | Name for this ObservationDefinition (computer friendly) |
title | ΣT | 0..1 | string | Name for this ObservationDefinition (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | If for testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | ΣT | 0..1 | string | The name of the individual or organization that published the ObservationDefinition |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | T | 0..1 | markdown | Natural language description of the ObservationDefinition |
useContext | Σ | 0..* | UsageContext | Content intends to support these contexts |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for this ObservationDefinition (if applicable) Jurisdiction ValueSet (Extensible) |
purpose | T | 0..1 | markdown | Why this ObservationDefinition is defined |
copyright | T | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | 0..1 | date | When ObservationDefinition was approved by publisher | |
lastReviewDate | 0..1 | date | Date on which the asset content was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | The effective date range for the ObservationDefinition |
derivedFromCanonical | Σ | 0..* | canonical(ObservationDefinition) | Based on FHIR definition of another observation |
derivedFromUri | Σ | 0..* | uri | Based on external definition |
subject | Σ | 0..* | CodeableConcept | Type of subject for the defined observation |
performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer for such kind of observation |
category | Σ | 0..* | CodeableConcept | General type of observation Observation Category Codes (Example) |
code | Σ | 1..1 | CodeableConcept | Type of observation LOINC Codes (Example) |
permittedDataType | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period ObservationDataType (Required) | |
multipleResultsAllowed | 0..1 | boolean | Multiple results allowed for conforming observations | |
bodySite | 0..1 | CodeableConcept | Body part to be observed SNOMED CT Body Structures (Example) | |
method | 0..1 | CodeableConcept | Method used to produce the observation Observation Methods (Example) | |
specimen | 0..* | Reference(SpecimenDefinition) | Kind of specimen used by this type of observation | |
device | 0..* | Reference(DeviceDefinition | Device) | Measurement device or model of device | |
preferredReportName | 0..1 | string | The preferred name to be used when reporting the observation results | |
quantitativeDetails | 0..1 | BackboneElement | Characteristics of quantitative results | |
unit | 0..1 | CodeableConcept | Primary unit for quantitative results UCUM Codes (Extensible) | |
customaryUnit | 0..1 | CodeableConcept | Customary (secondary) unit for quantitative results UCUM Codes (Extensible) | |
conversionFactor | 0..1 | decimal | Primary to secondary unit conversion factor | |
decimalPrecision | 0..1 | integer | Decimal precision of observation quantitative results | |
qualifiedValue | 0..* | BackboneElement | Set of qualified values for observation results | |
context | 0..1 | CodeableConcept | Context qualifier for the set of qualified values Observation Reference Range Meaning Codes (Extensible) | |
appliesTo | 0..* | CodeableConcept | Targetted population for the set of qualified values Observation Reference Range Applies To Codes (Example) | |
gender | 0..1 | code | male | female | other | unknown AdministrativeGender (Required) | |
age | 0..1 | Range | Applicable age range for the set of qualified values | |
gestationalAge | 0..1 | Range | Applicable gestational age range for the set of qualified values | |
condition | 0..1 | string | Condition associated with the set of qualified values | |
rangeCategory | 0..1 | code | reference | critical | absolute ObservationRangeCategory (Required) | |
range | 0..1 | Range | The range for continuous or ordinal observations | |
validCodedValueSet | 0..1 | canonical(ValueSet) | Value set of valid coded values as part of this set of qualified values | |
normalCodedValueSet | 0..1 | canonical(ValueSet) | Value set of normal coded values as part of this set of qualified values | |
abnormalCodedValueSet | 0..1 | canonical(ValueSet) | Value set of abnormal coded values as part of this set of qualified values | |
criticalCodedValueSet | 0..1 | canonical(ValueSet) | Value set of critical coded values as part of this set of qualified values | |
hasMember | 0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | |
component | 0..* | BackboneElement | Component results | |
code | 1..1 | CodeableConcept | Type of observation LOINC Codes (Example) | |
permittedDataType | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period ObservationDataType (Required) | |
quantitativeDetails | 0..1 | see quantitativeDetails | Characteristics of quantitative results | |
qualifiedValue | 0..* | see qualifiedValue | Set of qualified values for observation results | |
Documentation for this format |
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<ObservationDefinition xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) --> <identifier><!-- 0..1 Identifier Business identifier of the ObservationDefinition --></identifier> <version value="[string]"/><!-- 0..1 Business version of the ObservationDefinition --> <name value="[string]"/><!-- I 0..1 Name for this ObservationDefinition (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this ObservationDefinition (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 The name of the individual or organization that published the ObservationDefinition --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the ObservationDefinition --> <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for this ObservationDefinition (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this ObservationDefinition is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When ObservationDefinition was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 Date on which the asset content was last reviewed --> <effectivePeriod><!-- 0..1 Period The effective date range for the ObservationDefinition --></effectivePeriod> <derivedFromCanonical><!-- 0..* canonical(ObservationDefinition) Based on FHIR definition of another observation --></derivedFromCanonical> <derivedFromUri value="[uri]"/><!-- 0..* Based on external definition --> <subject><!-- 0..* CodeableConcept Type of subject for the defined observation --></subject> <performerType><!-- 0..1 CodeableConcept Desired kind of performer for such kind of observation --></performerType> <category><!-- 0..* CodeableConcept General type of observation --></category> <code><!-- 1..1 CodeableConcept Type of observation --></code> <permittedDataType value="[code]"/><!-- 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period --> <multipleResultsAllowed value="[boolean]"/><!-- 0..1 Multiple results allowed for conforming observations --> <bodySite><!-- 0..1 CodeableConcept Body part to be observed --></bodySite> <method><!-- 0..1 CodeableConcept Method used to produce the observation --></method> <specimen><!-- 0..* Reference(SpecimenDefinition) Kind of specimen used by this type of observation --></specimen> <device><!-- 0..* Reference(Device|DeviceDefinition) Measurement device or model of device --></device> <preferredReportName value="[string]"/><!-- 0..1 The preferred name to be used when reporting the observation results --> <quantitativeDetails> <!-- 0..1 Characteristics of quantitative results --> <unit><!-- 0..1 CodeableConcept Primary unit for quantitative results --></unit> <customaryUnit><!-- 0..1 CodeableConcept Customary (secondary) unit for quantitative results --></customaryUnit> <conversionFactor value="[decimal]"/><!-- 0..1 Primary to secondary unit conversion factor --> <decimalPrecision value="[integer]"/><!-- 0..1 Decimal precision of observation quantitative results --> </quantitativeDetails> <qualifiedValue> <!-- 0..* Set of qualified values for observation results --> <context><!-- 0..1 CodeableConcept Context qualifier for the set of qualified values --></context> <appliesTo><!-- 0..* CodeableConcept Targetted population for the set of qualified values --></appliesTo> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --> <age><!-- 0..1 Range Applicable age range for the set of qualified values --></age> <gestationalAge><!-- 0..1 Range Applicable gestational age range for the set of qualified values --></gestationalAge> <condition value="[string]"/><!-- 0..1 Condition associated with the set of qualified values --> <rangeCategory value="[code]"/><!-- 0..1 reference | critical | absolute --> <range><!-- 0..1 Range The range for continuous or ordinal observations --></range> <validCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of valid coded values as part of this set of qualified values --></validCodedValueSet> <normalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of normal coded values as part of this set of qualified values --></normalCodedValueSet> <abnormalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of abnormal coded values as part of this set of qualified values --></abnormalCodedValueSet> <criticalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of critical coded values as part of this set of qualified values --></criticalCodedValueSet> </qualifiedValue> <hasMember><!-- 0..* Reference(ObservationDefinition|Questionnaire) Definitions of related resources belonging to this kind of observation group --></hasMember> <component> <!-- 0..* Component results --> <code><!-- 1..1 CodeableConcept Type of observation --></code> <permittedDataType value="[code]"/><!-- 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period --> <quantitativeDetails><!-- 0..1 Content as for ObservationDefinition.quantitativeDetails Characteristics of quantitative results --></quantitativeDetails> <qualifiedValue><!-- 0..* Content as for ObservationDefinition.qualifiedValue Set of qualified values for observation results --></qualifiedValue> </component> </ObservationDefinition>
JSON Template
{ "resourceType" : "ObservationDefinition", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Logical canonical URL to reference this ObservationDefinition (globally unique) "identifier" : { Identifier }, // Business identifier of the ObservationDefinition "version" : "<string>", // Business version of the ObservationDefinition "name" : "<string>", // I Name for this ObservationDefinition (computer friendly) "title" : "<string>", // Name for this ObservationDefinition (human friendly) "status" : "<code>", // R! draft | active | retired | unknown "experimental" : <boolean>, // If for testing purposes, not real usage "date" : "<dateTime>", // Date last changed "publisher" : "<string>", // The name of the individual or organization that published the ObservationDefinition "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // Natural language description of the ObservationDefinition "useContext" : [{ UsageContext }], // Content intends to support these contexts "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for this ObservationDefinition (if applicable) "purpose" : "<markdown>", // Why this ObservationDefinition is defined "copyright" : "<markdown>", // Use and/or publishing restrictions "approvalDate" : "<date>", // When ObservationDefinition was approved by publisher "lastReviewDate" : "<date>", // Date on which the asset content was last reviewed "effectivePeriod" : { Period }, // The effective date range for the ObservationDefinition "derivedFromCanonical" : ["<canonical(ObservationDefinition)>"], // Based on FHIR definition of another observation "derivedFromUri" : ["<uri>"], // Based on external definition "subject" : [{ CodeableConcept }], // Type of subject for the defined observation "performerType" : { CodeableConcept }, // Desired kind of performer for such kind of observation "category" : [{ CodeableConcept }], // General type of observation "code" : { CodeableConcept }, // R! Type of observation "permittedDataType" : ["<code>"], // Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period "multipleResultsAllowed" : <boolean>, // Multiple results allowed for conforming observations "bodySite" : { CodeableConcept }, // Body part to be observed "method" : { CodeableConcept }, // Method used to produce the observation "specimen" : [{ Reference(SpecimenDefinition) }], // Kind of specimen used by this type of observation "device" : [{ Reference(Device|DeviceDefinition) }], // Measurement device or model of device "preferredReportName" : "<string>", // The preferred name to be used when reporting the observation results "quantitativeDetails" : { // Characteristics of quantitative results "unit" : { CodeableConcept }, // Primary unit for quantitative results "customaryUnit" : { CodeableConcept }, // Customary (secondary) unit for quantitative results "conversionFactor" : <decimal>, // Primary to secondary unit conversion factor "decimalPrecision" : <integer> // Decimal precision of observation quantitative results }, "qualifiedValue" : [{ // Set of qualified values for observation results "context" : { CodeableConcept }, // Context qualifier for the set of qualified values "appliesTo" : [{ CodeableConcept }], // Targetted population for the set of qualified values "gender" : "<code>", // male | female | other | unknown "age" : { Range }, // Applicable age range for the set of qualified values "gestationalAge" : { Range }, // Applicable gestational age range for the set of qualified values "condition" : "<string>", // Condition associated with the set of qualified values "rangeCategory" : "<code>", // reference | critical | absolute "range" : { Range }, // The range for continuous or ordinal observations "validCodedValueSet" : "<canonical(ValueSet)>", // Value set of valid coded values as part of this set of qualified values "normalCodedValueSet" : "<canonical(ValueSet)>", // Value set of normal coded values as part of this set of qualified values "abnormalCodedValueSet" : "<canonical(ValueSet)>", // Value set of abnormal coded values as part of this set of qualified values "criticalCodedValueSet" : "<canonical(ValueSet)>" // Value set of critical coded values as part of this set of qualified values }], "hasMember" : [{ Reference(ObservationDefinition|Questionnaire) }], // Definitions of related resources belonging to this kind of observation group "component" : [{ // Component results "code" : { CodeableConcept }, // R! Type of observation "permittedDataType" : ["<code>"], // Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period "quantitativeDetails" : { Content as for ObservationDefinition.quantitativeDetails }, // Characteristics of quantitative results "qualifiedValue" : [{ Content as for ObservationDefinition.qualifiedValue }] // Set of qualified values for observation results }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:ObservationDefinition; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:ObservationDefinition.url [ uri ]; # 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) fhir:ObservationDefinition.identifier [ Identifier ]; # 0..1 Business identifier of the ObservationDefinition fhir:ObservationDefinition.version [ string ]; # 0..1 Business version of the ObservationDefinition fhir:ObservationDefinition.name [ string ]; # 0..1 I Name for this ObservationDefinition (computer friendly) fhir:ObservationDefinition.title [ string ]; # 0..1 Name for this ObservationDefinition (human friendly) fhir:ObservationDefinition.status [ code ]; # 1..1 draft | active | retired | unknown fhir:ObservationDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage fhir:ObservationDefinition.date [ dateTime ]; # 0..1 Date last changed fhir:ObservationDefinition.publisher [ string ]; # 0..1 The name of the individual or organization that published the ObservationDefinition fhir:ObservationDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:ObservationDefinition.description [ markdown ]; # 0..1 Natural language description of the ObservationDefinition fhir:ObservationDefinition.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts fhir:ObservationDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for this ObservationDefinition (if applicable) fhir:ObservationDefinition.purpose [ markdown ]; # 0..1 Why this ObservationDefinition is defined fhir:ObservationDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:ObservationDefinition.approvalDate [ date ]; # 0..1 When ObservationDefinition was approved by publisher fhir:ObservationDefinition.lastReviewDate [ date ]; # 0..1 Date on which the asset content was last reviewed fhir:ObservationDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the ObservationDefinition fhir:ObservationDefinition.derivedFromCanonical [ canonical(ObservationDefinition) ], ... ; # 0..* Based on FHIR definition of another observation fhir:ObservationDefinition.derivedFromUri [ uri ], ... ; # 0..* Based on external definition fhir:ObservationDefinition.subject [ CodeableConcept ], ... ; # 0..* Type of subject for the defined observation fhir:ObservationDefinition.performerType [ CodeableConcept ]; # 0..1 Desired kind of performer for such kind of observation fhir:ObservationDefinition.category [ CodeableConcept ], ... ; # 0..* General type of observation fhir:ObservationDefinition.code [ CodeableConcept ]; # 1..1 Type of observation fhir:ObservationDefinition.permittedDataType [ code ], ... ; # 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period fhir:ObservationDefinition.multipleResultsAllowed [ boolean ]; # 0..1 Multiple results allowed for conforming observations fhir:ObservationDefinition.bodySite [ CodeableConcept ]; # 0..1 Body part to be observed fhir:ObservationDefinition.method [ CodeableConcept ]; # 0..1 Method used to produce the observation fhir:ObservationDefinition.specimen [ Reference(SpecimenDefinition) ], ... ; # 0..* Kind of specimen used by this type of observation fhir:ObservationDefinition.device [ Reference(Device|DeviceDefinition) ], ... ; # 0..* Measurement device or model of device fhir:ObservationDefinition.preferredReportName [ string ]; # 0..1 The preferred name to be used when reporting the observation results fhir:ObservationDefinition.quantitativeDetails [ # 0..1 Characteristics of quantitative results fhir:ObservationDefinition.quantitativeDetails.unit [ CodeableConcept ]; # 0..1 Primary unit for quantitative results fhir:ObservationDefinition.quantitativeDetails.customaryUnit [ CodeableConcept ]; # 0..1 Customary (secondary) unit for quantitative results fhir:ObservationDefinition.quantitativeDetails.conversionFactor [ decimal ]; # 0..1 Primary to secondary unit conversion factor fhir:ObservationDefinition.quantitativeDetails.decimalPrecision [ integer ]; # 0..1 Decimal precision of observation quantitative results ]; fhir:ObservationDefinition.qualifiedValue [ # 0..* Set of qualified values for observation results fhir:ObservationDefinition.qualifiedValue.context [ CodeableConcept ]; # 0..1 Context qualifier for the set of qualified values fhir:ObservationDefinition.qualifiedValue.appliesTo [ CodeableConcept ], ... ; # 0..* Targetted population for the set of qualified values fhir:ObservationDefinition.qualifiedValue.gender [ code ]; # 0..1 male | female | other | unknown fhir:ObservationDefinition.qualifiedValue.age [ Range ]; # 0..1 Applicable age range for the set of qualified values fhir:ObservationDefinition.qualifiedValue.gestationalAge [ Range ]; # 0..1 Applicable gestational age range for the set of qualified values fhir:ObservationDefinition.qualifiedValue.condition [ string ]; # 0..1 Condition associated with the set of qualified values fhir:ObservationDefinition.qualifiedValue.rangeCategory [ code ]; # 0..1 reference | critical | absolute fhir:ObservationDefinition.qualifiedValue.range [ Range ]; # 0..1 The range for continuous or ordinal observations fhir:ObservationDefinition.qualifiedValue.validCodedValueSet [ canonical(ValueSet) ]; # 0..1 Value set of valid coded values as part of this set of qualified values fhir:ObservationDefinition.qualifiedValue.normalCodedValueSet [ canonical(ValueSet) ]; # 0..1 Value set of normal coded values as part of this set of qualified values fhir:ObservationDefinition.qualifiedValue.abnormalCodedValueSet [ canonical(ValueSet) ]; # 0..1 Value set of abnormal coded values as part of this set of qualified values fhir:ObservationDefinition.qualifiedValue.criticalCodedValueSet [ canonical(ValueSet) ]; # 0..1 Value set of critical coded values as part of this set of qualified values ], ...; fhir:ObservationDefinition.hasMember [ Reference(ObservationDefinition|Questionnaire) ], ... ; # 0..* Definitions of related resources belonging to this kind of observation group fhir:ObservationDefinition.component [ # 0..* Component results fhir:ObservationDefinition.component.code [ CodeableConcept ]; # 1..1 Type of observation fhir:ObservationDefinition.component.permittedDataType [ code ], ... ; # 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period fhir:ObservationDefinition.component.quantitativeDetails [ See ObservationDefinition.quantitativeDetails ]; # 0..1 Characteristics of quantitative results fhir:ObservationDefinition.component.qualifiedValue [ See ObservationDefinition.qualifiedValue ], ... ; # 0..* Set of qualified values for observation results ], ...; ]
Changes since R4
ObservationDefinition | |
ObservationDefinition.url |
|
ObservationDefinition.identifier |
|
ObservationDefinition.version |
|
ObservationDefinition.name |
|
ObservationDefinition.title |
|
ObservationDefinition.status |
|
ObservationDefinition.experimental |
|
ObservationDefinition.date |
|
ObservationDefinition.publisher |
|
ObservationDefinition.contact |
|
ObservationDefinition.description |
|
ObservationDefinition.useContext |
|
ObservationDefinition.jurisdiction |
|
ObservationDefinition.purpose |
|
ObservationDefinition.copyright |
|
ObservationDefinition.approvalDate |
|
ObservationDefinition.lastReviewDate |
|
ObservationDefinition.effectivePeriod |
|
ObservationDefinition.derivedFromCanonical |
|
ObservationDefinition.derivedFromUri |
|
ObservationDefinition.subject |
|
ObservationDefinition.performerType |
|
ObservationDefinition.bodySite |
|
ObservationDefinition.specimen |
|
ObservationDefinition.device |
|
ObservationDefinition.qualifiedValue |
|
ObservationDefinition.qualifiedValue.context |
|
ObservationDefinition.qualifiedValue.appliesTo |
|
ObservationDefinition.qualifiedValue.gender |
|
ObservationDefinition.qualifiedValue.age |
|
ObservationDefinition.qualifiedValue.gestationalAge |
|
ObservationDefinition.qualifiedValue.condition |
|
ObservationDefinition.qualifiedValue.rangeCategory |
|
ObservationDefinition.qualifiedValue.range |
|
ObservationDefinition.qualifiedValue.validCodedValueSet |
|
ObservationDefinition.qualifiedValue.normalCodedValueSet |
|
ObservationDefinition.qualifiedValue.abnormalCodedValueSet |
|
ObservationDefinition.qualifiedValue.criticalCodedValueSet |
|
ObservationDefinition.hasMember |
|
ObservationDefinition.component |
|
ObservationDefinition.component.code |
|
ObservationDefinition.component.permittedDataType |
|
ObservationDefinition.component.quantitativeDetails |
|
ObservationDefinition.component.qualifiedValue |
|
ObservationDefinition.qualifiedInterval |
|
ObservationDefinition.validCodedValueSet |
|
ObservationDefinition.normalCodedValueSet |
|
ObservationDefinition.abnormalCodedValueSet |
|
ObservationDefinition.criticalCodedValueSet |
|
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ObservationDefinition | TU | DomainResource | Definition of an observation + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
url | Σ | 0..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) |
identifier | Σ | 0..1 | Identifier | Business identifier of the ObservationDefinition |
version | Σ | 0..1 | string | Business version of the ObservationDefinition |
name | ΣC | 0..1 | string | Name for this ObservationDefinition (computer friendly) |
title | ΣT | 0..1 | string | Name for this ObservationDefinition (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | If for testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | ΣT | 0..1 | string | The name of the individual or organization that published the ObservationDefinition |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | T | 0..1 | markdown | Natural language description of the ObservationDefinition |
useContext | Σ | 0..* | UsageContext | Content intends to support these contexts |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for this ObservationDefinition (if applicable) Jurisdiction ValueSet (Extensible) |
purpose | T | 0..1 | markdown | Why this ObservationDefinition is defined |
copyright | T | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | 0..1 | date | When ObservationDefinition was approved by publisher | |
lastReviewDate | 0..1 | date | Date on which the asset content was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | The effective date range for the ObservationDefinition |
derivedFromCanonical | Σ | 0..* | canonical(ObservationDefinition) | Based on FHIR definition of another observation |
derivedFromUri | Σ | 0..* | uri | Based on external definition |
subject | Σ | 0..* | CodeableConcept | Type of subject for the defined observation |
performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer for such kind of observation |
category | Σ | 0..* | CodeableConcept | General type of observation Observation Category Codes (Example) |
code | Σ | 1..1 | CodeableConcept | Type of observation LOINC Codes (Example) |
permittedDataType | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period ObservationDataType (Required) | |
multipleResultsAllowed | 0..1 | boolean | Multiple results allowed for conforming observations | |
bodySite | 0..1 | CodeableConcept | Body part to be observed SNOMED CT Body Structures (Example) | |
method | 0..1 | CodeableConcept | Method used to produce the observation Observation Methods (Example) | |
specimen | 0..* | Reference(SpecimenDefinition) | Kind of specimen used by this type of observation | |
device | 0..* | Reference(DeviceDefinition | Device) | Measurement device or model of device | |
preferredReportName | 0..1 | string | The preferred name to be used when reporting the observation results | |
quantitativeDetails | 0..1 | BackboneElement | Characteristics of quantitative results | |
unit | 0..1 | CodeableConcept | Primary unit for quantitative results UCUM Codes (Extensible) | |
customaryUnit | 0..1 | CodeableConcept | Customary (secondary) unit for quantitative results UCUM Codes (Extensible) | |
conversionFactor | 0..1 | decimal | Primary to secondary unit conversion factor | |
decimalPrecision | 0..1 | integer | Decimal precision of observation quantitative results | |
qualifiedValue | 0..* | BackboneElement | Set of qualified values for observation results | |
context | 0..1 | CodeableConcept | Context qualifier for the set of qualified values Observation Reference Range Meaning Codes (Extensible) | |
appliesTo | 0..* | CodeableConcept | Targetted population for the set of qualified values Observation Reference Range Applies To Codes (Example) | |
gender | 0..1 | code | male | female | other | unknown AdministrativeGender (Required) | |
age | 0..1 | Range | Applicable age range for the set of qualified values | |
gestationalAge | 0..1 | Range | Applicable gestational age range for the set of qualified values | |
condition | 0..1 | string | Condition associated with the set of qualified values | |
rangeCategory | 0..1 | code | reference | critical | absolute ObservationRangeCategory (Required) | |
range | 0..1 | Range | The range for continuous or ordinal observations | |
validCodedValueSet | 0..1 | canonical(ValueSet) | Value set of valid coded values as part of this set of qualified values | |
normalCodedValueSet | 0..1 | canonical(ValueSet) | Value set of normal coded values as part of this set of qualified values | |
abnormalCodedValueSet | 0..1 | canonical(ValueSet) | Value set of abnormal coded values as part of this set of qualified values | |
criticalCodedValueSet | 0..1 | canonical(ValueSet) | Value set of critical coded values as part of this set of qualified values | |
hasMember | 0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | |
component | 0..* | BackboneElement | Component results | |
code | 1..1 | CodeableConcept | Type of observation LOINC Codes (Example) | |
permittedDataType | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period ObservationDataType (Required) | |
quantitativeDetails | 0..1 | see quantitativeDetails | Characteristics of quantitative results | |
qualifiedValue | 0..* | see qualifiedValue | Set of qualified values for observation results | |
Documentation for this format |
See the Extensions for this resource
XML Template
<ObservationDefinition xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) --> <identifier><!-- 0..1 Identifier Business identifier of the ObservationDefinition --></identifier> <version value="[string]"/><!-- 0..1 Business version of the ObservationDefinition --> <name value="[string]"/><!-- I 0..1 Name for this ObservationDefinition (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this ObservationDefinition (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 The name of the individual or organization that published the ObservationDefinition --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the ObservationDefinition --> <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for this ObservationDefinition (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this ObservationDefinition is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When ObservationDefinition was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 Date on which the asset content was last reviewed --> <effectivePeriod><!-- 0..1 Period The effective date range for the ObservationDefinition --></effectivePeriod> <derivedFromCanonical><!-- 0..* canonical(ObservationDefinition) Based on FHIR definition of another observation --></derivedFromCanonical> <derivedFromUri value="[uri]"/><!-- 0..* Based on external definition --> <subject><!-- 0..* CodeableConcept Type of subject for the defined observation --></subject> <performerType><!-- 0..1 CodeableConcept Desired kind of performer for such kind of observation --></performerType> <category><!-- 0..* CodeableConcept General type of observation --></category> <code><!-- 1..1 CodeableConcept Type of observation --></code> <permittedDataType value="[code]"/><!-- 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period --> <multipleResultsAllowed value="[boolean]"/><!-- 0..1 Multiple results allowed for conforming observations --> <bodySite><!-- 0..1 CodeableConcept Body part to be observed --></bodySite> <method><!-- 0..1 CodeableConcept Method used to produce the observation --></method> <specimen><!-- 0..* Reference(SpecimenDefinition) Kind of specimen used by this type of observation --></specimen> <device><!-- 0..* Reference(Device|DeviceDefinition) Measurement device or model of device --></device> <preferredReportName value="[string]"/><!-- 0..1 The preferred name to be used when reporting the observation results --> <quantitativeDetails> <!-- 0..1 Characteristics of quantitative results --> <unit><!-- 0..1 CodeableConcept Primary unit for quantitative results --></unit> <customaryUnit><!-- 0..1 CodeableConcept Customary (secondary) unit for quantitative results --></customaryUnit> <conversionFactor value="[decimal]"/><!-- 0..1 Primary to secondary unit conversion factor --> <decimalPrecision value="[integer]"/><!-- 0..1 Decimal precision of observation quantitative results --> </quantitativeDetails> <qualifiedValue> <!-- 0..* Set of qualified values for observation results --> <context><!-- 0..1 CodeableConcept Context qualifier for the set of qualified values --></context> <appliesTo><!-- 0..* CodeableConcept Targetted population for the set of qualified values --></appliesTo> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --> <age><!-- 0..1 Range Applicable age range for the set of qualified values --></age> <gestationalAge><!-- 0..1 Range Applicable gestational age range for the set of qualified values --></gestationalAge> <condition value="[string]"/><!-- 0..1 Condition associated with the set of qualified values --> <rangeCategory value="[code]"/><!-- 0..1 reference | critical | absolute --> <range><!-- 0..1 Range The range for continuous or ordinal observations --></range> <validCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of valid coded values as part of this set of qualified values --></validCodedValueSet> <normalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of normal coded values as part of this set of qualified values --></normalCodedValueSet> <abnormalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of abnormal coded values as part of this set of qualified values --></abnormalCodedValueSet> <criticalCodedValueSet><!-- 0..1 canonical(ValueSet) Value set of critical coded values as part of this set of qualified values --></criticalCodedValueSet> </qualifiedValue> <hasMember><!-- 0..* Reference(ObservationDefinition|Questionnaire) Definitions of related resources belonging to this kind of observation group --></hasMember> <component> <!-- 0..* Component results --> <code><!-- 1..1 CodeableConcept Type of observation --></code> <permittedDataType value="[code]"/><!-- 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period --> <quantitativeDetails><!-- 0..1 Content as for ObservationDefinition.quantitativeDetails Characteristics of quantitative results --></quantitativeDetails> <qualifiedValue><!-- 0..* Content as for ObservationDefinition.qualifiedValue Set of qualified values for observation results --></qualifiedValue> </component> </ObservationDefinition>
JSON Template
{ "resourceType" : "ObservationDefinition", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Logical canonical URL to reference this ObservationDefinition (globally unique) "identifier" : { Identifier }, // Business identifier of the ObservationDefinition "version" : "<string>", // Business version of the ObservationDefinition "name" : "<string>", // I Name for this ObservationDefinition (computer friendly) "title" : "<string>", // Name for this ObservationDefinition (human friendly) "status" : "<code>", // R! draft | active | retired | unknown "experimental" : <boolean>, // If for testing purposes, not real usage "date" : "<dateTime>", // Date last changed "publisher" : "<string>", // The name of the individual or organization that published the ObservationDefinition "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // Natural language description of the ObservationDefinition "useContext" : [{ UsageContext }], // Content intends to support these contexts "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for this ObservationDefinition (if applicable) "purpose" : "<markdown>", // Why this ObservationDefinition is defined "copyright" : "<markdown>", // Use and/or publishing restrictions "approvalDate" : "<date>", // When ObservationDefinition was approved by publisher "lastReviewDate" : "<date>", // Date on which the asset content was last reviewed "effectivePeriod" : { Period }, // The effective date range for the ObservationDefinition "derivedFromCanonical" : ["<canonical(ObservationDefinition)>"], // Based on FHIR definition of another observation "derivedFromUri" : ["<uri>"], // Based on external definition "subject" : [{ CodeableConcept }], // Type of subject for the defined observation "performerType" : { CodeableConcept }, // Desired kind of performer for such kind of observation "category" : [{ CodeableConcept }], // General type of observation "code" : { CodeableConcept }, // R! Type of observation "permittedDataType" : ["<code>"], // Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period "multipleResultsAllowed" : <boolean>, // Multiple results allowed for conforming observations "bodySite" : { CodeableConcept }, // Body part to be observed "method" : { CodeableConcept }, // Method used to produce the observation "specimen" : [{ Reference(SpecimenDefinition) }], // Kind of specimen used by this type of observation "device" : [{ Reference(Device|DeviceDefinition) }], // Measurement device or model of device "preferredReportName" : "<string>", // The preferred name to be used when reporting the observation results "quantitativeDetails" : { // Characteristics of quantitative results "unit" : { CodeableConcept }, // Primary unit for quantitative results "customaryUnit" : { CodeableConcept }, // Customary (secondary) unit for quantitative results "conversionFactor" : <decimal>, // Primary to secondary unit conversion factor "decimalPrecision" : <integer> // Decimal precision of observation quantitative results }, "qualifiedValue" : [{ // Set of qualified values for observation results "context" : { CodeableConcept }, // Context qualifier for the set of qualified values "appliesTo" : [{ CodeableConcept }], // Targetted population for the set of qualified values "gender" : "<code>", // male | female | other | unknown "age" : { Range }, // Applicable age range for the set of qualified values "gestationalAge" : { Range }, // Applicable gestational age range for the set of qualified values "condition" : "<string>", // Condition associated with the set of qualified values "rangeCategory" : "<code>", // reference | critical | absolute "range" : { Range }, // The range for continuous or ordinal observations "validCodedValueSet" : "<canonical(ValueSet)>", // Value set of valid coded values as part of this set of qualified values "normalCodedValueSet" : "<canonical(ValueSet)>", // Value set of normal coded values as part of this set of qualified values "abnormalCodedValueSet" : "<canonical(ValueSet)>", // Value set of abnormal coded values as part of this set of qualified values "criticalCodedValueSet" : "<canonical(ValueSet)>" // Value set of critical coded values as part of this set of qualified values }], "hasMember" : [{ Reference(ObservationDefinition|Questionnaire) }], // Definitions of related resources belonging to this kind of observation group "component" : [{ // Component results "code" : { CodeableConcept }, // R! Type of observation "permittedDataType" : ["<code>"], // Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period "quantitativeDetails" : { Content as for ObservationDefinition.quantitativeDetails }, // Characteristics of quantitative results "qualifiedValue" : [{ Content as for ObservationDefinition.qualifiedValue }] // Set of qualified values for observation results }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:ObservationDefinition; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:ObservationDefinition.url [ uri ]; # 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) fhir:ObservationDefinition.identifier [ Identifier ]; # 0..1 Business identifier of the ObservationDefinition fhir:ObservationDefinition.version [ string ]; # 0..1 Business version of the ObservationDefinition fhir:ObservationDefinition.name [ string ]; # 0..1 I Name for this ObservationDefinition (computer friendly) fhir:ObservationDefinition.title [ string ]; # 0..1 Name for this ObservationDefinition (human friendly) fhir:ObservationDefinition.status [ code ]; # 1..1 draft | active | retired | unknown fhir:ObservationDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage fhir:ObservationDefinition.date [ dateTime ]; # 0..1 Date last changed fhir:ObservationDefinition.publisher [ string ]; # 0..1 The name of the individual or organization that published the ObservationDefinition fhir:ObservationDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:ObservationDefinition.description [ markdown ]; # 0..1 Natural language description of the ObservationDefinition fhir:ObservationDefinition.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts fhir:ObservationDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for this ObservationDefinition (if applicable) fhir:ObservationDefinition.purpose [ markdown ]; # 0..1 Why this ObservationDefinition is defined fhir:ObservationDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:ObservationDefinition.approvalDate [ date ]; # 0..1 When ObservationDefinition was approved by publisher fhir:ObservationDefinition.lastReviewDate [ date ]; # 0..1 Date on which the asset content was last reviewed fhir:ObservationDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the ObservationDefinition fhir:ObservationDefinition.derivedFromCanonical [ canonical(ObservationDefinition) ], ... ; # 0..* Based on FHIR definition of another observation fhir:ObservationDefinition.derivedFromUri [ uri ], ... ; # 0..* Based on external definition fhir:ObservationDefinition.subject [ CodeableConcept ], ... ; # 0..* Type of subject for the defined observation fhir:ObservationDefinition.performerType [ CodeableConcept ]; # 0..1 Desired kind of performer for such kind of observation fhir:ObservationDefinition.category [ CodeableConcept ], ... ; # 0..* General type of observation fhir:ObservationDefinition.code [ CodeableConcept ]; # 1..1 Type of observation fhir:ObservationDefinition.permittedDataType [ code ], ... ; # 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period fhir:ObservationDefinition.multipleResultsAllowed [ boolean ]; # 0..1 Multiple results allowed for conforming observations fhir:ObservationDefinition.bodySite [ CodeableConcept ]; # 0..1 Body part to be observed fhir:ObservationDefinition.method [ CodeableConcept ]; # 0..1 Method used to produce the observation fhir:ObservationDefinition.specimen [ Reference(SpecimenDefinition) ], ... ; # 0..* Kind of specimen used by this type of observation fhir:ObservationDefinition.device [ Reference(Device|DeviceDefinition) ], ... ; # 0..* Measurement device or model of device fhir:ObservationDefinition.preferredReportName [ string ]; # 0..1 The preferred name to be used when reporting the observation results fhir:ObservationDefinition.quantitativeDetails [ # 0..1 Characteristics of quantitative results fhir:ObservationDefinition.quantitativeDetails.unit [ CodeableConcept ]; # 0..1 Primary unit for quantitative results fhir:ObservationDefinition.quantitativeDetails.customaryUnit [ CodeableConcept ]; # 0..1 Customary (secondary) unit for quantitative results fhir:ObservationDefinition.quantitativeDetails.conversionFactor [ decimal ]; # 0..1 Primary to secondary unit conversion factor fhir:ObservationDefinition.quantitativeDetails.decimalPrecision [ integer ]; # 0..1 Decimal precision of observation quantitative results ]; fhir:ObservationDefinition.qualifiedValue [ # 0..* Set of qualified values for observation results fhir:ObservationDefinition.qualifiedValue.context [ CodeableConcept ]; # 0..1 Context qualifier for the set of qualified values fhir:ObservationDefinition.qualifiedValue.appliesTo [ CodeableConcept ], ... ; # 0..* Targetted population for the set of qualified values fhir:ObservationDefinition.qualifiedValue.gender [ code ]; # 0..1 male | female | other | unknown fhir:ObservationDefinition.qualifiedValue.age [ Range ]; # 0..1 Applicable age range for the set of qualified values fhir:ObservationDefinition.qualifiedValue.gestationalAge [ Range ]; # 0..1 Applicable gestational age range for the set of qualified values fhir:ObservationDefinition.qualifiedValue.condition [ string ]; # 0..1 Condition associated with the set of qualified values fhir:ObservationDefinition.qualifiedValue.rangeCategory [ code ]; # 0..1 reference | critical | absolute fhir:ObservationDefinition.qualifiedValue.range [ Range ]; # 0..1 The range for continuous or ordinal observations fhir:ObservationDefinition.qualifiedValue.validCodedValueSet [ canonical(ValueSet) ]; # 0..1 Value set of valid coded values as part of this set of qualified values fhir:ObservationDefinition.qualifiedValue.normalCodedValueSet [ canonical(ValueSet) ]; # 0..1 Value set of normal coded values as part of this set of qualified values fhir:ObservationDefinition.qualifiedValue.abnormalCodedValueSet [ canonical(ValueSet) ]; # 0..1 Value set of abnormal coded values as part of this set of qualified values fhir:ObservationDefinition.qualifiedValue.criticalCodedValueSet [ canonical(ValueSet) ]; # 0..1 Value set of critical coded values as part of this set of qualified values ], ...; fhir:ObservationDefinition.hasMember [ Reference(ObservationDefinition|Questionnaire) ], ... ; # 0..* Definitions of related resources belonging to this kind of observation group fhir:ObservationDefinition.component [ # 0..* Component results fhir:ObservationDefinition.component.code [ CodeableConcept ]; # 1..1 Type of observation fhir:ObservationDefinition.component.permittedDataType [ code ], ... ; # 0..* Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period fhir:ObservationDefinition.component.quantitativeDetails [ See ObservationDefinition.quantitativeDetails ]; # 0..1 Characteristics of quantitative results fhir:ObservationDefinition.component.qualifiedValue [ See ObservationDefinition.qualifiedValue ], ... ; # 0..* Set of qualified values for observation results ], ...; ]
Changes since Release 4
ObservationDefinition | |
ObservationDefinition.url |
|
ObservationDefinition.identifier |
|
ObservationDefinition.version |
|
ObservationDefinition.name |
|
ObservationDefinition.title |
|
ObservationDefinition.status |
|
ObservationDefinition.experimental |
|
ObservationDefinition.date |
|
ObservationDefinition.publisher |
|
ObservationDefinition.contact |
|
ObservationDefinition.description |
|
ObservationDefinition.useContext |
|
ObservationDefinition.jurisdiction |
|
ObservationDefinition.purpose |
|
ObservationDefinition.copyright |
|
ObservationDefinition.approvalDate |
|
ObservationDefinition.lastReviewDate |
|
ObservationDefinition.effectivePeriod |
|
ObservationDefinition.derivedFromCanonical |
|
ObservationDefinition.derivedFromUri |
|
ObservationDefinition.subject |
|
ObservationDefinition.performerType |
|
ObservationDefinition.bodySite |
|
ObservationDefinition.specimen |
|
ObservationDefinition.device |
|
ObservationDefinition.qualifiedValue |
|
ObservationDefinition.qualifiedValue.context |
|
ObservationDefinition.qualifiedValue.appliesTo |
|
ObservationDefinition.qualifiedValue.gender |
|
ObservationDefinition.qualifiedValue.age |
|
ObservationDefinition.qualifiedValue.gestationalAge |
|
ObservationDefinition.qualifiedValue.condition |
|
ObservationDefinition.qualifiedValue.rangeCategory |
|
ObservationDefinition.qualifiedValue.range |
|
ObservationDefinition.qualifiedValue.validCodedValueSet |
|
ObservationDefinition.qualifiedValue.normalCodedValueSet |
|
ObservationDefinition.qualifiedValue.abnormalCodedValueSet |
|
ObservationDefinition.qualifiedValue.criticalCodedValueSet |
|
ObservationDefinition.hasMember |
|
ObservationDefinition.component |
|
ObservationDefinition.component.code |
|
ObservationDefinition.component.permittedDataType |
|
ObservationDefinition.component.quantitativeDetails |
|
ObservationDefinition.component.qualifiedValue |
|
ObservationDefinition.qualifiedInterval |
|
ObservationDefinition.validCodedValueSet |
|
ObservationDefinition.normalCodedValueSet |
|
ObservationDefinition.abnormalCodedValueSet |
|
ObservationDefinition.criticalCodedValueSet |
|
See the Full Difference for further information
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis
Path | Definition | Type | Reference |
---|---|---|---|
ObservationDefinition.status | The lifecycle status of an artifact. | Required | PublicationStatus |
ObservationDefinition.jurisdiction | This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used. Note: The codes for countries and country subdivisions are taken from ISO 3166 while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) . | Extensible | JurisdictionValueSet |
ObservationDefinition.category | Observation Category codes. | Example | ObservationCategoryCodes |
ObservationDefinition.code | This value set includes all LOINC codes | Example | LOINCCodes (a valid code from LOINC ) |
ObservationDefinition.permittedDataType | Permitted data type for observation value. | Required | ObservationDataType |
ObservationDefinition.bodySite | This value set includes all codes from SNOMED CT where concept is-a 442083009 (Anatomical or acquired body site (body structure)). | Example | SNOMEDCTBodyStructures |
ObservationDefinition.method | Observation Method codes from SNOMED CT where concept is-a 272394005 (Technique (qualifier value)) or is-a 129264002 (Action (qualifier value)) or is-a 386053000 (Evaluation procedure(procedure)) | Example | ObservationMethods |
ObservationDefinition.quantitativeDetails.unit | Unified Code for Units of Measure (UCUM). This value set includes all UCUM codes | Extensible | UCUMCodes (a valid code from UCUM ) |
ObservationDefinition.quantitativeDetails.customaryUnit | Unified Code for Units of Measure (UCUM). This value set includes all UCUM codes | Extensible | UCUMCodes (a valid code from UCUM ) |
ObservationDefinition.qualifiedValue.context | This value set defines a set of codes that can be used to indicate the meaning/use of a reference range for a particular target population. | Extensible | ObservationReferenceRangeMeaningCodes |
ObservationDefinition.qualifiedValue.appliesTo | This value set defines a set of codes that can be used to indicate the particular target population the reference range applies to. | Example | ObservationReferenceRangeAppliesToCodes |
ObservationDefinition.qualifiedValue.gender | The gender of a person used for administrative purposes. | Required | AdministrativeGender |
ObservationDefinition.qualifiedValue.rangeCategory | Codes identifying the category of observation range. | Required | ObservationRangeCategory |
ObservationDefinition.component.code | This value set includes all LOINC codes | Example | LOINCCodes (a valid code from LOINC ) |
ObservationDefinition.component.permittedDataType | Permitted data type for observation value. | Required | ObservationDataType |
UniqueKey | Level | Location | Description | Expression |
cnl-0 | Warning | (base) | 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]([A-Za-z0-9_]){1,254}') |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
category | token | Category (class) of observation | ObservationDefinition.category | |
code | token | Observation code | ObservationDefinition.code | |
experimental | token | Not for genuine usage (true) | ObservationDefinition.experimental | |
identifier | token | The unique identifier associated with the specimen definition | ObservationDefinition.identifier | 28 Resources |
method | token | Method of observation | ObservationDefinition.method | |
status | token | Publication status of the ObservationDefinition: draft, active, retired, unknown | ObservationDefinition.status | 34 Resources |
title | string | Human-friendly name of the ObservationDefinition | ObservationDefinition.title | 27 Resources |
url | uri | The uri that identifies the observation definition | ObservationDefinition.url | 33 Resources |