|
|
| Line 1: |
Line 1: |
| == Basic shapes ==
| |
| These shapes are the meta classes of the named entities within the information model.
| |
| {| class="wikitable"
| |
| |+
| |
| !Shape
| |
| !colspan="2"|Property
| |
| !Card.
| |
| !Value type
| |
| !Comment
| |
| |-
| |
| |rowspan="2"|<span id="class_IrirRef">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/ <span style="color:navy"> '''IrirRef'''</span>]</span>
| |
| |colspan="4"|
| |
| |A resource with an iri and name
| |
| |-
| |
| |colspan="2"|<span style="color:green">label</span>
| |
| |1..1
| |
| |<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
| |
| |-
| |
| |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>]<br> (subtype of [[#class_IrirRef|IrirRef]])</span>
| |
| |colspan="4"|
| |
| |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
| |
| |-
| |
| |colspan="2"|<span style="color:green">comment</span>
| |
| |0..1
| |
| |<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
| |
| |-
| |
|
| |
|
| |colspan="2"|<span style="color:green">type</span>
| |
| |1..1
| |
| |<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
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">status</span>
| |
| |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>
| |
| |The status of the entity being active, inactive, draft or unassigned
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">scheme</span>
| |
| |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>
| |
| |The code scheme or graph which the entity belongs to
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="2"|<span id="class_IriAlias">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriAlias/ <span style="color:navy"> '''IriAlias'''</span>]<br> (subtype of [[#class_IrirRef|IrirRef]])</span>
| |
| |colspan="4"|
| |
| |An IRI with a name and an alias (for use as variables for reference
| |
| |-
| |
| |colspan="2"|<span style="color:green">alias</span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |The column name in a select clause for this property, or a variable used to reference the result set of the values matched
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |}
| |
|
| |
| == Query language shapes ==
| |
| These shapes form the query language DSL for retrieving data from the IM or health records.
| |
| {| class="wikitable"
| |
| |+
| |
| !Shape
| |
| !colspan="2"|Property
| |
| !Card.
| |
| !Value type
| |
| !Comment
| |
| |-
| |
| |rowspan="7"|<span id="class_Query Request">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/ <span style="color:navy"> '''Query Request'''</span>]</span>
| |
| |colspan="4"|
| |
| |A request for data sent as a body (json in local name format) to the /queryIM API.<br>Contains either a query or query iri with run time variable values for use in the query
| |
| |-
| |
| |colspan="2"|<span style="color:green">page</span>
| |
| |0..1
| |
| |<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
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">textSearch</span>
| |
| |0..1
| |
| |<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
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">argument</span>
| |
| |0..*
| |
| |<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
| |
| |-
| |
|
| |
| |rowspan="2"|or<br>1..1
| |
| |<span style="color:green">query</span>
| |
| |1..1
| |
| |<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
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">queryIri</span>
| |
| |1..1
| |
| |<span title="A Query definition holding the logical definition of a query in a standard language">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/ im:Query]</span>
| |
| |The IRI of a predefined query in the information model. i.e. request the system to run query X
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">referenceDate</span>
| |
| |0..1
| |
| |<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
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="3"|<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="4"|
| |
| |Information about paging if the client wishes to page results, including page number and page size
| |
| |-
| |
| |colspan="2"|<span style="color:green">pageNumber</span>
| |
| |1..1
| |
| |<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
| |
| |Page number (starting at 1)
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">pageSize</span>
| |
| |1..1
| |
| |<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
| |
| |number of entries per page
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="6"|<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="4"|
| |
| |A named parameter and a value for passing into a function
| |
| |-
| |
| |colspan="2"|<span style="color:green">parameter</span>
| |
| |1..1
| |
| |<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
| |
| |-
| |
|
| |
| |rowspan="4"|or<br>1..1
| |
| |<span style="color:green">valueData</span>
| |
| |1..1
| |
| |<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
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">valueVariable</span>
| |
| |1..1
| |
| |<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
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">valueSelect</span>
| |
| |1..1
| |
| |<span title="">[[#class_SelectClause|SelectClause]]</span>
| |
| |Argument value that is the result of a select query
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">valueIri</span>
| |
| |1..1
| |
| |<span title="A resource with an iri and name">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/ im:IriRef]</span>
| |
| |Argument value that is an iri
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="7"|<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_ClauseHeading|ClauseHeading]])</span>
| |
| |colspan="4"|
| |
| |A Query definition holding the logical definition of a query in a standard language
| |
| |-
| |
| |colspan="2"|<span style="color:green">resultFormat</span>
| |
| |0..1
| |
| |<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
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">usePrefixes</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |true if you want the results to use IRI prefixes
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">activeOnly</span>
| |
| |0..1
| |
| |<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
| |
| |-
| |
|
| |
| |rowspan="2"|or<br>1..1
| |
| |<span style="color:green">select</span>
| |
| |1..1
| |
| |<span title="">[[#class_SelectClause|SelectClause]]</span>
| |
| |Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">ask</span>
| |
| |0..1
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.<br>Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
| |
| |If the query is a boolean true or false use match clauses as an ask
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">mainEntity</span>
| |
| |0..1
| |
| |<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)
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="12"|<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_ClauseHeading|ClauseHeading]])</span>
| |
| |colspan="4"|
| |
| |null
| |
| |-
| |
| |colspan="2"|<span style="color:green">count</span>
| |
| |0..1
| |
| |<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(id)
| |
| |-
| |
|
| |
| |rowspan="2"|or<br>0..1
| |
| |<span style="color:green">property</span>
| |
| |1..*
| |
| |<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
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">pathToTarget</span>
| |
| |1..1
| |
| |<span title="Information about the target of a path query, including the IRI of the target and the number of hops processed.">[[#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
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">match</span>
| |
| |0..*
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.<br>Supports graph traversal filtering and inference for subsumption query">[[#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
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">distinct</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Whether the entity objects returned should be distinct
| |
| |-
| |
|
| |
| |rowspan="3"|or<br>0..1
| |
| |<span style="color:green">entityType</span>
| |
| |1..1
| |
| |<span title="">[[#class_ConceptReference|ConceptReference]]</span>
| |
| |The entity type for instances this select clause operates on. Options include including subtypes.
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">entityId</span>
| |
| |1..1
| |
| |<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
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">entityIn</span>
| |
| |1..1
| |
| |<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.
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">groupBy</span>
| |
| |0..*
| |
| |<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
| |
| |If the results need to be grouped, the grouping properties.
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">orderLimit</span>
| |
| |0..*
| |
| |<span title="Orders the value of the property (property as represented by the iri and alias)">[[#class_OrderLimitClause|OrderLimitClause]]</span>
| |
| |Ordering of instances via a property value and limiting th enumber returned.
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">subselect</span>
| |
| |0..*
| |
| |<span title="">[[#class_SelectClause|SelectClause]]</span>
| |
| |For a query with column groups such as a list report, the select query for each group
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="2"|<span id="class_ClauseHeading">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ClauseHeading/ <span style="color:navy"> '''ClauseHeading'''</span>]<br> (subtype of [[#class_Entity|Entity]])</span>
| |
| |colspan="4"|
| |
| |General headings such as name description and alias
| |
| |-
| |
| |colspan="2"|<span style="color:green">alias</span>
| |
| |1..1
| |
| |<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
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="15"|<span id="class_MatchClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23MatchClause/ <span style="color:navy"> '''MatchClause'''</span>]<br> (subtype of [[#class_ClauseHeading|ClauseHeading]])</span>
| |
| |colspan="4"|
| |
| |A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.<br>Supports graph traversal filtering and inference for subsumption query
| |
| |-
| |
| |colspan="2"|<span style="color:green">pathTo</span>
| |
| |0..1
| |
| |<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
| |
| |A convenient way of traversing properties and objects to get to the match object, avoiding excessive nesting.<br>The properties are listed and thus traversed in strict order
| |
| |-
| |
|
| |
| |rowspan="2"|or<br>0..1
| |
| |<span style="color:green">or</span>
| |
| |2..*
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.<br>Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
| |
| |Boolean operator OR on subclauses
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">and</span>
| |
| |2..*
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.<br>Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
| |
| |Boolean operator AND on subclauses
| |
| |-
| |
|
| |
| |rowspan="2"|or<br>0..1
| |
| |<span style="color:green">entityType</span>
| |
| |1..1
| |
| |<span title="">[[#class_ConceptReference|ConceptReference]]</span>
| |
| |The entity type that matched instances must be (including subtypes). Options include including subtypes.
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">entityId</span>
| |
| |1..1
| |
| |<span title="">[[#class_ConceptReference|ConceptReference]]</span>
| |
| |An instance of an entitu for which this match clause operates on. As in entity type, optionally to include subtypes, where the entity id is a concept
| |
| |-
| |
|
| |
| |rowspan="2"|or<br>0..1
| |
| |<span style="color:green">entityInSet</span>
| |
| |1..1
| |
| |<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
| |
| |The concept set, value set, or query result set that the instances must be in to match.<br>on which the select clause operates. e.g. a parent cohort.
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">entityNotInSet</span>
| |
| |1..1
| |
| |<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
| |
| |The concept set, value set, or query result set that the instances must NOT be in to match.<br>on which the select clause operates. e.g. a parent cohort.
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">graph</span>
| |
| |0..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>
| |
| |The iri of a graph if the query is limied to a particular data set
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">property</span>
| |
| |0..*
| |
| |<span title="A property (Oas a concept reference) and value filter supporting ranges sets and functions,<br>As a result of the concept references, supports sub properties as well as inferred values">[[#class_PropertyValueClause|PropertyValueClause]]</span>
| |
| |Properties and their values required to match (or not match), including any nesting of objects (joins).<br>The default assumption is the AND operator on the properties. Use orProperty for or operator
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">orProperty</span>
| |
| |2..*
| |
| |<span title="A property (Oas a concept reference) and value filter supporting ranges sets and functions,<br>As a result of the concept references, supports sub properties as well as inferred values">[[#class_PropertyValueClause|PropertyValueClause]]</span>
| |
| |Properties and their values one of which is required to match (or not match), including any nesting of objects (joins).
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">notExist</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Negation indicator for this entire clause. i.e. for the instance to be included it must NOT match.
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">orderLimit</span>
| |
| |0..1
| |
| |<span title="Orders the value of the property (property as represented by the iri and alias)">[[#class_OrderLimitClause|OrderLimitClause]]</span>
| |
| |Ability to order and limit the match before the select or matchstatement operates.<br> Crucially, this is processed before the application of a test or check, enabling things like latest or earliest, max or min
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">testProperty</span>
| |
| |0..*
| |
| |<span title="A property (Oas a concept reference) and value filter supporting ranges sets and functions,<br>As a result of the concept references, supports sub properties as well as inferred values">[[#class_PropertyValueClause|PropertyValueClause]]</span>
| |
| |Further test applied to the result of an ordered limited match.<br> The rest of the match clause then becomes a sub select query on which these tests operate. Implicit operator is AND
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">displayText</span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Optional text for display in query viewer if dfferent from the match clause name
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="8"|<span id="class_PropertySelectClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertySelectClause/ <span style="color:navy"> '''PropertySelectClause'''</span>]<br> (subtype of [[#class_ConceptReference|ConceptReference]])</span>
| |
| |colspan="4"|
| |
| |null
| |
| |-
| |
| |rowspan="3"|or<br>0..1
| |
| |<span style="color:green">sum</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Whether the result is a summation of this property's values
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">average</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Whether the result is an average of this property's values
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">max</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Whether the result is the maximum of this property's values
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">select</span>
| |
| |0..1
| |
| |<span title="">[[#class_SelectClause|SelectClause]]</span>
| |
| |Nested select clause for graphql style results format
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">inverseOf</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Indicates if true that the selected property is an inverse relationship with the target object
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">function</span>
| |
| |0..1
| |
| |<span title="A named function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/ im:Function]</span>
| |
| |The iri of a function indicating that the result is the result of a function operating on the property values, and any arguments passed in
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">argument</span>
| |
| |0..*
| |
| |<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span>
| |
| |Arguments to pass into the function
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="2"|<span id="class_PathTargetClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PathTargetClause/ <span style="color:navy"> '''PathTargetClause'''</span>]<br> (subtype of [[#class_IrirRef|IrirRef]])</span>
| |
| |colspan="4"|
| |
| |Information about the target of a path query, including the IRI of the target and the number of hops processed.
| |
| |-
| |
| |colspan="2"|<span style="color:green">depth</span>
| |
| |0..1
| |
| |<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
| |
| |How many hops to be taken in the graph between source and target
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="4"|<span id="class_ConceptReference">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptReference/ <span style="color:navy"> '''ConceptReference'''</span>]<br> (subtype of [[#class_IriAlias|IriAlias]])</span>
| |
| |colspan="4"|
| |
| |null
| |
| |-
| |
| |colspan="2"|<span style="color:green">includeSubtypes</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Whether to include the subtypes of the entites selected or matched
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">includeSupertypes</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Whether to include the supertypes of the entity in a match clause. Used for ascending the hierarch to look for properties inherited
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">excludeSelf</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Whether to exclude this entity when either include supbtypes or include suprtypes is set. Rarely used but sometimes found in ECL definitions
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="4"|<span id="class_OrderLimitClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23OrderLimitClause/ <span style="color:navy"> '''OrderLimitClause'''</span>]</span>
| |
| |colspan="4"|
| |
| |Orders the value of the property (property as represented by the iri and alias)
| |
| |-
| |
| |colspan="2"|<span style="color:green">orderBy</span>
| |
| |1..1
| |
| |<span title="An IRI with a name and an alias (for use as variables for reference">[[#class_IriAlias|IriAlias]]</span>
| |
| |The property or property variable to order the results by
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">direction</span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |ASCENDING or DESCENDING to indicate the order direction
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">limit</span>
| |
| |0..1
| |
| |<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
| |
| |The count of instances to return after ordering
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="15"|<span id="class_PropertyValueClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyValueClause/ <span style="color:navy"> '''PropertyValueClause'''</span>]<br> (subtype of [[#class_ConceptReference|ConceptReference]])</span>
| |
| |colspan="4"|
| |
| |A property (Oas a concept reference) and value filter supporting ranges sets and functions,<br>As a result of the concept references, supports sub properties as well as inferred values
| |
| |-
| |
| |colspan="2"|<span style="color:green">optional</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Optional match for this property, used to enable IF a present then A must have X,Y.<br> N.B for SPARQL experts the OPTIONAL is generally generated automatically from SELECT, so optional need only be set when a test is to be applied to a linked object
| |
| |-
| |
|
| |
| |rowspan="7"|or<br>0..1
| |
| |<span style="color:green">value</span>
| |
| |1..1
| |
| |<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
| |
| |If testing a property value as equal greater than ete. use compare
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">inSet</span>
| |
| |1..*
| |
| |<span title="">[[#class_ConceptReference|ConceptReference]]</span>
| |
| |The value of the property must be in the concept set IRI.<br>For teesting simple lists or single concepts use isConcept
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">notInSet</span>
| |
| |1..*
| |
| |<span title="">[[#class_ConceptReference|ConceptReference]]</span>
| |
| |The value of the property must NOT be in the concept set IRI.<br> Note that this is not negation of the entire match, only the negation of this entry instance when tested. Equivalent to SPARQL filter not in.<br> For testing simple lists of concepts use isNotConcept
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">isConcept</span>
| |
| |1..*
| |
| |<span title="">[[#class_ConceptReference|ConceptReference]]</span>
| |
| |The value of the property be this concept (and otionally its sub types).<br> Used for inline sets or single concepts
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">isNotConcept</span>
| |
| |1..*
| |
| |<span title="">[[#class_ConceptReference|ConceptReference]]</span>
| |
| |The value of the property must NOT be this concept (and otionally its sub types).<br> Used for inline sets or single concepts.<br>Note that this is not negation of the entire match, only the negation of this entry instance when tested. Equivalent to SPARQL filter not in.
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">inRange</span>
| |
| |1..1
| |
| |<span title="A range for use in property value testing">[[#class_RangeClause|RangeClause]]</span>
| |
| |Test foe a value being between two absolute or relative values
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">valueMatch</span>
| |
| |1..1
| |
| |<span title="A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.<br>Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
| |
| |The match clause operating on the property value object.<br> Equivalent to a join in SQL or '.' in sparql
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">pathTo</span>
| |
| |0..1
| |
| |<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
| |
| |A convenient way of traversing properties and objects to get to a property, avoiding excessive nesting.<br>The properties are listed and thus traversed in strict order
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">function</span>
| |
| |1..1
| |
| |<span title="A function used in a query consisting of the function iri and one or more arguments to pass in at run time">[[#class_FunctionClause|FunctionClause]]</span>
| |
| |A function that operates on the property value (and other parameters) prior to a compare or range or inclusion test. For example a time difference function operating on the date and a reference date.<br>Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">inverseOf</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |Tests the property as an inverse property (inbound relationship)
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">notExist</span>
| |
| |0..1
| |
| |<span title="">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
| |
| |The property match must not exist. This is negatation at a more granular level than the match clause.<br>For example to test for a null field or absent property
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">argument</span>
| |
| |0..1
| |
| |<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span>
| |
| |Arguments to pass into a function when the property is a function property.<br>Note that if the test is a function then the argument list would be in the function clause
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">displayText</span>
| |
| |0..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Optional text for display in query viewer if dfferent from the match clause name
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="5"|<span id="class_CompareClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23CompareClause/ <span style="color:navy"> '''CompareClause'''</span>]</span>
| |
| |colspan="4"|
| |
| |Tests a value, whether equal, greater than, less than etc.
| |
| |-
| |
| |colspan="2"|<span style="color:green">comparison</span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |Comparison operators : EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, NOT_EQUAL
| |
| |-
| |
|
| |
| |rowspan="3"|or<br>1..1
| |
| |<span style="color:green">valueData</span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |The value to compare against. This is a string which will be cast to a number or date, depending on the data type of the property value
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">valueVariable</span>
| |
| |1..1
| |
| |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
| |
| |The variable (alias) to compare against. The variable may be an argument to the query (e.g. $reference date or an alias in this query or another query. Use the $ prefix to make it clear
| |
| |-
| |
|
| |
| |
| |
| <span style="color:green">valueSelect</span>
| |
| |1..1
| |
| |<span title="">[[#class_SelectClause|SelectClause]]</span>
| |
| |The result to compare the property value against is derived from a select sub query
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="3"|<span id="class_RangeClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RangeClause/ <span style="color:navy"> '''RangeClause'''</span>]</span>
| |
| |colspan="4"|
| |
| |A range for use in property value testing
| |
| |-
| |
| |colspan="2"|<span style="color:green">from</span>
| |
| |1..1
| |
| |<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
| |
| |The value comparison for lower end of the range
| |
| |-
| |
|
| |
| |colspan="2"|<span style="color:green">to</span>
| |
| |1..1
| |
| |<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
| |
| |The value comparison of upper end of the range
| |
| |-
| |
|
| |
| |-
| |
| |rowspan="2"|<span id="class_FunctionClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionClause/ <span style="color:navy"> '''FunctionClause'''</span>]<br> (subtype of [[#class_IrirRef|IrirRef]])</span>
| |
| |colspan="4"|
| |
| |A function used in a query consisting of the function iri and one or more arguments to pass in at run time
| |
| |-
| |
| |colspan="2"|<span style="color:green">argument</span>
| |
| |0..*
| |
| |<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span>
| |
| |Arguments to pass into the function. They should match the parameter definitions of the function
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |-
| |
|
| |
| |}
| |
|
| |
| == Data Model shapes ==
| |
| These shapes are the meta classes of the data modelling entities within the information model.
| |
| {| class="wikitable"
| |
| |+
| |
| !Shape
| |
| !colspan="2"|Property
| |
| !Card.
| |
| !Value type
| |
| !Comment
| |
| |-
| |
|
| |
| |}
| |
|
| |
| == Transactional entity filing shapes ==
| |
| These shapes form the meta classes for entities to be filed into the model or health records.
| |
| {| class="wikitable"
| |
| |+
| |
| !Shape
| |
| !colspan="2"|Property
| |
| !Card.
| |
| !Value type
| |
| !Comment
| |
| |-
| |
|
| |
| |}
| |
