This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Orders and Observations Work Group | Maturity Level: 1 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
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.
This resource relates to these other resource:.
This resource is referenced by ActivityDefinition, CatalogEntry, ClinicalUseIssue, itself and RegulatedAuthorization.
This resource does not implement any patterns.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ObservationDefinition | TU | DomainResource | Definition of an observation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
url | Σ | 0..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) |
identifier | Σ | 0..1 | Identifier | Business identifier of the ObservationDefinition |
version | Σ | 0..1 | string | Business version of the ObservationDefinition |
title | Σ | 0..1 | string | Name for this ObservationDefinition (Human friendly) |
derivedFromCanonical | Σ | 0..* | canonical(ObservationDefinition) | Based on FHIR definition of another observation |
derivedFromUri | Σ | 0..* | uri | Based on external definition |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | ?!Σ | 0..1 | boolean | If for testing purposes, not real usage |
subject[x] | Σ | 0..1 | Type of subject for the defined observation | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | Σ | 0..1 | dateTime | Date status first applied |
publisher | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The name of the individual or organization that published the ObservationDefinition |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the ObservationDefinition | |
useContext | 0..* | UsageContext | Content intends to support these contexts | |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for this ObservationDefinition (if applicable) Jurisdiction (Extensible) |
purpose | 0..1 | markdown | Why this ObservationDefinition is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When ObservationDefinition was approved by publisher | |
lastReviewDate | 0..1 | date | Date on which the asset content was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | The effective date range for the ObservationDefinition |
performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer for such kind of observation |
category | Σ | 0..* | CodeableConcept | General type of observation Observation Category Codes (Example) |
code | Σ | 1..1 | CodeableConcept | Type of observation LOINC Codes (Example) |
permittedDataType | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period ObservationDataType (Required) | |
multipleResultsAllowed | 0..1 | boolean | Multiple results allowed for conforming observations | |
bodySite | 0..1 | CodeableConcept | Body part to be observed SNOMED CT Body Structures (Example) | |
method | 0..1 | CodeableConcept | Method used to produce the observation Observation Methods (Example) | |
specimen | 0..1 | Reference(SpecimenDefinition) | Kind of specimen used by this type of observation | |
device | 0..1 | Reference(Device) | Measurement device | |
preferredReportName | 0..1 | string | The preferred name to be used when reporting the observation results | |
quantitativeDetails | 0..1 | BackboneElement | Characteristics of quantitative results | |
customaryUnit | 0..1 | CodeableConcept | Customary unit for quantitative results UCUM Codes (Extensible) | |
unit | 0..1 | CodeableConcept | SI unit for quantitative results UCUM Codes (Extensible) | |
conversionFactor | 0..1 | decimal | SI to Customary unit conversion factor | |
decimalPrecision | 0..1 | integer | Decimal precision of observation quantitative results | |
qualifiedInterval | 0..* | BackboneElement | Qualified range for continuous and ordinal observation results | |
category | 0..1 | code | reference | critical | absolute ObservationRangeCategory (Required) | |
range | 0..1 | Range | The interval itself, for continuous or ordinal observations | |
context | 0..1 | CodeableConcept | Range context qualifier Observation Reference Range Meaning Codes (Extensible) | |
appliesTo | 0..* | CodeableConcept | Targetted population of the range Observation Reference Range Applies To Codes (Example) | |
gender | 0..1 | code | male | female | other | unknown AdministrativeGender (Required) | |
age | 0..1 | Range | Applicable age range, if relevant | |
gestationalAge | 0..1 | Range | Applicable gestational age range, if relevant | |
condition | 0..1 | string | Condition associated with the reference range | |
validCodedValueSet | 0..1 | Reference(ValueSet) | Value set of valid coded values for the observations conforming to this ObservationDefinition | |
normalCodedValueSet | 0..1 | Reference(ValueSet) | Value set of normal coded values for the observations conforming to this ObservationDefinition | |
abnormalCodedValueSet | 0..1 | Reference(ValueSet) | Value set of abnormal coded values for the observations conforming to this ObservationDefinition | |
criticalCodedValueSet | 0..1 | Reference(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..* | BackboneElement | Component results | |
code | 1..1 | CodeableConcept | Type of observation LOINC Codes (Example) | |
permittedDataType | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period ObservationDataType (Required) | |
quantitativeDetails | 0..1 | see quantitativeDetails | Characteristics of quantitative results | |
qualifiedInterval | 0..* | see qualifiedInterval | Qualified range for continuous and ordinal observation results | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<ObservationDefinition xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) --> <identifier><!-- 0..1 Identifier Business identifier of the ObservationDefinition --></identifier> <version value="[string]"/><!-- 0..1 Business version of the ObservationDefinition --> <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 Date on which the asset content was last reviewed --> <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 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..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 The preferred name to be used when reporting the observation results --> <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 Characteristics of quantitative results --></quantitativeDetails> <qualifiedInterval><!-- 0..* Content as for ObservationDefinition.qualifiedInterval Qualified range for continuous and ordinal observation results --></qualifiedInterval> </component> </ObservationDefinition>
JSON Template
{ "resourceType" : "ObservationDefinition", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Logical canonical URL to reference this ObservationDefinition (globally unique) "identifier" : { Identifier }, // Business identifier of the ObservationDefinition "version" : "<string>", // Business version of the ObservationDefinition "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>", // Date on which the asset content was last reviewed "effectivePeriod" : { Period }, // The effective date range for the ObservationDefinition "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) }, // Measurement device "preferredReportName" : "<string>", // The preferred name to be used when reporting the observation results "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 }, // Characteristics of quantitative results "qualifiedInterval" : [{ Content as for ObservationDefinition.qualifiedInterval }] // Qualified range for continuous and ordinal observation results }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:ObservationDefinition; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:ObservationDefinition.url [ uri ]; # 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) fhir:ObservationDefinition.identifier [ Identifier ]; # 0..1 Business identifier of the ObservationDefinition fhir:ObservationDefinition.version [ string ]; # 0..1 Business version of the ObservationDefinition fhir:ObservationDefinition.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 Date on which the asset content was last reviewed 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..* 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..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 The preferred name to be used when reporting the observation results 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 Characteristics of quantitative results fhir:ObservationDefinition.component.qualifiedInterval [ See ObservationDefinition.qualifiedInterval ], ... ; # 0..* Qualified range for continuous and ordinal observation results ], ...; ]
Changes since R3
ObservationDefinition | |
ObservationDefinition.url |
|
ObservationDefinition.identifier |
|
ObservationDefinition.version |
|
ObservationDefinition.title |
|
ObservationDefinition.derivedFromCanonical |
|
ObservationDefinition.derivedFromUri |
|
ObservationDefinition.status |
|
ObservationDefinition.experimental |
|
ObservationDefinition.subject[x] |
|
ObservationDefinition.date |
|
ObservationDefinition.publisher |
|
ObservationDefinition.contact |
|
ObservationDefinition.description |
|
ObservationDefinition.useContext |
|
ObservationDefinition.jurisdiction |
|
ObservationDefinition.purpose |
|
ObservationDefinition.copyright |
|
ObservationDefinition.approvalDate |
|
ObservationDefinition.lastReviewDate |
|
ObservationDefinition.effectivePeriod |
|
ObservationDefinition.performerType |
|
ObservationDefinition.permittedDataType |
|
ObservationDefinition.bodySite |
|
ObservationDefinition.specimen |
|
ObservationDefinition.device |
|
ObservationDefinition.qualifiedInterval.category |
|
ObservationDefinition.qualifiedInterval.gender |
|
ObservationDefinition.hasMember |
|
ObservationDefinition.component |
|
ObservationDefinition.component.code |
|
ObservationDefinition.component.permittedDataType |
|
ObservationDefinition.component.quantitativeDetails |
|
ObservationDefinition.component.qualifiedInterval |
|
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ObservationDefinition | TU | DomainResource | Definition of an observation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
url | Σ | 0..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) |
identifier | Σ | 0..1 | Identifier | Business identifier of the ObservationDefinition |
version | Σ | 0..1 | string | Business version of the ObservationDefinition |
title | Σ | 0..1 | string | Name for this ObservationDefinition (Human friendly) |
derivedFromCanonical | Σ | 0..* | canonical(ObservationDefinition) | Based on FHIR definition of another observation |
derivedFromUri | Σ | 0..* | uri | Based on external definition |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | ?!Σ | 0..1 | boolean | If for testing purposes, not real usage |
subject[x] | Σ | 0..1 | Type of subject for the defined observation | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | Σ | 0..1 | dateTime | Date status first applied |
publisher | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The name of the individual or organization that published the ObservationDefinition |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the ObservationDefinition | |
useContext | 0..* | UsageContext | Content intends to support these contexts | |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for this ObservationDefinition (if applicable) Jurisdiction (Extensible) |
purpose | 0..1 | markdown | Why this ObservationDefinition is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When ObservationDefinition was approved by publisher | |
lastReviewDate | 0..1 | date | Date on which the asset content was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | The effective date range for the ObservationDefinition |
performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer for such kind of observation |
category | Σ | 0..* | CodeableConcept | General type of observation Observation Category Codes (Example) |
code | Σ | 1..1 | CodeableConcept | Type of observation LOINC Codes (Example) |
permittedDataType | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period ObservationDataType (Required) | |
multipleResultsAllowed | 0..1 | boolean | Multiple results allowed for conforming observations | |
bodySite | 0..1 | CodeableConcept | Body part to be observed SNOMED CT Body Structures (Example) | |
method | 0..1 | CodeableConcept | Method used to produce the observation Observation Methods (Example) | |
specimen | 0..1 | Reference(SpecimenDefinition) | Kind of specimen used by this type of observation | |
device | 0..1 | Reference(Device) | Measurement device | |
preferredReportName | 0..1 | string | The preferred name to be used when reporting the observation results | |
quantitativeDetails | 0..1 | BackboneElement | Characteristics of quantitative results | |
customaryUnit | 0..1 | CodeableConcept | Customary unit for quantitative results UCUM Codes (Extensible) | |
unit | 0..1 | CodeableConcept | SI unit for quantitative results UCUM Codes (Extensible) | |
conversionFactor | 0..1 | decimal | SI to Customary unit conversion factor | |
decimalPrecision | 0..1 | integer | Decimal precision of observation quantitative results | |
qualifiedInterval | 0..* | BackboneElement | Qualified range for continuous and ordinal observation results | |
category | 0..1 | code | reference | critical | absolute ObservationRangeCategory (Required) | |
range | 0..1 | Range | The interval itself, for continuous or ordinal observations | |
context | 0..1 | CodeableConcept | Range context qualifier Observation Reference Range Meaning Codes (Extensible) | |
appliesTo | 0..* | CodeableConcept | Targetted population of the range Observation Reference Range Applies To Codes (Example) | |
gender | 0..1 | code | male | female | other | unknown AdministrativeGender (Required) | |
age | 0..1 | Range | Applicable age range, if relevant | |
gestationalAge | 0..1 | Range | Applicable gestational age range, if relevant | |
condition | 0..1 | string | Condition associated with the reference range | |
validCodedValueSet | 0..1 | Reference(ValueSet) | Value set of valid coded values for the observations conforming to this ObservationDefinition | |
normalCodedValueSet | 0..1 | Reference(ValueSet) | Value set of normal coded values for the observations conforming to this ObservationDefinition | |
abnormalCodedValueSet | 0..1 | Reference(ValueSet) | Value set of abnormal coded values for the observations conforming to this ObservationDefinition | |
criticalCodedValueSet | 0..1 | Reference(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..* | BackboneElement | Component results | |
code | 1..1 | CodeableConcept | Type of observation LOINC Codes (Example) | |
permittedDataType | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period ObservationDataType (Required) | |
quantitativeDetails | 0..1 | see quantitativeDetails | Characteristics of quantitative results | |
qualifiedInterval | 0..* | see qualifiedInterval | Qualified range for continuous and ordinal observation results | |
Documentation for this format |
XML Template
<ObservationDefinition xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) --> <identifier><!-- 0..1 Identifier Business identifier of the ObservationDefinition --></identifier> <version value="[string]"/><!-- 0..1 Business version of the ObservationDefinition --> <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 Date on which the asset content was last reviewed --> <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 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..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 The preferred name to be used when reporting the observation results --> <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 Characteristics of quantitative results --></quantitativeDetails> <qualifiedInterval><!-- 0..* Content as for ObservationDefinition.qualifiedInterval Qualified range for continuous and ordinal observation results --></qualifiedInterval> </component> </ObservationDefinition>
JSON Template
{ "resourceType" : "ObservationDefinition", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Logical canonical URL to reference this ObservationDefinition (globally unique) "identifier" : { Identifier }, // Business identifier of the ObservationDefinition "version" : "<string>", // Business version of the ObservationDefinition "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>", // Date on which the asset content was last reviewed "effectivePeriod" : { Period }, // The effective date range for the ObservationDefinition "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) }, // Measurement device "preferredReportName" : "<string>", // The preferred name to be used when reporting the observation results "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 }, // Characteristics of quantitative results "qualifiedInterval" : [{ Content as for ObservationDefinition.qualifiedInterval }] // Qualified range for continuous and ordinal observation results }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:ObservationDefinition; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:ObservationDefinition.url [ uri ]; # 0..1 Logical canonical URL to reference this ObservationDefinition (globally unique) fhir:ObservationDefinition.identifier [ Identifier ]; # 0..1 Business identifier of the ObservationDefinition fhir:ObservationDefinition.version [ string ]; # 0..1 Business version of the ObservationDefinition fhir:ObservationDefinition.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 Date on which the asset content was last reviewed 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..* 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..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 The preferred name to be used when reporting the observation results 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 Characteristics of quantitative results fhir:ObservationDefinition.component.qualifiedInterval [ See ObservationDefinition.qualifiedInterval ], ... ; # 0..* Qualified range for continuous and ordinal observation results ], ...; ]
Changes since Release 3
ObservationDefinition | |
ObservationDefinition.url |
|
ObservationDefinition.identifier |
|
ObservationDefinition.version |
|
ObservationDefinition.title |
|
ObservationDefinition.derivedFromCanonical |
|
ObservationDefinition.derivedFromUri |
|
ObservationDefinition.status |
|
ObservationDefinition.experimental |
|
ObservationDefinition.subject[x] |
|
ObservationDefinition.date |
|
ObservationDefinition.publisher |
|
ObservationDefinition.contact |
|
ObservationDefinition.description |
|
ObservationDefinition.useContext |
|
ObservationDefinition.jurisdiction |
|
ObservationDefinition.purpose |
|
ObservationDefinition.copyright |
|
ObservationDefinition.approvalDate |
|
ObservationDefinition.lastReviewDate |
|
ObservationDefinition.effectivePeriod |
|
ObservationDefinition.performerType |
|
ObservationDefinition.permittedDataType |
|
ObservationDefinition.bodySite |
|
ObservationDefinition.specimen |
|
ObservationDefinition.device |
|
ObservationDefinition.qualifiedInterval.category |
|
ObservationDefinition.qualifiedInterval.gender |
|
ObservationDefinition.hasMember |
|
ObservationDefinition.component |
|
ObservationDefinition.component.code |
|
ObservationDefinition.component.permittedDataType |
|
ObservationDefinition.component.quantitativeDetails |
|
ObservationDefinition.component.qualifiedInterval |
|
See the Full Difference for further information
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
Path | Definition | Type | Reference |
---|---|---|---|
ObservationDefinition.status | Codes identifying the state of an ObservationDefinition. | Required | PublicationStatus |
ObservationDefinition.jurisdiction | Codes for country, country subdivision and region for indicating where a resource is intended to be used. | Extensible | Jurisdiction ValueSet |
ObservationDefinition.category | Codes for high level observation categories. | Example | ObservationCategoryCodes |
ObservationDefinition.code ObservationDefinition.component.code | Codes identifying names of simple observations. | Example | LOINCCodes |
ObservationDefinition.permittedDataType ObservationDefinition.component.permittedDataType | Permitted data type for observation value. | Required | ObservationDataType |
ObservationDefinition.bodySite | SNOMED CT body structures. | Example | SNOMEDCTBodyStructures |
ObservationDefinition.method | Methods for simple observations. | Example | ObservationMethods |
ObservationDefinition.quantitativeDetails.customaryUnit ObservationDefinition.quantitativeDetails.unit | Codes identifying units of measure. | Extensible | UCUMCodes |
ObservationDefinition.qualifiedInterval.category | Codes identifying the category of observation range. | Required | ObservationRangeCategory |
ObservationDefinition.qualifiedInterval.context | Code identifying the health context of a range. | Extensible | ObservationReferenceRangeMeaningCodes |
ObservationDefinition.qualifiedInterval.appliesTo | Codes identifying the population the reference range applies to. | Example | ObservationReferenceRangeAppliesToCodes |
ObservationDefinition.qualifiedInterval.gender | The gender of a person used for administrative purposes. | Required | AdministrativeGender |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
category | token | Category (class) of observation | ObservationDefinition.category | |
code | token | Observation code | ObservationDefinition.code | |
experimental N | token | Not for genuine usage (true) | ObservationDefinition.experimental | |
identifier | token | The unique identifier associated with the specimen definition | ObservationDefinition.identifier | |
method | token | Method of observation | ObservationDefinition.method | |
status N | token | Publication status of the ObservationDefinition: draft, active, retired, unknown | ObservationDefinition.status | |
title N | string | Human-friendly name of the ObservationDefinition | ObservationDefinition.title | |
url N | uri | The uri that identifies the observation definition | ObservationDefinition.url |