Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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 Work GroupMaturity Level: 0 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.

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 resource relates to these other resource:.

  • Resource ObservationDefinition is referenced by resource CatalogEntry. This enables items of catalogs, representing healthcare services or products, to declare the observations, which are consumed or produced by these items.
  • Observation.basedOn references ObservationDefinition resource.

8.26.3 References

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

This resource does not implement any patterns.

8.26.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition TUDomainResourceDefinition of an observation
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
... title Σ0..1stringName for this ObservationDefinition (Human friendly)
... derivedFromCanonical Σ0..*canonical(ObservationDefinition)Based on FHIR definition of another observation
... derivedFromUri Σ0..*uriBased on external definition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... subject[x] Σ0..1Type of subject for the defined observation
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate status first applied
... 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..1dateLast review date for the ObservationDefinition
... effectivePeriod Σ0..1PeriodThe effective date range for the ObservationDefinition
... performerType Σ0..1CodeableConceptDesired kind of performer for such kind of observation
... category Σ0..*CodeableConceptCategory 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
... 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..1Reference(SpecimenDefinition)Kind of specimen used by this type of observation
... device 0..1Reference(Device)Measurement device
... preferredReportName 0..1stringPreferred report name
... quantitativeDetails 0..1BackboneElementCharacteristics of quantitative results
.... customaryUnit 0..1CodeableConceptCustomary unit for quantitative results
UCUM Codes (Extensible)
.... unit 0..1CodeableConceptSI unit for quantitative results
UCUM Codes (Extensible)
.... conversionFactor 0..1decimalSI to Customary unit conversion factor
.... decimalPrecision 0..1integerDecimal precision of observation quantitative results
... qualifiedInterval 0..*BackboneElementQualified range for continuous and ordinal observation results
.... category 0..1codereference | critical | absolute
ObservationRangeCategory (Required)
.... range 0..1RangeThe interval itself, for continuous or ordinal observations
.... context 0..1CodeableConceptRange context qualifier
Observation Reference Range Meaning Codes (Extensible)
.... appliesTo 0..*CodeableConceptTargetted population of the range
Observation Reference Range Applies To Codes (Example)
.... gender 0..1codemale | female | other | unknown
AdministrativeGender (Required)
.... age 0..1RangeApplicable age range, if relevant
.... gestationalAge 0..1RangeApplicable gestational age range, if relevant
.... condition 0..1stringCondition associated with the reference range
... validCodedValueSet 0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition
... normalCodedValueSet 0..1Reference(ValueSet)Value set of normal coded values for the observations conforming to this ObservationDefinition
... abnormalCodedValueSet 0..1Reference(ValueSet)Value set of abnormal coded values for the observations conforming to this ObservationDefinition
... criticalCodedValueSet 0..1Reference(ValueSet)Value set of critical coded values for the observations conforming to this ObservationDefinition
... 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 quantitativeDetailsQuantitative details
.... qualifiedInterval 0..*see qualifiedIntervalQualified interval

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 short, descriptive, user-friendly title for the ObservationDefinitiontitle : string [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..*]The current state of the ObservationDefinition (this element modifies the meaning of other elements)status : code [1..1] « Codes identifying the state of an ObservationDefinition. (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]A code or group definition that describes the intended subject of Observation instances conforming to this ObservationDefinitionsubject[x] : DataType [0..1] « CodeableConcept|Reference(Group) »For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawaldate : 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 terms may be used to assist with indexing and searching of observation definitionsuseContext : UsageContext [0..*]A jurisdiction in which the ObservationDefinition is intended to be usedjurisdiction : CodeableConcept [0..*] « Codes for country, country subdivision and region for indicating where a resource is intended to be used. (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 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..*] « Codes for high level observation categories. (Strength=Example)ObservationCategoryCodes?? »Describes what will be observed. Sometimes this is called the observation "name"code : CodeableConcept [1..1] « Codes identifying names of simple observations. (Strength=Example)LOINCCodes?? »The data types allowed for the value element of the instance observations conforming to this ObservationDefinitionpermittedDataType : code [0..*] « Permitted data type for observation value. (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] « SNOMED CT body structures. (Strength=Example)SNOMEDCTBodyStructures?? »The method or technique used to perform the observationmethod : CodeableConcept [0..1] « Methods for simple observations. (Strength=Example)ObservationMethods?? »The kind of specimen that this type of observation is produced onspecimen : Reference [0..1] « SpecimenDefinition »The measurement device used to produce observations of this typedevice : Reference [0..1] « Device »The preferred name to be used when reporting the results of observations conforming to this ObservationDefinitionpreferredReportName : string [0..1]The set of valid coded results for the observations conforming to this ObservationDefinitionvalidCodedValueSet : Reference [0..1] « ValueSet »The set of normal coded results for the observations conforming to this ObservationDefinitionnormalCodedValueSet : Reference [0..1] « ValueSet »The set of abnormal coded results for the observation conforming to this ObservationDefinitionabnormalCodedValueSet : Reference [0..1] « ValueSet »The set of critical coded results for the observation conforming to this ObservationDefinitioncriticalCodedValueSet : Reference [0..1] « ValueSet »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 »QuantitativeDetailsCustomary unit used to report quantitative results of observations conforming to this ObservationDefinitioncustomaryUnit : CodeableConcept [0..1] « Codes identifying units of measure. (Strength=Extensible)UCUMCodes+ »SI unit used to report quantitative results of observations conforming to this ObservationDefinitionunit : CodeableConcept [0..1] « Codes identifying units of measure. (Strength=Extensible)UCUMCodes+ »Factor for converting value expressed with SI unit to value expressed with customary unitconversionFactor : decimal [0..1]Number of digits after decimal separator when the results of such observations are of type QuantitydecimalPrecision : integer [0..1]QualifiedIntervalThe category of interval of values for continuous or ordinal observations conforming to this ObservationDefinitioncategory : code [0..1] « Codes identifying the category of observation range. (Strength=Required)ObservationRangeCategory! »The low and high values determining the interval. There may be only one of the tworange : Range [0..1]Codes to indicate the health context the range applies to. For example, the normal or therapeutic rangecontext : CodeableConcept [0..1] « Code identifying the health context of a range. (Strength=Extensible)ObservationReferenceRangeMean...+ »Codes to indicate the target population this reference range applies toappliesTo : CodeableConcept [0..*] « Codes identifying the population the reference range applies to. (Strength=Example) ObservationReferenceRangeAppl...?? »Sex of the population the range applies togender : code [0..1] « The gender of a person used for administrative purposes. (Strength=Required)AdministrativeGender! »The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says soage : Range [0..1]The gestational age to which this reference range is applicable, in the context of pregnancygestationalAge : Range [0..1]Text based condition for which the reference range is validcondition : string [0..1]ComponentDescribes what will be observedcode : CodeableConcept [1..1] « Codes identifying names of simple observations. (Strength=Example)LOINCCodes?? »The data types allowed for the value element of the instance of this component observationspermittedDataType : code [0..*] « Permitted data type for observation value. (Strength=Required)ObservationDataType! »Characteristics for quantitative results of this observationquantitativeDetails[0..1]Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinitionqualifiedInterval[0..*]The quantitative details specifiedquantitativeDetails[0..1]The qualified interval specifiedqualifiedInterval[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 -->
 <title value="[string]"/><!-- 0..1 Name for this ObservationDefinition (Human friendly) -->
 <derivedFromCanonical><!-- 0..* canonical(ObservationDefinition) Based on FHIR definition of another observation --></derivedFromCanonical>
 <derivedFromUri value="[uri]"/><!-- 0..* Based on external definition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of subject for the defined observation --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date status first applied -->
 <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 Last review date for the ObservationDefinition -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the ObservationDefinition --></effectivePeriod>
 <performerType><!-- 0..1 CodeableConcept Desired kind of performer for such kind of observation --></performerType>
 <category><!-- 0..* CodeableConcept Category 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 -->
 <bodySite><!-- 0..1 CodeableConcept Body part to be observed --></bodySite>
 <method><!-- 0..1 CodeableConcept Method used to produce the observation --></method>
 <specimen><!-- 0..1 Reference(SpecimenDefinition) Kind of specimen used by this type of observation --></specimen>
 <device><!-- 0..1 Reference(Device) Measurement device --></device>
 <preferredReportName value="[string]"/><!-- 0..1 Preferred report name -->
 <quantitativeDetails>  <!-- 0..1 Characteristics of quantitative results -->
  <customaryUnit><!-- 0..1 CodeableConcept Customary unit for quantitative results --></customaryUnit>
  <unit><!-- 0..1 CodeableConcept SI unit for quantitative results --></unit>
  <conversionFactor value="[decimal]"/><!-- 0..1 SI to Customary unit conversion factor -->
  <decimalPrecision value="[integer]"/><!-- 0..1 Decimal precision of observation quantitative results -->
 </quantitativeDetails>
 <qualifiedInterval>  <!-- 0..* Qualified range for continuous and ordinal observation results -->
  <category value="[code]"/><!-- 0..1 reference | critical | absolute -->
  <range><!-- 0..1 Range The interval itself, for continuous or ordinal observations --></range>
  <context><!-- 0..1 CodeableConcept Range context qualifier --></context>
  <appliesTo><!-- 0..* CodeableConcept Targetted population of the range --></appliesTo>
  <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
  <age><!-- 0..1 Range Applicable age range, if relevant --></age>
  <gestationalAge><!-- 0..1 Range Applicable gestational age range, if relevant --></gestationalAge>
  <condition value="[string]"/><!-- 0..1 Condition associated with the reference range -->
 </qualifiedInterval>
 <validCodedValueSet><!-- 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition --></validCodedValueSet>
 <normalCodedValueSet><!-- 0..1 Reference(ValueSet) Value set of normal coded values for the observations conforming to this ObservationDefinition --></normalCodedValueSet>
 <abnormalCodedValueSet><!-- 0..1 Reference(ValueSet) Value set of abnormal coded values for the observations conforming to this ObservationDefinition --></abnormalCodedValueSet>
 <criticalCodedValueSet><!-- 0..1 Reference(ValueSet) Value set of critical coded values for the observations conforming to this ObservationDefinition --></criticalCodedValueSet>
 <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 Quantitative details --></quantitativeDetails>
  <qualifiedInterval><!-- 0..* Content as for ObservationDefinition.qualifiedInterval Qualified interval --></qualifiedInterval>
 </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
  "title" : "<string>", // Name for this ObservationDefinition (Human friendly)
  "derivedFromCanonical" : [{ canonical(ObservationDefinition) }], // Based on FHIR definition of another observation
  "derivedFromUri" : ["<uri>"], // Based on external definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // If for testing purposes, not real usage
  // subject[x]: Type of subject for the defined observation. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date status first applied
  "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>", // Last review date for the ObservationDefinition
  "effectivePeriod" : { Period }, // The effective date range for the ObservationDefinition
  "performerType" : { CodeableConcept }, // Desired kind of performer for such kind of observation
  "category" : [{ CodeableConcept }], // Category 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
  "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) }, // Measurement device
  "preferredReportName" : "<string>", // Preferred report name
  "quantitativeDetails" : { // Characteristics of quantitative results
    "customaryUnit" : { CodeableConcept }, // Customary unit for quantitative results
    "unit" : { CodeableConcept }, // SI unit for quantitative results
    "conversionFactor" : <decimal>, // SI to Customary unit conversion factor
    "decimalPrecision" : <integer> // Decimal precision of observation quantitative results
  },
  "qualifiedInterval" : [{ // Qualified range for continuous and ordinal observation results
    "category" : "<code>", // reference | critical | absolute
    "range" : { Range }, // The interval itself, for continuous or ordinal observations
    "context" : { CodeableConcept }, // Range context qualifier
    "appliesTo" : [{ CodeableConcept }], // Targetted population of the range
    "gender" : "<code>", // male | female | other | unknown
    "age" : { Range }, // Applicable age range, if relevant
    "gestationalAge" : { Range }, // Applicable gestational age range, if relevant
    "condition" : "<string>" // Condition associated with the reference range
  }],
  "validCodedValueSet" : { Reference(ValueSet) }, // Value set of valid coded values for the observations conforming to this ObservationDefinition
  "normalCodedValueSet" : { Reference(ValueSet) }, // Value set of normal coded values for the observations conforming to this ObservationDefinition
  "abnormalCodedValueSet" : { Reference(ValueSet) }, // Value set of abnormal coded values for the observations conforming to this ObservationDefinition
  "criticalCodedValueSet" : { Reference(ValueSet) }, // Value set of critical coded values for the observations conforming to this ObservationDefinition
  "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 }, // Quantitative details
    "qualifiedInterval" : [{ Content as for ObservationDefinition.qualifiedInterval }] // Qualified interval
  }]
}

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.title [ string ]; # 0..1 Name for this ObservationDefinition (Human friendly)
  fhir:ObservationDefinition.derivedFromCanonical [ canonical(ObservationDefinition) ], ... ; # 0..* Based on FHIR definition of another observation
  fhir:ObservationDefinition.derivedFromUri [ uri ], ... ; # 0..* Based on external definition
  fhir:ObservationDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ObservationDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  # ObservationDefinition.subject[x] : 0..1 Type of subject for the defined observation. One of these 2
    fhir:ObservationDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:ObservationDefinition.subjectReference [ Reference(Group) ]
  fhir:ObservationDefinition.date [ dateTime ]; # 0..1 Date status first applied
  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 Last review date for the ObservationDefinition
  fhir:ObservationDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the ObservationDefinition
  fhir:ObservationDefinition.performerType [ CodeableConcept ]; # 0..1 Desired kind of performer for such kind of observation
  fhir:ObservationDefinition.category [ CodeableConcept ], ... ; # 0..* Category 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
  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..1 Kind of specimen used by this type of observation
  fhir:ObservationDefinition.device [ Reference(Device) ]; # 0..1 Measurement device
  fhir:ObservationDefinition.preferredReportName [ string ]; # 0..1 Preferred report name
  fhir:ObservationDefinition.quantitativeDetails [ # 0..1 Characteristics of quantitative results
    fhir:ObservationDefinition.quantitativeDetails.customaryUnit [ CodeableConcept ]; # 0..1 Customary unit for quantitative results
    fhir:ObservationDefinition.quantitativeDetails.unit [ CodeableConcept ]; # 0..1 SI unit for quantitative results
    fhir:ObservationDefinition.quantitativeDetails.conversionFactor [ decimal ]; # 0..1 SI to Customary unit conversion factor
    fhir:ObservationDefinition.quantitativeDetails.decimalPrecision [ integer ]; # 0..1 Decimal precision of observation quantitative results
  ];
  fhir:ObservationDefinition.qualifiedInterval [ # 0..* Qualified range for continuous and ordinal observation results
    fhir:ObservationDefinition.qualifiedInterval.category [ code ]; # 0..1 reference | critical | absolute
    fhir:ObservationDefinition.qualifiedInterval.range [ Range ]; # 0..1 The interval itself, for continuous or ordinal observations
    fhir:ObservationDefinition.qualifiedInterval.context [ CodeableConcept ]; # 0..1 Range context qualifier
    fhir:ObservationDefinition.qualifiedInterval.appliesTo [ CodeableConcept ], ... ; # 0..* Targetted population of the range
    fhir:ObservationDefinition.qualifiedInterval.gender [ code ]; # 0..1 male | female | other | unknown
    fhir:ObservationDefinition.qualifiedInterval.age [ Range ]; # 0..1 Applicable age range, if relevant
    fhir:ObservationDefinition.qualifiedInterval.gestationalAge [ Range ]; # 0..1 Applicable gestational age range, if relevant
    fhir:ObservationDefinition.qualifiedInterval.condition [ string ]; # 0..1 Condition associated with the reference range
  ], ...;
  fhir:ObservationDefinition.validCodedValueSet [ Reference(ValueSet) ]; # 0..1 Value set of valid coded values for the observations conforming to this ObservationDefinition
  fhir:ObservationDefinition.normalCodedValueSet [ Reference(ValueSet) ]; # 0..1 Value set of normal coded values for the observations conforming to this ObservationDefinition
  fhir:ObservationDefinition.abnormalCodedValueSet [ Reference(ValueSet) ]; # 0..1 Value set of abnormal coded values for the observations conforming to this ObservationDefinition
  fhir:ObservationDefinition.criticalCodedValueSet [ Reference(ValueSet) ]; # 0..1 Value set of critical coded values for the observations conforming to this ObservationDefinition
  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 Quantitative details
    fhir:ObservationDefinition.component.qualifiedInterval [ See ObservationDefinition.qualifiedInterval ], ... ; # 0..* Qualified interval
  ], ...;
]

