ObservationDefinition - FHIR Resource (r4)

This ObservationDefinition Resource uses the FHIR API standard for access and structure.

Validate an ObservationDefinition FHIR Resource (r4)

Validate this ObservationDefinition

Resource Attributes

Attribute	Field is list	Type	Description
abnormalCodedValueSet	false	Reference	# Value set of abnormal coded values for the observations conforming to this ObservationDefinition
category	true	CodeableConcept	# Category of observation
code	false	CodeableConcept	# Type of observation (code / type)
criticalCodedValueSet	false	Reference	# Value set of critical coded values for the observations conforming to this ObservationDefinition
identifier	true	Identifier	# Business identifier for this ObservationDefinition instance
method	false	CodeableConcept	# Method used to produce the observation
multipleResultsAllowed	false	boolean	# Multiple results allowed
normalCodedValueSet	false	Reference	# Value set of normal coded values for the observations conforming to this ObservationDefinition
permittedDataType	true	code	# Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
preferredReportName	false	string	# Preferred report name
qualifiedInterval	true	Data Type	# Qualified range for continuous and ordinal observation results
quantitativeDetails	false	Data Type	# Characteristics of quantitative results
validCodedValueSet	false	Reference	# Value set of valid coded values for the observations conforming to this ObservationDefinition

ObservationDefinition Example

{
  "resourceType": "ObservationDefinition",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>code</b>: Glucose [Moles/volume] in Blood <span>(Details : {LOINC code '15074-8' = 'Glucose [Moles/volume] in Blood', given as 'Glucose [Moles/volume] in Blood'})</span></p></div>"
  },
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "15074-8",
        "display": "Glucose [Moles/volume] in Blood"
      }
    ]
  }
}

ObservationDefinition Structure

{
  "resourceType" : "ObservationDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "category" : [{ CodeableConcept }], // Category of observation
  "code" : { CodeableConcept }, // R!  Type of observation (code / type)
  "identifier" : [{ Identifier }], // Business identifier for this ObservationDefinition instance
  "permittedDataType" : ["<code>"], // Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
  "multipleResultsAllowed" : <boolean>, // Multiple results allowed
  "method" : { CodeableConcept }, // Method used to produce the observation
  "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
}

ObservationDefinition Search Parameters

The following search parameters can be used to query ObservationDefinition resources. Just submit them like so:

https://api.1up.health/fhir/r4/ObservationDefinition?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched