Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). 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

8.26 Resource ObservationDefinition - Content

Orders and Observations icon Work Group Maturity Level : 0 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.

8.26.1 Scope and Usage

Note that this content is preliminary has not undergone proper review by the appropriate Workgroups.

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.

8.26.2 Boundaries and Relationships

This An ObservationDefinition resource relates 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 other resource:. 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:

  • Resource Category, code, datatype of the value, bodySite, method.
  • Each referenceRange element present in Observation should come from a qualifiedInterval element of ObservationDefinition.
  • If ObservationDefinition has declared a ValueSet of valid coded values, and if Observation has a valueCodeableConcept, the value is expected to be part of that ValueSet.
  • The subject of the Observation should be conformant with one of the subjectCodeableConcept listed in ObservationDefinition.
  • If the Observation has a device element, the referenced by Device resource CatalogEntry. This enables items of catalogs, representing healthcare services or products, should conform to declare the observations, which are consumed a DeviceDefinition or produced Device referenced by these items. ObservationDefinition.device (if present).
  • Observation.basedOn references ObservationDefinition resource. If the Observation has a specimen element, the referenced Specimen resource should conform to a SpecimenDefinition referenced by ObservationDefinition.specimen (if present).

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.

8.26.3 References to this Resource

This resource is referenced by

8.26.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . 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 Σ 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 Σ 0..1 Reference ( Practitioner | PractitionerRole | Organization ) The name of the individual or organization that published the ObservationDefinition
... contact Σ 0..* ContactDetail Contact details for the publisher

... description 0..1 markdown Natural language description of the ObservationDefinition
... useContext Σ 0..* UsageContext Content intends to support these contexts

. . . category jurisdiction Σ 0..* CodeableConcept Category of observation Intended jurisdiction for this ObservationDefinition (if applicable)
Observation Category Codes Jurisdiction ( Example Extensible )

. . . purpose 0..1 markdown Why this ObservationDefinition is defined
... copyright 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
. . . code effectivePeriod Σ 1..1 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 (code / type)
LOINC Codes
. . . performerType ( Example ) Σ 0..1 CodeableConcept Desired kind of performer for such kind of observation
. . . identifier category Σ 0..* Identifier CodeableConcept Business identifier for this ObservationDefinition instance 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 Preferred report The preferred name to be used when reporting the observation results
. . . quantitativeDetails 0..1 BackboneElement Characteristics of quantitative results
. . . . customaryUnit unit 0..1 CodeableConcept Customary Primary unit for quantitative results
UCUM Codes ( Extensible )
. . . . unit customaryUnit 0..1 CodeableConcept SI Customary (secondary) unit for quantitative results
UCUM Codes ( Extensible )
. . . . conversionFactor 0..1 decimal SI Primary to Customary secondary unit conversion factor
. . . . decimalPrecision 0..1 integer Decimal precision of observation quantitative results
. . . qualifiedInterval qualifiedValue 0..* BackboneElement Qualified range Set of qualified values for continuous and ordinal observation results
category 0..1 code reference | critical | absolute
ObservationRangeCategory ( Required ) range 0..1 Range The interval itself, for continuous or ordinal observations
. . . . context 0..1 CodeableConcept Range context Context qualifier for the set of qualified values
Observation Reference Range Meaning Codes ( Extensible )
. . . . appliesTo 0..* CodeableConcept Targetted population of for the range 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, if relevant range for the set of qualified values
. . . . gestationalAge 0..1 Range Applicable gestational age range, if relevant 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 Reference canonical ( ValueSet ) Value set of valid coded values for the observations conforming to as part of this ObservationDefinition set of qualified values
. . . . normalCodedValueSet 0..1 Reference canonical ( ValueSet ) Value set of normal coded values for the observations conforming to as part of this ObservationDefinition set of qualified values
. . . . abnormalCodedValueSet 0..1 Reference canonical ( ValueSet ) Value set of abnormal coded values for the observations conforming to as part of this ObservationDefinition set of qualified values
. . . . criticalCodedValueSet 0..1 Reference canonical ( ValueSet ) Value set of critical coded values for the observations conforming to 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


doco Documentation for this format

See the Extensions for this resource

UML Diagram ( Legend )

