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:navy"> '''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:navy"> '''QueryRequest'''</span>]</span>
|colspan="2"|<span style="color:green">page</span>
|colspan="2"|<span style="color:green">page</span>
|colspan="2"|0..1
|0..1
|<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:


|colspan="2"|<span style="color:green">textSearch</span>
|colspan="2"|<span style="color:green">textSearch</span>
|colspan="2"|0..1
|0..1
|<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:


|colspan="2"|<span style="color:green">argument</span>
|colspan="2"|<span style="color:green">argument</span>
|colspan="2"|0..*
|0..*
|<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
|-
|-


|rowspan="2"|or
|rowspan="2"|or<br>1..1
|<span style="color:green">query</span>
|<span style="color:green">query</span>
|rowspan="2"|1..1
|1..1
|1..1
|<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>
Line 42: Line 41:


|colspan="2"|<span style="color:green">referenceDate</span>
|colspan="2"|<span style="color:green">referenceDate</span>
|colspan="2"|0..1
|0..1
|<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 50: Line 49:
|rowspan="2"|<span id="class_PageInformation">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PageInformation/  <span style="color:navy"> '''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:navy"> '''PageInformation'''</span>]</span>
|colspan="2"|<span style="color:green">pageNumber</span>
|colspan="2"|<span style="color:green">pageNumber</span>
|colspan="2"|1..1
|1..1
|<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 56: Line 55:


|colspan="2"|<span style="color:green">pageSize</span>
|colspan="2"|<span style="color:green">pageSize</span>
|colspan="2"|1..1
|1..1
|<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 64: Line 63:
|rowspan="5"|<span id="class_Argument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Argument/  <span style="color:navy"> '''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:navy"> '''Argument'''</span>]</span>
|colspan="2"|<span style="color:green">parameter</span>
|colspan="2"|<span style="color:green">parameter</span>
|colspan="2"|1..1
|1..1
|<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
|-
|-


