DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
Line 3: | Line 3: | ||
!Class | !Class | ||
!colspan="2"|Field | !colspan="2"|Field | ||
!colspan="2"| | !colspan="2"|c | ||
!Type | !Type | ||
!Comment | !Comment | ||
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> | ||
|0..1<br> | |colspan="2"|0..1<br> | ||
||<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 21: | Line 21: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">argument</span> | |colspan="2"|<span style="color:green">argument</span> | ||
|0..*<br> | |colspan="2"|0..*<br> | ||
||<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"|colspan="2"|1..1<br>or | ||
|<span style="color:green">query</span> | |<span style="color:green">query</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
| | | | ||
<span style="color:green">queryIri</span> | <span style="color:green">queryIri</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">referenceDate</span> | |colspan="2"|<span style="color:green">referenceDate</span> | ||
|0..1<br> | |colspan="2"|0..1<br> | ||
||<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: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> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">pageSize</span> | |colspan="2"|<span style="color:green">pageSize</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: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> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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"|1..1<br>or | |rowspan="4"|colspan="2"|1..1<br>or | ||
|<span style="color:green">valueData</span> | |<span style="color:green">valueData</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
| | | | ||
<span style="color:green">valueVariable</span> | <span style="color:green">valueVariable</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
| | | | ||
<span style="color:green">valueSelect</span> | <span style="color:green">valueSelect</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
| | | | ||
<span style="color:green">valueIri</span> | <span style="color:green">valueIri</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: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> | ||
|0..1<br> | |colspan="2"|0..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">usePrefixes</span> | |colspan="2"|<span style="color:green">usePrefixes</span> | ||
|0..1<br> | |colspan="2"|0..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">activeOnly</span> | |colspan="2"|<span style="color:green">activeOnly</span> | ||
|0..1<br> | |colspan="2"|0..1<br> | ||
||<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"|1..1<br>or | |rowspan="2"|colspan="2"|1..1<br>or | ||
|<span style="color:green">select</span> | |<span style="color:green">select</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
| | | | ||
<span style="color:green">ask</span> | <span style="color:green">ask</span> | ||
|0..1<br> | |colspan="2"|0..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">mainEntity</span> | |colspan="2"|<span style="color:green">mainEntity</span> | ||
|0..1<br> | |colspan="2"|0..1<br> | ||
||<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: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> | ||
|0..1<br> | |colspan="2"|0..1<br> | ||
||<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"|0..1<br>or | |rowspan="2"|colspan="2"|0..1<br>or | ||
|<span style="color:green">property</span> | |<span style="color:green">property</span> | ||
|0..*<br> | |colspan="2"|0..*<br> | ||
||<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: | ||
| | | | ||
<span style="color:green">pathToTarget</span> | <span style="color:green">pathToTarget</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">match</span> | |colspan="2"|<span style="color:green">match</span> | ||
|0..*<br> | |colspan="2"|0..*<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">distinct</span> | |colspan="2"|<span style="color:green">distinct</span> | ||
|0..1<br> | |colspan="2"|0..1<br> | ||
||<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"|0..1<br>or | |rowspan="3"|colspan="2"|0..1<br>or | ||
|<span style="color:green">entityType</span> | |<span style="color:green">entityType</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
| | | | ||
<span style="color:green">entityId</span> | <span style="color:green">entityId</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
| | | | ||
<span style="color:green">entityIn</span> | <span style="color:green">entityIn</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">groupBy</span> | |colspan="2"|<span style="color:green">groupBy</span> | ||
|0..*<br> | |colspan="2"|0..*<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">orderLimit</span> | |colspan="2"|<span style="color:green">orderLimit</span> | ||
|0..*<br> | |colspan="2"|0..*<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">subselect</span> | |colspan="2"|<span style="color:green">subselect</span> | ||
|0..*<br> | |colspan="2"|0..*<br> | ||
||<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: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> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: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> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">comment</span> | |colspan="2"|<span style="color:green">comment</span> | ||
|0..1<br> | |colspan="2"|0..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">type</span> | |colspan="2"|<span style="color:green">type</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">status</span> | |colspan="2"|<span style="color:green">status</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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: | ||
|- | |- | ||
|colspan="2"|<span style="color:green">scheme</span> | |colspan="2"|<span style="color:green">scheme</span> | ||
|1..1<br> | |colspan="2"|1..1<br> | ||
||<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:38, 24 August 2022
Class | Field | c | 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 | |||
colspan="2"|1..1 or |
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 | ||
colspan="2"|1..1 or |
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 | |||
colspan="2"|1..1 or |
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) | ||
colspan="2"|0..1 or |
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 | |||
colspan="2"|0..1 or |
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 |