ObservationDefinition ( DomainResource ) + MetadataResource 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 url : uri [0..1] 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 identifier : Identifier [0..1] 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 version : string [0..1] 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 name : string [0..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the ObservationDefinition title : string [0..1] The current state of the ObservationDefinition (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) PublicationStatus ! » 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 experimental : boolean [0..1] The date (and optionally time) when the ObservationDefinition was published. 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 date : dateTime [0..1] Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact publisher : Reference [0..1] « Practitioner | PractitionerRole | Organization » Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the ObservationDefinition from the consumer's perspective description : markdown [0..1] 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 useContext : UsageContext [0..*] A jurisdiction in which the ObservationDefinition is intended to be used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) Jurisdiction ValueSet + » Explains why this ObservationDefinition is needed and why it has been designed as it has purpose : markdown [0..1] Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition copyright : markdown [0..1] The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date lastReviewDate : date [0..1] The period during which the ObservationDefinition content was or is planned to be effective effectivePeriod : Period [0..1] The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition derivedFromCanonical : canonical [0..*] « ObservationDefinition » 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 derivedFromUri : uri [0..*] A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition subject : CodeableConcept [0..*] The type of individual/organization/device that is expected to act upon instances of this definition performerType : CodeableConcept [0..1] A code that classifies the general type of observation category : CodeableConcept [0..*] « null (Strength=Example) ObservationCategoryCodes ?? » Describes what will be observed. Sometimes this is called the observation "name" code : CodeableConcept [1..1] « null (Strength=Example) LOINCCodes ?? » A unique identifier assigned to this ObservationDefinition artifact identifier : Identifier [0..*] The data types allowed for the value element of the instance observations conforming to this ObservationDefinition permittedDataType : code [0..*] « null (Strength=Required) ObservationDataType ! » Multiple results allowed for observations conforming to this ObservationDefinition multipleResultsAllowed : boolean [0..1] The method or technique used to perform site on the subject's body where the observation is to be made method bodySite : CodeableConcept [0..1] « null (Strength=Example) ObservationMethods SNOMEDCTBodyStructures ?? » The preferred name to be method or technique used when reporting the results of observations conforming to this ObservationDefinition perform the observation preferredReportName method : string CodeableConcept [0..1] « null (Strength=Example) ObservationMethods ?? » The set kind of valid coded results for the observations conforming to specimen that this ObservationDefinition type of observation is produced on validCodedValueSet specimen : Reference [0..1] [0..*] « ValueSet SpecimenDefinition » The set measurement model of normal coded results for the observations conforming device or actual device used to produce observations of this ObservationDefinition type normalCodedValueSet device : Reference [0..1] [0..*] « ValueSet DeviceDefinition | Device » The set of abnormal coded results for preferred name to be used when reporting the observation results of observations conforming to this ObservationDefinition abnormalCodedValueSet preferredReportName : Reference string [0..1] « ValueSet » The This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of critical coded results for vital sign measurements) that includes the observation conforming to this ObservationDefinition target as a member of the group criticalCodedValueSet hasMember : Reference [0..1] [0..*] « ValueSet ObservationDefinition | Questionnaire » QuantitativeDetails Customary Primary unit used to report quantitative results of observations conforming to this ObservationDefinition customaryUnit unit : CodeableConcept [0..1] « null (Strength=Extensible) UCUMCodes + » SI Secondary unit used to report quantitative results of observations conforming to this ObservationDefinition unit customaryUnit : CodeableConcept [0..1] « null (Strength=Extensible) UCUMCodes + » Factor for converting value expressed with SI primary unit to value expressed with customary secondary unit conversionFactor : decimal [0..1] Number of digits after decimal separator when the results of such observations are of type Quantity decimalPrecision : integer [0..1] QualifiedInterval QualifiedValue The category of interval of values A concept defining the context for continuous or ordinal observations conforming to this ObservationDefinition category : code [0..1] « null (Strength=Required) ObservationRangeCategory ! » The low and high values determining the interval. There may be only one set of the two range : Range [0..1] Codes to indicate the health context the range applies to. For example, the normal or therapeutic range qualified values context : CodeableConcept [0..1] « null (Strength=Extensible) ObservationReferenceRangeMean... + » Codes to indicate the The target population this reference range set of qualified values applies to appliesTo : CodeableConcept [0..*] « null (Strength=Example) ObservationReferenceRangeAppl... ?? » Sex The gender this set of the population the range qualified values applies to gender : code [0..1] « null (Strength=Required) AdministrativeGender ! » The age at which this reference range is applicable. This is a neonatal age (e.g. number this set of weeks at term) if the meaning says so qualified values applies to age : Range [0..1] The gestational age to which this reference range is applicable, in the context set of pregnancy qualified values applies to gestationalAge : Range [0..1] Text based condition for which the reference range the set of qualified values is valid condition : string [0..1] The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values rangeCategory : code [0..1] « null (Strength=Required) ObservationRangeCategory ! » The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values range : Range [0..1] The set of valid coded results for qualitative observations that match the criteria of this set of qualified values validCodedValueSet : canonical [0..1] « ValueSet » The set of normal coded results for qualitative observations that match the criteria of this set of qualified values normalCodedValueSet : canonical [0..1] « ValueSet » The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified values abnormalCodedValueSet : canonical [0..1] « ValueSet » The set of critical coded results for qualitative observations that match the criteria of this set of qualified values criticalCodedValueSet : canonical [0..1] « ValueSet » Component Describes what will be observed code : CodeableConcept [1..1] « null (Strength=Example) LOINCCodes ?? » The data types allowed for the value element of the instance of this component observations permittedDataType : code [0..*] « null (Strength=Required) ObservationDataType ! » Characteristics for quantitative results of observations conforming to this observation ObservationDefinition quantitativeDetails [0..1] Multiple ranges A set of results qualified by different contexts values associated with a context and a set of conditions - provides a range for quantitative and ordinal or continuous observations conforming to and a collection of value sets for qualitative observations qualifiedValue [0..*] Characteristics for quantitative results of this ObservationDefinition observation qualifiedInterval quantitativeDetails [0..1] 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 qualifiedValue [0..*] Some observations have multiple component observations, expressed as separate code value pairs component [0..*]

