Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 7: Line 7:
!Comment
!Comment
|-
|-
|rowspan="6"|<span style="color:green" id="class_QueryRequest">[https://dev.endhealth.co.uk/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/ '''QueryRequest''']</span>
|rowspan="6"|<span style="color:green" id="class_QueryRequest">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/ '''QueryRequest''']</span>
|0..1<br>
|0..1<br>
|colspan="2"|page
|colspan="2"|page
Line 36: Line 36:
1..1<br>
1..1<br>
|queryIri
|queryIri
|<span title="international resource identifier">[https://dev.endhealth.co.uk/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 42: Line 42:
|0..1<br>
|0..1<br>
|colspan="2"|referenceDate
|colspan="2"|referenceDate
|<span title="im date time format">[https://dev.endhealth.co.uk/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


|-
|-
|rowspan="2"|<span style="color:green" id="class_PageInformation">[https://dev.endhealth.co.uk/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PageInformation/ '''PageInformation''']</span>
|rowspan="2"|<span style="color:green" id="class_PageInformation">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PageInformation/ '''PageInformation''']</span>
|1..1<br>
|1..1<br>
|colspan="2"|pageNumber
|colspan="2"|pageNumber
Line 59: Line 59:


|-
|-
|rowspan="5"|<span style="color:green" id="class_Argument">[https://dev.endhealth.co.uk/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Argument/ '''Argument''']</span>
|rowspan="5"|<span style="color:green" id="class_Argument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Argument/ '''Argument''']</span>
|1..1<br>
|1..1<br>
|colspan="2"|parameter
|colspan="2"|parameter
Line 77: Line 77:
|valueVariable
|valueVariable
|<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>
|argumetn 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 90: Line 90:
1..1<br>
1..1<br>
|valueIri
|valueIri
|<span title="international resource identifier">[https://dev.endhealth.co.uk/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 96: Line 96:
|
|
|-
|-
|rowspan="6"|<span style="color:green" id="class_Query">[https://dev.endhealth.co.uk/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/ '''Query''']<br> (subtype of [[#class_ModelHeading|ModelHeading]])</span>
|rowspan="6"|<span style="color:green" id="class_Query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/ '''Query''']<br> (subtype of [[#class_ModelHeading|ModelHeading]])</span>
|0..1<br>
|0..1<br>
|colspan="2"|resultFormat
|colspan="2"|resultFormat
Line 131: Line 131:
|0..1<br>
|0..1<br>
|colspan="2"|mainEntity
|colspan="2"|mainEntity
|<span title="international resource identifier">[https://dev.endhealth.co.uk/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</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.
|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)
 
|-
|rowspan="11"|<span style="color:green" id="class_SelectClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SelectClause/ '''SelectClause''']<br> (subtype of [[#class_ModelHeading|ModelHeading]])</span>
|0..1<br>
|colspan="2"|count
|<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)
 
|-
|rowspan="2"|0..1<br>or
|0..*<br>
|property
|<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
 
|-
|
1..1<br>
|pathToTarget
|<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
 
|-
|0..*<br>
|colspan="2"|match
|<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
 
|-
|0..1<br>
|colspan="2"|distinct
|<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether the entity objects returned should be distinct
 
|-
|rowspan="3"|0..1<br>or
|1..1<br>
|entityType
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|The entity type for instances this select clause operates on. Options include including subtypes.
 
|-
|
1..1<br>
|entityId
|<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
 
|-
|
1..1<br>
|entityIn
|<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.
 
|-
|0..*<br>
|colspan="2"|groupBy
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
|If the results need to be grouped, the grouping properties.
 
|-
|0..*<br>
|colspan="2"|orderLimit
|<span title="">[[#class_OrderLimitClause|OrderLimitClause]]</span>
|Ordering of instances via a property value and limiting th enumber returned.


|-
|-
|rowspan="1"|<span style="color:green" id="class_SelectClause">[https://dev.endhealth.co.uk/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SelectClause/ '''SelectClause''']</span>
|0..*<br>
|0..*<br>
|colspan="2"|subselect
|colspan="2"|subselect
Line 142: Line 207:


|-
|-
|rowspan="1"|<span style="color:green" id="class_ModelHeading">[https://dev.endhealth.co.uk/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ModelHeading/ '''ModelHeading''']<br> (subtype of [[#class_Entity|Entity]])</span>
|rowspan="1"|<span style="color:green" id="class_ModelHeading">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ModelHeading/ '''ModelHeading''']<br> (subtype of [[#class_Entity|Entity]])</span>
|1..1<br>
|1..1<br>
|colspan="2"|alias
|colspan="2"|alias
Line 149: Line 214:


|-
|-
|<span style="color:green" id="class_MatchClause">[https://dev.endhealth.co.uk/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23MatchClause/ '''MatchClause''']</span>
|<span style="color:green" id="class_MatchClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23MatchClause/ '''MatchClause''']</span>
|
|-
|-
 
|-
|<span style="color:green" id="class_PropertySelectClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertySelectClause/ '''PropertySelectClause''']</span>
|
|-
|-
|<span style="color:green" id="class_PathTargetClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PathTargetClause/ '''PathTargetClause''']</span>
|
|-
|-
|<span style="color:green" id="class_ConceptReference">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptReference/ '''ConceptReference''']</span>
|
|-
|-
|<span style="color:green" id="class_OrderLimitClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23OrderLimitClause/ '''OrderLimitClause''']</span>
|
|
|-
|-
|-
|-
|rowspan="5"|<span style="color:green" id="class_Entity">[https://dev.endhealth.co.uk/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Entity/ '''Entity''']</span>
|rowspan="5"|<span style="color:green" id="class_Entity">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Entity/ '''Entity''']</span>
|1..1<br>
|1..1<br>
|colspan="2"|label
|colspan="2"|label
Line 168: Line 251:
|1..1<br>
|1..1<br>
|colspan="2"|type
|colspan="2"|type
|<span title="">[https://dev.endhealth.co.uk/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 174: Line 257:
|1..1<br>
|1..1<br>
|colspan="2"|status
|colspan="2"|status
|<span title="A status that is in active or active">[https://dev.endhealth.co.uk/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 180: Line 263:
|1..1<br>
|1..1<br>
|colspan="2"|scheme
|colspan="2"|scheme
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://dev.endhealth.co.uk/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:14, 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