Release 5 Draft Ballot

8.26 Resource ObservationDefinition - Content

Orders and Observations Work GroupMaturity Level: 1 Trial UseSecurity 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, a number of elements of the Observation resource are expected to have their content conforming to the corresponding definitional elements declared in the ObservationDefinition resource:

  • Elements category, code, bodySite, method SHOULD be directly inherited from ObservationDefinition.
  • Observation.subject should belong to the kind of subject specified by ObservationDefinition.suject.
  • Observation.device SHOULD be conformant to ObservationDefinition.device. In particular, if ObservationDefinition references one or more DeviceDefinition resources, a Device resource referenced by Observation SHOULD be conformant to the model of device described in a DeviceDefinition resource referenced by ObservationDefinition.
  • Observation.specimen SHOULD be conformant to ObservationDefinition.specimen. In particular, a Specimen resource referenced by Observation SHOULD be of the kind of specimen described in a SpecimenDefinition resource referenced by ObservationDefinition.
  • Observation.value SHOULD be conformant to the characteristics specified in ObservationDefinition for values: permittedDataType, multipleResultsAllowed, quantitativeDetails, qualifiedValue.
  • If ObservationDefinition contains qualifiedValue elements embedding range elements, then a referenceRange element in Observation SHOULD derive from the appropriate ObservationDefinition.qualifiedValue.range according to the criteria elements specified within ObservationDefinition.qualifiedValue, met by the current context of the observation.
  • If ObservationDefinition contains qualifiedValue elements embedding a validCodedValueSet element, and if Observation.value is a coded value, that value should come from the ValueSet referenced by a validCodedValueSet element of the qualifiedValue element met by the current context of the observation.

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.

This resource is referenced by ActivityDefinition, CatalogEntry, ClinicalUseIssue, Observation, itself and RegulatedAuthorization.

