Observation - FHIR Resource (dstu2)

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

Validate an Observation FHIR Resource (dstu2)

Observation Attributes

AttributeField is listTypeDescription

Description: Type of observation (code / type)

FHIR Version: dstu2

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code":

Learn more about the (Observation) code FHIR attribute

Description: High, low, normal, etc.

FHIR Version: dstu2

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: dstu2

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: dstu2

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: dstu2

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: dstu2

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: dstu2

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: dstu2

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subject":

Learn more about the (Observation) subject FHIR attribute

Description: Classification of type of observation

FHIR Version: dstu2

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"category":

Learn more about the (Observation) category FHIR attribute

Description: Comments about result

FHIR Version: dstu2

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"comments":

Learn more about the (Observation) comments FHIR attribute

Description: "effectiveDateTime" : "<dateTime>",

FHIR Version: dstu2

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"effectiveDateTime":

Learn more about the (Observation) effectiveDateTime FHIR attribute

Description: How it was done

FHIR Version: dstu2

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: dstu2

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: dstu2

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status":

Learn more about the (Observation) status FHIR attribute

Description: "valueCodeableConcept" : { CodeableConcept },

FHIR Version: dstu2

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: dstu2

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: dstu2

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: dstu2

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: dstu2

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: dstu2

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: dstu2

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: Healthcare event during which this observation is made

FHIR Version: dstu2

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"encounter":

Learn more about the (Observation) encounter FHIR attribute

Description: "valueSampledData" : { SampledData },

FHIR Version: dstu2

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: dstu2

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: dstu2

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: dstu2

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: dstu2

Attribute Type : Quantity

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"valueQuantity":

Learn more about the (Observation) valueQuantity FHIR attribute

Description: "valueRatio" : { Ratio },

FHIR Version: dstu2

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: dstu2

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: Unique Id for this particular observation

FHIR Version: dstu2

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 Structure


  
{
  "resourceType" : "Observation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique Id for this particular observation
  "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
  "encounter" : { Reference(Encounter) }, // 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 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 result is missing
  "interpretation" : { CodeableConcept }, // High, low, normal, etc.
  "comments" : "<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
    "meaning" : { CodeableConcept }, // Indicates the meaning/use of this range of this range
    "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) } // R!  Resource that is related to this one
  }],
  "component" : [{ // Component results
    "code" : { CodeableConcept }, // C? 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
    "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/dstu2/Observation?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`category`	`text`	`category`
`code`	`text`	`code`
`code-value-[x]`	`composite`
`component-code`	`text`	`component.code`
`component-code-value-[x]`	`composite`
`component-data-absent-reason`	`text`	`component.dataAbsentReason`
`component-value-concept`	`text`	`component.valueCodeableConcept`
`component-value-quantity`	`quantity`	`component.valueQuantity`
`component-value-string`	`text`	`component.valueString`
`data-absent-reason`	`text`	`dataAbsentReason`
`date`	`date`	`effective[x]`
`device`	`reference`	`device`
`encounter`	`reference`	`encounter`
`identifier`	`text`	`identifier`
`patient`	`reference`	`subject`
`performer`	`reference`	`performer`
`related`	`composite`
`related-target`	`reference`	`related.target`
`related-type`	`text`	`related.type`
`specimen`	`reference`	`specimen`
`status`	`text`	`status`
`subject`	`reference`	`subject`
`value-concept`	`text`	`valueCodeableConcept`
`value-date`	`date`	`valueDateTime, Observation.valuePeriod`
`value-quantity`	`quantity`	`valueQuantity`
`value-string`	`text`	`valueString`