Image Observation

Observation requests and examples

Terminology Bindings

Terminology Detail
Observation.category A code that classifies the general type of observation being made.
Observation.code Describes what was observed. Sometimes this is called the observation "name".
Observation.component Some observations have multiple component observations.

Parameters

Parameter Is Required Description
Id This, or patient. The logical resource ID associated with the resource.
patient This plus code, or ID The patient who has the immunization.
code This plus patient The observations code. Example: code=72166-2
category This plus patient The observations report's category
date No Date range into which the observation falls. Example: date=gt2014-09-24
_revinclude No A request to include any Provenance resource in the bundle.

Smoking Status Requests

Smoking Status by Patient and Code

GET: 'https://api.practicestudio.net/patientportal/fhir/Observation?code=72166-2&patient={Patient_ID}'

Smoking Status by Resource ID

GET: 'https://api.practicestudio.net/patientportal/fhir/Observation/SmokingStatus-{Resource_ID}'

Smoking Status Example Response

Example Smoking Status JSON Response:


{
  "resourceType": "Bundle",
  "meta": {
    "lastUpdated": "2022-08-11T14:48:35.7522978-05:00"
  },
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self"
    }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "Observation",
        "id": "SmokingStatus-10121698",
        "meta": {
          "lastUpdated": "0001-01-01T00:00:00-06:00",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
          ]
        },
        "extension": [
          {
            "url": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
            "valueCode": "unknown"
          }
        ],
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/observation-category",
                "code": "social-history",
                "display": "Social History",
                "userSelected": false
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "72166-2",
              "display": "Tobacco smoking status",
              "userSelected": false
            }
          ]
        },
        "subject": {
          "reference": "Patient/000034"
        },
        "issued": "2022-08-11T14:48:35.753299-05:00",
        "valueCodeableConcept": {
          "extension": [
            {
              "url": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
              "valueCode": "unknown"
            }
          ],
          "coding": [
            {
              "extension": [
                {
                  "url": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                  "valueCode": "unknown"
                }
              ],
              "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
              "code": "unknown",
              "display": "Unknown",
              "userSelected": false
            }
          ]
        }
      },
      "search": {
        "mode": "match",
        "score": 1
      }
    }
  ]
}

Lab Requests

Lab by Patient, Category, Date, and Code

Patient and Category:
 GET: 'https://api.practicestudio.net/patientportal/fhir/Observation?category=laboratory&patient={Patient_ID}'

Patient, Category, and Date:
 GET: 'https://api.practicestudio.net/patientportal/fhir/Observation?category=laboratory&date=2011-06-10&patient={Patient_ID}'

Patient and Code:
 GET: 'https://api.practicestudio.net/patientportal/fhir/Observation?code=UNK&patient={Patient_ID}'

Lab by Resource ID

GET: 'https://api.practicestudio.net/patientportal/fhir/Observation/Lab-{Resource_ID}'

Lab Example Response

Example Lab JSON Response:


{
  "resourceType": "Bundle",
  "meta": {
    "lastUpdated": "2022-08-11T14:48:54.7349291-05:00"
  },
  "type": "searchset",
  "total": 15,
  "link": [
    {
      "relation": "self"
    }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "Observation",
        "id": "Lab-10000114",
        "meta": {
          "lastUpdated": "0001-01-01T00:00:00-06:00",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observationresults"
          ]
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "laboratory",
                "display": "Laboratory",
                "userSelected": false
              }
            ],
            "text": "Laboratory"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/v3/NullFlavor",
              "code": "UNK",
              "display": "unknown",
              "userSelected": false
            }
          ],
          "text": "Hematocrit"
        },
        "subject": {
          "reference": "Patient/000034"
        },
        "effectiveDateTime": "2011-06-10",
        "valueQuantity": {
          "value": 100,
          "unit": "mg/dL",
          "system": "http://unitsofmeasure.org",
          "code": "mg/dL"
        }
      },
      "search": {
        "mode": "match",
        "score": 1
      }
    }
  ]
}

Vitals Requests

Vitals by Patient

GET: 'https://api.practicestudio.net/patientportal/fhir/Observation?category=vital-signs&patient={Patient_ID}'

Vitals Example Response

Example Vitals JSON Response:


{
  "resourceType": "Bundle",
  "meta": {
    "lastUpdated": "2022-08-11T14:48:54.7349291-05:00"
  },
  "type": "searchset",
  "total": 15,
  "link": [
    {
      "relation": "self"
    }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "Observation",
        "id": "Lab-10000114",
        "meta": {
          "lastUpdated": "0001-01-01T00:00:00-06:00",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observationresults"
          ]
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "laboratory",
                "display": "Laboratory",
                "userSelected": false
              }
            ],
            "text": "Laboratory"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/v3/NullFlavor",
              "code": "UNK",
              "display": "unknown",
              "userSelected": false
            }
          ],
          "text": "Hematocrit"
        },
        "subject": {
          "reference": "Patient/000034"
        },
        "effectiveDateTime": "2011-06-10",
        "valueQuantity": {
          "value": 100,
          "unit": "mg/dL",
          "system": "http://unitsofmeasure.org",
          "code": "mg/dL"
        }
      },
      "search": {
        "mode": "match",
        "score": 1
      }
    }
  ]
}