This resource does not implement any patterns.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition TUDomainResourceDefinition 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
... url Σ0..1uriLogical canonical URL to reference this ObservationDefinition (globally unique)
... identifier Σ0..1IdentifierBusiness identifier of the ObservationDefinition
... version Σ0..1stringBusiness version of the ObservationDefinition
... name ΣI0..1stringName for this ObservationDefinition (computer friendly)
... title Σ0..1stringName for this ObservationDefinition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1Reference(Practitioner | PractitionerRole | Organization)The name of the individual or organization that published the ObservationDefinition
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the ObservationDefinition
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for this ObservationDefinition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this ObservationDefinition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen ObservationDefinition was approved by publisher
... lastReviewDate 0..1dateDate on which the asset content was last reviewed
... effectivePeriod Σ0..1PeriodThe effective date range for the ObservationDefinition
... derivedFromCanonical Σ0..*canonical(ObservationDefinition)Based on FHIR definition of another observation
... derivedFromUri Σ0..*uriBased on external definition
... subject Σ0..1CodeableConceptType of subject for the defined observation
... performerType Σ0..1CodeableConceptDesired kind of performer for such kind of observation
... category Σ0..*CodeableConceptGeneral type of observation
Observation Category Codes (Example)
... code Σ1..1CodeableConceptType of observation
LOINC Codes (Example)
... permittedDataType 0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
ObservationDataType (Required)
... multipleResultsAllowed 0..1booleanMultiple results allowed for conforming observations
... bodySite 0..1CodeableConceptBody part to be observed
SNOMED CT Body Structures (Example)
... method 0..1CodeableConceptMethod 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..1stringThe preferred name to be used when reporting the observation results
... quantitativeDetails 0..1BackboneElementCharacteristics of quantitative results
.... unit 0..1CodeableConceptPrimary unit for quantitative results
UCUM Codes (Extensible)
.... customaryUnit 0..1CodeableConceptCustomary (secondary) unit for quantitative results
UCUM Codes (Extensible)
.... conversionFactor 0..1decimalPrimary to secondary unit conversion factor
.... decimalPrecision 0..1integerDecimal precision of observation quantitative results
... qualifiedValue 0..*BackboneElementSet of qualified values for observation results
.... context 0..1CodeableConceptContext qualifier for the set of qualified values
Observation Reference Range Meaning Codes (Extensible)
.... appliesTo 0..*CodeableConceptTargetted population for the set of qualified values
Observation Reference Range Applies To Codes (Example)
.... gender 0..1codemale | female | other | unknown
AdministrativeGender (Required)
.... age 0..1RangeApplicable age range for the set of qualified values
.... gestationalAge 0..1RangeApplicable gestational age range for the set of qualified values
.... condition 0..1stringCondition associated with the set of qualified values
.... rangeCategory 0..1codereference | critical | absolute
ObservationRangeCategory (Required)
.... range 0..1RangeThe range for continuous or ordinal observations
.... validCodedValueSet 0..1canonical(ValueSet)Value set of valid coded values as part of this set of qualified values
.... normalCodedValueSet 0..1canonical(ValueSet)Value set of normal coded values as part of this set of qualified values
.... abnormalCodedValueSet 0..1canonical(ValueSet)Value set of abnormal coded values as part of this set of qualified values
.... criticalCodedValueSet 0..1canonical(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..*BackboneElementComponent results
.... code 1..1CodeableConceptType of observation
LOINC Codes (Example)
.... permittedDataType 0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
ObservationDataType (Required)
.... quantitativeDetails 0..1see quantitativeDetailsCharacteristics of quantitative results
.... qualifiedValue 0..*see qualifiedValueSet of qualified values for observation results

doco Documentation for this format

UML Diagram (Legend)

ObservationDefinition (DomainResource)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 Versionsurl : 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 serveridentifier : 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 orderableversion : 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 generationname : string [0..1]A short, descriptive, user-friendly title for the ObservationDefinitiontitle : 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 (this element modifies the meaning of other elements)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 changesdate : dateTime [0..1]Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contactpublisher : Reference [0..1] « Practitioner|PractitionerRole| Organization »Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the ObservationDefinition from the consumer's perspectivedescription : 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 instancesuseContext : UsageContext [0..*]A jurisdiction in which the ObservationDefinition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explains why this ObservationDefinition is needed and why it has been designed as it haspurpose : 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 ObservationDefinitioncopyright : 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 usageapprovalDate : 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 datelastReviewDate : date [0..1]The period during which the ObservationDefinition content was or is planned to be effectiveeffectivePeriod : Period [0..1]The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definitionderivedFromCanonical : 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 definitionderivedFromUri : uri [0..*]A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinitionsubject : CodeableConcept [0..1]The type of individual/organization/device that is expected to act upon instances of this definitionperformerType : CodeableConcept [0..1]A code that classifies the general type of observationcategory : 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?? »The data types allowed for the value element of the instance observations conforming to this ObservationDefinitionpermittedDataType : code [0..*] « null (Strength=Required)ObservationDataType! »Multiple results allowed for observations conforming to this ObservationDefinitionmultipleResultsAllowed : boolean [0..1]The site on the subject's body where the observation is to be madebodySite : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTBodyStructures?? »The method or technique used to perform the observationmethod : CodeableConcept [0..1] « null (Strength=Example)ObservationMethods?? »The kind of specimen that this type of observation is produced onspecimen : Reference [0..*] « SpecimenDefinition »The measurement model of device or actual device used to produce observations of this typedevice : Reference [0..*] « DeviceDefinition|Device »The preferred name to be used when reporting the results of observations conforming to this ObservationDefinitionpreferredReportName : string [0..1]This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the grouphasMember : Reference [0..*] « ObservationDefinition|Questionnaire »QuantitativeDetailsPrimary unit used to report quantitative results of observations conforming to this ObservationDefinitionunit : CodeableConcept [0..1] « null (Strength=Extensible)UCUMCodes+ »Secondary unit used to report quantitative results of observations conforming to this ObservationDefinitioncustomaryUnit : CodeableConcept [0..1] « null (Strength=Extensible)UCUMCodes+ »Factor for converting value expressed with primary unit to value expressed with secondary unitconversionFactor : decimal [0..1]Number of digits after decimal separator when the results of such observations are of type QuantitydecimalPrecision : integer [0..1]QualifiedValueA concept defining the context for this set of qualified valuescontext : CodeableConcept [0..1] « null (Strength=Extensible)ObservationReferenceRangeMean...+ »The target population this set of qualified values applies toappliesTo : CodeableConcept [0..*] « null (Strength=Example) ObservationReferenceRangeAppl...?? »The gender this set of qualified values applies togender : code [0..1] « null (Strength=Required)AdministrativeGender! »The age range this set of qualified values applies toage : Range [0..1]The gestational age this set of qualified values applies togestationalAge : Range [0..1]Text based condition for which the the set of qualified values is validcondition : string [0..1]The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified valuesrangeCategory : 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 valuesrange : Range [0..1]The set of valid coded results for qualitative observations that match the criteria of this set of qualified valuesvalidCodedValueSet : canonical [0..1] « ValueSet »The set of normal coded results for qualitative observations that match the criteria of this set of qualified valuesnormalCodedValueSet : canonical [0..1] « ValueSet »The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified valuesabnormalCodedValueSet : canonical [0..1] « ValueSet »The set of critical coded results for qualitative observations that match the criteria of this set of qualified valuescriticalCodedValueSet : canonical [0..1] « ValueSet »ComponentDescribes what will be observedcode : CodeableConcept [1..1] « null (Strength=Example)LOINCCodes?? »The data types allowed for the value element of the instance of this component observationspermittedDataType : code [0..*] « null (Strength=Required)ObservationDataType! »Characteristics for quantitative results of observations conforming to this ObservationDefinitionquantitativeDetails[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 observationsqualifiedValue[0..*]Characteristics for quantitative results of this observationquantitativeDetails[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 observationsqualifiedValue[0..*]Some observations have multiple component observations, expressed as separate code value pairscomponent[0..*]

XML Template

<ObservationDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- 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]"/><!-- ?? 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..1 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

{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>", // C? 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: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 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..1 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 R3

ObservationDefinition
ObservationDefinition.url
  • Added Element
ObservationDefinition.identifier
  • 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.permittedDataType
  • Change value set from http://hl7.org/fhir/ValueSet/permitted-data-type|4.0.0 to http://hl7.org/fhir/ValueSet/permitted-data-type|4.6.0
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.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition TUDomainResourceDefinition 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
... url Σ0..1uriLogical canonical URL to reference this ObservationDefinition (globally unique)
... identifier Σ0..1IdentifierBusiness identifier of the ObservationDefinition
... version Σ0..1stringBusiness version of the ObservationDefinition
... name ΣI0..1stringName for this ObservationDefinition (computer friendly)
... title Σ0..1stringName for this ObservationDefinition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1Reference(Practitioner | PractitionerRole | Organization)The name of the individual or organization that published the ObservationDefinition
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the ObservationDefinition
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for this ObservationDefinition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this ObservationDefinition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen ObservationDefinition was approved by publisher
... lastReviewDate 0..1dateDate on which the asset content was last reviewed
... effectivePeriod Σ0..1PeriodThe effective date range for the ObservationDefinition
... derivedFromCanonical Σ0..*canonical(ObservationDefinition)Based on FHIR definition of another observation
... derivedFromUri Σ0..*uriBased on external definition
... subject Σ0..1CodeableConceptType of subject for the defined observation
... performerType Σ0..1CodeableConceptDesired kind of performer for such kind of observation
... category Σ0..*CodeableConceptGeneral type of observation
Observation Category Codes (Example)
... code Σ1..1CodeableConceptType of observation
LOINC Codes (Example)
... permittedDataType 0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
ObservationDataType (Required)
... multipleResultsAllowed 0..1booleanMultiple results allowed for conforming observations
... bodySite 0..1CodeableConceptBody part to be observed
SNOMED CT Body Structures (Example)
... method 0..1CodeableConceptMethod 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..1stringThe preferred name to be used when reporting the observation results
... quantitativeDetails 0..1BackboneElementCharacteristics of quantitative results
.... unit 0..1CodeableConceptPrimary unit for quantitative results
UCUM Codes (Extensible)
.... customaryUnit 0..1CodeableConceptCustomary (secondary) unit for quantitative results
UCUM Codes (Extensible)
.... conversionFactor 0..1decimalPrimary to secondary unit conversion factor
.... decimalPrecision 0..1integerDecimal precision of observation quantitative results
... qualifiedValue 0..*BackboneElementSet of qualified values for observation results
.... context 0..1CodeableConceptContext qualifier for the set of qualified values
Observation Reference Range Meaning Codes (Extensible)
.... appliesTo 0..*CodeableConceptTargetted population for the set of qualified values
Observation Reference Range Applies To Codes (Example)
.... gender 0..1codemale | female | other | unknown
AdministrativeGender (Required)
.... age 0..1RangeApplicable age range for the set of qualified values
.... gestationalAge 0..1RangeApplicable gestational age range for the set of qualified values
.... condition 0..1stringCondition associated with the set of qualified values
.... rangeCategory 0..1codereference | critical | absolute
ObservationRangeCategory (Required)
.... range 0..1RangeThe range for continuous or ordinal observations
.... validCodedValueSet 0..1canonical(ValueSet)Value set of valid coded values as part of this set of qualified values
.... normalCodedValueSet 0..1canonical(ValueSet)Value set of normal coded values as part of this set of qualified values
.... abnormalCodedValueSet 0..1canonical(ValueSet)Value set of abnormal coded values as part of this set of qualified values
.... criticalCodedValueSet 0..1canonical(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..*BackboneElementComponent results
.... code 1..1CodeableConceptType of observation
LOINC Codes (Example)
.... permittedDataType 0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
ObservationDataType (Required)
.... quantitativeDetails 0..1see quantitativeDetailsCharacteristics of quantitative results
.... qualifiedValue 0..*see qualifiedValueSet of qualified values for observation results

doco Documentation for this format

UML Diagram (Legend)

ObservationDefinition (DomainResource)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 Versionsurl : 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 serveridentifier : 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 orderableversion : 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 generationname : string [0..1]A short, descriptive, user-friendly title for the ObservationDefinitiontitle : 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 (this element modifies the meaning of other elements)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 changesdate : dateTime [0..1]Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contactpublisher : Reference [0..1] « Practitioner|PractitionerRole| Organization »Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the ObservationDefinition from the consumer's perspectivedescription : 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 instancesuseContext : UsageContext [0..*]A jurisdiction in which the ObservationDefinition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explains why this ObservationDefinition is needed and why it has been designed as it haspurpose : 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 ObservationDefinitioncopyright : 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 usageapprovalDate : 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 datelastReviewDate : date [0..1]The period during which the ObservationDefinition content was or is planned to be effectiveeffectivePeriod : Period [0..1]The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definitionderivedFromCanonical : 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 definitionderivedFromUri : uri [0..*]A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinitionsubject : CodeableConcept [0..1]The type of individual/organization/device that is expected to act upon instances of this definitionperformerType : CodeableConcept [0..1]A code that classifies the general type of observationcategory : 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?? »The data types allowed for the value element of the instance observations conforming to this ObservationDefinitionpermittedDataType : code [0..*] « null (Strength=Required)ObservationDataType! »Multiple results allowed for observations conforming to this ObservationDefinitionmultipleResultsAllowed : boolean [0..1]The site on the subject's body where the observation is to be madebodySite : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTBodyStructures?? »The method or technique used to perform the observationmethod : CodeableConcept [0..1] « null (Strength=Example)ObservationMethods?? »The kind of specimen that this type of observation is produced onspecimen : Reference [0..*] « SpecimenDefinition »The measurement model of device or actual device used to produce observations of this typedevice : Reference [0..*] « DeviceDefinition|Device »The preferred name to be used when reporting the results of observations conforming to this ObservationDefinitionpreferredReportName : string [0..1]This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the grouphasMember : Reference [0..*] « ObservationDefinition|Questionnaire »QuantitativeDetailsPrimary unit used to report quantitative results of observations conforming to this ObservationDefinitionunit : CodeableConcept [0..1] « null (Strength=Extensible)UCUMCodes+ »Secondary unit used to report quantitative results of observations conforming to this ObservationDefinitioncustomaryUnit : CodeableConcept [0..1] « null (Strength=Extensible)UCUMCodes+ »Factor for converting value expressed with primary unit to value expressed with secondary unitconversionFactor : decimal [0..1]Number of digits after decimal separator when the results of such observations are of type QuantitydecimalPrecision : integer [0..1]QualifiedValueA concept defining the context for this set of qualified valuescontext : CodeableConcept [0..1] « null (Strength=Extensible)ObservationReferenceRangeMean...+ »The target population this set of qualified values applies toappliesTo : CodeableConcept [0..*] « null (Strength=Example) ObservationReferenceRangeAppl...?? »The gender this set of qualified values applies togender : code [0..1] « null (Strength=Required)AdministrativeGender! »The age range this set of qualified values applies toage : Range [0..1]The gestational age this set of qualified values applies togestationalAge : Range [0..1]Text based condition for which the the set of qualified values is validcondition : string [0..1]The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified valuesrangeCategory : 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 valuesrange : Range [0..1]The set of valid coded results for qualitative observations that match the criteria of this set of qualified valuesvalidCodedValueSet : canonical [0..1] « ValueSet »The set of normal coded results for qualitative observations that match the criteria of this set of qualified valuesnormalCodedValueSet : canonical [0..1] « ValueSet »The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified valuesabnormalCodedValueSet : canonical [0..1] « ValueSet »The set of critical coded results for qualitative observations that match the criteria of this set of qualified valuescriticalCodedValueSet : canonical [0..1] « ValueSet »ComponentDescribes what will be observedcode : CodeableConcept [1..1] « null (Strength=Example)LOINCCodes?? »The data types allowed for the value element of the instance of this component observationspermittedDataType : code [0..*] « null (Strength=Required)ObservationDataType! »Characteristics for quantitative results of observations conforming to this ObservationDefinitionquantitativeDetails[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 observationsqualifiedValue[0..*]Characteristics for quantitative results of this observationquantitativeDetails[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 observationsqualifiedValue[0..*]Some observations have multiple component observations, expressed as separate code value pairscomponent[0..*]

XML Template

<ObservationDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- 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]"/><!-- ?? 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..1 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

{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>", // C? 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: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 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..1 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 3

ObservationDefinition
ObservationDefinition.url
  • Added Element
ObservationDefinition.identifier
  • 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.permittedDataType
  • Change value set from http://hl7.org/fhir/ValueSet/permitted-data-type|4.0.0 to http://hl7.org/fhir/ValueSet/permitted-data-type|4.6.0
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.

 

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

PathDefinitionTypeReference
ObservationDefinition.status RequiredPublicationStatus
ObservationDefinition.jurisdiction ExtensibleJurisdiction ValueSet
ObservationDefinition.category ExampleObservationCategoryCodes
ObservationDefinition.code ExampleLOINCCodes
ObservationDefinition.permittedDataType RequiredObservationDataType
ObservationDefinition.bodySite ExampleSNOMEDCTBodyStructures
ObservationDefinition.method ExampleObservationMethods
ObservationDefinition.quantitativeDetails.unit ExtensibleUCUMCodes
ObservationDefinition.quantitativeDetails.customaryUnit ExtensibleUCUMCodes
ObservationDefinition.qualifiedValue.context ExtensibleObservationReferenceRangeMeaningCodes
ObservationDefinition.qualifiedValue.appliesTo ExampleObservationReferenceRangeAppliesToCodes
ObservationDefinition.qualifiedValue.gender RequiredAdministrativeGender
ObservationDefinition.qualifiedValue.rangeCategory RequiredObservationRangeCategory
ObservationDefinition.component.code ExampleLOINCCodes
ObservationDefinition.component.permittedDataType RequiredObservationDataType

idLevelLocationDescriptionExpression
cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
categorytokenCategory (class) of observationObservationDefinition.category
codetokenObservation codeObservationDefinition.code
experimental NtokenNot for genuine usage (true)ObservationDefinition.experimental
identifiertokenThe unique identifier associated with the specimen definitionObservationDefinition.identifier
methodtokenMethod of observationObservationDefinition.method
status NtokenPublication status of the ObservationDefinition: draft, active, retired, unknownObservationDefinition.status
title NstringHuman-friendly name of the ObservationDefinitionObservationDefinition.title
url NuriThe uri that identifies the observation definitionObservationDefinition.url