XML Template 

<ObservationDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</category>
 <</code>
 <</identifier>

 <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><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) The name of the individual or organization that published the ObservationDefinition --></publisher>
 <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>
 <
 <
  <</customaryUnit>
  <</unit>
  <

 <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>
 <
  <
  <</range>
  <</context>
  <</appliesTo>
  <
  <</age>
  <</gestationalAge>
  <
 </qualifiedInterval>
 <</validCodedValueSet>
 <</normalCodedValueSet>
 <</abnormalCodedValueSet>
 <</criticalCodedValueSet>

 <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 

{doco
  "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" : { Reference(Organization|Practitioner|PractitionerRole) }, // 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/> .doco


[ 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:
  fhir:
  fhir:

  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 [ Reference(Organization|Practitioner|PractitionerRole) ]; # 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:

  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:
  fhir:
    fhir:
    fhir:
    fhir:

  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:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:

  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

  ], ...;
  fhir:
  fhir:
  fhir:
  fhir:

]

Changes since R4

ObservationDefinition
ObservationDefinition.url
  • No Changes Added Element
ObservationDefinition.identifier
  • Max Cardinality changed from * to 1
  • Max Cardinality changed from * to 1
ObservationDefinition.version
  • Added Element
ObservationDefinition.name
  • Added Element
ObservationDefinition.title
  • Added Element
ObservationDefinition.status
  • Added Mandatory Element
ObservationDefinition.experimental
  • Added Element
ObservationDefinition.date
  • Added Element
ObservationDefinition.publisher
  • Added Element
ObservationDefinition.contact
  • Added Element
ObservationDefinition.description
  • Added Element
ObservationDefinition.useContext
  • Added Element
ObservationDefinition.jurisdiction
  • Added Element
ObservationDefinition.purpose
  • Added Element
ObservationDefinition.copyright
  • Added Element
ObservationDefinition.approvalDate
  • Added Element
ObservationDefinition.lastReviewDate
  • Added Element
ObservationDefinition.effectivePeriod
  • Added Element
ObservationDefinition.derivedFromCanonical
  • Added Element
ObservationDefinition.derivedFromUri
  • Added Element
ObservationDefinition.subject
  • Added Element
ObservationDefinition.performerType
  • Added Element
ObservationDefinition.bodySite
  • Added Element
ObservationDefinition.specimen
  • Added Element
ObservationDefinition.device
  • Added Element