|rowspan="4"|or
|rowspan="4"|or<br>1..1
|<span style="color:green">valueData</span>
|<span style="color:green">valueData</span>
|rowspan="4"|1..1
|1..1
|1..1
|<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>
Line 101: Line 99:
|rowspan="6"|<span id="class_Query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/  <span style="color:navy"> '''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:navy"> '''Query'''</span>]<br> (subtype of [[#class_ModelHeading|ModelHeading]])</span>
|colspan="2"|<span style="color:green">resultFormat</span>
|colspan="2"|<span style="color:green">resultFormat</span>
|colspan="2"|0..1
|0..1
|<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 107: Line 105:


|colspan="2"|<span style="color:green">usePrefixes</span>
|colspan="2"|<span style="color:green">usePrefixes</span>
|colspan="2"|0..1
|0..1
|<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 113: Line 111:


|colspan="2"|<span style="color:green">activeOnly</span>
|colspan="2"|<span style="color:green">activeOnly</span>
|colspan="2"|0..1
|0..1
|<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
|-
|-


|rowspan="2"|or
|rowspan="2"|or<br>1..1
|<span style="color:green">select</span>
|<span style="color:green">select</span>
|rowspan="2"|1..1
|1..1
|1..1
|<span title="">[[#class_SelectClause|SelectClause]]</span>
|<span title="">[[#class_SelectClause|SelectClause]]</span>
Line 134: Line 131:


|colspan="2"|<span style="color:green">mainEntity</span>
|colspan="2"|<span style="color:green">mainEntity</span>
|colspan="2"|0..1
|0..1
|<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 142: Line 139:
|rowspan="11"|<span id="class_SelectClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SelectClause/  <span style="color:navy"> '''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:navy"> '''SelectClause'''</span>]<br> (subtype of [[#class_ModelHeading|ModelHeading]])</span>
|colspan="2"|<span style="color:green">count</span>
|colspan="2"|<span style="color:green">count</span>
|colspan="2"|0..1
|0..1
|<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)
|-
|-


|rowspan="2"|or
|rowspan="2"|or<br>0..1
|<span style="color:green">property</span>
|<span style="color:green">property</span>
|rowspan="2"|0..1
|0..*
|0..*
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
Line 163: Line 159:


|colspan="2"|<span style="color:green">match</span>
|colspan="2"|<span style="color:green">match</span>
|colspan="2"|0..*
|0..*
|<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 169: Line 165:


|colspan="2"|<span style="color:green">distinct</span>
|colspan="2"|<span style="color:green">distinct</span>
|colspan="2"|0..1
|0..1
|<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
|-
|-


|rowspan="3"|or
|rowspan="3"|or<br>0..1
|<span style="color:green">entityType</span>
|<span style="color:green">entityType</span>
|rowspan="3"|0..1
|1..1
|1..1
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
Line 197: Line 192:


|colspan="2"|<span style="color:green">groupBy</span>
|colspan="2"|<span style="color:green">groupBy</span>
|colspan="2"|0..*
|0..*
|<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 203: Line 198:


|colspan="2"|<span style="color:green">orderLimit</span>
|colspan="2"|<span style="color:green">orderLimit</span>
|colspan="2"|0..*
|0..*
|<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 209: Line 204:


|colspan="2"|<span style="color:green">subselect</span>
|colspan="2"|<span style="color:green">subselect</span>
|colspan="2"|0..*
|0..*
|<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 217: Line 212:
|rowspan="1"|<span id="class_ModelHeading">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ModelHeading/  <span style="color:navy"> '''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:navy"> '''ModelHeading'''</span>]<br> (subtype of [[#class_Entity|Entity]])</span>
|colspan="2"|<span style="color:green">alias</span>
|colspan="2"|<span style="color:green">alias</span>
|colspan="2"|1..1
|1..1
|<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 247: Line 242:
|rowspan="5"|<span id="class_Entity">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Entity/  <span style="color:navy"> '''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:navy"> '''Entity'''</span>]</span>
|colspan="2"|<span style="color:green">label</span>
|colspan="2"|<span style="color:green">label</span>
|colspan="2"|1..1
|1..1
|<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 253: Line 248:


|colspan="2"|<span style="color:green">comment</span>
|colspan="2"|<span style="color:green">comment</span>
|colspan="2"|0..1
|0..1
|<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 259: Line 254:


|colspan="2"|<span style="color:green">type</span>
|colspan="2"|<span style="color:green">type</span>
|colspan="2"|1..1
|1..1
|<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 265: Line 260:


|colspan="2"|<span style="color:green">status</span>
|colspan="2"|<span style="color:green">status</span>
|colspan="2"|1..1
|1..1
|<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 271: Line 266:


|colspan="2"|<span style="color:green">scheme</span>
|colspan="2"|<span style="color:green">scheme</span>
|colspan="2"|1..1
|1..1
|<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 13:59, 24 August 2022

Class Field Card. Type Comment
QueryRequest page 0..1 PageInformation optional page number and size if the client is looking for paged results
textSearch 0..1 xsd:string If a free text search is part of the query
argument 0..* Argument arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs
or
1..1
query 1..1 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

queryIri

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

valueVariable

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

valueSelect

1..1 SelectClause Argument value that is the result of a select query

valueIri

1..1 sh:IRI Argument value that is an iri
Query
(subtype of ModelHeading)
resultFormat 0..1 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
usePrefixes 0..1 xsd:boolean true if you want the results to use IRI prefixes
activeOnly 0..1 xsd:boolean Whether only active entities are included in the match clauses or select clauses
or
1..1
select 1..1 SelectClause Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability

ask

0..1 MatchClause If the query is a boolean true or false use match clauses as an ask
mainEntity 0..1 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)
count 0..1 xsd:boolean If the query result is simply a sum of the main entities found. equivalent to COUNT(ie)
or
0..1
property 0..* 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

pathToTarget

1..1 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
match 0..* MatchClause The match pattern to which the select clause must comply. Equivalent to a where/filter in SPARQL and JOIN/WHERE in SQL
distinct 0..1 xsd:boolean Whether the entity objects returned should be distinct
or
0..1
entityType 1..1 ConceptReference The entity type for instances this select clause operates on. Options include including subtypes.

entityId

1..1 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

entityIn

1..1 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.
groupBy 0..* PropertySelectClause If the results need to be grouped, the grouping properties.
orderLimit 0..* OrderLimitClause Ordering of instances via a property value and limiting th enumber returned.
subselect 0..* SelectClause For a query with column groups such as a list report, the select query for each group
ModelHeading
(subtype of Entity)
alias 1..1 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 label 1..1 xsd:string the name of the entity
comment 0..1 xsd:string the description of the entity
type 1..1 rdfs:Resource the base type of the entity i.e. one of the high level entity types
status 1..1 im:Status the status of the entity being active, inactive, draft or unassigned
scheme 1..1 im:Graph The code scheme or graph which the entity belongs to