Observation - FHIR Resource (dstu2)


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

Validate an Observation FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
bodySitefalseCodeableConcept# Observed body part
categoryfalseCodeableConcept# Classification of type of observation
codefalseCodeableConcept# Type of observation (code / type)
commentsfalsestring# Comments about result
componenttrueData Type# Component results
dataAbsentReasonfalseCodeableConcept# C? Why the result is missing
devicefalseReference# (Measurement) Device
effectiveDateTimefalsedateTime# "effectiveDateTime" : "<dateTime>",
effectivePeriodfalsePeriod# "effectivePeriod" : { Period },
encounterfalseReference# Healthcare event during which this observation is made
identifiertrueIdentifier# Unique Id for this particular observation
interpretationfalseCodeableConcept# High, low, normal, etc.
issuedfalseinstant# Date/Time this was made available
methodfalseCodeableConcept# How it was done
performertrueReference# Who is responsible for the observation
referenceRangetrueData Type# Provides guide for interpretation
relatedtrueData Type# Resource related to this observation
specimenfalseReference# Specimen used for this observation
statusfalsecode# registered | preliminary | final | amended +
subjectfalseReference# Who and/or what this is about
valueAttachmentfalseAttachment# "valueAttachment" : { Attachment },
valueCodeableConceptfalseCodeableConcept# "valueCodeableConcept" : { CodeableConcept },
valueDateTimefalsedateTime# "valueDateTime" : "<dateTime>",
valuePeriodfalsePeriod# "valuePeriod" : { Period },
valueQuantityfalseQuantity# "valueQuantity" : { Quantity },
valueRangefalseRange# "valueRange" : { Range },
valueRatiofalseRatio# "valueRatio" : { Ratio },
valueSampledDatafalseSampledData# "valueSampledData" : { SampledData },
valueStringfalsestring# "valueString" : "<string>",
valueTimefalsetime# "valueTime" : "<time>",

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 the like so:

https://api.1up.health/fhir/dstu2/Observation?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
categorytextcategory
codetextcode
code-value-[x]composite
component-codetextcomponent.code
component-code-value-[x]composite
component-data-absent-reasontextcomponent.dataAbsentReason
component-value-concepttextcomponent.valueCodeableConcept
component-value-quantityquantitycomponent.valueQuantity
component-value-stringtextcomponent.valueString
data-absent-reasontextdataAbsentReason
datedateeffective[x]
devicereferencedevice
encounterreferenceencounter
identifiertextidentifier
patientreferencesubject
performerreferenceperformer
relatedcomposite
related-targetreferencerelated.target
related-typetextrelated.type
specimenreferencespecimen
statustextstatus
subjectreferencesubject
value-concepttextvalueCodeableConcept
value-datedatevalueDateTime, Observation.valuePeriod
value-quantityquantityvalueQuantity
value-stringtextvalueString