|
|
| Line 1: |
Line 1: |
| {| class="wikitable"
| |
| |+
| |
| !Rule/property/API
| |
| !Overview
| |
| !Cardinality
| |
| !colspan="2"|Subrule/property or literal type
| |
| |-
| |
| |rowspan="6"|<span style="color:green" id="rule_.../queryIM">'''.../queryIM'''</span>
| |
| |rowspan="6"|A request containing a query to be passed as a payload to the queryIM API.
| |
| |0..1<br>
| |
| |colspan="2"|<span title="optional page number and size if the client is looking for paged results"> [[#rule_page|page]]</span>
| |
| |-
| |
| |0..1<br>
| |
| |colspan="2"|<span title="If a free text search is part of the query"> [[#rule_textSearch|textSearch]]</span>
| |
| |-
| |
| |0..*<br>
| |
| |colspan="2"|<span title="arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs"> [[#rule_argument|argument]]</span>
| |
| |-
| |
| |rowspan="2"|1..1<br>or
| |
| |1..1<br>
| |
| |<span title="The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach"> [[#rule_query|query]]</span>
| |
| |-
| |
| |
| |
| 1..1<br>
| |
| |<span title="The IRI of a predefined query in the information model. i.e. request the system to run query X"> [[#rule_queryIri|queryIri]]</span>
| |
| |-
| |
| |0..1<br>
| |
| |colspan="2"|<span title="reference date for date ranges that use reference date. Note that it could be passed in as an argeument"> [[#rule_referenceDate|referenceDate]]</span>
| |
| |-
| |
| |rowspan="2"|<span style="color:green" id="rule_page">'''page'''</span>
| |
| |rowspan="2"|Information about paging if the client wishes to page results, including page number and page size
| |
| |1..1<br>
| |
| |colspan="2"|<span title="Page number (starting at 1)"> [[#rule_pageNumber|pageNumber]]</span>
| |
| |-
| |
| |1..1<br>
| |
| |colspan="2"|<span title="number of entries per page"> [[#rule_pageSize|pageSize]]</span>
| |
| |-
| |
| |<span style="color:green" id="rule_textSearch">'''textSearch'''</span>
| |
| |If a free text search is part of the query
| |
| |
| |
| |colspan="2"|<span title="any valid json value characters with json escapes">Text</span>
| |
| |-
| |
| |rowspan="5"|<span style="color:green" id="rule_argument">'''argument'''</span>
| |
| |rowspan="5"|A named parameter and a value for passing into a function
| |
| |1..1<br>
| |
| |colspan="2"|<span title="Parameter name for a function or the parameter name for an argument"> [[#rule_parameter|parameter]]</span>
| |
| |-
| |
| |rowspan="4"|1..1<br>or
| |
| |1..1<br>
| |
| |<span title="Vaue that is a literal such as a string or number"> [[#rule_valueData|valueData]]</span>
| |
| |-
| |
| |
| |
| 1..1<br>
| |
| |<span title="argumetn value which is a variable name to be resolved at run time"> [[#rule_valueVariable|valueVariable]]</span>
| |
| |-
| |
| |
| |
| 1..1<br>
| |
| |<span title="Argument value that is the result of a select query"> [[#rule_valueSelect|valueSelect]]</span>
| |
| |-
| |
| |
| |
| 1..1<br>
| |
| |<span title="Argument value that is an iri"> [[#rule_valueIri|valueIri]]</span>
| |
| |-
| |
| |
| |
| |-
| |
| |rowspan="7"|<span style="color:green" id="rule_query">'''query'''<br> (subtype of [[#rule_ModelHeading|ModelHeading]])</span>
| |
| |rowspan="7"|A Query definition holding the logical definition of a query in a standard language
| |
| |0..1<br>
| |
| |colspan="2"|<span title="Whether the result set is required flat select style json or a nested graphql json object style 'RELATIONAL' or 'OBJECT. Default is OBJECT"> [[#rule_resultFormat|resultFormat]]</span>
| |
| |-
| |
| |0..1<br>
| |
| |colspan="2"|<span title="true if you want the results to use IRI prefixes"> [[#rule_usePrefixes|usePrefixes]]</span>
| |
| |-
| |
| |0..1<br>
| |
| |colspan="2"|<span title="Whether only active entities are included in the match clauses or select clauses"> [[#rule_activeOnly|activeOnly]]</span>
| |
| |-
| |
| |rowspan="2"|1..1<br>or
| |
| |1..1<br>
| |
| |<span title="Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability"> [[#rule_select|select]]</span>
| |
| |-
| |
| |
| |
| 0..1<br>
| |
| |<span title="If the query is a boolean true or false use match clauses as an ask"> [[#rule_ask|ask]]</span>
| |
| |-
| |
| |0..*<br>
| |
| |colspan="2"|<span title="For a query with column groups such as a list report, the select query for each group"> [[#rule_subselect|subselect]]</span>
| |
| |-
| |
| |0..1<br>
| |
| |colspan="2"|<span title="The main entity to which all matches must be related e.g. Patient or organisation."> [[#rule_mainEntity|mainEntity]]</span>
| |
| |-
| |
| |<span style="color:green" id="rule_queryIri">'''queryIri'''</span>
| |
| |The IRI of a predefined query in the information model. i.e. request the system to run query X
| |
| |
| |
| |colspan="2"|<span title="international resource identifier">IRI</span>
| |
| |-
| |
| |<span style="color:green" id="rule_referenceDate">'''referenceDate'''</span>
| |
| |reference date for date ranges that use reference date. Note that it could be passed in as an argeument
| |
| |
| |
| |colspan="2"|<span title="im date time format">im:DateTime</span>
| |
| |-
| |
| |<span style="color:green" id="rule_pageNumber">'''pageNumber'''</span>
| |
| |Page number (starting at 1)
| |
| |
| |
| |colspan="2"|<span title="whole number">Integer</span>
| |
| |-
| |
| |<span style="color:green" id="rule_pageSize">'''pageSize'''</span>
| |
| |number of entries per page
| |
| |
| |
| |colspan="2"|<span title="whole number">Integer</span>
| |
| |-
| |
| |<span style="color:green" id="rule_parameter">'''parameter'''</span>
| |
| |Parameter name for a function or the parameter name for an argument
| |
| |
| |
| |colspan="2"|<span title="any valid json value characters with json escapes">Text</span>
| |
| |-
| |
| |<span style="color:green" id="rule_valueData">'''valueData'''</span>
| |
| |Vaue that is a literal such as a string or number
| |
| |
| |
| |colspan="2"|<span title="any valid json value characters with json escapes">Text</span>
| |
| |-
| |
| |<span style="color:green" id="rule_valueVariable">'''valueVariable'''</span>
| |
| |argumetn value which is a variable name to be resolved at run time
| |
| |
| |
| |colspan="2"|<span title="any valid json value characters with json escapes">Text</span>
| |
| |-
| |
| |<span style="color:green" id="rule_valueSelect">'''valueSelect'''</span>
| |
| |Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability
| |
| |
| |
| |-
| |
| |-
| |
| |<span style="color:green" id="rule_valueIri">'''valueIri'''</span>
| |
| |Argument value that is an iri
| |
| |
| |
| |colspan="2"|<span title="international resource identifier">IRI</span>
| |
| |-
| |
| |<span style="color:green" id="rule_resultFormat">'''resultFormat'''</span>
| |
| |Whether the result set is required flat select style json or a nested graphql json object style 'RELATIONAL' or 'OBJECT. Default is OBJECT
| |
| |
| |
| |colspan="2"|<span title="any valid json value characters with json escapes">Text</span>
| |
| |-
| |
| |<span style="color:green" id="rule_usePrefixes">'''usePrefixes'''</span>
| |
| |true if you want the results to use IRI prefixes
| |
| |
| |
| |colspan="2"|xsd:boolean
| |
| |-
| |
| |<span style="color:green" id="rule_activeOnly">'''activeOnly'''</span>
| |
| |Whether only active entities are included in the match clauses or select clauses
| |
| |
| |
| |colspan="2"|xsd:boolean
| |
| |-
| |
| |<span style="color:green" id="rule_select">'''select'''</span>
| |
| |null
| |
| |
| |
| |-
| |
| |-
| |
| |<span style="color:green" id="rule_ask">'''ask'''</span>
| |
| |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
| |
| |
| |
| |-
| |
| |-
| |
|
| |
|
| |-
| |
| |<span style="color:green" id="rule_mainEntity">'''mainEntity'''</span>
| |
| |The main entity to which all matches must be related e.g. Patient or organisation.
| |
| |
| |
| |colspan="2"|<span title="international resource identifier">IRI</span>
| |
| |-
| |
| |rowspan="1"|<span style="color:green" id="rule_ModelHeading">'''ModelHeading'''<br> (subtype of [[#rule_Entity|Entity]])</span>
| |
| |rowspan="1"|General headings such as name description and alias
| |
| |1..1<br>
| |
| |colspan="2"|<span title="An alias or reference term that can be used throughout a query as shorthand for the result set"> [[#rule_alias|alias]]</span>
| |
| |-
| |
| |rowspan="5"|<span style="color:green" id="rule_Entity">'''Entity'''</span>
| |
| |rowspan="5"|The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status
| |
| |1..1<br>
| |
| |colspan="2"|<span title="the name of the entity"> [[#rule_label|label]]</span>
| |
| |-
| |
| |0..1<br>
| |
| |colspan="2"|<span title="the description of the entity"> [[#rule_comment|comment]]</span>
| |
| |-
| |
| |1..1<br>
| |
| |colspan="2"|<span title="the base type of the entity i.e. one of the high level entity types"> [[#rule_type|type]]</span>
| |
| |-
| |
| |1..1<br>
| |
| |colspan="2"|<span title="the status of the entity being active, inactive, draft or unassigned"> [[#rule_status|status]]</span>
| |
| |-
| |
| |1..1<br>
| |
| |colspan="2"|<span title="The code scheme or graph which the entity belongs to"> [[#rule_scheme|scheme]]</span>
| |
| |-
| |
| |<span style="color:green" id="rule_alias">'''alias'''</span>
| |
| |An alias or reference term that can be used throughout a query as shorthand for the result set
| |
| |
| |
| |colspan="2"|<span title="any valid json value characters with json escapes">Text</span>
| |
| |-
| |
| |<span style="color:green" id="rule_label">'''label'''</span>
| |
| |the name of the entity
| |
| |
| |
| |colspan="2"|<span title="any valid json value characters with json escapes">Text</span>
| |
| |-
| |
| |<span style="color:green" id="rule_comment">'''comment'''</span>
| |
| |the description of the entity
| |
| |
| |
| |colspan="2"|<span title="any valid json value characters with json escapes">Text</span>
| |
| |-
| |
| |<span style="color:green" id="rule_type">'''type'''</span>
| |
| |the base type of the entity i.e. one of the high level entity types
| |
| |
| |
| |colspan="2"|rdfs:Resource
| |
| |-
| |
| |<span style="color:green" id="rule_status">'''status'''</span>
| |
| |the status of the entity being active, inactive, draft or unassigned
| |
| |
| |
| |colspan="2"|im:Status
| |
| |-
| |
| |<span style="color:green" id="rule_scheme">'''scheme'''</span>
| |
| |The code scheme or graph which the entity belongs to
| |
| |
| |
| |colspan="2"|im:Graph
| |
| |-
| |
|
| |
| |}
| |
