Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated cql-to-elm instructions in README.md #317

Merged
merged 2 commits into from
Dec 20, 2023

Conversation

sorliog
Copy link
Contributor

@sorliog sorliog commented Dec 19, 2023

Pull requests into cql-execution require the following.
Submitter and reviewer should ✔ when done.
For items that are not-applicable, mark "N/A" and ✔.

CDS Connect and Bonnie are the main users of this repository.
It is strongly recommended to include a person from each of those projects as a reviewer.

Summary

Instructions for translating CQL to ELM in README.md are out of date with clinical_quality_language. This update changes the documentation to use the cql-to-elm-cli executable instead of the cql-to-elm library.

Submitter:

  • This pull request describes why these changes were made
  • [ N/A ] Code diff has been done and been reviewed (it does not contain: additional white space, not applicable code changes, debug statements, etc.)
  • [ N/A ] Tests are included and test edge cases
  • [ N/A ] Tests have been run locally and pass
  • [ N/A ] Code coverage has not gone down and all code touched or added is covered.
  • [ N/A ] Code passes lint and prettier (hint: use npm run test:plus to run tests, lint, and prettier)
  • [ N/A ] All dependent libraries are appropriately updated or have a corresponding PR related to this change
  • [ N/A ] cql4browsers.js built with npm run build:browserify if source changed.

Reviewer:

Name:

  • Code is maintainable and reusable, reuses existing code and infrastructure where appropriate, and accomplishes the task’s purpose
  • The tests appropriately test the new code, including edge cases
  • You have tried to break the code

Copy link
Member

@cmoesel cmoesel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution. Your changes around cql-to-elm-cli look good! I've requested one change related to how you reformatted the example that uses promises -- but once you fix that, I think we're good to go!

README.md Outdated Show resolved Hide resolved
README.md Outdated
Comment on lines 254 to 309
"library" : {
"identifier" : { "id" : "TestSnippet", "version" : "1" },
"schemaIdentifier" : { "id" : "urn:hl7-org:elm", "version" : "r1" },
"usings" : {
"def" : [
{ "localIdentifier" : "System", "uri" : "urn:hl7-org:elm-types:r1" },
{ "localIdentifier" : "Simple", "uri" : "https://github.com/cqframework/cql-execution/simple", "version" : "1.0.0" }
]
},
"statements" : {
"def" : [ {
"name" : "Patient",
"context" : "Patient",
"expression" : {
"type" : "SingletonFrom",
"operand" : {
"dataType" : "{https://github.com/cqframework/cql-execution/simple}Patient",
"type" : "Retrieve"
}
}
}, {
"name" : "AllTrue",
"context" : "Patient",
"accessLevel" : "Public",
"expression" : {
"type" : "And",
"operand" : [
{ "valueType" : "{urn:hl7-org:elm-types:r1}Boolean", "value" : "true", "type" : "Literal" },
{ "valueType" : "{urn:hl7-org:elm-types:r1}Boolean", "value" : "true", "type" : "Literal" }
]
}
}, {
"name" : "SomeTrue",
"context" : "Patient",
"accessLevel" : "Public",
"expression" : {
"type" : "And",
"operand" : [
{ "valueType" : "{urn:hl7-org:elm-types:r1}Boolean", "value" : "true", "type" : "Literal" },
{ "valueType" : "{urn:hl7-org:elm-types:r1}Boolean", "value" : "false", "type" : "Literal" }
]
}
}, {
"name" : "AllFalse",
"context" : "Patient",
"accessLevel" : "Public",
"expression" : {
"type" : "And",
"operand" : [
{ "valueType" : "{urn:hl7-org:elm-types:r1}Boolean", "value" : "false", "type" : "Literal" },
{ "valueType" : "{urn:hl7-org:elm-types:r1}Boolean", "value" : "false", "type" : "Literal" }
]
}
}
]}
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This indent, on the other hand, looks good. I'm not sure how/why we had a three-space indent before. Thanks for fixing it!

@cmoesel
Copy link
Member

cmoesel commented Dec 20, 2023

Thanks, @sorliog. It looks like npm audit is failing CI, but since this is a documentation-only PR, I don't think that it's fair to expect you to address npm audit issues. So... I will merge. Thanks again!

@cmoesel cmoesel merged commit d69c85e into cqframework:master Dec 20, 2023
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants