DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
Line 16: | Line 16: | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|textSearch | |colspan="2"|textSearch | ||
|<span title="any valid json value characters with json escapes"> | |<span title="any valid json value characters with json escapes">xsd:string</span> | ||
|If a free text search is part of the query | |If a free text search is part of the query | ||
Line 36: | Line 36: | ||
1..1<br> | 1..1<br> | ||
|queryIri | |queryIri | ||
|<span title="international resource identifier"> | |<span title="international resource identifier">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 42: | Line 42: | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|referenceDate | |colspan="2"|referenceDate | ||
|<span title="im date time format"> | |<span title="im date time format">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 49: | Line 49: | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|pageNumber | |colspan="2"|pageNumber | ||
|<span title="whole number"> | |<span title="whole number">xsd:integer</span> | ||
|Page number (starting at 1) | |Page number (starting at 1) | ||
Line 55: | Line 55: | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|pageSize | |colspan="2"|pageSize | ||
|<span title="whole number"> | |<span title="whole number">xsd:integer</span> | ||
|number of entries per page | |number of entries per page | ||
Line 62: | Line 62: | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|parameter | |colspan="2"|parameter | ||
|<span title="any valid json value characters with json escapes"> | |<span title="any valid json value characters with json escapes">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 69: | Line 69: | ||
|1..1<br> | |1..1<br> | ||
|valueData | |valueData | ||
|<span title="any valid json value characters with json escapes"> | |<span title="any valid json value characters with json escapes">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 76: | Line 76: | ||
1..1<br> | 1..1<br> | ||
|valueVariable | |valueVariable | ||
|<span title="any valid json value characters with json escapes"> | |<span title="any valid json value characters with json escapes">xsd:string</span> | ||
|argumetn value which is a variable name to be resolved at run time | |argumetn value which is a variable name to be resolved at run time | ||
Line 83: | Line 83: | ||
1..1<br> | 1..1<br> | ||
|valueSelect | |valueSelect | ||
|<span title=" | |<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 90: | Line 90: | ||
1..1<br> | 1..1<br> | ||
|valueIri | |valueIri | ||
|<span title="international resource identifier"> | |<span title="international resource identifier">sh:IRI</span> | ||
|Argument value that is an iri | |Argument value that is an iri | ||
Line 99: | Line 99: | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|resultFormat | |colspan="2"|resultFormat | ||
|<span title="any valid json value characters with json escapes"> | |<span title="any valid json value characters with json escapes">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 105: | Line 105: | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|usePrefixes | |colspan="2"|usePrefixes | ||
|<span title=""> | |<span title="">xsd:boolean</span> | ||
|true if you want the results to use IRI prefixes | |true if you want the results to use IRI prefixes | ||
Line 111: | Line 111: | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|activeOnly | |colspan="2"|activeOnly | ||
|<span title=""> | |<span title="">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 131: | Line 131: | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|mainEntity | |colspan="2"|mainEntity | ||
|<span title="international resource identifier"> | |<span title="international resource identifier">sh:IRI</span> | ||
|The main entity to which all matches must be related e.g. Patient or organisation. | |The main entity to which all matches must be related e.g. Patient or organisation. | ||
|- | |- | ||
|<span style="color:green" id=" | |rowspan="1"|<span style="color:green" id="class_SelectClause">'''SelectClause'''</span> | ||
| | |0..*<br> | ||
| | |colspan="2"|subselect | ||
|<span title="">[[#class_SelectClause|SelectClause]]</span> | |||
|For a query with column groups such as a list report, the select query for each group | |||
|- | |- | ||
|rowspan="1"|<span style="color:green" id="class_ModelHeading">'''ModelHeading'''<br> (subtype of [[#class_Entity|Entity]])</span> | |rowspan="1"|<span style="color:green" id="class_ModelHeading">'''ModelHeading'''<br> (subtype of [[#class_Entity|Entity]])</span> | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|alias | |colspan="2"|alias | ||
|<span title="any valid json value characters with json escapes"> | |<span title="any valid json value characters with json escapes">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 160: | Line 156: | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|label | |colspan="2"|label | ||
|<span title="any valid json value characters with json escapes"> | |<span title="any valid json value characters with json escapes">xsd:string</span> | ||
|the name of the entity | |the name of the entity | ||
Line 166: | Line 162: | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|comment | |colspan="2"|comment | ||
|<span title="any valid json value characters with json escapes"> | |<span title="any valid json value characters with json escapes">xsd:string</span> | ||
|the description of the entity | |the description of the entity | ||
Line 172: | Line 168: | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|type | |colspan="2"|type | ||
|<span title=""> | |<span title="">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 178: | Line 174: | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|status | |colspan="2"|status | ||
|<span title=""> | |<span title="A status that is in active or active">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 184: | Line 180: | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|scheme | |colspan="2"|scheme | ||
|<span title=""> | |<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">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 08:17, 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 | argumetn 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:IRI | The main entity to which all matches must be related e.g. Patient or organisation. | ||
SelectClause | 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 | |||||
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 |