ObservationDefinition.qualifiedValue
  • Added Element
ObservationDefinition.qualifiedValue.context
  • Added Element
ObservationDefinition.qualifiedValue.appliesTo
  • Added Element
ObservationDefinition.qualifiedValue.gender
  • Added Element
ObservationDefinition.qualifiedValue.age
  • Added Element
ObservationDefinition.qualifiedValue.gestationalAge
  • Added Element
ObservationDefinition.qualifiedValue.condition
  • Added Element
ObservationDefinition.qualifiedValue.rangeCategory
  • Added Element
ObservationDefinition.qualifiedValue.range
  • Added Element
ObservationDefinition.qualifiedValue.validCodedValueSet
  • Added Element
ObservationDefinition.qualifiedValue.normalCodedValueSet
  • Added Element
ObservationDefinition.qualifiedValue.abnormalCodedValueSet
  • Added Element
ObservationDefinition.qualifiedValue.criticalCodedValueSet
  • Added Element
ObservationDefinition.hasMember
  • Added Element
ObservationDefinition.component
  • Added Element
ObservationDefinition.component.code
  • Added Mandatory Element
ObservationDefinition.component.permittedDataType
  • Added Element
ObservationDefinition.component.quantitativeDetails
  • Added Element
ObservationDefinition.component.qualifiedValue
  • Added Element
ObservationDefinition.qualifiedInterval
  • deleted
ObservationDefinition.validCodedValueSet
  • deleted
ObservationDefinition.normalCodedValueSet
  • deleted
ObservationDefinition.abnormalCodedValueSet
  • deleted
ObservationDefinition.criticalCodedValueSet
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

Structure

Name Flags Card. Type Description & Constraints doco
. . 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 Σ 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 Σ 0..1 Reference ( Practitioner | PractitionerRole | Organization ) The name of the individual or organization that published the ObservationDefinition
... contact Σ 0..* ContactDetail Contact details for the publisher

... description 0..1 markdown Natural language description of the ObservationDefinition
... useContext Σ 0..* UsageContext Content intends to support these contexts

. . . category jurisdiction Σ 0..* CodeableConcept Category of observation Intended jurisdiction for this ObservationDefinition (if applicable)
Observation Category Codes Jurisdiction ( Example Extensible )

. . . purpose 0..1 markdown Why this ObservationDefinition is defined
... copyright 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
. . . code effectivePeriod Σ 1..1 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 (code / type)
LOINC Codes
. . . performerType ( Example ) Σ 0..1 CodeableConcept Desired kind of performer for such kind of observation
. . . identifier category Σ 0..* Identifier CodeableConcept Business identifier for this ObservationDefinition instance 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 Preferred report The preferred name to be used when reporting the observation results
. . . quantitativeDetails 0..1 BackboneElement Characteristics of quantitative results
. . . . customaryUnit unit 0..1 CodeableConcept Customary Primary unit for quantitative results
UCUM Codes ( Extensible )
. . . . unit customaryUnit 0..1 CodeableConcept SI Customary (secondary) unit for quantitative results
UCUM Codes ( Extensible )
. . . . conversionFactor 0..1 decimal SI Primary to Customary secondary unit conversion factor
. . . . decimalPrecision 0..1 integer Decimal precision of observation quantitative results
. . . qualifiedInterval qualifiedValue 0..* BackboneElement Qualified range Set of qualified values for continuous and ordinal observation results
category 0..1 code reference | critical | absolute
ObservationRangeCategory ( Required ) range 0..1 Range The interval itself, for continuous or ordinal observations
. . . . context 0..1 CodeableConcept Range context Context qualifier for the set of qualified values
Observation Reference Range Meaning Codes ( Extensible )
. . . . appliesTo 0..* CodeableConcept Targetted population of for the range 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, if relevant range for the set of qualified values
. . . . gestationalAge 0..1 Range Applicable gestational age range, if relevant 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 Reference canonical ( ValueSet ) Value set of valid coded values for the observations conforming to as part of this ObservationDefinition set of qualified values
. . . . normalCodedValueSet 0..1 Reference canonical ( ValueSet ) Value set of normal coded values for the observations conforming to as part of this ObservationDefinition set of qualified values
. . . . abnormalCodedValueSet 0..1 Reference canonical ( ValueSet ) Value set of abnormal coded values for the observations conforming to as part of this ObservationDefinition set of qualified values
. . . . criticalCodedValueSet 0..1 Reference canonical ( ValueSet ) Value set of critical coded values for the observations conforming to 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


