DavidStables (talk | contribs) |
DavidStables (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
__TOC__ | __TOC__ | ||
These pages describe the IM Query grammar conventions and | These pages describe the IM Query grammar conventions and meaning. | ||
A formal IMQ Grammar can be accessed in ABNF form at https://github.com/endeavourhealth-discovery/IMDirectory/blob/develop/im_library/src/antlr4/grammars/ECL.g4 | |||
The following is used as a working example throughout the pages:<syntaxhighlight lang="actionscript3"> | |||
Find: | |||
Patients | |||
Registered for GMS | |||
Aged 65 to 70 or Diabetic | |||
Latest systolic BP within the last 6 months is >150 | |||
Not followed by a screening invite | |||
Not already hypertensive | |||
</syntaxhighlight> | |||
=== Symbol conventions === | === Symbol conventions === | ||
A small set of symbols are used to represent meaningful language tokens. These are: | A small set of symbols are used to represent meaningful language tokens. These are: | ||
{| class="wikitable" | |||
|+ | |||
!Symbol | |||
where { :concept in | !Meaning | ||
!Example | |||
from { @:Patient} means that the query is looking for all instances of type patient. | |- | ||
|'{' '}' | |||
|Used for clauses to differentiate the content from other similar clauses, as well as to indicate graph traversal. It is used in the same way as { } is used in Json to represent and object. | |||
|where {age >=65 to <75 units : years} | |||
|- | |||
|',' | |||
|comma used to indicate a list entry number 2 or more. the language does not require brackets to show a list. | |||
|<nowiki>where { :concept in ^xx:VSET_Diabetes, <<:sct:714628002|Prediabetes } means that the concept is either a member of the Diabetes value set or is prediabetes</nowiki> | |||
|- | |||
|'@' | |||
|sed as an identifier qualifier to indicate a type. | |||
|im:Concept | |||
indicates that this refers to instances of type im:concept | |||
from { @:Patient} | |||
means that the query is looking for all instances of type patient. | |||
|- | |||
|<nowiki>''^'</nowiki> | |||
|used as an identifier qualifier to indicate a set or population elsewhere defined | |||
|rom { ^ex:RegisteredPatients} means the set of registered patients, used mostly in referencing base populations or value /reference sets | |||
|- | |||
|'<<' | |||
|ubsumption qualifier used to indicate descendants or Self of against an identifier | |||
|<nowiki><<:sct:714628002|Prediabetes|</nowiki> | |||
means prediabetes or any of its descendants | |||
|- | |||
|'<' | |||
|used to indicate 'descendants of but not including self' | |||
|<nowiki><:sct:714628002|Prediabetes|</nowiki> | |||
means any of its descendants but not prediabetes itself * (rarely used) | |||
|- | |||
|'>>' | |||
|ed to indicate 'Ancestors of including self; against an identifier . | |||
|<nowiki>from {>>sct:127489000| has active ingredients</nowiki> | |||
means the property active ingredients or any of its super properties. Used to validate attributes in the domain range Snomed concept model. | |||
|- | |||
|<nowiki>''|' '|' </nowiki> | |||
|used as a short cut to indicate the name of a concept or | |||
|<nowiki>:sct:714628002|Prediabetes|</nowiki> | |||
|} | |||
=== Identifiers === | === Identifiers === |
Revision as of 10:35, 12 March 2023
These pages describe the IM Query grammar conventions and meaning.
A formal IMQ Grammar can be accessed in ABNF form at https://github.com/endeavourhealth-discovery/IMDirectory/blob/develop/im_library/src/antlr4/grammars/ECL.g4
The following is used as a working example throughout the pages:
Find:
Patients
Registered for GMS
Aged 65 to 70 or Diabetic
Latest systolic BP within the last 6 months is >150
Not followed by a screening invite
Not already hypertensive
Symbol conventions
A small set of symbols are used to represent meaningful language tokens. These are:
Symbol | Meaning | Example |
---|---|---|
'{' '}' | Used for clauses to differentiate the content from other similar clauses, as well as to indicate graph traversal. It is used in the same way as { } is used in Json to represent and object. | where {age >=65 to <75 units : years} |
',' | comma used to indicate a list entry number 2 or more. the language does not require brackets to show a list. | where { :concept in ^xx:VSET_Diabetes, <<:sct:714628002|Prediabetes } means that the concept is either a member of the Diabetes value set or is prediabetes |
'@' | sed as an identifier qualifier to indicate a type. | im:Concept
indicates that this refers to instances of type im:concept from { @:Patient} means that the query is looking for all instances of type patient. |
''^' | used as an identifier qualifier to indicate a set or population elsewhere defined | rom { ^ex:RegisteredPatients} means the set of registered patients, used mostly in referencing base populations or value /reference sets |
'<<' | ubsumption qualifier used to indicate descendants or Self of against an identifier | <<:sct:714628002|Prediabetes|
means prediabetes or any of its descendants |
'<' | used to indicate 'descendants of but not including self' | <:sct:714628002|Prediabetes|
means any of its descendants but not prediabetes itself * (rarely used) |
'>>' | ed to indicate 'Ancestors of including self; against an identifier . | from {>>sct:127489000| has active ingredients
means the property active ingredients or any of its super properties. Used to validate attributes in the domain range Snomed concept model. |
''|' '|' | used as a short cut to indicate the name of a concept or | :sct:714628002|Prediabetes| |
Identifiers
Query definitions include reference to a data model types, properties, concepts or sets. Identifiers are represented as RDF IRIs in both the full or prefixed form. For example:
http://snomed.info/sct# and sct: 29857009 may be equivalent where the query contains a prefix list
Boolean operators
The boolean operators 'and' , 'or' and 'not' can operate in either the from or where clause, using a "bool" predicate. 'and' is the same as an intersection (all must be true), or is a union (at least one true) and 'not' is a union of negation (any one must be false). Further nesting can resolve boolean combinations (e.g. not/and)
Example use of boolean operators in where clause:
Plain | Json |
---|---|
where {
{:age>= 18 units: years} and {:statedGender is :905031000252103|Male|} } |
{"where" : {
"bool" : "and",
"where" : [ { "id" : "age",
"operator" : ">=",
"value" : 18,
"unit" : "year"},
{"id" : "statedGender",
"in" : [ {"@id" : "im:905031000252103",
"name" : "Male (stated gender)" } ] } ] }
|