Working with FHIR

Fast Healthcare Interoperability Resources (FHIR) is a widely used health IT data standard for exchanging healthcare data. The Precision Sets Interop API includes support for FHIR structured responses. This page provides a general overview of FHIR and a deep dive into how to access the FHIR response via API.

Use Case

The Precision Sets Interop API FHIR capability simplifies healthcare organization integrations by facilitating seamless communication and interoperability among all health IT systems within their organization. This output structure is ideal for organizations who leverage FHIR for data storage or retrieval or integrate with other health systems supporting the FHIR standard. The FHIR standard provides the following benefits:

Interoperable communication
Ease of Electronic Health Record (EHR) integration
Efficient data exchange

By utilizing FHIR, any healthcare organization can achieve a significant improvement in data interoperability, leading to more efficient and patient-centered care delivery across its network.

API Usage - Search

curl

curl -X 'GET' \
  'https://api.imohealth.com/fhir/r6/ValueSet/search?searchText=chest+pain' \
  -H 'accept: application/json'

Response

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "Self",
      "url": "https://api.imohealth.com/fhir/r6/ValueSet/fhir/r6/ValueSet/search?searchText=chest+pain&page=1&pageSize=10"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://api.imohealth.com/fhir/r6/ValueSet/fhir/r6/ValueSet/1234",
      "resource": {
        "resourceType": "ValueSet",
        "id": "1234",
        "meta": {
          "versionId": "5678"
        },
        "extension": [
          {
            "url": "http://imohealth.com/domain",
            "valueString": "Problem"
          }
        ],
        "identifier": [
          {
            "system": "http://imohealth.com/identifiers",
            "value": "7896452"
          }
        ],
        "name": "ChestPainExcludingShoulderProblemPatientCohortIdentification",
        "title": "Chest Pain Excluding Shoulder Problem Patient Cohort Identification",
        "status": "active",
        "date": "2023-06-24T03:11:59.43787+00:00",
        "publisher": "IMO",
        "description": "Problem terms that indicate chest pain and other types of discomfort of the thorax excluding shoulder girdle, used to find patients for analytics or decision support.",
        "approvalDate": "2025-01-30",
        "author": [
          {
            "name": "IMO"
          }
        ],
        "editor": [
          {
            "name": "IMO"
          }
        ],
        "scope": {
          "inclusionCriteria": "Descriptions of discomfort using a broad range of words, including pain, tenderness, and tightness;  terms that attribute chest discomfort to causes or structures of the thorax (e.g., angina, intercostal neuralgia, pleurisy) excluding shoulder girdle.",
          "exclusionCriteria": "Pain and other types of discomfort  of the breast, nipple; history or risk of chest pain."
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

API Usage - Value Set details

curl

curl -X 'GET' \
  'https://api.imohealth.com/fhir/r6/ValueSet/1234' \
  -H 'accept: application/json'

Response

{
  "resource": {
    "resourceType": "ValueSet",
    "id": "1234",
    "meta": {
      "versionId": "5678"
    },
    "extension": [
      {
        "url": "http://imohealth.com/domain",
        "valueString": "Problem"
      }
    ],
    "identifier": [
      {
        "system": "http://imohealth.com/identifiers",
        "value": "7896452"
      }
    ],
    "name": "ChestPainExcludingShoulderProblemPatientCohortIdentification",
    "title": "Chest Pain Excluding Shoulder Problem Patient Cohort Identification",
    "status": "active",
    "date": "2023-06-24T03:11:59.43787+00:00",
    "publisher": "IMO",
    "description": "Problem terms that indicate chest pain and other types of discomfort of the thorax excluding shoulder girdle, used to find patients for analytics or decision support.",
    "approvalDate": "2025-01-30",
    "author": [
      {
        "name": "IMO"
      }
    ],
    "editor": [
      {
        "name": "IMO"
      }
    ],
    "expansion": {
      "timestamp": "2025-01-30T00:00:00+00:00",
      "total": 50,
      "contains": [
        {
          "system": "http://snomed.info/sct",
          "code": "13763000",
          "display": "Gestation period, 34 weeks (finding)"
        }
      ]
    },
    "scope": {
      "inclusionCriteria": "Descriptions of discomfort using a broad range of words, including pain, tenderness, and tightness;  terms that attribute chest discomfort to causes or structures of the thorax (e.g., angina, intercostal neuralgia, pleurisy) excluding shoulder girdle.",
      "exclusionCriteria": "Pain and other types of discomfort  of the breast, nipple; history or risk of chest pain."
    }
  }
}

For a more comprehensive schema, see the Reference Documentation at https://developer.imohealth.com/api-catalog/precision-sets-interop-api

Note: This API response currently supports HL7 FHIR version R6.

Notices

SNOMED®️ and SNOMED CT®️ are registered trademarks of IHTSDO.

LOINC®️ is a registered United States trademark of Regenstrief Institute Inc.

RxNorm is publicly available data courtesy of the U.S. National Library of Medicine (NLM), National Institutes of Health, Department of Health and Human Services.