doco Documentation for this format

See the Extensions for this resource

UML Diagram ( Legend )

ObservationDefinition ( DomainResource ) + MetadataResource 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 url : uri [0..1] 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 identifier : Identifier [0..1] 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 version : string [0..1] 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 name : string [0..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the ObservationDefinition title : string [0..1] The current state of the ObservationDefinition (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) PublicationStatus ! » 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 experimental : boolean [0..1] The date (and optionally time) when the ObservationDefinition was published. 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 date : dateTime [0..1] Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact publisher : Reference [0..1] « Practitioner | PractitionerRole | Organization » Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the ObservationDefinition from the consumer's perspective description : markdown [0..1] 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 useContext : UsageContext [0..*] A jurisdiction in which the ObservationDefinition is intended to be used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) Jurisdiction ValueSet + » Explains why this ObservationDefinition is needed and why it has been designed as it has purpose : markdown [0..1] Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition copyright : markdown [0..1] The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date lastReviewDate : date [0..1] The period during which the ObservationDefinition content was or is planned to be effective effectivePeriod : Period [0..1] The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition derivedFromCanonical : canonical [0..*] « ObservationDefinition » 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 derivedFromUri : uri [0..*] A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition subject : CodeableConcept [0..*] The type of individual/organization/device that is expected to act upon instances of this definition performerType : CodeableConcept [0..1] A code that classifies the general type of observation category : CodeableConcept [0..*] « null (Strength=Example) ObservationCategoryCodes ?? » Describes what will be observed. Sometimes this is called the observation "name" code : CodeableConcept [1..1] « null (Strength=Example) LOINCCodes ?? » A unique identifier assigned to this ObservationDefinition artifact identifier : Identifier [0..*] The data types allowed for the value element of the instance observations conforming to this ObservationDefinition permittedDataType : code [0..*] « null (Strength=Required) ObservationDataType ! » Multiple results allowed for observations conforming to this ObservationDefinition multipleResultsAllowed : boolean [0..1] The method or technique used to perform site on the subject's body where the observation is to be made method bodySite : CodeableConcept [0..1] « null (Strength=Example) ObservationMethods SNOMEDCTBodyStructures ?? » The preferred name to be method or technique used when reporting the results of observations conforming to this ObservationDefinition perform the observation preferredReportName method : string CodeableConcept [0..1] « null (Strength=Example) ObservationMethods ?? » The set kind of valid coded results for the observations conforming to specimen that this ObservationDefinition type of observation is produced on validCodedValueSet specimen : Reference [0..1] [0..*] « ValueSet SpecimenDefinition » The set measurement model of normal coded results for the observations conforming device or actual device used to produce observations of this ObservationDefinition type normalCodedValueSet device : Reference [0..1] [0..*] « ValueSet DeviceDefinition | Device » The set of abnormal coded results for preferred name to be used when reporting the observation results of observations conforming to this ObservationDefinition abnormalCodedValueSet preferredReportName : Reference string [0..1] « ValueSet » The This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of critical coded results for vital sign measurements) that includes the observation conforming to this ObservationDefinition target as a member of the group criticalCodedValueSet hasMember : Reference [0..1] [0..*] « ValueSet ObservationDefinition | Questionnaire » QuantitativeDetails Customary Primary unit used to report quantitative results of observations conforming to this ObservationDefinition customaryUnit unit : CodeableConcept [0..1] « null (Strength=Extensible) UCUMCodes + » SI Secondary unit used to report quantitative results of observations conforming to this ObservationDefinition unit customaryUnit : CodeableConcept [0..1] « null (Strength=Extensible) UCUMCodes + » Factor for converting value expressed with SI primary unit to value expressed with customary secondary unit conversionFactor : decimal [0..1] Number of digits after decimal separator when the results of such observations are of type Quantity decimalPrecision : integer [0..1] QualifiedInterval QualifiedValue The category of interval of values A concept defining the context for continuous or ordinal observations conforming to this ObservationDefinition category : code [0..1] « null (Strength=Required) ObservationRangeCategory ! » The low and high values determining the interval. There may be only one set of the two range : Range [0..1] Codes to indicate the health context the range applies to. For example, the normal or therapeutic range qualified values context : CodeableConcept [0..1] « null (Strength=Extensible) ObservationReferenceRangeMean... + » Codes to indicate the The target population this reference range set of qualified values applies to appliesTo : CodeableConcept [0..*] « null (Strength=Example) ObservationReferenceRangeAppl... ?? » Sex The gender this set of the population the range qualified values applies to gender : code [0..1] « null (Strength=Required) AdministrativeGender ! » The age at which this reference range is applicable. This is a neonatal age (e.g. number this set of weeks at term) if the meaning says so qualified values applies to age : Range [0..1] The gestational age to which this reference range is applicable, in the context set of pregnancy qualified values applies to gestationalAge : Range [0..1] Text based condition for which the reference range the set of qualified values is valid condition : string [0..1] The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values rangeCategory : code [0..1] « null (Strength=Required) ObservationRangeCategory ! » The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values range : Range [0..1] The set of valid coded results for qualitative observations that match the criteria of this set of qualified values validCodedValueSet : canonical [0..1] « ValueSet » The set of normal coded results for qualitative observations that match the criteria of this set of qualified values normalCodedValueSet : canonical [0..1] « ValueSet » The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified values abnormalCodedValueSet : canonical [0..1] « ValueSet » The set of critical coded results for qualitative observations that match the criteria of this set of qualified values criticalCodedValueSet : canonical [0..1] « ValueSet » Component Describes what will be observed code : CodeableConcept [1..1] « null (Strength=Example) LOINCCodes ?? » The data types allowed for the value element of the instance of this component observations permittedDataType : code [0..*] « null (Strength=Required) ObservationDataType ! » Characteristics for quantitative results of observations conforming to this observation ObservationDefinition quantitativeDetails [0..1] Multiple ranges A set of results qualified by different contexts values associated with a context and a set of conditions - provides a range for quantitative and ordinal or continuous observations conforming to and a collection of value sets for qualitative observations qualifiedValue [0..*] Characteristics for quantitative results of this ObservationDefinition observation qualifiedInterval quantitativeDetails [0..1] 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 qualifiedValue [0..*] Some observations have multiple component observations, expressed as separate code value pairs component [0..*]

