|
|
Line 144: |
Line 144: |
| |} | | |} |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/ Function] === | | === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/ Function] === |
| Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionClause/ FunctionClause]
| |
|
| |
|
| Is a subtype of [[#Entity|Entity]] | | Is a subtype of [[#Entity|Entity]] |
Line 510: |
Line 509: |
| |colspan="2"|<span title="The query definition itself">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definition/ <span style="color:green">definition ]</span></span> | | |colspan="2"|<span title="The query definition itself">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definition/ <span style="color:green">definition ]</span></span> |
| |0..1 | | |0..1 |
| |<span title="A set definition holding the logical definition of a set. Usually referred to as a Query as these are used to retrieve data.Includes most of the main logical query constructs used in mainstream query languages, thus is a constrained version of mainstream languages that is schema independent.">[[#QueryDefinition|QueryDefinition]]</span> | | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> |
| |The query definition itself | | |The query definition itself |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryDefinition/ Query definition] ===
| |
|
| |
| Is a subtype of [[#IriAlias|IriAlias]]
| |
|
| |
| A set definition holding the logical definition of a set. Usually referred to as a Query as these are used to retrieve data.<br>Includes most of the main logical query constructs used in mainstream query languages, thus is a constrained version of mainstream languages that is schema independent.
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="Optional description for clause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23description/ <span style="color:green">description ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Optional description of the query definition for support purposes.
| |
| |-
| |
| |colspan="2"|<span title="The value comparison for lower end of the range">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23from/ <span style="color:green">from ]</span></span>
| |
| |0..*
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |The base cohort/ set or type(s), or instance(s) on which all the subsequent where or filter clauses operate. If more than one this is treated as an OR list.
| |
| |-
| |
| |colspan="2"|<span title="A chained where clause operating on the property value object. Equivalent to a join in SQL or '.' in sparql">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23where/ <span style="color:green">where ]</span></span>
| |
| |0..1
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.Supports graph traversal filtering and inference for subsumption query">[[#WhereClause|WhereClause]]</span>
| |
| |Tests properties and property paths and applies filters. Equivalent to SQL Join/ Where and SPARQL Where<br>Bollean where clauses supported.
| |
| |-
| |
| |colspan="2"|<span title="Return query clause logically similar to SQL/SPARQL select and CYPHER Return in object form">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23return/ <span style="color:green">return ]</span></span>
| |
| |1..1
| |
| |<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and sub selects for column groups">[[#SelectClause|SelectClause]]</span>
| |
| |Return query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability
| |
| |-
| |
| |colspan="2"|<span title="If the results need to be grouped, the grouping properties.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23groupBy/ <span style="color:green">groupBy ]</span></span>
| |
| |0..*
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |If the results need to be grouped, the grouping properties.
| |
| |-
| |
| |colspan="2"|<span title="Ordering of instances via a property value in order to further test in another where clause.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderBy/ <span style="color:green">orderBy ]</span></span>
| |
| |0..*
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |Ordering of instances via a property value returned.
| |
| |-
| |
| |colspan="2"|<span title="direction of ordering (DESC or ASC) .">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23direction/ <span style="color:green">direction ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |direction of ordering (DESC or ASC) .
| |
| |-
| |
| |colspan="2"|<span title="Number of entities to return. Normally used with order by">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23limit/ <span style="color:green">limit ]</span></span>
| |
| |0..1
| |
| |<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
| |
| |Number of entities to return. Normally used with order by
| |
| |-
| |
| |colspan="2"|<span title="Tests an aggregate result from the group clause for a value">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23having/ <span style="color:green">having ]</span></span>
| |
| |0..1
| |
| |<span title="A clause testing an aggregate function on a property usually one that is grouped">[[#HavingClause|HavingClause]]</span>
| |
| |Tests an aggregate result from the group clause for a value
| |
| |-
| |
| |colspan="2"|<span title="SubQueries used to group columns in multi group reports. The sub queries are all subsets of the main query clauses">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23subQuery/ <span style="color:green">subQuery ]</span></span>
| |
| |0..*
| |
| |<span title="A set definition holding the logical definition of a set. Usually referred to as a Query as these are used to retrieve data.Includes most of the main logical query constructs used in mainstream query languages, thus is a constrained version of mainstream languages that is schema independent.">[[#QueryDefinition|QueryDefinition]]</span>
| |
| |SubQueries used to group columns in multi group reports. The sub queries are all subsets of the main query clauses
| |
| |-
| |
| |colspan="2"|<span title="Prefixe used in the rest of the document">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23prefix/ <span style="color:green">prefix ]</span></span>
| |
| |0..0
| |
| |<span title="The model of a class containing an iri prefix map">[[#PrefixShape|PrefixShape]]</span>
| |
| |list of prefix to namespace expansion to enable readability of iris
| |
| |-
| |
| |colspan="2"|<span title="true if you want the results to use IRI prefixes">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23usePrefixes/ <span style="color:green">usePrefixes ]</span></span>
| |
| |0..1
| |
| |<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |true if you want the results to use IRI prefixes
| |
| |-
| |
| |colspan="2"|<span title="Whether only active entities are included in the match clauses or select clauses">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23activeOnly/ <span style="color:green">activeOnly ]</span></span>
| |
| |0..1
| |
| |<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Whether only active entities are included in the match clauses or select clauses
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23WhereClause/ WhereClause] ===
| |
| A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.<br>Supports graph traversal filtering and inference for subsumption query
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="The column name in a select clause for this property, or a variable used to reference the result set of the values matched">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23alias/ <span style="color:green">alias ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Used to define the clause with a readable term and also used in other clauses for further refinement
| |
| |-
| |
| |colspan="2"|<span title="Optional description for clause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23description/ <span style="color:green">description ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Optional description for clause
| |
| |-
| |
| |colspan="2"|<span title="The value comparison for lower end of the range">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23from/ <span style="color:green">from ]</span></span>
| |
| |0..*
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |Refers <br> a) to the alias of another where clause to indicate the set of objects defined by the referenced clause, which will be further refined by this where clause.<br>Equivalent to accessing a temporary or derived table in SQL.<br>(b) One or more instance objects to test properties of<br>(c) or instances of a certain type(s)<br>(d) external result set (e.g. a base cohort population)<br>If more than one it is considered an OR List.<br>Represents a subject of a triple or entity. Should be used with caution in IM query
| |
| |-
| |
| |colspan="2"|<span title="The graph to which these entities apply by default. This may be overridden by the entitiesThis means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ <span style="color:green">graph ]</span></span>
| |
| |0..1
| |
| |<span title="Core graphs for core ontologies and taxonomies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span>
| |
| |The iri of a graph if the query is limited to a particular data set
| |
| |-
| |
| |colspan="2"|<span title="A property type path made up of space delimitediri strings, from the outer entity to the entity on which this clause operates. Alternates property and typeEquivalent to an inner join in SQL">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathTo/ <span style="color:green">pathTo ]</span></span>
| |
| |0..1
| |
| |<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
| |
| |A property type path made up of space delimitediri strings, from the outer entity to the entity on which this clause operates. Alternates property and type<br>Equivalent to an inner join in SQL
| |
| |-
| |
| |colspan="2"|<span title="Points to a nested where clause. If the nested clause returns results then the entity referenced by the outer where clause is excluded.In other words, for the outer entity to be included, the nested entity must have no results. This contrasts with 'not'">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notExist/ <span style="color:green">notExist ]</span></span>
| |
| |0..1
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.Supports graph traversal filtering and inference for subsumption query">[[#WhereClause|WhereClause]]</span>
| |
| |Points to a nested where clause. If the nested clause returns results then the entity referenced by the outer where clause is excluded.<br>In other words, for the outer entity to be included, the nested entity must have no results. This contrasts with 'not'
| |
| |-
| |
| |colspan="2"|<span title="Boolean operator OR on subclauses">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23or/ <span style="color:green">or ]</span></span>
| |
| |2..*
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.Supports graph traversal filtering and inference for subsumption query">[[#WhereClause|WhereClause]]</span>
| |
| |Boolean operator OR on subclauses
| |
| |-
| |
| |colspan="2"|<span title="Boolean operator AND on subclauses">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23and/ <span style="color:green">and ]</span></span>
| |
| |2..*
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.Supports graph traversal filtering and inference for subsumption query">[[#WhereClause|WhereClause]]</span>
| |
| |Boolean operator AND on subclauses
| |
| |-
| |
| |colspan="2"|<span title="Tests properties and property paths and applies filters. Equivalent to SQL Join/ Where and SPARQL WhereBollean where clauses supported.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
| |
| |0..*
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |a property tgo test. Note that this is applied to the entity after the path has been resolved.
| |
| |-
| |
| |colspan="2"|<span title="Whether the value is in this list of sets or concepts (including any sub types)">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23in/ <span style="color:green">in ]</span></span>
| |
| |0..*
| |
| |<span title="A reference to resource with an iri and optional name to enable readability">[[#IriRef|IriRef]]</span>
| |
| |Whether the value is in this list of sets or concepts (including any sub types)
| |
| |-
| |
| |colspan="2"|<span title="Whether the value is this concept (and optionally if set to include sub or supertypes)">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23is/ <span style="color:green">is ]</span></span>
| |
| |0..*
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |Whether the value is this concept (and optionally if set to include sub or supertypes)
| |
| |-
| |
| |colspan="2"|<span title="Testing for the value as a not. Note that this filters out the instances but does not exclude the outer entity (see not exist)">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23not/ <span style="color:green">not ]</span></span>
| |
| |0..1
| |
| |<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Testing for the value as a not. Note that this filters out the instances but does not exclude the outer entity (see not exist)
| |
| |-
| |
| |colspan="2"|<span title="A function that operates on the property value (and other parameters) prior to a compare or range or inclusion test. For example a time difference function operating on the date and a reference date.Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ <span style="color:green">function ]</span></span>
| |
| |1..1
| |
| |<span title="A call to a function used in a query consisting of the function iri and one or more arguments to pass in at run time">[[#FunctionClause|FunctionClause]]</span>
| |
| |A function that operates on the property value (and other parameters) prior to a compare or range or inclusion test. For example a time difference function operating on the date and a reference date.<br>Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.
| |
| |-
| |
| |rowspan="2"|or<br>0..1
| |
| |<span title="Where the value is within a range of another valueNote that if the test is a function then the argument list would be in the function clause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23within/ <span style="color:green">within ]</span></span>
| |
| |0..1
| |
| |<span title="Tests a value against another value, either as comparison or range">[[#WithinClause|WithinClause]]</span>
| |
| |Where the value is within a range of another value<br>Note that if the test is a function then the argument list would be in the function clause
| |
| |-
| |
|
| |
| |
| |
| <span title="The value of the property used in a test. This is a string which will be cast to a number or date, depending on the data type of the property value">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23value/ <span style="color:green">value ]</span></span>
| |
| |1..1
| |
| |<span title="Tests a value, whether equal, greater than, less than etc. optionally including a value to compare against">[[#ValueClause|ValueClause]]</span>
| |
| |If testing a property value as equal greater than ete. use compare
| |
| |-
| |
| |colspan="2"|<span title="Test foe a value being between two absolute or relative values">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23range/ <span style="color:green">range ]</span></span>
| |
| |1..1
| |
| |<span title="A range for use in property value testing">[[#RangeClause|RangeClause]]</span>
| |
| |Test foe a value being between two absolute or relative values
| |
| |-
| |
| |colspan="2"|<span title="A chained where clause operating on the property value object. Equivalent to a join in SQL or '.' in sparql">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23where/ <span style="color:green">where ]</span></span>
| |
| |1..1
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.Supports graph traversal filtering and inference for subsumption query">[[#WhereClause|WhereClause]]</span>
| |
| |A chained where clause operating on the property value object.<br> Equivalent to a join in SQL or '.' in sparql
| |
| |-
| |
| |colspan="2"|<span title="Ordering of instances via a property value in order to further test in another where clause.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderBy/ <span style="color:green">orderBy ]</span></span>
| |
| |0..*
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |Ordering of instances via a property value in order to further test in another where clause.
| |
| |-
| |
| |colspan="2"|<span title="direction of ordering (DESC or ASC) .">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23direction/ <span style="color:green">direction ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |direction of ordering (DESC or ASC) .
| |
| |-
| |
| |colspan="2"|<span title="Number of entities to return. Normally used with order by">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23limit/ <span style="color:green">limit ]</span></span>
| |
| |0..1
| |
| |<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
| |
| |Number of entities to return. Normally used with order by
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SelectClause/ SelectClause] ===
| |
| Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and sub selects for column groups
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="A property path made up of space delimited iri strings, from the outer entity to the entity on which this clause operates. Shortcut for nested selects">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23path/ <span style="color:green">path ]</span></span>
| |
| |0..1
| |
| |<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
| |
| |A property path made up of space delimited iri strings, from the outer entity to the entity on which this clause operates.<br> Shortcut for nested selects
| |
| |-
| |
| |colspan="2"|<span title="Tests properties and property paths and applies filters. Equivalent to SQL Join/ Where and SPARQL WhereBollean where clauses supported.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
| |
| |1..1
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |Information about a property or field to include in the results. Property select supports nesting with selects for the objects that may be values of the property
| |
| |-
| |
| |colspan="2"|<span title="Nested select property clauses from the objects that are values of this select's property Note that if the value is null then this select would be absent">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23select/ <span style="color:green">select ]</span></span>
| |
| |0..*
| |
| |<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and sub selects for column groups">[[#SelectClause|SelectClause]]</span>
| |
| |Nested select property clauses from the objects that are values of this select's property Note that if the value is null then this select would be absent
| |
| |-
| |
| |colspan="2"|<span title="A chained where clause operating on the property value object. Equivalent to a join in SQL or '.' in sparql">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23where/ <span style="color:green">where ]</span></span>
| |
| |0..*
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.Supports graph traversal filtering and inference for subsumption query">[[#WhereClause|WhereClause]]</span>
| |
| |Nested where clause operating on the values of this select's property<br>Enables multi- level filtering as used in JOIN where clauses in SQL
| |
| |-
| |
| |colspan="2"|<span title="If the results need to be grouped, the grouping properties.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23groupBy/ <span style="color:green">groupBy ]</span></span>
| |
| |0..*
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |If the results need to be grouped, the grouping properties.
| |
| |-
| |
| |colspan="2"|<span title="Ordering of instances via a property value in order to further test in another where clause.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderBy/ <span style="color:green">orderBy ]</span></span>
| |
| |0..*
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |Ordering of instances via a property value returned.
| |
| |-
| |
| |colspan="2"|<span title="direction of ordering (DESC or ASC) .">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23direction/ <span style="color:green">direction ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |direction of ordering (DESC or ASC) .
| |
| |-
| |
| |colspan="2"|<span title="Number of entities to return. Normally used with order by">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23limit/ <span style="color:green">limit ]</span></span>
| |
| |0..1
| |
| |<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
| |
| |Number of entities to return. Normally used with order by
| |
| |-
| |
| |colspan="2"|<span title="Tests an aggregate result from the group clause for a value">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23having/ <span style="color:green">having ]</span></span>
| |
| |0..1
| |
| |<span title="A clause testing an aggregate function on a property usually one that is grouped">[[#HavingClause|HavingClause]]</span>
| |
| |Tests an aggregate result from the group clause for a value
| |
| |-
| |
| |colspan="2"|<span title="Name of an aggregate function to operate on the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23aggregate/ <span style="color:green">aggregate ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Name of an aggregate function to operate on the property
| |
| |-
| |
| |colspan="2"|<span title="A function that operates on the property value (and other parameters) prior to a compare or range or inclusion test. For example a time difference function operating on the date and a reference date.Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ <span style="color:green">function ]</span></span>
| |
| |0..1
| |
| |<span title="A call to a function used in a query consisting of the function iri and one or more arguments to pass in at run time">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionClause/ im:FunctionClause]</span>
| |
| |The iri of a function indicating that the result is the result of a function operating on the property values, and any arguments passed in
| |
| |-
| |
| |colspan="2"|<span title="Arguments to pass into the function. They should match the parameter definitions of the function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ <span style="color:green">argument ]</span></span>
| |
| |0..*
| |
| |<span title="A named parameter and a value for passing into a function">[[#Argument|Argument]]</span>
| |
| |Arguments to pass into the function
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23HavingClause/ Having clause] ===
| |
| A clause testing an aggregate function on a property usually one that is grouped
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="Name of an aggregate function to operate on the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23aggregate/ <span style="color:green">aggregate ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Name of the aggregate function e.g. MAX,MIN,COUNT,SUM, AVERAGE
| |
| |-
| |
| |colspan="2"|<span title="Tests properties and property paths and applies filters. Equivalent to SQL Join/ Where and SPARQL WhereBollean where clauses supported.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
| |
| |0..1
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |The property on which the aggregate function operates
| |
| |-
| |
| |colspan="2"|<span title="The value of the property used in a test. This is a string which will be cast to a number or date, depending on the data type of the property value">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23value/ <span style="color:green">value ]</span></span>
| |
| |0..1
| |
| |<span title="Tests a value, whether equal, greater than, less than etc. optionally including a value to compare against">[[#ValueClause|ValueClause]]</span>
| |
| |The value of the aggregate result to be tested
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PrefixShape/ Prefix shape] ===
| |
| The model of a class containing an iri prefix map
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="Prefixe used in the rest of the document">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23prefix/ <span style="color:green">prefix ]</span></span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Prefixe used in the rest of the document
| |
| |-
| |
| |colspan="2"|<span title="The iri or namespace or graph iri this prefix refers to">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23iri/ <span style="color:green">iri ]</span></span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |The iri or namespace or graph iri this prefix refers to
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionClause/ FunctionClause] ===
| |
|
| |
| Is a subtype of [[#IrirRef|IrirRef]]
| |
|
| |
| A call to a function used in a query consisting of the function iri and one or more arguments to pass in at run time
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="Arguments to pass into the function. They should match the parameter definitions of the function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ <span style="color:green">argument ]</span></span>
| |
| |0..*
| |
| |<span title="A named parameter and a value for passing into a function">[[#Argument|Argument]]</span>
| |
| |Arguments to pass into the function. They should match the parameter definitions of the function
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23WithinClause/ Within clause] ===
| |
| Tests a value against another value, either as comparison or range
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |rowspan="2"|or<br>1..1
| |
| |<span title="The value of the property used in a test. This is a string which will be cast to a number or date, depending on the data type of the property value">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23value/ <span style="color:green">value ]</span></span>
| |
| |1..1
| |
| |<span title="Tests a value, whether equal, greater than, less than etc. optionally including a value to compare against">[[#ValueClause|ValueClause]]</span>
| |
| |The test is for an actual value (including comparison against another value
| |
| |-
| |
|
| |
| |
| |
| <span title="Test foe a value being between two absolute or relative values">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23range/ <span style="color:green">range ]</span></span>
| |
| |1..1
| |
| |<span title="A range for use in property value testing">[[#RangeClause|RangeClause]]</span>
| |
| |The test is for a range of values against another value
| |
| |-
| |
| |colspan="2"|<span title="The alias and property the value test is against">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23of/ <span style="color:green">of ]</span></span>
| |
| |1..1
| |
| |<span title="When comparing a value to another variable's value this defines the target to compare against. Might be property, alias of a property, or a variable value">[[#CompareClause|CompareClause]]</span>
| |
| |The alias and property the value test is against
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ValueClause/ ValueClause] ===
| |
| Tests a value, whether equal, greater than, less than etc. optionally including a value to compare against
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="Comparison operators : =, <, <=, >, >=">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23comparison/ <span style="color:green">comparison ]</span></span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Comparison operators : =, <, <=, >, >=
| |
| |-
| |
| |rowspan="2"|or<br>1..1
| |
| |<span title="The value of the property used in a test. This is a string which will be cast to a number or date, depending on the data type of the property value">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23value/ <span style="color:green">value ]</span></span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |The value of the property used in a test. This is a string which will be cast to a number or date, depending on the data type of the property value
| |
| |-
| |
|
| |
| |
| |
| <span title="The value is the value of a variable or property set elsewhere in the query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueOf/ <span style="color:green">valueOf ]</span></span>
| |
| |0..1
| |
| |<span title="When comparing a value to another variable's value this defines the target to compare against. Might be property, alias of a property, or a variable value">[[#CompareClause|CompareClause]]</span>
| |
| |The value is the value of a variable or property set elsewhere in the query
| |
| |-
| |
| |colspan="2"|<span title="When the target value or value of is a date and the value is a number then the units of time e.g. years or months as a parameter to a function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23unitOfTime/ <span style="color:green">unitOfTime ]</span></span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |When the target value or value of is a date and the value is a number then the units of time e.g. years or months as a parameter to a function
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RangeClause/ RangeClause] ===
| |
| A range for use in property value testing
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="The value comparison for lower end of the range">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23from/ <span style="color:green">from ]</span></span>
| |
| |1..1
| |
| |<span title="Tests a value, whether equal, greater than, less than etc. optionally including a value to compare against">[[#ValueClause|ValueClause]]</span>
| |
| |The value comparison for lower end of the range
| |
| |-
| |
| |colspan="2"|<span title="The value comparison of upper end of the range">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23to/ <span style="color:green">to ]</span></span>
| |
| |1..1
| |
| |<span title="Tests a value, whether equal, greater than, less than etc. optionally including a value to compare against">[[#ValueClause|ValueClause]]</span>
| |
| |The value comparison of upper end of the range
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Argument/ Argument] ===
| |
| A named parameter and a value for passing into a function
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="The parameters of a function or constraint component.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter ]</span></span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Parameter name for a function or the parameter name for an argument
| |
| |-
| |
| |rowspan="2"|or<br>1..1
| |
| |<span title="Value that is a literal such as a string or number">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueData/ <span style="color:green">valueData ]</span></span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Value that is a literal such as a string or number
| |
| |-
| |
|
| |
| |
| |
| <span title="argument value which is a variable name to be resolved at run time">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueVariable/ <span style="color:green">valueVariable ]</span></span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |argument value which is a variable name to be resolved at run time
| |
| |-
| |
| |colspan="2"|<span title="Passes in the result set from a previous where clause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueFrom/ <span style="color:green">valueFrom ]</span></span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Passes in the result set from a previous where clause
| |
| |-
| |
| |colspan="2"|<span title="Function specific paylod object, normally a json object deserialized to object as determined by the function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueObject/ <span style="color:green">valueObject ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Function specific paylod object, normally a json object deserialized to object as determined by the function
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23CompareClause/ CompareClause] ===
| |
| When comparing a value to another variable's value this defines the target to compare against. Might be property, alias of a property, or a variable value
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="The column name in a select clause for this property, or a variable used to reference the result set of the values matched">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23alias/ <span style="color:green">alias ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |The alias of the result set from another where clause
| |
| |-
| |
| |colspan="2"|<span title="Tests properties and property paths and applies filters. Equivalent to SQL Join/ Where and SPARQL WhereBollean where clauses supported.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
| |
| |0..1
| |
| |<span title="An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
| |
| |The property of the objects in the result set (as indicated by the alias) to test
| |
| |-
| |
| |colspan="2"|<span title="The name of a variable, passed as an argument to a function. Assumed to be a collection">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23variable/ <span style="color:green">variable ]</span></span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |If a value is being compared against a variable passed in as an argument, the name of the variable
| |
| |-
| |
|
| |
| |}
| |
| === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionShape/ FunctionShape] ===
| |
| Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionClause/ FunctionClause]
| |
|
| |
| Is a subtype of [[#Entity|Entity]]
| |
|
| |
| Data model of a function i.e. models the parameters. A query that calls a function uses a function clause that uses this function definition to name each argument passed in
| |
| {| class="wikitable"
| |
| |+
| |
| |colspan="2"|Property
| |
| |Card.
| |
| |Value type
| |
| |Description
| |
| |-
| |
| |colspan="2"|<span title="The parameters of a function or constraint component.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter ]</span></span>
| |
| |0..*
| |
| |<span title="Models a named parameter used in function or other clauses. The parameter name and data type of the parameter (if literal) or class (if on object) ">[[#Parameter|Parameter]]</span>
| |
| |A list of parameters and data types used in this function
| |
| |- | | |- |
|
| |
|
Line 1,057: |
Line 557: |
| |colspan="2"|<span title="The query definition itself">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definition/ <span style="color:green">definition ]</span></span> | | |colspan="2"|<span title="The query definition itself">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definition/ <span style="color:green">definition ]</span></span> |
| |0..1 | | |0..1 |
| |<span title="A set definition holding the logical definition of a set. Usually referred to as a Query as these are used to retrieve data.Includes most of the main logical query constructs used in mainstream query languages, thus is a constrained version of mainstream languages that is schema independent.">[[#QueryDefinition|QueryDefinition]]</span> | | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> |
| |The query definition itself | | |The query definition itself |
| |- | | |- |