Changes since R3

ObservationDefinition
ObservationDefinition.url
  • Added Element
ObservationDefinition.identifier
  • Max Cardinality changed from * to 1
ObservationDefinition.version
  • Added Element
ObservationDefinition.title
  • Added Element
ObservationDefinition.derivedFromCanonical
  • Added Element
ObservationDefinition.derivedFromUri
  • Added Element
ObservationDefinition.status
  • Added Mandatory Element
ObservationDefinition.experimental
  • Added Element
ObservationDefinition.subject[x]
  • 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.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.2.0
ObservationDefinition.bodySite
  • Added Element
ObservationDefinition.specimen
  • Added Element
ObservationDefinition.device
  • Added Element
ObservationDefinition.qualifiedInterval.category
  • Change value set from http://hl7.org/fhir/ValueSet/observation-range-category|4.0.0 to http://hl7.org/fhir/ValueSet/observation-range-category|4.2.0
ObservationDefinition.qualifiedInterval.gender
  • Change value set from http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0 to http://hl7.org/fhir/ValueSet/administrative-gender|4.2.0
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.qualifiedInterval
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition TUDomainResourceDefinition of an observation
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
... title Σ0..1stringName for this ObservationDefinition (Human friendly)
... derivedFromCanonical Σ0..*canonical(ObservationDefinition)Based on FHIR definition of another observation
... derivedFromUri Σ0..*uriBased on external definition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... subject[x] Σ0..1Type of subject for the defined observation
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate status first applied
... 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..1dateLast review date for the ObservationDefinition
... effectivePeriod Σ0..1PeriodThe effective date range for the ObservationDefinition
... performerType Σ0..1CodeableConceptDesired kind of performer for such kind of observation
... category Σ0..*CodeableConceptCategory 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
... 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..1Reference(SpecimenDefinition)Kind of specimen used by this type of observation
... device 0..1Reference(Device)Measurement device
... preferredReportName 0..1stringPreferred report name
... quantitativeDetails 0..1BackboneElementCharacteristics of quantitative results
.... customaryUnit 0..1CodeableConceptCustomary unit for quantitative results
UCUM Codes (Extensible)
.... unit 0..1CodeableConceptSI unit for quantitative results
UCUM Codes (Extensible)
.... conversionFactor 0..1decimalSI to Customary unit conversion factor
.... decimalPrecision 0..1integerDecimal precision of observation quantitative results
... qualifiedInterval 0..*BackboneElementQualified range for continuous and ordinal observation results
.... category 0..1codereference | critical | absolute
ObservationRangeCategory (Required)
.... range 0..1RangeThe interval itself, for continuous or ordinal observations
.... context 0..1CodeableConceptRange context qualifier
Observation Reference Range Meaning Codes (Extensible)
.... appliesTo 0..*CodeableConceptTargetted population of the range
Observation Reference Range Applies To Codes (Example)
.... gender 0..1codemale | female | other | unknown
AdministrativeGender (Required)
.... age 0..1RangeApplicable age range, if relevant
.... gestationalAge 0..1RangeApplicable gestational age range, if relevant
.... condition 0..1stringCondition associated with the reference range
... validCodedValueSet 0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition
... normalCodedValueSet 0..1Reference(ValueSet)Value set of normal coded values for the observations conforming to this ObservationDefinition
... abnormalCodedValueSet 0..1Reference(ValueSet)Value set of abnormal coded values for the observations conforming to this ObservationDefinition
... criticalCodedValueSet 0..1Reference(ValueSet)Value set of critical coded values for the observations conforming to this ObservationDefinition
... 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 quantitativeDetailsQuantitative details
.... qualifiedInterval 0..*see qualifiedIntervalQualified interval

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 short, descriptive, user-friendly title for the ObservationDefinitiontitle : string [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..*]The current state of the ObservationDefinition (this element modifies the meaning of other elements)status : code [1..1] « Codes identifying the state of an ObservationDefinition. (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]A code or group definition that describes the intended subject of Observation instances conforming to this ObservationDefinitionsubject[x] : DataType [0..1] « CodeableConcept|Reference(Group) »For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawaldate : 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 terms may be used to assist with indexing and searching of observation definitionsuseContext : UsageContext [0..*]A jurisdiction in which the ObservationDefinition is intended to be usedjurisdiction : CodeableConcept [0..*] « Codes for country, country subdivision and region for indicating where a resource is intended to be used. (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 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..*] « Codes for high level observation categories. (Strength=Example)ObservationCategoryCodes?? »Describes what will be observed. Sometimes this is called the observation "name"code : CodeableConcept [1..1] « Codes identifying names of simple observations. (Strength=Example)LOINCCodes?? »The data types allowed for the value element of the instance observations conforming to this ObservationDefinitionpermittedDataType : code [0..*] « Permitted data type for observation value. (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] « SNOMED CT body structures. (Strength=Example)SNOMEDCTBodyStructures?? »The method or technique used to perform the observationmethod : CodeableConcept [0..1] « Methods for simple observations. (Strength=Example)ObservationMethods?? »The kind of specimen that this type of observation is produced onspecimen : Reference [0..1] « SpecimenDefinition »The measurement device used to produce observations of this typedevice : Reference [0..1] « Device »The preferred name to be used when reporting the results of observations conforming to this ObservationDefinitionpreferredReportName : string [0..1]The set of valid coded results for the observations conforming to this ObservationDefinitionvalidCodedValueSet : Reference [0..1] « ValueSet »The set of normal coded results for the observations conforming to this ObservationDefinitionnormalCodedValueSet : Reference [0..1] « ValueSet »The set of abnormal coded results for the observation conforming to this ObservationDefinitionabnormalCodedValueSet : Reference [0..1] « ValueSet »The set of critical coded results for the observation conforming to this ObservationDefinitioncriticalCodedValueSet : Reference [0..1] « ValueSet »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 »QuantitativeDetailsCustomary unit used to report quantitative results of observations conforming to this ObservationDefinitioncustomaryUnit : CodeableConcept [0..1] « Codes identifying units of measure. (Strength=Extensible)UCUMCodes+ »SI unit used to report quantitative results of observations conforming to this ObservationDefinitionunit : CodeableConcept [0..1] « Codes identifying units of measure. (Strength=Extensible)UCUMCodes+ »Factor for converting value expressed with SI unit to value expressed with customary unitconversionFactor : decimal [0..1]Number of digits after decimal separator when the results of such observations are of type QuantitydecimalPrecision : integer [0..1]QualifiedIntervalThe category of interval of values for continuous or ordinal observations conforming to this ObservationDefinitioncategory : code [0..1] « Codes identifying the category of observation range. (Strength=Required)ObservationRangeCategory! »The low and high values determining the interval. There may be only one of the tworange : Range [0..1]Codes to indicate the health context the range applies to. For example, the normal or therapeutic rangecontext : CodeableConcept [0..1] « Code identifying the health context of a range. (Strength=Extensible)ObservationReferenceRangeMean...+ »Codes to indicate the target population this reference range applies toappliesTo : CodeableConcept [0..*] « Codes identifying the population the reference range applies to. (Strength=Example) ObservationReferenceRangeAppl...?? »Sex of the population the range applies togender : code [0..1] « The gender of a person used for administrative purposes. (Strength=Required)AdministrativeGender! »The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says soage : Range [0..1]The gestational age to which this reference range is applicable, in the context of pregnancygestationalAge : Range [0..1]Text based condition for which the reference range is validcondition : string [0..1]ComponentDescribes what will be observedcode : CodeableConcept [1..1] « Codes identifying names of simple observations. (Strength=Example)LOINCCodes?? »The data types allowed for the value element of the instance of this component observationspermittedDataType : code [0..*] « Permitted data type for observation value. (Strength=Required)ObservationDataType! »Characteristics for quantitative results of this observationquantitativeDetails[0..1]Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinitionqualifiedInterval[0..*]The quantitative details specifiedquantitativeDetails[0..1]The qualified interval specifiedqualifiedInterval[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 -->
 <title value="[string]"/><!-- 0..1 Name for this ObservationDefinition (Human friendly) -->
 <derivedFromCanonical><!-- 0..* canonical(ObservationDefinition) Based on FHIR definition of another observation --></derivedFromCanonical>
 <derivedFromUri value="[uri]"/><!-- 0..* Based on external definition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of subject for the defined observation --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date status first applied -->
 <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 Last review date for the ObservationDefinition -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the ObservationDefinition --></effectivePeriod>
 <performerType><!-- 0..1 CodeableConcept Desired kind of performer for such kind of observation --></performerType>
 <category><!-- 0..* CodeableConcept Category 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 -->
 <bodySite><!-- 0..1 CodeableConcept Body part to be observed --></bodySite>
 <method><!-- 0..1 CodeableConcept Method used to produce the observation --></method>
 <specimen><!-- 0..1 Reference(SpecimenDefinition) Kind of specimen used by this type of observation --></specimen>
 <device><!-- 0..1 Reference(Device) Measurement device --></device>
 <preferredReportName value="[string]"/><!-- 0..1 Preferred report name -->
 <quantitativeDetails>  <!-- 0..1 Characteristics of quantitative results -->
  <customaryUnit><!-- 0..1 CodeableConcept Customary unit for quantitative results --></customaryUnit>
  <unit><!-- 0..1 CodeableConcept SI unit for quantitative results --></unit>
  <conversionFactor value="[decimal]"/><!-- 0..1 SI to Customary unit conversion factor -->
  <decimalPrecision value="[integer]"/><!-- 0..1 Decimal precision of observation quantitative results -->
 </quantitativeDetails>
 <qualifiedInterval>  <!-- 0..* Qualified range for continuous and ordinal observation results -->
  <category value="[code]"/><!-- 0..1 reference | critical | absolute -->
  <range><!-- 0..1 Range The interval itself, for continuous or ordinal observations --></range>
  <context><!-- 0..1 CodeableConcept Range context qualifier --></context>
  <appliesTo><!-- 0..* CodeableConcept Targetted population of the range --></appliesTo>
  <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
  <age><!-- 0..1 Range Applicable age range, if relevant --></age>
  <gestationalAge><!-- 0..1 Range Applicable gestational age range, if relevant --></gestationalAge>
  <condition value="[string]"/><!-- 0..1 Condition associated with the reference range -->
 </qualifiedInterval>
 <validCodedValueSet><!-- 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition --></validCodedValueSet>
 <normalCodedValueSet><!-- 0..1 Reference(ValueSet) Value set of normal coded values for the observations conforming to this ObservationDefinition --></normalCodedValueSet>
 <abnormalCodedValueSet><!-- 0..1 Reference(ValueSet) Value set of abnormal coded values for the observations conforming to this ObservationDefinition --></abnormalCodedValueSet>
 <criticalCodedValueSet><!-- 0..1 Reference(ValueSet) Value set of critical coded values for the observations conforming to this ObservationDefinition --></criticalCodedValueSet>
 <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 Quantitative details --></quantitativeDetails>
  <qualifiedInterval><!-- 0..* Content as for ObservationDefinition.qualifiedInterval Qualified interval --></qualifiedInterval>
 </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
  "title" : "<string>", // Name for this ObservationDefinition (Human friendly)
  "derivedFromCanonical" : [{ canonical(ObservationDefinition) }], // Based on FHIR definition of another observation
  "derivedFromUri" : ["<uri>"], // Based on external definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // If for testing purposes, not real usage
  // subject[x]: Type of subject for the defined observation. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date status first applied
  "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>", // Last review date for the ObservationDefinition
  "effectivePeriod" : { Period }, // The effective date range for the ObservationDefinition
  "performerType" : { CodeableConcept }, // Desired kind of performer for such kind of observation
  "category" : [{ CodeableConcept }], // Category 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
  "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) }, // Measurement device
  "preferredReportName" : "<string>", // Preferred report name
  "quantitativeDetails" : { // Characteristics of quantitative results
    "customaryUnit" : { CodeableConcept }, // Customary unit for quantitative results
    "unit" : { CodeableConcept }, // SI unit for quantitative results
    "conversionFactor" : <decimal>, // SI to Customary unit conversion factor
    "decimalPrecision" : <integer> // Decimal precision of observation quantitative results
  },
  "qualifiedInterval" : [{ // Qualified range for continuous and ordinal observation results
    "category" : "<code>", // reference | critical | absolute
    "range" : { Range }, // The interval itself, for continuous or ordinal observations
    "context" : { CodeableConcept }, // Range context qualifier
    "appliesTo" : [{ CodeableConcept }], // Targetted population of the range
    "gender" : "<code>", // male | female | other | unknown
    "age" : { Range }, // Applicable age range, if relevant
    "gestationalAge" : { Range }, // Applicable gestational age range, if relevant
    "condition" : "<string>" // Condition associated with the reference range
  }],
  "validCodedValueSet" : { Reference(ValueSet) }, // Value set of valid coded values for the observations conforming to this ObservationDefinition
  "normalCodedValueSet" : { Reference(ValueSet) }, // Value set of normal coded values for the observations conforming to this ObservationDefinition
  "abnormalCodedValueSet" : { Reference(ValueSet) }, // Value set of abnormal coded values for the observations conforming to this ObservationDefinition
  "criticalCodedValueSet" : { Reference(ValueSet) }, // Value set of critical coded values for the observations conforming to this ObservationDefinition
  "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 }, // Quantitative details
    "qualifiedInterval" : [{ Content as for ObservationDefinition.qualifiedInterval }] // Qualified interval
  }]
}

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.title [ string ]; # 0..1 Name for this ObservationDefinition (Human friendly)
  fhir:ObservationDefinition.derivedFromCanonical [ canonical(ObservationDefinition) ], ... ; # 0..* Based on FHIR definition of another observation
  fhir:ObservationDefinition.derivedFromUri [ uri ], ... ; # 0..* Based on external definition
  fhir:ObservationDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ObservationDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  # ObservationDefinition.subject[x] : 0..1 Type of subject for the defined observation. One of these 2
    fhir:ObservationDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:ObservationDefinition.subjectReference [ Reference(Group) ]
  fhir:ObservationDefinition.date [ dateTime ]; # 0..1 Date status first applied
  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 Last review date for the ObservationDefinition
  fhir:ObservationDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the ObservationDefinition
  fhir:ObservationDefinition.performerType [ CodeableConcept ]; # 0..1 Desired kind of performer for such kind of observation
  fhir:ObservationDefinition.category [ CodeableConcept ], ... ; # 0..* Category 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
  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..1 Kind of specimen used by this type of observation
  fhir:ObservationDefinition.device [ Reference(Device) ]; # 0..1 Measurement device
  fhir:ObservationDefinition.preferredReportName [ string ]; # 0..1 Preferred report name
  fhir:ObservationDefinition.quantitativeDetails [ # 0..1 Characteristics of quantitative results
    fhir:ObservationDefinition.quantitativeDetails.customaryUnit [ CodeableConcept ]; # 0..1 Customary unit for quantitative results
    fhir:ObservationDefinition.quantitativeDetails.unit [ CodeableConcept ]; # 0..1 SI unit for quantitative results
    fhir:ObservationDefinition.quantitativeDetails.conversionFactor [ decimal ]; # 0..1 SI to Customary unit conversion factor
    fhir:ObservationDefinition.quantitativeDetails.decimalPrecision [ integer ]; # 0..1 Decimal precision of observation quantitative results
  ];
  fhir:ObservationDefinition.qualifiedInterval [ # 0..* Qualified range for continuous and ordinal observation results
    fhir:ObservationDefinition.qualifiedInterval.category [ code ]; # 0..1 reference | critical | absolute
    fhir:ObservationDefinition.qualifiedInterval.range [ Range ]; # 0..1 The interval itself, for continuous or ordinal observations
    fhir:ObservationDefinition.qualifiedInterval.context [ CodeableConcept ]; # 0..1 Range context qualifier
    fhir:ObservationDefinition.qualifiedInterval.appliesTo [ CodeableConcept ], ... ; # 0..* Targetted population of the range
    fhir:ObservationDefinition.qualifiedInterval.gender [ code ]; # 0..1 male | female | other | unknown
    fhir:ObservationDefinition.qualifiedInterval.age [ Range ]; # 0..1 Applicable age range, if relevant
    fhir:ObservationDefinition.qualifiedInterval.gestationalAge [ Range ]; # 0..1 Applicable gestational age range, if relevant
    fhir:ObservationDefinition.qualifiedInterval.condition [ string ]; # 0..1 Condition associated with the reference range
  ], ...;
  fhir:ObservationDefinition.validCodedValueSet [ Reference(ValueSet) ]; # 0..1 Value set of valid coded values for the observations conforming to this ObservationDefinition
  fhir:ObservationDefinition.normalCodedValueSet [ Reference(ValueSet) ]; # 0..1 Value set of normal coded values for the observations conforming to this ObservationDefinition
  fhir:ObservationDefinition.abnormalCodedValueSet [ Reference(ValueSet) ]; # 0..1 Value set of abnormal coded values for the observations conforming to this ObservationDefinition
  fhir:ObservationDefinition.criticalCodedValueSet [ Reference(ValueSet) ]; # 0..1 Value set of critical coded values for the observations conforming to this ObservationDefinition
  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 Quantitative details
    fhir:ObservationDefinition.component.qualifiedInterval [ See ObservationDefinition.qualifiedInterval ], ... ; # 0..* Qualified interval
  ], ...;
]