XML Template 

<ObservationDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</category>
 <</code>
 <</identifier>

 <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><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) The name of the individual or organization that published the ObservationDefinition --></publisher>
 <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>
 <
 <
  <</customaryUnit>
  <</unit>
  <

 <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>
 <
  <
  <</range>
  <</context>
  <</appliesTo>
  <
  <</age>
  <</gestationalAge>
  <
 </qualifiedInterval>
 <</validCodedValueSet>
 <</normalCodedValueSet>
 <</abnormalCodedValueSet>
 <</criticalCodedValueSet>

 <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 

{doco
  "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" : { Reference(Organization|Practitioner|PractitionerRole) }, // 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/> .doco


[ 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:
  fhir:
  fhir:

  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 [ Reference(Organization|Practitioner|PractitionerRole) ]; # 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:

  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:
  fhir:
    fhir:
    fhir:
    fhir:

  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:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:

  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

  ], ...;
  fhir:
  fhir:
  fhir:
  fhir:

]

Changes since Release 4

ObservationDefinition
ObservationDefinition.url
  • No Changes Added Element
ObservationDefinition.identifier
  • Max Cardinality changed from * to 1
  • Max Cardinality changed from * to 1
ObservationDefinition.version
  • Added Element
ObservationDefinition.name
  • Added Element
ObservationDefinition.title
  • Added Element
ObservationDefinition.status
  • Added Mandatory Element
ObservationDefinition.experimental
  • Added Element
ObservationDefinition.date
  • Added Element
ObservationDefinition.publisher
  • Added Element
ObservationDefinition.contact
  • Added Element
ObservationDefinition.description
  • Added Element
ObservationDefinition.useContext
  • Added Element
ObservationDefinition.jurisdiction
  • Added Element
ObservationDefinition.purpose
  • Added Element
ObservationDefinition.copyright
  • Added Element
ObservationDefinition.approvalDate
  • Added Element
ObservationDefinition.lastReviewDate
  • Added Element
