HiMS API Documentation

The Observation resource records a variety of data elements central to determining diagnoses and managing care. Examples of observations include vital signs, laboratory data, imaging, device measurements, personal characteristics such as eye color, and social history such as smoking status.

The Observation resource returns data classes and elements defined for Laboratory in United States Core Data for Interoperability (USCDI v2) containing Tests and Values/Results. It also returns data classes and elements defined for Smoking Status and Vital Signs Systolic blood pressure, Diastolic blood pressure, Heart Rate, Respiratory rate, Body temperature, Body height, Body weight, Pulse oximetry, Inhaled oxygen concentration, BMI Percentile (2 - 20 years), Weight-for-length Percentile (Birth - 36 Months), and Head Occipital-frontal Circumference Percentile (Birth - 36 Months).

• Vital Signs
• Laboratory
• Smoking Status

📘 This endpoint implements the US Core Laboratory Results Observation Profile. The following USCDI data elements are retrievable from this endpoint:

Laboratory:

• Tests
• Values/Results

Smoking Status:

• Smoking Status

Vital Signs:

• Pediatric Weight for Height
• Pediatric BMI for Age
• Pulse Oximetry
• Pediatric Head Occipital-frontal Circumference Percentile
• Body Height
• Body Temperature
• Blood Pressure
• Body Weight
• Heart Rate
• Respiratory Rate

Example requests for observation data are shown below:

Retrieve observations related to a patient

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/Observation?patient={patientId}' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Examples:
GET https://fhir-api.hmsfirst.com/r4/Observation?patient=29355
                    

Response schema

{
  "type": "object",
  "required": [],
  "properties": {
    "resourceType": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "total": {
      "type": "number"
    },
    "link": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "relation": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      }
    },
    "entry": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "fullUrl": {
            "type": "string"
          },
          "resource": {
            "type": "object",
            "required": [],
            "properties": {
              "resourceType": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "meta": {
                "type": "object",
                "required": [],
                "properties": {
                  "versionId": {
                    "type": "string"
                  },
                  "lastUpdated": {
                    "type": "string"
                  },
                  "profile": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              },
              "status": {
                "type": "string"
              },
              "category": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [],
                  "properties": {
                    "coding": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [],
                        "properties": {
                          "system": {
                            "type": "string"
                          },
                          "code": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    "text": {
                      "type": "string"
                    }
                  }
                }
              },
              "code": {
                "type": "object",
                "required": [],
                "properties": {
                  "coding": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [],
                      "properties": {
                        "system": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "text": {
                    "type": "string"
                  }
                }
              },
              "subject": {
                "type": "object",
                "required": [],
                "properties": {
                  "reference": {
                    "type": "string"
                  }
                }
              },
              "effectiveDateTime": {
                "type": "string"
              },
              "performer": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [],
                  "properties": {
                    "reference": {
                      "type": "string"
                    }
                  }
                }
              },
              "valueString": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}