Spark Editor Docs

Appearance

Getting Started ​

Signup for the CQL editor ​

If you don't have an account, first you need to sign up for the CQL editor. Currently there are two ways to sign up for the CQL Editor.

  • Using your email address
  • Using GitHub

TIP

💡 Navigate to Signup to sign up with your email address or using GitHub.

Signing up with email address ​

When Signing up with your email address, you will first have to provide some information. These include,

  • Your name
  • A working email address
  • A password

After entering the above details click Signup.

This will create your user user account and you will be automatically redirected to the login page.

And you can now login with your email address and password.

INFO

If you sign up with an email address, you will not be able to push your CQL to GitHub. But don't worry you can always give access to GitHub later.

Signing up with GitHub ​

If you prefer to sign up with GitHub which is more convenient (you don't have to remember a password), you can simply click Login With GitHub button.

This will redirect you to the CQL Pen GitHub application which give permission to login to CQL Editor using your GitHub account.

As similar to Signing up with your email address, Signing up with GitHub will automatically obtain your Name, and Email address used in your GitHub account.

In future can easily login to CQL editor using your GitHub account from the login page.

TIP

We will automatically generate a profile picture for your account using Gravatar. If you already have a profile picture defined using Gravatar, it will be used instead.

CQL Editor ​

The CQL Editor has few key fundamental concepts

  • Projects
  • Codes and CodeSystems
  • The Editor

Projects ​

A project is a collection of CQL and the associated documentation. So the first thing you will have to do is create a new project for you and the team after signing up for CQL editor.

There can be one or more collaborators, working a in a single project. A project administrator can add collaborators and give access to a project.

When you first sign up for a project, you will be automatically given access to the demo project which is only created for demonstration purposes.

TIP

Read more about Projects and managing your projects in the 📖 Projects page.

Codes and CodeSystems ​

CodeSystem and Codes are concepts used in FHIR,

  • Codes in FHIR are standardized values that represent specific concepts in healthcare. They're used to represent diagnoses, medications, procedures, demographics, and other clinical and administrative information.

  • CodeSystems are collections of codes with assigned meanings. They define the set of possible values that can be used in specific contexts.

Before you start using CQL Editor, you will have to upload a CodeSystem with a codes (concepts) to CQL Editor. You can also connect a terminology server like OCL to get to codes from there.

So it is very important that you upload a CodeSystem before you start writing CQL on CQL editor to use the auto-complete feature.

You can still use the CQL editor without uploading a CodeSystem a terminology server, the editor will still provide you with syntax highlighting and error checking, but you will not get the nice autocomplete and parsing.

TIP

Read more about managing your CodeSystems and Codes within CQL editor in the 📖 Codes and CodeSystems page.

INFO

Read more about FHIR Codes and CodeSystems here: Codes and CodeSystems in FHIR

The Editor ​

After you created the project, you can start writing CQL on the editor. The editor is a powerful tool that allows you to write, collaborate and check for errors in your CQL.

The editor has the CQL documentation built in, where you can see the documentation popping up when you hover important keywords.

Also if you have uploaded or connected a CodeSystem, you will see the definitions of the Codes popping up when you hover over the codes, you can also parse the CQL to human readable format and has many more features.

TIP

Read more about the editor in the 📖 Editor page.

Signup for the CQL editor ​

If you don't have an account, first you need to signup for the CQL editor. Currently there are two ways to signup for the CQL Editor.

  • Using your email address
  • Using GitHub

TIP

💡 Navigate to Signup to signup with your email address or using GitHub.

Signing up with email address ​

When Signing up with your email address, you will first have to provide some information. These include,

  • Your name
  • A working email address
  • A password

After entering the above details click Signup.

This will create your user user account and you will be automatically redirected to the login page.

And you can now login with your email address and password.

INFO

If you signup with an email address, you will not be able to push your CQL to GitHub. But don't worry you can always give access to GitHub later.

Signing up with GitHub ​

If you prefer to signup with GitHub which is more convinient (you don't have to remember a password), you can simply click Login With GitHub button.

This will redirect you to the CQL Pen GitHub application which give permission to login to CQL Editor using your GitHub account.

As similar to Signing up with your email address, Signing up with GitHub will automatically obtain your Name, and Email address used in your GitHub account.

In future can easily login to CQL editor using your GitHub account from the login page.

TIP

We will automatically generate a profile picture for your account using Gravatar. If you already have a profile picture defined using Gravatar, it will be used instead.

CQL Editor ​

The CQL Editor has few key fundemental concepts

  • Projects
  • Codes and CodeSystems
  • The Editor

Projects ​

A project is a collection of CQL and the associated documentation. So the first thing you will have to do is create a new project for you and the team after signing up for CQL editor.

There can be one or more collaborators, working a in a sigle project project. A project administrator can add collaborators and give access to a project.

When you first sign up for a project, you will be automatically given access to the demo project which is only creatred for deonstration purposes.

TIP

Read more about Projects and managing your projects in the 📖 Projects page.

Codes and CodeSystems ​

CodeSystem and Codes are concepts used in FHIR,

  • Codes in FHIR are standardized values that represent specific concepts in healthcare. They're used to represent diagnoses, medications, procedures, demographics, and other clinical and administrative information.

  • CodeSystems are collections of codes with assigned meanings. They define the set of possible values that can be used in specific contexts.

Before you start using CQL Editor, you will have to upload a CodeSystem with a codes (concepts) to CQL Editor. You can also connect a terminology server like OCL to get to codes from there.

So it is very important that you upload a CodeSystem before you start writing CQL on CQL editor to use the auto-complete feature.

You can still use the CQL editor without uploading a CodeSystem a terminology server, the editor will still provide you with syntax highlighting and error checking, but you will not get the nice autocomplete and parsing.

TIP

Read more about managing your CodeSystems and Codes within CQL editor in the 📖 Codes and CodeSystems page.

INFO

Read more about FHIR Codes and CodeSystems here: Codes and CodeSystems in FHIR

The Editor ​

After you created the project, you can start writing CQL on the editor. The editor is a powerful tool that allows you to write, collaborate and check for errors in your CQL.

The editor has the CQL documentation built in, where you can see the documentation popping up when you hover important keywords.

Also if you have uploaded or connected a CodeSystem, you will see the definitions of the Codes popping up when you however over the codes, you can also parse the CQL to human readable format and has many more features.

TIP

Read more about the editor in the 📖 Editor page.