Observation - FHIR Resource (stu3)
This Observation Resource uses the FHIR API standard for access and structure.
Validate an Observation FHIR Resource (stu3)
Observation Attributes
AttributeField is listTypeDescription
Description: Comments about result
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"comment": Learn more about the (Observation) comment FHIR attribute
Description: Type of observation (code / type)
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": {
"coding": [
{
"code": "29463-7",
"system": "http://loinc.org",
"display": "Body Weight"
},
{
"code": "3141-9",
"system": "http://loinc.org",
"display": "Body weight Measured"
},
{
"code": "27113001",
"system": "http://snomed.info/sct",
"display": "Body weight"
},
{
"code": "body-weight",
"system": "http://acme.org/devices/clinical-codes",
"display": "Body Weight"
}
]
}Learn more about the (Observation) code FHIR attribute
Description: High, low, normal, etc.
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"interpretation": Learn more about the (Observation) interpretation FHIR attribute
Description: Date/Time this was made available
FHIR Version: stu3
Attribute Type : instant
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"issued": Learn more about the (Observation) issued FHIR attribute
Description: Resource related to this observation
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"related": Learn more about the (Observation) related FHIR attribute
Description: Who is responsible for the observation
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performer": Learn more about the (Observation) performer FHIR attribute
Description: Observed body part
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"bodySite": Learn more about the (Observation) bodySite FHIR attribute
Description: C? Why the result is missing
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dataAbsentReason": Learn more about the (Observation) dataAbsentReason FHIR attribute
Description: Who and/or what this is about
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example"
}Learn more about the (Observation) subject FHIR attribute
Description: Classification of type of observation
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
{
"coding": [
{
"code": "vital-signs",
"system": "http://hl7.org/fhir/observation-category",
"display": "Vital Signs"
}
]
}
]Learn more about the (Observation) category FHIR attribute
Description: "basedOn" : [{ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"basedOn": Learn more about the (Observation) basedOn FHIR attribute
Description: "valueBoolean" : <boolean>,
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valueBoolean": Learn more about the (Observation) valueBoolean FHIR attribute
Description: "effectiveDateTime" : "<dateTime>",
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"effectiveDateTime": "2016-03-28"Learn more about the (Observation) effectiveDateTime FHIR attribute
Description: How it was done
FHIR Version: stu3
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 (Observation) method FHIR attribute
Description: "valueString" : "<string>",
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valueString": Learn more about the (Observation) valueString FHIR attribute
Description: registered | preliminary | final | amended +
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "final"Learn more about the (Observation) status FHIR attribute
Description: "valueCodeableConcept" : { CodeableConcept },
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valueCodeableConcept": Learn more about the (Observation) valueCodeableConcept FHIR attribute
Description: Specimen used for this observation
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"specimen": Learn more about the (Observation) specimen FHIR attribute
Description: "effectivePeriod" : { Period },
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"effectivePeriod": Learn more about the (Observation) effectivePeriod FHIR attribute
Description: Component results
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"component": Learn more about the (Observation) component FHIR attribute
Description: "valueRange" : { Range },
FHIR Version: stu3
Attribute Type : Range
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valueRange": Learn more about the (Observation) valueRange FHIR attribute
Description: (Measurement) Device
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"device": Learn more about the (Observation) device FHIR attribute
Description: "valueDateTime" : "<dateTime>",
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valueDateTime": Learn more about the (Observation) valueDateTime FHIR attribute
Description: "valueSampledData" : { SampledData },
FHIR Version: stu3
Attribute Type : SampledData
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valueSampledData": Learn more about the (Observation) valueSampledData FHIR attribute
Description: "valueTime" : "<time>",
FHIR Version: stu3
Attribute Type : time
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valueTime": Learn more about the (Observation) valueTime FHIR attribute
Description: "valuePeriod" : { Period },
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valuePeriod": Learn more about the (Observation) valuePeriod FHIR attribute
Description: Provides guide for interpretation
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"referenceRange": Learn more about the (Observation) referenceRange FHIR attribute
Description: "valueQuantity" : { Quantity },
FHIR Version: stu3
Attribute Type : Quantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valueQuantity": {
"code": "[lb_av]",
"unit": "lbs",
"value": 185,
"system": "http://unitsofmeasure.org"
}Learn more about the (Observation) valueQuantity FHIR attribute
Description: "valueRatio" : { Ratio },
FHIR Version: stu3
Attribute Type : Ratio
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valueRatio": Learn more about the (Observation) valueRatio FHIR attribute
Description: "valueAttachment" : { Attachment },
FHIR Version: stu3
Attribute Type : Attachment
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"valueAttachment": Learn more about the (Observation) valueAttachment FHIR attribute
Description: Healthcare event during which this observation is made
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": {
"reference": "Encounter/example"
}Learn more about the (Observation) context FHIR attribute
Description: Business Identifier for observation
FHIR Version: stu3
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 (Observation) identifier FHIR attribute
Observation Example
{
"category": [
{
"coding": [
{
"code": "vital-signs",
"system": "http://hl7.org/fhir/observation-category",
"display": "Vital Signs"
}
]
}
],
"status": "final",
"code": {
"coding": [
{
"code": "29463-7",
"system": "http://loinc.org",
"display": "Body Weight"
},
{
"code": "3141-9",
"system": "http://loinc.org",
"display": "Body weight Measured"
},
{
"code": "27113001",
"system": "http://snomed.info/sct",
"display": "Body weight"
},
{
"code": "body-weight",
"system": "http://acme.org/devices/clinical-codes",
"display": "Body Weight"
}
]
},
"resourceType": "Observation",
"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>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://hl7.org/fhir/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Body Weight <span>(Details : {LOINC code '29463-7' = 'Body weight', given as 'Body Weight'}; {LOINC code '3141-9' = 'Body weight Measured', given as 'Body weight Measured'}; {SNOMED CT code '27113001' = 'Body weight', given as 'Body weight'}; {http://acme.org/devices/clinical-codes code 'body-weight' = 'body-weight', given as 'Body Weight'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>context</b>: <a>Encounter/example</a></p><p><b>effective</b>: 28/03/2016</p><p><b>value</b>: 185 lbs<span> (Details: UCUM code [lb_av] = 'lb_av')</span></p></div>"
},
"valueQuantity": {
"code": "[lb_av]",
"unit": "lbs",
"value": 185,
"system": "http://unitsofmeasure.org"
},
"context": {
"reference": "Encounter/example"
},
"effectiveDateTime": "2016-03-28",
"id": "example",
"subject": {
"reference": "Patient/example"
}
}Observation Structure
{
"resourceType" : "Observation",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier for observation
"basedOn" : [{ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
MedicationRequest|NutritionOrder|ProcedureRequest|ReferralRequest) }], // Fulfills plan, proposal or order
"status" : "<code>", // R! registered | preliminary | final | amended +
"category" : [{ CodeableConcept }], // Classification of type of observation
"code" : { CodeableConcept }, // R! Type of observation (code / type)
"subject" : { Reference(Patient|Group|Device|Location) }, // Who and/or what this is about
"context" : { Reference(Encounter|EpisodeOfCare) }, // Healthcare event during which this observation is made
// effective[x]: Clinically relevant time/time-period for observation. One of these 2:
"effectiveDateTime" : "<dateTime>",
"effectivePeriod" : { Period },
"issued" : "<instant>", // Date/Time this was made available
"performer" : [{ Reference(Practitioner|Organization|Patient|RelatedPerson) }], // Who is responsible for the observation
// value[x]: Actual result. One of these 11:
"valueQuantity" : { Quantity },
"valueCodeableConcept" : { CodeableConcept },
"valueString" : "<string>",
"valueBoolean" : <boolean>,
"valueRange" : { Range },
"valueRatio" : { Ratio },
"valueSampledData" : { SampledData },
"valueAttachment" : { Attachment },
"valueTime" : "<time>",
"valueDateTime" : "<dateTime>",
"valuePeriod" : { Period },
"dataAbsentReason" : { CodeableConcept }, // C? Why the result is missing
"interpretation" : { CodeableConcept }, // High, low, normal, etc.
"comment" : "<string>", // Comments about result
"bodySite" : { CodeableConcept }, // Observed body part
"method" : { CodeableConcept }, // How it was done
"specimen" : { Reference(Specimen) }, // Specimen used for this observation
"device" : { Reference(Device|DeviceMetric) }, // (Measurement) Device
"referenceRange" : [{ // Provides guide for interpretation
"low" : { Quantity(SimpleQuantity) }, // C? Low Range, if relevant
"high" : { Quantity(SimpleQuantity) }, // C? High Range, if relevant
"type" : { CodeableConcept }, // Reference range qualifier
"appliesTo" : [{ CodeableConcept }], // Reference range population
"age" : { Range }, // Applicable age range, if relevant
"text" : "<string>" // Text based reference range in an observation
}],
"related" : [{ // Resource related to this observation
"type" : "<code>", // has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
"target" : { Reference(Observation|QuestionnaireResponse|Sequence) } // R! Resource that is related to this one
}],
"component" : [{ // Component results
"code" : { CodeableConcept }, // R! Type of component observation (code / type)
// value[x]: Actual component result. One of these 10:
"valueQuantity" : { Quantity },
"valueCodeableConcept" : { CodeableConcept },
"valueString" : "<string>",
"valueRange" : { Range },
"valueRatio" : { Ratio },
"valueSampledData" : { SampledData },
"valueAttachment" : { Attachment },
"valueTime" : "<time>",
"valueDateTime" : "<dateTime>",
"valuePeriod" : { Period },
"dataAbsentReason" : { CodeableConcept }, // C? Why the component result is missing
"interpretation" : { CodeableConcept }, // High, low, normal, etc.
"referenceRange" : [{ Content as for Observation.referenceRange }] // Provides guide for interpretation of component result
}]
}
Observation Search Parameters
The following search parameters can be used to query Observation resources. Just submit them like so:
https://api.1up.health/fhir/stu3/Observation?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
based-on | reference | basedOn |
category | text | category |
code | text | code |
code-value-concept | composite | |
code-value-date | composite | |
code-value-quantity | composite | |
code-value-string | composite | |
combo-code | text | code, component.code |
combo-code-value-concept | composite | , component |
combo-code-value-quantity | composite | , component |
combo-data-absent-reason | text | dataAbsentReason, component.dataAbsentReason |
combo-value-concept | text | value.as |
combo-value-quantity | quantity | value.as |
component-code | text | component.code |
component-code-value-concept | composite | component |
component-code-value-quantity | composite | component |
component-data-absent-reason | text | component.dataAbsentReason |
component-value-concept | text | component.value.as |
component-value-quantity | quantity | component.value.as |
context | reference | context |
data-absent-reason | text | dataAbsentReason |
date | date | effective |
device | reference | device |
encounter | reference | context |
identifier | text | identifier |
method | text | method |
patient | reference | subject |
performer | reference | performer |
related | composite | related |
related-target | reference | related.target |
related-type | text | related.type |
specimen | reference | specimen |
status | text | status |
subject | reference | subject |
value-concept | text | value.as |
value-date | date | value.as |
value-quantity | quantity | value.as |
value-string | text | value.as |