Changes since Release 3

ObservationDefinition
ObservationDefinition.url
  • Added Element
ObservationDefinition.identifier
  • Max Cardinality changed from * to 1
ObservationDefinition.version
  • Added Element
ObservationDefinition.title
  • Added Element
ObservationDefinition.derivedFromCanonical
  • Added Element
ObservationDefinition.derivedFromUri
  • Added Element
ObservationDefinition.status
  • Added Mandatory Element
ObservationDefinition.experimental
  • Added Element
ObservationDefinition.subject[x]
  • 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.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.2.0
ObservationDefinition.bodySite
  • Added Element
ObservationDefinition.specimen
  • Added Element
ObservationDefinition.device
  • Added Element
ObservationDefinition.qualifiedInterval.category
  • Change value set from http://hl7.org/fhir/ValueSet/observation-range-category|4.0.0 to http://hl7.org/fhir/ValueSet/observation-range-category|4.2.0
ObservationDefinition.qualifiedInterval.gender
  • Change value set from http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0 to http://hl7.org/fhir/ValueSet/administrative-gender|4.2.0
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.qualifiedInterval
  • Added Element

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

8.26.4.1 Terminology Bindings

PathDefinitionTypeReference
ObservationDefinition.status Codes identifying the state of an ObservationDefinition.RequiredPublicationStatus
ObservationDefinition.jurisdiction Codes for country, country subdivision and region for indicating where a resource is intended to be used.ExtensibleJurisdiction ValueSet
ObservationDefinition.category Codes for high level observation categories.ExampleObservationCategoryCodes
ObservationDefinition.code
ObservationDefinition.component.code 		Codes identifying names of simple observations.ExampleLOINCCodes
ObservationDefinition.permittedDataType
ObservationDefinition.component.permittedDataType 		Permitted data type for observation value.RequiredObservationDataType
ObservationDefinition.bodySite SNOMED CT body structures.ExampleSNOMEDCTBodyStructures
ObservationDefinition.method Methods for simple observations.ExampleObservationMethods
ObservationDefinition.quantitativeDetails.customaryUnit
ObservationDefinition.quantitativeDetails.unit 		Codes identifying units of measure.ExtensibleUCUMCodes
ObservationDefinition.qualifiedInterval.category Codes identifying the category of observation range.RequiredObservationRangeCategory
ObservationDefinition.qualifiedInterval.context Code identifying the health context of a range.ExtensibleObservationReferenceRangeMeaningCodes
ObservationDefinition.qualifiedInterval.appliesTo Codes identifying the population the reference range applies to.ExampleObservationReferenceRangeAppliesToCodes
ObservationDefinition.qualifiedInterval.gender The gender of a person used for administrative purposes.RequiredAdministrativeGender

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.

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