ObservationDefinition.effectivePeriod
  • Added Element
ObservationDefinition.derivedFromCanonical
  • Added Element
ObservationDefinition.derivedFromUri
  • Added Element
ObservationDefinition.subject
  • Added Element
ObservationDefinition.performerType
  • Added Element
ObservationDefinition.bodySite
  • Added Element
ObservationDefinition.specimen
  • Added Element
ObservationDefinition.device
  • Added Element
ObservationDefinition.qualifiedValue
  • Added Element
ObservationDefinition.qualifiedValue.context
  • Added Element
ObservationDefinition.qualifiedValue.appliesTo
  • Added Element
ObservationDefinition.qualifiedValue.gender
  • Added Element
ObservationDefinition.qualifiedValue.age
  • Added Element
ObservationDefinition.qualifiedValue.gestationalAge
  • Added Element
ObservationDefinition.qualifiedValue.condition
  • Added Element
ObservationDefinition.qualifiedValue.rangeCategory
  • Added Element
ObservationDefinition.qualifiedValue.range
  • Added Element
ObservationDefinition.qualifiedValue.validCodedValueSet
  • Added Element
ObservationDefinition.qualifiedValue.normalCodedValueSet
  • Added Element
ObservationDefinition.qualifiedValue.abnormalCodedValueSet
  • Added Element
ObservationDefinition.qualifiedValue.criticalCodedValueSet
  • Added Element
ObservationDefinition.hasMember
  • Added Element
ObservationDefinition.component
  • Added Element
ObservationDefinition.component.code
  • Added Mandatory Element
ObservationDefinition.component.permittedDataType
  • Added Element
ObservationDefinition.component.quantitativeDetails
  • Added Element
ObservationDefinition.component.qualifiedValue
  • Added Element
ObservationDefinition.qualifiedInterval
  • deleted
ObservationDefinition.validCodedValueSet
  • deleted
ObservationDefinition.normalCodedValueSet
  • deleted
ObservationDefinition.abnormalCodedValueSet
  • deleted
ObservationDefinition.criticalCodedValueSet
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see , the extensions spreadsheet version & the dependency analysis

8.26.4.1 Terminology Bindings

ObservationDefinition.method ObservationDefinition.quantitativeDetails.customaryUnit ObservationDefinition.qualifiedInterval.category
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 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.

 Extensible Jurisdiction ValueSet
ObservationDefinition.category

Observation Category codes.

Example ObservationCategoryCodes
ObservationDefinition.code

This value set includes all LOINC codes

Example LOINCCodes
ObservationDefinition.permittedDataType

Permitted data type for observation value.

Required ObservationDataType
ObservationDefinition.bodySite

This value set includes all codes from SNOMED CT icon where concept is-a 442083009 (Anatomical or acquired body site (body structure)).

Example ObservationMethods SNOMEDCTBodyStructures
ObservationDefinition.method

Observation Method codes from SNOMED CT icon where concept is-a 272394005 (Technique (qualifier value)) or is-a 129264002 (Action (qualifier value)) or is-a 386053000 (Evaluation procedure(procedure))

Extensible Example UCUMCodes ObservationMethods
ObservationDefinition.quantitativeDetails.unit

Unified Code for Units of Measure (UCUM). This value set includes all UCUM codes

Extensible UCUMCodes
ObservationDefinition.quantitativeDetails.customaryUnit

Unified Code for Units of Measure (UCUM). This value set includes all UCUM codes

Required Extensible ObservationRangeCategory UCUMCodes
ObservationDefinition.qualifiedInterval.context 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.qualifiedInterval.appliesTo 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.qualifiedInterval.gender 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
ObservationDefinition.component.permittedDataType

Permitted data type for observation value.

Required ObservationDataType

8.26.4.2 Constraints

UniqueKey Level Location Description Expression
img  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}')

8.26.5 Search Parameters

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 N token Not for genuine usage (true) ObservationDefinition.experimental
identifier token The unique identifier associated with the specimen definition ObservationDefinition.identifier
method token Method of observation ObservationDefinition.method
status N token Publication status of the ObservationDefinition: draft, active, retired, unknown ObservationDefinition.status
title N string Human-friendly name of the ObservationDefinition ObservationDefinition.title
url N uri The uri that identifies the observation definition ObservationDefinition.url