ObservationDefinition - FHIR Resource (r4)
This ObservationDefinition Resource uses the FHIR API standard for access and structure.
Validate an ObservationDefinition FHIR Resource (r4)
ObservationDefinition Attributes
AttributeField is listTypeDescription
Description: Category of observation
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": Learn more about the (ObservationDefinition) category FHIR attribute
Description: Type of observation (code / type)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "15074-8",
"display": "Glucose [Moles/volume] in Blood"
}
]
}Learn more about the (ObservationDefinition) code FHIR attribute
Description: Business identifier for this ObservationDefinition instance
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (ObservationDefinition) identifier FHIR attribute
Description: Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"permittedDataType": Learn more about the (ObservationDefinition) permittedDataType FHIR attribute
Description: Multiple results allowed
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"multipleResultsAllowed": Learn more about the (ObservationDefinition) multipleResultsAllowed FHIR attribute
Description: Method used to produce the observation
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"method": Learn more about the (ObservationDefinition) method FHIR attribute
Description: Preferred report name
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"preferredReportName": Learn more about the (ObservationDefinition) preferredReportName FHIR attribute
Description: Characteristics of quantitative results
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"quantitativeDetails": Learn more about the (ObservationDefinition) quantitativeDetails FHIR attribute
Description: Qualified range for continuous and ordinal observation results
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"qualifiedInterval": Learn more about the (ObservationDefinition) qualifiedInterval FHIR attribute
Description: Value set of valid coded values for the observations conforming to this ObservationDefinition
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"validCodedValueSet": Learn more about the (ObservationDefinition) validCodedValueSet FHIR attribute
Description: Value set of normal coded values for the observations conforming to this ObservationDefinition
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"normalCodedValueSet": Learn more about the (ObservationDefinition) normalCodedValueSet FHIR attribute
Description: Value set of abnormal coded values for the observations conforming to this ObservationDefinition
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"abnormalCodedValueSet": Learn more about the (ObservationDefinition) abnormalCodedValueSet FHIR attribute
Description: Value set of critical coded values for the observations conforming to this ObservationDefinition
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"criticalCodedValueSet": Learn more about the (ObservationDefinition) criticalCodedValueSet FHIR attribute
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 |
|---|
