Understanding the OMOP CDM

Oct 13, 2025 by magicalceylontours.com 104 views

Introduction

The Observational Medical Outcomes Partnership (OMOP) Common Data Model (CDM) has revolutionized the way healthcare data is collected, stored, and analyzed. The OMOP CDM provides a standardized framework for representing healthcare data, enabling seamless integration and comparison of data from diverse sources. In this article, we will delve into the API - OMOP Observation, a crucial component of the OMOP CDM, and explore its various endpoints and functionalities.

Understanding the OMOP CDM

The OMOP CDM is a comprehensive data model that captures the complexities of healthcare data. It consists of several domains, including:

Person: Represents individuals, including demographic information and relationships.
Visit: Captures clinical visits, including dates, locations, and providers.
Observation: Records measurements, observations, and results, such as lab values, medications, and diagnoses.
Condition: Represents chronic conditions, allergies, and other health issues.

API - OMOP Observation Endpoints

The API - OMOP Observation provides several endpoints for retrieving and manipulating observation data. These endpoints enable developers to access and analyze observation data, facilitating research, quality improvement, and decision-making.

1. List All Observations

The GET /api/omop/observation endpoint retrieves all observations with optional pagination and sorting.

Description: Retrieves all observations with optional pagination and sorting.
HTTP Method: GET
Endpoint: /api/omop/observation
Query Parameters:
- page (Optional): Page number for pagination, default is 1.
- pageSize (Optional): Number of results per page, default is 20.
- sortOrder (Optional): Sorting order (asc or desc), default is desc.

Example

GET /api/omop/observation?page=1&pageSize=10&sortOrder=asc

2. Get Observation by Person ID

The GET /api/omop/observation/person/{person_id} endpoint retrieves observations for a specified person_id.

Description: Retrieves observations for a specified person_id.
HTTP Method: GET
Endpoint: /api/omop/observation/person/{person_id}
Query Parameters:
- page (Optional): Page number for pagination, default is 1.
- pageSize (Optional): Number of results per page, default is 20.
- sortOrder (Optional): Sorting order (asc or desc), default is desc.

Example

GET /api/omop/observation/person/101?page=1&pageSize=10&sortOrder=asc

3. Get Observations by Array of Person IDs

The POST /api/omop/observation/person/ids endpoint retrieves observations for multiple person_ids.

Description: Retrieves observations for multiple person_ids.
HTTP Method: POST
Endpoint: /api/omop/observation/person/ids
Body: { "person_ids": [101, 102, 103] }

Example

POST /api/omop/observation/person/ids?page=1&pageSize=10&sortOrder=asc
{
  "person_ids": [101, 102, 103]
}

4. Get Observation by Visit Occurrence ID

The GET /api/omop/observation/visit/{visit_occurrence_id} endpoint retrieves observations for a specified visit_occurrence_id.

Description: Retrieves observations for a specified visit_occurrence_id.
HTTP Method: GET
Endpoint: /api/omop/observation/visit/{visit_occurrence_id}
Query Parameters:
- page (Optional): Page number for pagination, default is 1.
- pageSize (Optional): Number of results per page, default is 20.
- sortOrder (Optional): Sorting order (asc or desc), default is desc.

Example

GET /api/omop/observation/visit/201?page=1&pageSize=10&sortOrder=asc

5. Get Observations by Array of Visit Occurrence IDs

The POST /api/omop/observation/visit/ids endpoint retrieves observations for multiple visit_occurrence_ids.

Description: Retrieves observations for multiple visit_occurrence_ids.
HTTP Method: POST
Endpoint: /api/omop/observation/visit/ids
Body: { "visit_occurrence_ids": [201, 202, 203] }

Example

POST /api/omop/observation/visit/ids?page=1&pageSize=10&sortOrder=asc
{
  "visit_occurrence_ids": [201, 202, 203]
}

6. Search Observations by Attributes

The POST /api/omop/observation/search endpoint searches observations by various attributes, such as date range, value, and concept IDs.

Description: Searches observations by various attributes, such as date range, value, and concept IDs.
HTTP Method: POST
Endpoint: /api/omop/observation/search
Body:
- start_date (Optional): Start of the date range.
- end_date (Optional): End of the date range.
- value_as_number (Optional): Numerical value.
- value_as_concept_id (Optional): Concept ID for categorical result.
- person_ids (Optional): Array of person_ids.
- visit_occurrence_ids (Optional): Array of visit_occurrence_ids.
- observation_concept_ids (Optional): Array of observation concept IDs.

Example

POST /api/omop/observation/search?page=1&pageSize=10&sortOrder=asc
{
  "start_date": "2020-01-01",
  "end_date": "2020-12-31",
  "value_as_number": 5.0,
  "person_ids": [101, 102],
  "visit_occurrence_ids": [12345, 67890],
  "observation_concept_ids": [3004249, 3027110]
}

Conclusion

Q: What is the OMOP Common Data Model (CDM)?

A: The OMOP CDM is a standardized framework for representing healthcare data, enabling seamless integration and comparison of data from diverse sources.

Q: What is the purpose of the API - OMOP Observation?

A: The API - OMOP Observation provides a set of endpoints for retrieving and manipulating observation data, facilitating research, quality improvement, and decision-making.

Q: What are the different types of observations that can be retrieved using the API?

A: The API allows you to retrieve various types of observations, including:

Person-level observations: Observations associated with a specific person.
Visit-level observations: Observations associated with a specific visit.
Condition-level observations: Observations associated with a specific condition.

Q: How can I filter observations using the API?

A: You can filter observations using various parameters, including:

Date range: Filter observations by date range using the start_date and end_date parameters.
Value: Filter observations by value using the value_as_number and value_as_concept_id parameters.
Person ID: Filter observations by person ID using the person_ids parameter.
Visit occurrence ID: Filter observations by visit occurrence ID using the visit_occurrence_ids parameter.

Q: Can I search observations using the API?

A: Yes, you can search observations using the POST /api/omop/observation/search endpoint. This endpoint allows you to search observations by various attributes, such as date range, value, and concept IDs.

Q: What is the difference between the `GET /api/omop/observation` and `POST /api/omop/observation/search` endpoints?

A: The GET /api/omop/observation endpoint retrieves all observations, while the POST /api/omop/observation/search endpoint searches observations by various attributes.

Q: Can I use the API to retrieve observations for multiple person IDs or visit occurrence IDs?

A: Yes, you can use the POST /api/omop/observation/person/ids and POST /api/omop/observation/visit/ids endpoints to retrieve observations for multiple person IDs or visit occurrence IDs.

Q: What is the format of the response data returned by the API?

A: The response data returned by the API is in JSON format.

Q: Can I use the API to update or delete observations?

A: No, the API only allows you to retrieve observations. If you need to update or delete observations, you will need to use a different API or interface.

Q: Is the API secure?

A: Yes, the API uses standard security protocols to ensure the integrity and confidentiality of the data.

Q: Can I use the API to integrate with other systems or applications?

A: Yes, the API can be used to integrate with other systems or applications, enabling seamless data exchange and analysis.

Q: Where can I find more information about the API?

A: You can find more information about the API on the official OMOP website or by contacting the API support team.