Observation - FHIR Resource (stu3)


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

Validate an Observation FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
basedOntrueReference "basedOn" : [{ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
bodySitefalseCodeableConcept Observed body part
categorytrueCodeableConcept Classification of type of observation
codefalseCodeableConcept Type of observation (code / type)
commentfalsestring Comments about result
componenttrueData Type Component results
contextfalseReference Healthcare event during which this observation is made
dataAbsentReasonfalseCodeableConcept C? Why the result is missing
devicefalseReference (Measurement) Device
effectiveDateTimefalsedateTime "effectiveDateTime" : "<dateTime>",
effectivePeriodfalsePeriod "effectivePeriod" : { Period },
identifiertrueIdentifier Business Identifier for 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 },
valueBooleanfalseboolean "valueBoolean" : <boolean>,
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 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 the like so:

https://api.1up.health/fhir/stu3/Observation?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
based-onreferencebasedOn
categorytextcategory
codetextcode
code-value-conceptcomposite
code-value-datecomposite
code-value-quantitycomposite
code-value-stringcomposite
combo-codetextcode, component.code
combo-code-value-conceptcomposite, component
combo-code-value-quantitycomposite, component
combo-data-absent-reasontextdataAbsentReason, component.dataAbsentReason
combo-value-concepttextvalue.as
combo-value-quantityquantityvalue.as
component-codetextcomponent.code
component-code-value-conceptcompositecomponent
component-code-value-quantitycompositecomponent
component-data-absent-reasontextcomponent.dataAbsentReason
component-value-concepttextcomponent.value.as
component-value-quantityquantitycomponent.value.as
contextreferencecontext
data-absent-reasontextdataAbsentReason
datedateeffective
devicereferencedevice
encounterreferencecontext
identifiertextidentifier
methodtextmethod
patientreferencesubject
performerreferenceperformer
relatedcompositerelated
related-targetreferencerelated.target
related-typetextrelated.type
specimenreferencespecimen
statustextstatus
subjectreferencesubject
value-concepttextvalue.as
value-datedatevalue.as
value-quantityquantityvalue.as
value-stringtextvalue.as