Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 9: Line 9:
|rowspan="6"|<span id="class_QueryRequest">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/  <span style="color:green"> '''QueryRequest'''</span>]</span>
|rowspan="6"|<span id="class_QueryRequest">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/  <span style="color:green"> '''QueryRequest'''</span>]</span>
|0..1<br>
|0..1<br>
|colspan="2"|page
|colspan="2"|<span style="color:olive">page</span>
|<span title="Information about paging if the client wishes to page results, including page number and page size">[[#class_PageInformation|PageInformation]]</span>
|<span title="Information about paging if the client wishes to page results, including page number and page size">[[#class_PageInformation|PageInformation]]</span>
|optional page number and size if the client is looking for paged results
|optional page number and size if the client is looking for paged results
Line 15: Line 15:
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|textSearch
|colspan="2"|<span style="color:olive">textSearch</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|If a free text search is part of the query
|If a free text search is part of the query
Line 21: Line 21:
|-
|-
|0..*<br>
|0..*<br>
|colspan="2"|argument
|colspan="2"|<span style="color:olive">argument</span>
|<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span>
|<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span>
|arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs
|arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs
Line 28: Line 28:
|rowspan="2"|1..1<br>or
|rowspan="2"|1..1<br>or
|1..1<br>
|1..1<br>
|query
|<span style="color:olive">query</span>
|<span title="A Query definition holding the logical definition of a query in a standard language">[[#class_Query|Query]]</span>
|<span title="A Query definition holding the logical definition of a query in a standard language">[[#class_Query|Query]]</span>
|The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach
|The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach
Line 35: Line 35:
|
|
1..1<br>
1..1<br>
|queryIri
|<span style="color:olive">queryIri</span>
|<span title="international resource identifier">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</span>
|<span title="international resource identifier">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</span>
|The IRI of a predefined query in the information model. i.e. request the system to run query X
|The IRI of a predefined query in the information model. i.e. request the system to run query X
Line 41: Line 41:
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|referenceDate
|colspan="2"|<span style="color:olive">referenceDate</span>
|<span title="im date time format">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DateTime/ im:DateTime]</span>
|<span title="im date time format">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DateTime/ im:DateTime]</span>
|reference date for date ranges that use reference date. Note that it could be passed in as an argeument
|reference date for date ranges that use reference date. Note that it could be passed in as an argeument
Line 48: Line 48:
|rowspan="2"|<span id="class_PageInformation">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PageInformation/  <span style="color:green"> '''PageInformation'''</span>]</span>
|rowspan="2"|<span id="class_PageInformation">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PageInformation/  <span style="color:green"> '''PageInformation'''</span>]</span>
|1..1<br>
|1..1<br>
|colspan="2"|pageNumber
|colspan="2"|<span style="color:olive">pageNumber</span>
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|Page number (starting at 1)
|Page number (starting at 1)
Line 54: Line 54:
|-
|-
|1..1<br>
|1..1<br>
|colspan="2"|pageSize
|colspan="2"|<span style="color:olive">pageSize</span>
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|number of entries per page
|number of entries per page
Line 61: Line 61:
|rowspan="5"|<span id="class_Argument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Argument/  <span style="color:green"> '''Argument'''</span>]</span>
|rowspan="5"|<span id="class_Argument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Argument/  <span style="color:green"> '''Argument'''</span>]</span>
|1..1<br>
|1..1<br>
|colspan="2"|parameter
|colspan="2"|<span style="color:olive">parameter</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<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
|Parameter name for a function or the parameter name for an argument
Line 68: Line 68:
|rowspan="4"|1..1<br>or
|rowspan="4"|1..1<br>or
|1..1<br>
|1..1<br>
|valueData
|<span style="color:olive">valueData</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|Vaue that is a literal such as a string or number
|Vaue that is a literal such as a string or number
Line 75: Line 75:
|
|
1..1<br>
1..1<br>
|valueVariable
|<span style="color:olive">valueVariable</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<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
|argumenT value which is a variable name to be resolved at run time
Line 82: Line 82:
|
|
1..1<br>
1..1<br>
|valueSelect
|<span style="color:olive">valueSelect</span>
|<span title="">[[#class_SelectClause|SelectClause]]</span>
|<span title="">[[#class_SelectClause|SelectClause]]</span>
|Argument value that is the result of a select query
|Argument value that is the result of a select query
Line 89: Line 89:
|
|
1..1<br>
1..1<br>
|valueIri
|<span style="color:olive">valueIri</span>
|<span title="international resource identifier">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</span>
|<span title="international resource identifier">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</span>
|Argument value that is an iri
|Argument value that is an iri
Line 98: Line 98:
|rowspan="6"|<span id="class_Query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/  <span style="color:green"> '''Query'''</span>]<br> (subtype of [[#class_ModelHeading|ModelHeading]])</span>
|rowspan="6"|<span id="class_Query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/  <span style="color:green"> '''Query'''</span>]<br> (subtype of [[#class_ModelHeading|ModelHeading]])</span>
|0..1<br>
|0..1<br>
|colspan="2"|resultFormat
|colspan="2"|<span style="color:olive">resultFormat</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|Whether the result set is required flat select style json or a nested graphql json object style 'RELATIONAL' or 'OBJECT. Default is OBJECT
|Whether the result set is required flat select style json or a nested graphql json object style 'RELATIONAL' or 'OBJECT. Default is OBJECT
Line 104: Line 104:
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|usePrefixes
|colspan="2"|<span style="color:olive">usePrefixes</span>
|<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|true if you want the results to use IRI prefixes
|true if you want the results to use IRI prefixes
Line 110: Line 110:
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|activeOnly
|colspan="2"|<span style="color:olive">activeOnly</span>
|<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether only active entities are included in the match clauses or select clauses
|Whether only active entities are included in the match clauses or select clauses
Line 117: Line 117:
|rowspan="2"|1..1<br>or
|rowspan="2"|1..1<br>or
|1..1<br>
|1..1<br>
|select
|<span style="color:olive">select</span>
|<span title="">[[#class_SelectClause|SelectClause]]</span>
|<span title="">[[#class_SelectClause|SelectClause]]</span>
|Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability
|Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability
Line 124: Line 124:
|
|
0..1<br>
0..1<br>
|ask
|<span style="color:olive">ask</span>
|<span title="A clause that matches a path to entity, its properties and its values or intersections unions or negation. Equivalent to a sparql wheew filter clause">[[#class_MatchClause|MatchClause]]</span>
|<span title="A clause that matches a path to entity, its properties and its values or intersections unions or negation. Equivalent to a sparql wheew filter clause">[[#class_MatchClause|MatchClause]]</span>
|If the query is a boolean true or false use match clauses as an ask
|If the query is a boolean true or false use match clauses as an ask
Line 130: Line 130:
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|mainEntity
|colspan="2"|<span style="color:olive">mainEntity</span>
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23NodeShape/ sh:NodeShape]</span>
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23NodeShape/ sh:NodeShape]</span>
|The main entity to which all matches must be related e.g. Patient or organisation. i.e. the IRI of a data model entity (SHACL shape)
|The main entity to which all matches must be related e.g. Patient or organisation. i.e. the IRI of a data model entity (SHACL shape)
Line 137: Line 137:
|rowspan="11"|<span id="class_SelectClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SelectClause/  <span style="color:green"> '''SelectClause'''</span>]<br> (subtype of [[#class_ModelHeading|ModelHeading]])</span>
|rowspan="11"|<span id="class_SelectClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SelectClause/  <span style="color:green"> '''SelectClause'''</span>]<br> (subtype of [[#class_ModelHeading|ModelHeading]])</span>
|0..1<br>
|0..1<br>
|colspan="2"|count
|colspan="2"|<span style="color:olive">count</span>
|<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|If the query result is simply a sum of the main entities found. equivalent to COUNT(ie)
|If the query result is simply a sum of the main entities found. equivalent to COUNT(ie)
Line 144: Line 144:
|rowspan="2"|0..1<br>or
|rowspan="2"|0..1<br>or
|0..*<br>
|0..*<br>
|property
|<span style="color:olive">property</span>
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
|Information about a  property or field to includein the results. Property select supports nesting with selects for the objects that may be values of the property
|Information about a  property or field to includein the results. Property select supports nesting with selects for the objects that may be values of the property
Line 151: Line 151:
|
|
1..1<br>
1..1<br>
|pathToTarget
|<span style="color:olive">pathToTarget</span>
|<span title="">[[#class_PathTargetClause|PathTargetClause]]</span>
|<span title="">[[#class_PathTargetClause|PathTargetClause]]</span>
|Special function for path query. Information about the target entity when the query is looking to return paths between a source and a target. Both are likely to be passed in as parameters
|Special function for path query. Information about the target entity when the query is looking to return paths between a source and a target. Both are likely to be passed in as parameters
Line 157: Line 157:
|-
|-
|0..*<br>
|0..*<br>
|colspan="2"|match
|colspan="2"|<span style="color:olive">match</span>
|<span title="A clause that matches a path to entity, its properties and its values or intersections unions or negation. Equivalent to a sparql wheew filter clause">[[#class_MatchClause|MatchClause]]</span>
|<span title="A clause that matches a path to entity, its properties and its values or intersections unions or negation. Equivalent to a sparql wheew filter clause">[[#class_MatchClause|MatchClause]]</span>
|The match pattern to which the select clause must comply. Equivalent to a where/filter in SPARQL and JOIN/WHERE in SQL
|The match pattern to which the select clause must comply. Equivalent to a where/filter in SPARQL and JOIN/WHERE in SQL
Line 163: Line 163:
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|distinct
|colspan="2"|<span style="color:olive">distinct</span>
|<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether the entity objects returned should be distinct
|Whether the entity objects returned should be distinct
Line 170: Line 170:
|rowspan="3"|0..1<br>or
|rowspan="3"|0..1<br>or
|1..1<br>
|1..1<br>
|entityType
|<span style="color:olive">entityType</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|The entity type for instances this select clause operates on. Options include including subtypes.
|The entity type for instances this select clause operates on. Options include including subtypes.
Line 177: Line 177:
|
|
1..1<br>
1..1<br>
|entityId
|<span style="color:olive">entityId</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|An instance of an enttu for which this select clause operates. As in entity type, optionally to include subtypes, where the entity id is a concept
|An instance of an enttu for which this select clause operates. As in entity type, optionally to include subtypes, where the entity id is a concept
Line 184: Line 184:
|
|
1..1<br>
1..1<br>
|entityIn
|<span style="color:olive">entityIn</span>
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|The consept set, value set, or query result set that forms the base population of instances on which the select clause operates. e.g. a parent cohort.
|The consept set, value set, or query result set that forms the base population of instances on which the select clause operates. e.g. a parent cohort.
Line 190: Line 190:
|-
|-
|0..*<br>
|0..*<br>
|colspan="2"|groupBy
|colspan="2"|<span style="color:olive">groupBy</span>
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
|If the results need to be grouped, the grouping properties.
|If the results need to be grouped, the grouping properties.
Line 196: Line 196:
|-
|-
|0..*<br>
|0..*<br>
|colspan="2"|orderLimit
|colspan="2"|<span style="color:olive">orderLimit</span>
|<span title="">[[#class_OrderLimitClause|OrderLimitClause]]</span>
|<span title="">[[#class_OrderLimitClause|OrderLimitClause]]</span>
|Ordering of instances via a property value and limiting th enumber returned.
|Ordering of instances via a property value and limiting th enumber returned.
Line 202: Line 202:
|-
|-
|0..*<br>
|0..*<br>
|colspan="2"|subselect
|colspan="2"|<span style="color:olive">subselect</span>
|<span title="">[[#class_SelectClause|SelectClause]]</span>
|<span title="">[[#class_SelectClause|SelectClause]]</span>
|For a query with column groups such as a list report, the select query for each group
|For a query with column groups such as a list report, the select query for each group
Line 209: Line 209:
|rowspan="1"|<span id="class_ModelHeading">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ModelHeading/  <span style="color:green"> '''ModelHeading'''</span>]<br> (subtype of [[#class_Entity|Entity]])</span>
|rowspan="1"|<span id="class_ModelHeading">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ModelHeading/  <span style="color:green"> '''ModelHeading'''</span>]<br> (subtype of [[#class_Entity|Entity]])</span>
|1..1<br>
|1..1<br>
|colspan="2"|alias
|colspan="2"|<span style="color:olive">alias</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|An alias or reference term that can be used throughout a query as shorthand for the result set
|An alias or reference term that can be used throughout a query as shorthand for the result set
Line 238: Line 238:
|rowspan="5"|<span id="class_Entity">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Entity/  <span style="color:green"> '''Entity'''</span>]</span>
|rowspan="5"|<span id="class_Entity">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Entity/  <span style="color:green"> '''Entity'''</span>]</span>
|1..1<br>
|1..1<br>
|colspan="2"|label
|colspan="2"|<span style="color:olive">label</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|the name of the entity
|the name of the entity
Line 244: Line 244:
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|comment
|colspan="2"|<span style="color:olive">comment</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|the description of the entity
|the description of the entity
Line 250: Line 250:
|-
|-
|1..1<br>
|1..1<br>
|colspan="2"|type
|colspan="2"|<span style="color:olive">type</span>
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|the base type of the entity i.e. one of the high level entity types
|the base type of the entity i.e. one of the high level entity types
Line 256: Line 256:
|-
|-
|1..1<br>
|1..1<br>
|colspan="2"|status
|colspan="2"|<span style="color:olive">status</span>
|<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span>
|<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span>
|the status of the entity being active, inactive, draft or unassigned
|the status of the entity being active, inactive, draft or unassigned
Line 262: Line 262:
|-
|-
|1..1<br>
|1..1<br>
|colspan="2"|scheme
|colspan="2"|<span style="color:olive">scheme</span>
|<span title="Core graphs for core ontologies 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>
|<span title="Core graphs for core ontologies 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 code scheme or graph which the entity belongs to
|The code scheme or graph which the entity belongs to

Revision as of 11:22, 24 August 2022

Class Field Type Comment
QueryRequest 0..1
page PageInformation optional page number and size if the client is looking for paged results
0..1
textSearch xsd:string If a free text search is part of the query
0..*
argument Argument arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs
1..1
or
1..1
query Query The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach

1..1

queryIri sh:IRI The IRI of a predefined query in the information model. i.e. request the system to run query X
0..1
referenceDate im:DateTime reference date for date ranges that use reference date. Note that it could be passed in as an argeument
PageInformation 1..1
pageNumber xsd:integer Page number (starting at 1)
1..1
pageSize xsd:integer number of entries per page
Argument 1..1
parameter xsd:string Parameter name for a function or the parameter name for an argument
1..1
or
1..1
valueData xsd:string Vaue that is a literal such as a string or number

1..1

valueVariable xsd:string argumenT value which is a variable name to be resolved at run time

1..1

valueSelect SelectClause Argument value that is the result of a select query

1..1

valueIri sh:IRI Argument value that is an iri
Query
(subtype of ModelHeading)
0..1
resultFormat xsd:string Whether the result set is required flat select style json or a nested graphql json object style 'RELATIONAL' or 'OBJECT. Default is OBJECT
0..1
usePrefixes xsd:boolean true if you want the results to use IRI prefixes
0..1
activeOnly xsd:boolean Whether only active entities are included in the match clauses or select clauses
1..1
or
1..1
select SelectClause Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability

0..1

ask MatchClause If the query is a boolean true or false use match clauses as an ask
0..1
mainEntity sh:NodeShape The main entity to which all matches must be related e.g. Patient or organisation. i.e. the IRI of a data model entity (SHACL shape)
SelectClause
(subtype of ModelHeading)
0..1
count xsd:boolean If the query result is simply a sum of the main entities found. equivalent to COUNT(ie)
0..1
or
0..*
property PropertySelectClause Information about a property or field to includein the results. Property select supports nesting with selects for the objects that may be values of the property

1..1

pathToTarget PathTargetClause Special function for path query. Information about the target entity when the query is looking to return paths between a source and a target. Both are likely to be passed in as parameters
0..*
match MatchClause The match pattern to which the select clause must comply. Equivalent to a where/filter in SPARQL and JOIN/WHERE in SQL
0..1
distinct xsd:boolean Whether the entity objects returned should be distinct
0..1
or
1..1
entityType ConceptReference The entity type for instances this select clause operates on. Options include including subtypes.

1..1

entityId ConceptReference An instance of an enttu for which this select clause operates. As in entity type, optionally to include subtypes, where the entity id is a concept

1..1

entityIn rdfs:Resource The consept set, value set, or query result set that forms the base population of instances on which the select clause operates. e.g. a parent cohort.
0..*
groupBy PropertySelectClause If the results need to be grouped, the grouping properties.
0..*
orderLimit OrderLimitClause Ordering of instances via a property value and limiting th enumber returned.
0..*
subselect SelectClause For a query with column groups such as a list report, the select query for each group
ModelHeading
(subtype of Entity)
1..1
alias xsd:string An alias or reference term that can be used throughout a query as shorthand for the result set
MatchClause
PropertySelectClause
PathTargetClause
ConceptReference
OrderLimitClause
Entity 1..1
label xsd:string the name of the entity
0..1
comment xsd:string the description of the entity
1..1
type rdfs:Resource the base type of the entity i.e. one of the high level entity types
1..1
status im:Status the status of the entity being active, inactive, draft or unassigned
1..1
scheme im:Graph The code scheme or graph which the entity belongs to