OpenSAFELY Data Builder table of contents

Danger

This page discusses the new OpenSAFELY Data Builder for accessing OpenSAFELY data sources.

Use OpenSAFELY cohort-extractor, unless you are specifically involved in the development or testing of Data Builder.

OpenSAFELY Data Builder and its documentation are still undergoing extensive development. We will announce when Data Builder is ready for general use on the Platform News page.

Note

This is a temporary page to provide links to any Data Builder documentation, while that documentation is not yet ready for a general audience.

If you start a new Data Builder page, add it here too.

The Data Builder pages will eventually be displayed in the table of contents as generated by MkDocs, and this page will be removed.

Contents

Data Builder and dataset definitions

• OpenSAFELY Data Builder introduction
• Data Builder Quick Start
• Data Builder versioning
• Writing a dataset definition
• Explaining query model
• Supplying a dummy dataset
• Dataset and SQL

ehrQL

• ehrQL: Data Builder's language for querying electronic health record data
• ehrQL tutorial entrypoint
• ehrQL explanation of rules for combining series and frames
• ehrQL examples
• ehrQL reference

Explainers

• Installing Data Builder with Python (not recommended, use OpenSAFELY CLI)

OpenSAFELY Contracts

• OpenSAFELY Contracts introduction
• OpenSAFELY Contracts reference
• OpenSAFELY data backends
• Guidance for data providers integrating into OpenSAFELY