Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 13: Line 13:
|A resource with an iri and name
|A resource with an iri and name
|-
|-
|colspan="2"|<span title="The name of the parameter"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ label]</span></span>
|colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label [/span></span>
|1..1
|1..1
|<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>
Line 24: Line 24:
|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
|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 title="Description of the property"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ comment]</span></span>
|colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment [/span></span>
|0..1
|0..1
|<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>
Line 30: Line 30:
|-
|-


|colspan="2"|<span title=""><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ type]</span></span>
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type [/span></span>
|1..1
|1..1
|<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>
Line 36: Line 36:
|-
|-


|colspan="2"|<span title="Status of relationship"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ status]</span></span>
|colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status [/span></span>
|1..1
|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>
|<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>
Line 42: Line 42:
|-
|-


|colspan="2"|<span title=""><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ scheme]</span></span>
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme [/span></span>
|1..1
|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>
|<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>
Line 48: Line 48:
|-
|-


|colspan="2"|<span title=""><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ subClassOf]</span></span>
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf [/span></span>
|0..*
|0..*
|<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/ im:EntityShape]</span>
|<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/ im:EntityShape]</span>
Line 59: Line 59:
|An IRI with a name and an alias (for use as variables for reference
|An IRI with a name and an alias (for use as variables for reference
|-
|-
|colspan="2"|<span title="The column name in a select clause for this property, or a variable used to reference the result set of the values matched"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23alias/ alias]</span></span>
|colspan="2"|<span title="The column name in a select clause for this property, or a variable used to reference the result set of the values matched">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23alias/ <span style="color:green">alias [/span></span>
|0..1
|0..1
|<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>
Line 87: Line 87:
|A query that is stored as an entity in a query library
|A query that is stored as an entity in a query library
|-
|-
|colspan="2"|<span title="The query definition itself"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23query/ query]</span></span>
|colspan="2"|<span title="The query definition itself">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23query/ <span style="color:green">query [/span></span>
|0..1
|0..1
|<span title="A Query definition holding the logical definition of a query in a standard language">[[#class_QueryDefinition|QueryDefinition]]</span>
|<span title="A Query definition holding the logical definition of a query in a standard language">[[#class_QueryDefinition|QueryDefinition]]</span>
Line 102: Line 102:
|A Query definition holding the logical definition of a query in a standard language
|A Query definition holding the logical definition of a query in a standard language
|-
|-
|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"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23resultFormat/ resultFormat]</span></span>
|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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23resultFormat/ <span style="color:green">resultFormat [/span></span>
|0..1
|0..1
|<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>
Line 108: Line 108:
|-
|-


|colspan="2"|<span title="true if you want the results to use IRI prefixes"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23usePrefixes/ usePrefixes]</span></span>
|colspan="2"|<span title="true if you want the results to use IRI prefixes">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23usePrefixes/ <span style="color:green">usePrefixes [/span></span>
|0..1
|0..1
|<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>
Line 114: Line 114:
|-
|-


|colspan="2"|<span title="Whether only active entities are included in the match clauses or select clauses"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23activeOnly/ activeOnly]</span></span>
|colspan="2"|<span title="Whether only active entities are included in the match clauses or select clauses">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23activeOnly/ <span style="color:green">activeOnly [/span></span>
|0..1
|0..1
|<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>
Line 121: Line 121:


|rowspan="2"|or<br>1..1
|rowspan="2"|or<br>1..1
|<span title="Nested select clause for graphql style results format"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23select/ select]</span></span>
|<span title="Nested select clause for graphql style results format">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23select/ <span style="color:green">select [/span></span>
|1..1
|1..1
|<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups">[[#class_SelectClause|SelectClause]]</span>
|<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups">[[#class_SelectClause|SelectClause]]</span>
Line 128: Line 128:


|
|
<span title="If the query is a boolean true or false use match clauses as an ask"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ask/ ask]</span></span>
<span title="If the query is a boolean true or false use match clauses as an ask">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ask/ <span style="color:green">ask [/span></span>
|0..1
|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.Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
|<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.Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
Line 134: Line 134:
|-
|-


|colspan="2"|<span title="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)"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23mainEntity/ mainEntity]</span></span>
|colspan="2"|<span title="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)">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23mainEntity/ <span style="color:green">mainEntity [/span></span>
|0..1
|0..1
|<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>
Line 145: Line 145:
|General headings such as name description and alias
|General headings such as name description and alias
|-
|-
|colspan="2"|<span title="The column name in a select clause for this property, or a variable used to reference the result set of the values matched"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23alias/ alias]</span></span>
|colspan="2"|<span title="The column name in a select clause for this property, or a variable used to reference the result set of the values matched">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23alias/ <span style="color:green">alias [/span></span>
|1..1
|1..1
|<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>
Line 156: Line 156:
|Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups
|Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups
|-
|-
|colspan="2"|<span title="If the query result is simply a sum of the main entities found. equivalent to COUNT(id)"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23count/ count]</span></span>
|colspan="2"|<span title="If the query result is simply a sum of the main entities found. equivalent to COUNT(id)">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23count/ <span style="color:green">count [/span></span>
|0..1
|0..1
|<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>
Line 163: Line 163:


|rowspan="2"|or<br>0..1
|rowspan="2"|or<br>0..1
|<span title="Properties and their values required to match (or not match), including any nesting of objects (joins).The default assumption is the AND operator on the properties. Use orProperty for or operator"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ property]</span></span>
|<span title="Properties and their values required to match (or not match), including any nesting of objects (joins).The default assumption is the AND operator on the properties. Use orProperty for or operator">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property [/span></span>
|1..*
|1..*
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
Line 170: Line 170:


|
|
<span title="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"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathToTarget/ pathToTarget]</span></span>
<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathToTarget/ <span style="color:green">pathToTarget [/span></span>
|1..1
|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>
|<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>
Line 176: Line 176:
|-
|-


|colspan="2"|<span title="The match pattern to which the select clause must comply. Equivalent to a where/filter in SPARQL and JOIN/WHERE in SQL"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23match/ match]</span></span>
|colspan="2"|<span title="The match pattern to which the select clause must comply. Equivalent to a where/filter in SPARQL and JOIN/WHERE in SQL">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23match/ <span style="color:green">match [/span></span>
|0..*
|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.Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
|<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.Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
Line 182: Line 182:
|-
|-


|colspan="2"|<span title="Whether the entity objects returned should be distinct"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23distinct/ distinct]</span></span>
|colspan="2"|<span title="Whether the entity objects returned should be distinct">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23distinct/ <span style="color:green">distinct [/span></span>
|0..1
|0..1
|<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>
Line 189: Line 189:


|rowspan="3"|or<br>0..1
|rowspan="3"|or<br>0..1
|<span title="The entity type that matched instances must be (including subtypes). Options include including subtypes."><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityType/ entityType]</span></span>
|<span title="The entity type that matched instances must be (including subtypes). Options include including subtypes.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityType/ <span style="color:green">entityType [/span></span>
|1..1
|1..1
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
Line 196: Line 196:


|
|
<span title="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"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityId/ entityId]</span></span>
<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityId/ <span style="color:green">entityId [/span></span>
|1..1
|1..1
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
Line 203: Line 203:


|
|
<span title="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."><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityIn/ entityIn]</span></span>
<span title="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.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityIn/ <span style="color:green">entityIn [/span></span>
|1..1
|1..1
|<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>
Line 209: Line 209:
|-
|-


|colspan="2"|<span title="If the results need to be grouped, the grouping properties."><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23groupBy/ groupBy]</span></span>
|colspan="2"|<span title="If the results need to be grouped, the grouping properties.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23groupBy/ <span style="color:green">groupBy [/span></span>
|0..*
|0..*
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
Line 215: Line 215:
|-
|-


|colspan="2"|<span title="Ability to order and limit the match before the select or matchstatement operates. Crucially, this is processed before the application of a test or check, enabling things like latest or earliest, max or min"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderLimit/ orderLimit]</span></span>
|colspan="2"|<span title="Ability to order and limit the match before the select or matchstatement operates. Crucially, this is processed before the application of a test or check, enabling things like latest or earliest, max or min">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderLimit/ <span style="color:green">orderLimit [/span></span>
|0..*
|0..*
|<span title="Orders the value of the property (property as represented by the iri and alias)">[[#class_OrderLimitClause|OrderLimitClause]]</span>
|<span title="Orders the value of the property (property as represented by the iri and alias)">[[#class_OrderLimitClause|OrderLimitClause]]</span>
Line 221: Line 221:
|-
|-


|colspan="2"|<span title="For a query with column groups such as a list report, the select query for each group"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23subselect/ subselect]</span></span>
|colspan="2"|<span title="For a query with column groups such as a list report, the select query for each group">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23subselect/ <span style="color:green">subselect [/span></span>
|0..*
|0..*
|<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups">[[#class_SelectClause|SelectClause]]</span>
|<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups">[[#class_SelectClause|SelectClause]]</span>
Line 232: Line 232:
|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
|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 title="A convenient way of traversing properties and objects to get to a property, avoiding excessive nesting.The properties are listed and thus traversed in strict order"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathTo/ pathTo]</span></span>
|colspan="2"|<span title="A convenient way of traversing properties and objects to get to a property, avoiding excessive nesting.The properties are listed and thus traversed in strict order">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathTo/ <span style="color:green">pathTo [/span></span>
|0..1
|0..1
|<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>
Line 239: Line 239:


|rowspan="2"|or<br>0..1
|rowspan="2"|or<br>0..1
|<span title="Boolean operator OR on subclauses"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23or/ or]</span></span>
|<span title="Boolean operator OR on subclauses">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23or/ <span style="color:green">or [/span></span>
|2..*
|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.Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
|<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.Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
Line 246: Line 246:


|
|
<span title="Boolean operator AND on subclauses"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23and/ and]</span></span>
<span title="Boolean operator AND on subclauses">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23and/ <span style="color:green">and [/span></span>
|2..*
|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.Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
|<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.Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
Line 253: Line 253:


|rowspan="2"|or<br>0..1
|rowspan="2"|or<br>0..1
|<span title="The entity type that matched instances must be (including subtypes). Options include including subtypes."><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityType/ entityType]</span></span>
|<span title="The entity type that matched instances must be (including subtypes). Options include including subtypes.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityType/ <span style="color:green">entityType [/span></span>
|1..1
|1..1
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
Line 260: Line 260:


|
|
<span title="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"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityId/ entityId]</span></span>
<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityId/ <span style="color:green">entityId [/span></span>
|1..1
|1..1
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
Line 267: Line 267:


|rowspan="2"|or<br>0..1
|rowspan="2"|or<br>0..1
|<span title="The concept set, value set, or query result set that the instances must be in to match.on which the select clause operates. e.g. a parent cohort."><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityInSet/ entityInSet]</span></span>
|<span title="The concept set, value set, or query result set that the instances must be in to match.on which the select clause operates. e.g. a parent cohort.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityInSet/ <span style="color:green">entityInSet [/span></span>
|1..1
|1..1
|<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>
Line 274: Line 274:


|
|
<span title="The concept set, value set, or query result set that the instances must NOT be in to match.on which the select clause operates. e.g. a parent cohort."><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityNotInSet/ entityNotInSet]</span></span>
<span title="The concept set, value set, or query result set that the instances must NOT be in to match.on which the select clause operates. e.g. a parent cohort.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityNotInSet/ <span style="color:green">entityNotInSet [/span></span>
|1..1
|1..1
|<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>
Line 280: Line 280:
|-
|-


|colspan="2"|<span title="The graph to which these entities apply by default. This may be overridden by the entitiesThis means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ graph]</span></span>
|colspan="2"|<span title="The graph to which these entities apply by default. This may be overridden by the entitiesThis means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ <span style="color:green">graph [/span></span>
|0..1
|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>
|<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>
Line 286: Line 286:
|-
|-


|colspan="2"|<span title="Properties and their values required to match (or not match), including any nesting of objects (joins).The default assumption is the AND operator on the properties. Use orProperty for or operator"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ property]</span></span>
|colspan="2"|<span title="Properties and their values required to match (or not match), including any nesting of objects (joins).The default assumption is the AND operator on the properties. Use orProperty for or operator">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property [/span></span>
|0..*
|0..*
|<span title="A property (as a concept reference) and value filter supporting ranges sets and functions,As a result of the concept references, supports sub properties as well as inferred values">[[#class_PropertyValueClause|PropertyValueClause]]</span>
|<span title="A property (as a concept reference) and value filter supporting ranges sets and functions,As a result of the concept references, supports sub properties as well as inferred values">[[#class_PropertyValueClause|PropertyValueClause]]</span>
Line 292: Line 292:
|-
|-


|colspan="2"|<span title="Properties and their values one of which is required to match (or not match), including any nesting of objects (joins)."><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orProperty/ orProperty]</span></span>
|colspan="2"|<span title="Properties and their values one of which is required to match (or not match), including any nesting of objects (joins).">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orProperty/ <span style="color:green">orProperty [/span></span>
|2..*
|2..*
|<span title="A property (as a concept reference) and value filter supporting ranges sets and functions,As a result of the concept references, supports sub properties as well as inferred values">[[#class_PropertyValueClause|PropertyValueClause]]</span>
|<span title="A property (as a concept reference) and value filter supporting ranges sets and functions,As a result of the concept references, supports sub properties as well as inferred values">[[#class_PropertyValueClause|PropertyValueClause]]</span>
Line 298: Line 298:
|-
|-


|colspan="2"|<span title="The property match must not exist. This is negatation at a more granular level than the match clause.For example to test for a null field or absent property"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notExist/ notExist]</span></span>
|colspan="2"|<span title="The property match must not exist. This is negatation at a more granular level than the match clause.For example to test for a null field or absent property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notExist/ <span style="color:green">notExist [/span></span>
|0..1
|0..1
|<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>
Line 304: Line 304:
|-
|-


|colspan="2"|<span title="Ability to order and limit the match before the select or matchstatement operates. Crucially, this is processed before the application of a test or check, enabling things like latest or earliest, max or min"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderLimit/ orderLimit]</span></span>
|colspan="2"|<span title="Ability to order and limit the match before the select or matchstatement operates. Crucially, this is processed before the application of a test or check, enabling things like latest or earliest, max or min">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderLimit/ <span style="color:green">orderLimit [/span></span>
|0..1
|0..1
|<span title="Orders the value of the property (property as represented by the iri and alias)">[[#class_OrderLimitClause|OrderLimitClause]]</span>
|<span title="Orders the value of the property (property as represented by the iri and alias)">[[#class_OrderLimitClause|OrderLimitClause]]</span>
Line 310: Line 310:
|-
|-


|colspan="2"|<span title="Further test applied to the result of an ordered limited match. The rest of the match clause then becomes a sub select query on which these tests operate. Implicit operator is AND"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23testProperty/ testProperty]</span></span>
|colspan="2"|<span title="Further test applied to the result of an ordered limited match. The rest of the match clause then becomes a sub select query on which these tests operate. Implicit operator is AND">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23testProperty/ <span style="color:green">testProperty [/span></span>
|0..*
|0..*
|<span title="A property (as a concept reference) and value filter supporting ranges sets and functions,As a result of the concept references, supports sub properties as well as inferred values">[[#class_PropertyValueClause|PropertyValueClause]]</span>
|<span title="A property (as a concept reference) and value filter supporting ranges sets and functions,As a result of the concept references, supports sub properties as well as inferred values">[[#class_PropertyValueClause|PropertyValueClause]]</span>
Line 316: Line 316:
|-
|-


|colspan="2"|<span title="Optional text for display in query viewer if dfferent from the match clause name"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23displayText/ displayText]</span></span>
|colspan="2"|<span title="Optional text for display in query viewer if dfferent from the match clause name">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23displayText/ <span style="color:green">displayText [/span></span>
|0..1
|0..1
|<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>
Line 332: Line 332:
|-
|-
|rowspan="3"|or<br>0..1
|rowspan="3"|or<br>0..1
|<span title="Whether the result is a summation of this property's values"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sum/ sum]</span></span>
|<span title="Whether the result is a summation of this property's values">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sum/ <span style="color:green">sum [/span></span>
|0..1
|0..1
|<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>
Line 339: Line 339:


|
|
<span title="Whether the result is an average of this property's values"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23average/ average]</span></span>
<span title="Whether the result is an average of this property's values">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23average/ <span style="color:green">average [/span></span>
|0..1
|0..1
|<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>
Line 346: Line 346:


|
|
<span title="Whether the result is the maximum of this property's values"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23max/ max]</span></span>
<span title="Whether the result is the maximum of this property's values">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23max/ <span style="color:green">max [/span></span>
|0..1
|0..1
|<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>
Line 352: Line 352:
|-
|-


|colspan="2"|<span title="Nested select clause for graphql style results format"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23select/ select]</span></span>
|colspan="2"|<span title="Nested select clause for graphql style results format">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23select/ <span style="color:green">select [/span></span>
|0..1
|0..1
|<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups">[[#class_SelectClause|SelectClause]]</span>
|<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups">[[#class_SelectClause|SelectClause]]</span>
Line 358: Line 358:
|-
|-


|colspan="2"|<span title="Indicates if true that the selected property is an inverse relationship with the target object"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inverseOf/ inverseOf]</span></span>
|colspan="2"|<span title="Indicates if true that the selected property is an inverse relationship with the target object">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inverseOf/ <span style="color:green">inverseOf [/span></span>
|0..1
|0..1
|<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>
Line 364: Line 364:
|-
|-


|colspan="2"|<span title="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"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ function]</span></span>
|colspan="2"|<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ <span style="color:green">function [/span></span>
|0..1
|0..1
|<span title="A function definition with optional parameters">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/ im:Function]</span>
|<span title="A function definition with optional parameters">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/ im:Function]</span>
Line 370: Line 370:
|-
|-


|colspan="2"|<span title="Arguments to pass into the function"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ argument]</span></span>
|colspan="2"|<span title="Arguments to pass into the function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ <span style="color:green">argument [/span></span>
|0..*
|0..*
|<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>
Line 381: Line 381:
|Information about the target of a path query, including the IRI of the target and the number of hops processed.
|Information about the target of a path query, including the IRI of the target and the number of hops processed.
|-
|-
|colspan="2"|<span title="How many hops to be taken in the graph between source and target"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23depth/ depth]</span></span>
|colspan="2"|<span title="How many hops to be taken in the graph between source and target">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23depth/ <span style="color:green">depth [/span></span>
|0..1
|0..1
|<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>
Line 392: Line 392:
|null
|null
|-
|-
|colspan="2"|<span title="Whether to include the subtypes of the entites selected or matched"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23includeSubtypes/ includeSubtypes]</span></span>
|colspan="2"|<span title="Whether to include the subtypes of the entites selected or matched">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23includeSubtypes/ <span style="color:green">includeSubtypes [/span></span>
|0..1
|0..1
|<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>
Line 398: Line 398:
|-
|-


|colspan="2"|<span title="Whether to include the supertypes of the entity in a match clause. Used for ascending the hierarch to look for properties inherited"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23includeSupertypes/ includeSupertypes]</span></span>
|colspan="2"|<span title="Whether to include the supertypes of the entity in a match clause. Used for ascending the hierarch to look for properties inherited">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23includeSupertypes/ <span style="color:green">includeSupertypes [/span></span>
|0..1
|0..1
|<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>
Line 404: Line 404:
|-
|-


|colspan="2"|<span title="Whether to exclude this entity when either include supbtypes or include suprtypes is set. Rarely used but sometimes found in ECL definitions"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23excludeSelf/ excludeSelf]</span></span>
|colspan="2"|<span title="Whether to exclude this entity when either include supbtypes or include suprtypes is set. Rarely used but sometimes found in ECL definitions">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23excludeSelf/ <span style="color:green">excludeSelf [/span></span>
|0..1
|0..1
|<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>
Line 415: Line 415:
|Orders the value of the property (property as represented by the iri and alias)
|Orders the value of the property (property as represented by the iri and alias)
|-
|-
|colspan="2"|<span title="The property or property variable to order the results by"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderBy/ orderBy]</span></span>
|colspan="2"|<span title="The property or property variable to order the results by">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderBy/ <span style="color:green">orderBy [/span></span>
|1..1
|1..1
|<span title="An IRI with a name and an alias (for use as variables for reference">[[#class_IriAlias|IriAlias]]</span>
|<span title="An IRI with a name and an alias (for use as variables for reference">[[#class_IriAlias|IriAlias]]</span>
Line 421: Line 421:
|-
|-


|colspan="2"|<span title="ASCENDING or DESCENDING to indicate the order direction"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23direction/ direction]</span></span>
|colspan="2"|<span title="ASCENDING or DESCENDING to indicate the order direction">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23direction/ <span style="color:green">direction [/span></span>
|1..1
|1..1
|<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>
Line 427: Line 427:
|-
|-


|colspan="2"|<span title="The count of instances to return after ordering"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23limit/ limit]</span></span>
|colspan="2"|<span title="The count of instances to return after ordering">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23limit/ <span style="color:green">limit [/span></span>
|0..1
|0..1
|<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>
Line 440: Line 440:
|A property (as 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
|A property (as 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 title="A convenient way of traversing properties and objects to get to a property, avoiding excessive nesting.The properties are listed and thus traversed in strict order"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathTo/ pathTo]</span></span>
|colspan="2"|<span title="A convenient way of traversing properties and objects to get to a property, avoiding excessive nesting.The properties are listed and thus traversed in strict order">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathTo/ <span style="color:green">pathTo [/span></span>
|0..1
|0..1
|<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>
Line 446: Line 446:
|-
|-


|colspan="2"|<span title="Indicates if true that the selected property is an inverse relationship with the target object"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inverseOf/ inverseOf]</span></span>
|colspan="2"|<span title="Indicates if true that the selected property is an inverse relationship with the target object">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inverseOf/ <span style="color:green">inverseOf [/span></span>
|0..1
|0..1
|<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>
Line 452: Line 452:
|-
|-


|colspan="2"|<span title="The property match must not exist. This is negatation at a more granular level than the match clause.For example to test for a null field or absent property"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notExist/ notExist]</span></span>
|colspan="2"|<span title="The property match must not exist. This is negatation at a more granular level than the match clause.For example to test for a null field or absent property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notExist/ <span style="color:green">notExist [/span></span>
|0..1
|0..1
|<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>
Line 458: Line 458:
|-
|-


|colspan="2"|<span title="Optional match for this property, used to enable IF a present then A must have X,Y. 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"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23optional/ optional]</span></span>
|colspan="2"|<span title="Optional match for this property, used to enable IF a present then A must have X,Y. 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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23optional/ <span style="color:green">optional [/span></span>
|0..1
|0..1
|<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>
Line 464: Line 464:
|-
|-


|colspan="2"|<span title="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"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ function]</span></span>
|colspan="2"|<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ <span style="color:green">function [/span></span>
|1..1
|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>
|<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>
Line 470: Line 470:
|-
|-


|colspan="2"|<span title="Arguments to pass into the function"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ argument]</span></span>
|colspan="2"|<span title="Arguments to pass into the function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ <span style="color:green">argument [/span></span>
|0..1
|0..1
|<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>
Line 477: Line 477:


|rowspan="7"|or<br>0..1
|rowspan="7"|or<br>0..1
|<span title="If testing a property value as equal greater than ete. use compare"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23value/ value]</span></span>
|<span title="If testing a property value as equal greater than ete. use compare">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23value/ <span style="color:green">value [/span></span>
|1..1
|1..1
|<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
|<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
Line 484: Line 484:


|
|
<span title="The value of the property must be in the concept set IRI.For teesting simple lists or single concepts use isConcept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inSet/ inSet]</span></span>
<span title="The value of the property must be in the concept set IRI.For teesting simple lists or single concepts use isConcept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inSet/ <span style="color:green">inSet [/span></span>
|1..*
|1..*
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
Line 491: Line 491:


|
|
<span title="The value of the property must NOT be in the concept set IRI. 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. For testing simple lists of concepts use isNotConcept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notInSet/ notInSet]</span></span>
<span title="The value of the property must NOT be in the concept set IRI. 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. For testing simple lists of concepts use isNotConcept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notInSet/ <span style="color:green">notInSet [/span></span>
|1..*
|1..*
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
Line 498: Line 498:


|
|
<span title="The value of the property be this concept (and otionally its sub types). Used for inline sets or single concepts"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isConcept/ isConcept]</span></span>
<span title="The value of the property be this concept (and otionally its sub types). Used for inline sets or single concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isConcept/ <span style="color:green">isConcept [/span></span>
|1..*
|1..*
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
Line 505: Line 505:


|
|
<span title="The value of the property must NOT be this concept (and otionally its sub types). Used for inline sets or single concepts.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"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isNotConcept/ isNotConcept]</span></span>
<span title="The value of the property must NOT be this concept (and otionally its sub types). Used for inline sets or single concepts.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.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isNotConcept/ <span style="color:green">isNotConcept [/span></span>
|1..*
|1..*
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
Line 512: Line 512:


|
|
<span title="Test foe a value being between two absolute or relative values"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inRange/ inRange]</span></span>
<span title="Test foe a value being between two absolute or relative values">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inRange/ <span style="color:green">inRange [/span></span>
|1..1
|1..1
|<span title="A range for use in property value testing">[[#class_RangeClause|RangeClause]]</span>
|<span title="A range for use in property value testing">[[#class_RangeClause|RangeClause]]</span>
Line 519: Line 519:


|
|
<span title="The match clause operating on the property value object. Equivalent to a join in SQL or '.' in sparql"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueMatch/ valueMatch]</span></span>
<span title="The match clause operating on the property value object. Equivalent to a join in SQL or '.' in sparql">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueMatch/ <span style="color:green">valueMatch [/span></span>
|1..1
|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.Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
|<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.Supports graph traversal filtering and inference for subsumption query">[[#class_MatchClause|MatchClause]]</span>
Line 525: Line 525:
|-
|-


|colspan="2"|<span title="Optional text for display in query viewer if dfferent from the match clause name"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23displayText/ displayText]</span></span>
|colspan="2"|<span title="Optional text for display in query viewer if dfferent from the match clause name">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23displayText/ <span style="color:green">displayText [/span></span>
|0..1
|0..1
|<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>
Line 538: Line 538:
|A named parameter and a value for passing into a function
|A named parameter and a value for passing into a function
|-
|-
|colspan="2"|<span title="A list of parameters and data types used in this function"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ parameter]</span></span>
|colspan="2"|<span title="A list of parameters and data types used in this function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter [/span></span>
|1..1
|1..1
|<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>
Line 545: Line 545:


|rowspan="4"|or<br>1..1
|rowspan="4"|or<br>1..1
|<span title="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"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueData/ valueData]</span></span>
|<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueData/ <span style="color:green">valueData [/span></span>
|1..1
|1..1
|<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>
Line 552: Line 552:


|
|
<span title="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"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueVariable/ valueVariable]</span></span>
<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueVariable/ <span style="color:green">valueVariable [/span></span>
|1..1
|1..1
|<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>
Line 559: Line 559:


|
|
<span title="The result to compare the property value against is derived from a select sub query"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueSelect/ valueSelect]</span></span>
<span title="The result to compare the property value against is derived from a select sub query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueSelect/ <span style="color:green">valueSelect [/span></span>
|1..1
|1..1
|<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups">[[#class_SelectClause|SelectClause]]</span>
|<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups">[[#class_SelectClause|SelectClause]]</span>
Line 566: Line 566:


|
|
<span title="Argument value that is an iri"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueIri/ valueIri]</span></span>
<span title="Argument value that is an iri">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueIri/ <span style="color:green">valueIri [/span></span>
|1..1
|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>
|<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>
Line 583: Line 583:
|A function used in a query consisting of the function iri and one or more arguments to pass in at run time
|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 title="Arguments to pass into the function"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ argument]</span></span>
|colspan="2"|<span title="Arguments to pass into the function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ <span style="color:green">argument [/span></span>
|0..*
|0..*
|<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>
Line 594: Line 594:
|Tests a value, whether equal, greater than, less than etc.
|Tests a value, whether equal, greater than, less than etc.
|-
|-
|colspan="2"|<span title="Comparison operators : EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, NOT_EQUAL"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23comparison/ comparison]</span></span>
|colspan="2"|<span title="Comparison operators : EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, NOT_EQUAL">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23comparison/ <span style="color:green">comparison [/span></span>
|1..1
|1..1
|<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>
Line 601: Line 601:


|rowspan="3"|or<br>1..1
|rowspan="3"|or<br>1..1
|<span title="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"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueData/ valueData]</span></span>
|<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueData/ <span style="color:green">valueData [/span></span>
|1..1
|1..1
|<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>
Line 608: Line 608:


|
|
<span title="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"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueVariable/ valueVariable]</span></span>
<span title="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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueVariable/ <span style="color:green">valueVariable [/span></span>
|1..1
|1..1
|<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>
Line 615: Line 615:


|
|
<span title="The result to compare the property value against is derived from a select sub query"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueSelect/ valueSelect]</span></span>
<span title="The result to compare the property value against is derived from a select sub query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueSelect/ <span style="color:green">valueSelect [/span></span>
|1..1
|1..1
|<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups">[[#class_SelectClause|SelectClause]]</span>
|<span title="Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups">[[#class_SelectClause|SelectClause]]</span>
Line 626: Line 626:
|A range for use in property value testing
|A range for use in property value testing
|-
|-
|colspan="2"|<span title="The value comparison for lower end of the range"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23from/ from]</span></span>
|colspan="2"|<span title="The value comparison for lower end of the range">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23from/ <span style="color:green">from [/span></span>
|1..1
|1..1
|<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
|<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
Line 632: Line 632:
|-
|-


|colspan="2"|<span title="The value comparison of upper end of the range"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23to/ to]</span></span>
|colspan="2"|<span title="The value comparison of upper end of the range">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23to/ <span style="color:green">to [/span></span>
|1..1
|1..1
|<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
|<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
Line 695: Line 695:
|null
|null
|-
|-
|colspan="2"|<span title="A list of parameters and data types used in this function"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ parameter]</span></span>
|colspan="2"|<span title="A list of parameters and data types used in this function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter [/span></span>
|0..*
|0..*
|<span title="">[[#class_Parameter|Parameter]]</span>
|<span title="">[[#class_Parameter|Parameter]]</span>
Line 754: Line 754:
|null
|null
|-
|-
|colspan="2"|<span title="The name of the parameter"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ label]</span></span>
|colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label [/span></span>
|1..1
|1..1
|<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>
Line 761: Line 761:


|rowspan="2"|or<br>1..1
|rowspan="2"|or<br>1..1
|<span title="The range of the property is a data type of this type"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23datatype/ datatype]</span></span>
|<span title="The range of the property is a data type of this type">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23datatype/ <span style="color:green">datatype [/span></span>
|1..1
|1..1
|<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>
Line 768: Line 768:


|
|
<span title="The iri for the class range of the property. The range of this property is a subclass of this class"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23class/ class]</span></span>
<span title="The iri for the class range of the property. The range of this property is a subclass of this class">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23class/ <span style="color:green">class [/span></span>
|1..1
|1..1
|<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>
Line 794: Line 794:
|The shape of a SHACL node shape
|The shape of a SHACL node shape
|-
|-
|colspan="2"|<span title="Parameter name for a function or the parameter name for an argument"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23property/ property]</span></span>
|colspan="2"|<span title="Parameter name for a function or the parameter name for an argument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23property/ <span style="color:green">property [/span></span>
|0..*
|0..*
|<span title="The data model of a shacl node shape describing a property of a data model entity">[[#class_PropertyNodeShape|PropertyNodeShape]]</span>
|<span title="The data model of a shacl node shape describing a property of a data model entity">[[#class_PropertyNodeShape|PropertyNodeShape]]</span>
Line 857: Line 857:
|The data model of a shacl node shape describing a property of a data model entity
|The data model of a shacl node shape describing a property of a data model entity
|-
|-
|colspan="2"|<span title="The iri of the property"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23path/ path]</span></span>
|colspan="2"|<span title="The iri of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23path/ <span style="color:green">path [/span></span>
|1..1
|1..1
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ rdf:Property]</span>
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ rdf:Property]</span>
Line 863: Line 863:
|-
|-


|colspan="2"|<span title="Minimum cardinality,if null assuming any number including zero"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23minCount/ minCount]</span></span>
|colspan="2"|<span title="Minimum cardinality,if null assuming any number including zero">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23minCount/ <span style="color:green">minCount [/span></span>
|0..1
|0..1
|<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>
Line 869: Line 869:
|-
|-


|colspan="2"|<span title="The maximum number allowed. If null then any number"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23maxCount/ maxCount]</span></span>
|colspan="2"|<span title="The maximum number allowed. If null then any number">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23maxCount/ <span style="color:green">maxCount [/span></span>
|0..1
|0..1
|<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>
Line 876: Line 876:


|rowspan="3"|or<br>1..1
|rowspan="3"|or<br>1..1
|<span title="The iri for the class range of the property. The range of this property is a subclass of this class"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23class/ class]</span></span>
|<span title="The iri for the class range of the property. The range of this property is a subclass of this class">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23class/ <span style="color:green">class [/span></span>
|1..1
|1..1
|<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>
Line 883: Line 883:


|
|
<span title="The range of the property is a data type of this type"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23datatype/ datatype]</span></span>
<span title="The range of the property is a data type of this type">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23datatype/ <span style="color:green">datatype [/span></span>
|1..1
|1..1
|<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>
Line 890: Line 890:


|
|
<span title="The property points to a node shape"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23node/ node]</span></span>
<span title="The property points to a node shape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23node/ <span style="color:green">node [/span></span>
|1..1
|1..1
|<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>
Line 896: Line 896:
|-
|-


|colspan="2"|<span title="Description of the property"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ comment]</span></span>
|colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment [/span></span>
|0..1
|0..1
|<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>
Line 902: Line 902:
|-
|-


|colspan="2"|<span title="The name of the property used for ease of recognition"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23name/ name]</span></span>
|colspan="2"|<span title="The name of the property used for ease of recognition">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23name/ <span style="color:green">name [/span></span>
|0..1
|0..1
|<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>
Line 908: Line 908:
|-
|-


|colspan="2"|<span title="The property order for display"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23order/ order]</span></span>
|colspan="2"|<span title="The property order for display">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23order/ <span style="color:green">order [/span></span>
|0..1
|0..1
|<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>
Line 936: Line 936:
|data model for terminology concepts
|data model for terminology concepts
|-
|-
|colspan="2"|<span title="a code for a codeable concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23code/ code]</span></span>
|colspan="2"|<span title="a code for a codeable concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23code/ <span style="color:green">code [/span></span>
|1..1
|1..1
|<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>
Line 942: Line 942:
|-
|-


|colspan="2"|<span title="links a an alternative term code to a concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23hasTermCode/ hasTermCode]</span></span>
|colspan="2"|<span title="links a an alternative term code to a concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23hasTermCode/ <span style="color:green">hasTermCode [/span></span>
|0..*
|0..*
|<span title="data model for a term code">[[#class_TermCodeShape|TermCodeShape]]</span>
|<span title="data model for a term code">[[#class_TermCodeShape|TermCodeShape]]</span>
Line 948: Line 948:
|-
|-


|colspan="2"|<span title=""><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23weighting/ weighting]</span></span>
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23weighting/ <span style="color:green">weighting [/span></span>
|0..1
|0..1
|<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>
Line 954: Line 954:
|-
|-


|colspan="2"|<span title="Points to the definitional status of this entity e.g. full defined as an equivalent class"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definitionalStatus/ definitionalStatus]</span></span>
|colspan="2"|<span title="Points to the definitional status of this entity e.g. full defined as an equivalent class">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definitionalStatus/ <span style="color:green">definitionalStatus [/span></span>
|0..1
|0..1
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Definitionalstatus/ im:VSET_Definitionalstatus]</span>
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Definitionalstatus/ im:VSET_Definitionalstatus]</span>
Line 960: Line 960:
|-
|-


|colspan="2"|<span title="points to one or more maps that matches this concept to another concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23hasMap/ hasMap]</span></span>
|colspan="2"|<span title="points to one or more maps that matches this concept to another concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23hasMap/ <span style="color:green">hasMap [/span></span>
|0..*
|0..*
|<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>
Line 966: Line 966:
|-
|-


|colspan="2"|<span title="usage total for a stats report"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23usageTotal/ usageTotal]</span></span>
|colspan="2"|<span title="usage total for a stats report">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23usageTotal/ <span style="color:green">usageTotal [/span></span>
|0..1
|0..1
|<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>
Line 972: Line 972:
|-
|-


|colspan="2"|<span title="the old identifier from im1"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23im1Id/ im1Id]</span></span>
|colspan="2"|<span title="the old identifier from im1">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23im1Id/ <span style="color:green">im1Id [/span></span>
|0..1
|0..1
|<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>
Line 978: Line 978:
|-
|-


|colspan="2"|<span title="Points to a match between the concept and a legacy concept as part of a map"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23matchedTo/ matchedTo]</span></span>
|colspan="2"|<span title="Points to a match between the concept and a legacy concept as part of a map">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23matchedTo/ <span style="color:green">matchedTo [/span></span>
|0..*
|0..*
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Unspecified/ im:VSET_Unspecified]</span>
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Unspecified/ im:VSET_Unspecified]</span>
Line 984: Line 984:
|-
|-


|colspan="2"|<span title="Points to the context object holding information about the source of this concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceContext/ sourceContext]</span></span>
|colspan="2"|<span title="Points to the context object holding information about the source of this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceContext/ <span style="color:green">sourceContext [/span></span>
|0..*
|0..*
|<span title="Data model for source context for a concept e.g. source system, field etc">[[#class_SourceContextShape|SourceContextShape]]</span>
|<span title="Data model for source context for a concept e.g. source system, field etc">[[#class_SourceContextShape|SourceContextShape]]</span>
Line 990: Line 990:
|-
|-


|colspan="2"|<span title=""><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fsnomed.info%2Fsct%23370124000/ 370124000]</span></span>
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fsnomed.info%2Fsct%23370124000/ <span style="color:green">370124000 [/span></span>
|0..*
|0..*
|<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span>
|<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span>
Line 996: Line 996:
|-
|-


|colspan="2"|<span title=""><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isChildOf/ isChildOf]</span></span>
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isChildOf/ <span style="color:green">isChildOf [/span></span>
|0..*
|0..*
|<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span>
|<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span>
Line 1,065: Line 1,065:
|data model for a term code
|data model for a term code
|-
|-
|colspan="2"|<span title="The name of the parameter"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ label]</span></span>
|colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label [/span></span>
|0..*
|0..*
|<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>
Line 1,071: Line 1,071:
|-
|-


|colspan="2"|<span title="a code for a codeable concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23code/ code]</span></span>
|colspan="2"|<span title="a code for a codeable concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23code/ <span style="color:green">code [/span></span>
|0..*
|0..*
|<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>
Line 1,077: Line 1,077:
|-
|-


|colspan="2"|<span title="Status of relationship"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ status]</span></span>
|colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status [/span></span>
|0..*
|0..*
|<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>
Line 1,088: Line 1,088:
|Data model for source context for a concept e.g. source system, field etc
|Data model for source context for a concept e.g. source system, field etc
|-
|-
|colspan="2"|<span title="Points to the source system that published this concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceSystem/ sourceSystem]</span></span>
|colspan="2"|<span title="Points to the source system that published this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceSystem/ <span style="color:green">sourceSystem [/span></span>
|1..*
|1..*
|<span title="A named computer system considered a type of device">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ComputerSystem/ im:ComputerSystem]</span>
|<span title="A named computer system considered a type of device">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ComputerSystem/ im:ComputerSystem]</span>
Line 1,094: Line 1,094:
|-
|-


|colspan="2"|<span title="Points to the source organisation that published this concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourcePublisher/ sourcePublisher]</span></span>
|colspan="2"|<span title="Points to the source organisation that published this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourcePublisher/ <span style="color:green">sourcePublisher [/span></span>
|1..*
|1..*
|<span title="A record of an organisation and its relationships. Named collections of people that have come together to achieve an objective">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Organisation/ im:Organisation]</span>
|<span title="A record of an organisation and its relationships. Named collections of people that have come together to achieve an objective">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Organisation/ im:Organisation]</span>
Line 1,100: Line 1,100:
|-
|-


|colspan="2"|<span title="Points to the source extract or message type that published this concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceSchema/ sourceSchema]</span></span>
|colspan="2"|<span title="Points to the source extract or message type that published this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceSchema/ <span style="color:green">sourceSchema [/span></span>
|1..*
|1..*
|<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>
Line 1,106: Line 1,106:
|-
|-


|colspan="2"|<span title="Points to the source table or resource or message segment that published this concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceTable/ sourceTable]</span></span>
|colspan="2"|<span title="Points to the source table or resource or message segment that published this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceTable/ <span style="color:green">sourceTable [/span></span>
|1..*
|1..*
|<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>
Line 1,112: Line 1,112:
|-
|-


|colspan="2"|<span title="Points to the source field, element or message field that published this concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceField/ sourceField]</span></span>
|colspan="2"|<span title="Points to the source field, element or message field that published this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceField/ <span style="color:green">sourceField [/span></span>
|1..*
|1..*
|<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>
Line 1,118: Line 1,118:
|-
|-


|colspan="2"|<span title="Points to the source regex or other pattern match used when creating the concept from a mix of code and term"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceRegex/ sourceRegex]</span></span>
|colspan="2"|<span title="Points to the source regex or other pattern match used when creating the concept from a mix of code and term">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceRegex/ <span style="color:green">sourceRegex [/span></span>
|1..*
|1..*
|<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>
Line 1,124: Line 1,124:
|-
|-


|colspan="2"|<span title="the source code or term that acts as the heading for a text qualifier such as negative or positive"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceHeading/ sourceHeading]</span></span>
|colspan="2"|<span title="the source code or term that acts as the heading for a text qualifier such as negative or positive">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceHeading/ <span style="color:green">sourceHeading [/span></span>
|1..*
|1..*
|<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>
Line 1,130: Line 1,130:
|-
|-


|colspan="2"|<span title="the source text for a text map"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceText/ sourceText]</span></span>
|colspan="2"|<span title="the source text for a text map">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceText/ <span style="color:green">sourceText [/span></span>
|1..*
|1..*
|<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>
Line 1,136: Line 1,136:
|-
|-


|colspan="2"|<span title="The orignal field value used to create the concept"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceValue/ sourceValue]</span></span>
|colspan="2"|<span title="The orignal field value used to create the concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceValue/ <span style="color:green">sourceValue [/span></span>
|1..*
|1..*
|<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>
Line 1,149: Line 1,149:
|A concept with role groups with roles
|A concept with role groups with roles
|-
|-
|colspan="2"|<span title="An anonymous property connecting to an anonymous class that has an intersection of sub roles"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23roleGroup/ roleGroup]</span></span>
|colspan="2"|<span title="An anonymous property connecting to an anonymous class that has an intersection of sub roles">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23roleGroup/ <span style="color:green">roleGroup [/span></span>
|0..*
|0..*
|<span title="data model for a role group">[[#class_RoleGroupShape|RoleGroupShape]]</span>
|<span title="data model for a role group">[[#class_RoleGroupShape|RoleGroupShape]]</span>
Line 1,226: Line 1,226:
|data model for a role group
|data model for a role group
|-
|-
|colspan="2"|<span title=""><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ Property]</span></span>
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ <span style="color:green">Property [/span></span>
|0..*
|0..*
|<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span>
|<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span>
Line 1,327: Line 1,327:
|An entity with the additional CRUD indicators to enable deletes updates, adding quads etc
|An entity with the additional CRUD indicators to enable deletes updates, adding quads etc
|-
|-
|colspan="2"|<span title="Indicates the nature of the default CRUD transaction for entities in thisdocument. Thes can be overridden in each entity. Must be  one of: im:DeleteAll, im:AddQuads (adds in additional triples), im:UpdateAll (replaces all the predicates for this entity in the graph with te ones submitted), im:UpdatePredicates ( replaces all the objects of these submitted predicates for this graph"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23crud/ crud]</span></span>
|colspan="2"|<span title="Indicates the nature of the default CRUD transaction for entities in thisdocument. Thes can be overridden in each entity. Must be  one of: im:DeleteAll, im:AddQuads (adds in additional triples), im:UpdateAll (replaces all the predicates for this entity in the graph with te ones submitted), im:UpdatePredicates ( replaces all the objects of these submitted predicates for this graph">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23crud/ <span style="color:green">crud [/span></span>
|1..1
|1..1
|<span title="Operations that Update delete and and triples">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23CrudOperation/ im:CrudOperation]</span>
|<span title="Operations that Update delete and and triples">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23CrudOperation/ im:CrudOperation]</span>
Line 1,333: Line 1,333:
|-
|-


|colspan="2"|<span title="The graph to which these entities apply by default. This may be overridden by the entitiesThis means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ graph]</span></span>
|colspan="2"|<span title="The graph to which these entities apply by default. This may be overridden by the entitiesThis means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ <span style="color:green">graph [/span></span>
|1..1
|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>
|<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>
Line 1,416: Line 1,416:
|A document containing any number of triples to file as a batch.<br>Note that if the document is sent as Json-LD with prefixed iris, a @context object will be required
|A document containing any number of triples to file as a batch.<br>Note that if the document is sent as Json-LD with prefixed iris, a @context object will be required
|-
|-
|colspan="2"|<span title="Indicates the nature of the default CRUD transaction for entities in thisdocument. Thes can be overridden in each entity. Must be  one of: im:DeleteAll, im:AddQuads (adds in additional triples), im:UpdateAll (replaces all the predicates for this entity in the graph with te ones submitted), im:UpdatePredicates ( replaces all the objects of these submitted predicates for this graph"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23crud/ crud]</span></span>
|colspan="2"|<span title="Indicates the nature of the default CRUD transaction for entities in thisdocument. Thes can be overridden in each entity. Must be  one of: im:DeleteAll, im:AddQuads (adds in additional triples), im:UpdateAll (replaces all the predicates for this entity in the graph with te ones submitted), im:UpdatePredicates ( replaces all the objects of these submitted predicates for this graph">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23crud/ <span style="color:green">crud [/span></span>
|1..1
|1..1
|<span title="Operations that Update delete and and triples">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23CrudOperation/ im:CrudOperation]</span>
|<span title="Operations that Update delete and and triples">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23CrudOperation/ im:CrudOperation]</span>
Line 1,422: Line 1,422:
|-
|-


|colspan="2"|<span title="The graph to which these entities apply by default. This may be overridden by the entitiesThis means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ graph]</span></span>
|colspan="2"|<span title="The graph to which these entities apply by default. This may be overridden by the entitiesThis means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ <span style="color:green">graph [/span></span>
|1..1
|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>
|<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>
Line 1,428: Line 1,428:
|-
|-


|colspan="2"|<span title="Set of entities to file. If the entities do not have crud or graphs oftheir own then the default from the document are used"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entities/ entities]</span></span>
|colspan="2"|<span title="Set of entities to file. If the entities do not have crud or graphs oftheir own then the default from the document are used">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entities/ <span style="color:green">entities [/span></span>
|1..*
|1..*
|<span title="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">[[#class_EntityShape|EntityShape]]</span>
|<span title="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">[[#class_EntityShape|EntityShape]]</span>
Line 1,511: Line 1,511:
|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
|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 title="optional page number and size if the client is looking for paged results"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23page/ page]</span></span>
|colspan="2"|<span title="optional page number and size if the client is looking for paged results">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23page/ <span style="color:green">page [/span></span>
|0..1
|0..1
|<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>
Line 1,517: Line 1,517:
|-
|-


|colspan="2"|<span title="If a free text search is part of the query"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23textSearch/ textSearch]</span></span>
|colspan="2"|<span title="If a free text search is part of the query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23textSearch/ <span style="color:green">textSearch [/span></span>
|0..1
|0..1
|<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>
Line 1,523: Line 1,523:
|-
|-


|colspan="2"|<span title="Arguments to pass into the function"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ argument]</span></span>
|colspan="2"|<span title="Arguments to pass into the function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ <span style="color:green">argument [/span></span>
|0..*
|0..*
|<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>
Line 1,530: Line 1,530:


|rowspan="2"|or<br>1..1
|rowspan="2"|or<br>1..1
|<span title="The query definition itself"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23query/ query]</span></span>
|<span title="The query definition itself">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23query/ <span style="color:green">query [/span></span>
|1..1
|1..1
|<span title="A Query definition holding the logical definition of a query in a standard language">[[#class_QueryDefinition|QueryDefinition]]</span>
|<span title="A Query definition holding the logical definition of a query in a standard language">[[#class_QueryDefinition|QueryDefinition]]</span>
Line 1,537: Line 1,537:


|
|
<span title="The IRI of a predefined query in the information model. i.e. request the system to run query X"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23queryIri/ queryIri]</span></span>
<span title="The IRI of a predefined query in the information model. i.e. request the system to run query X">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23queryIri/ <span style="color:green">queryIri [/span></span>
|1..1
|1..1
|<span title="The query definition for a stored query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/ im:Query]</span>
|<span title="The query definition for a stored query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/ im:Query]</span>
Line 1,543: Line 1,543:
|-
|-


|colspan="2"|<span title="reference date for date ranges that use reference date. Note that it could be passed in as an argeument"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23referenceDate/ referenceDate]</span></span>
|colspan="2"|<span title="reference date for date ranges that use reference date. Note that it could be passed in as an argeument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23referenceDate/ <span style="color:green">referenceDate [/span></span>
|0..1
|0..1
|<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>
Line 1,626: Line 1,626:
|Information about paging if the client wishes to page results, including page number and page size
|Information about paging if the client wishes to page results, including page number and page size
|-
|-
|colspan="2"|<span title="Page number (starting at 1)"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pageNumber/ pageNumber]</span></span>
|colspan="2"|<span title="Page number (starting at 1)">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pageNumber/ <span style="color:green">pageNumber [/span></span>
|1..1
|1..1
|<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>
Line 1,632: Line 1,632:
|-
|-


|colspan="2"|<span title="number of entries per page"><span style="color:green"> [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pageSize/ pageSize]</span></span>
|colspan="2"|<span title="number of entries per page">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pageSize/ <span style="color:green">pageSize [/span></span>
|1..1
|1..1
|<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>

Revision as of 09:08, 28 August 2022

Basic shapes

These shapes are the meta classes of the named entities within the information model.

Shape Property Card. Value type Comment
IrirRef A resource with an iri and name
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ label [/span> 1..1 xsd:string The name of the entity
Entity shape
(subtype of IrirRef)
targetClass Fixed :im:Entity 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
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ comment [/span> 0..1 xsd:string The description of the entity
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ type [/span> 1..1 rdfs:Resource The base type of the entity i.e. one of the high level entity types
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ status [/span> 1..1 im:Status The status of the entity being active, inactive, draft or unassigned
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ scheme [/span> 1..1 im:Graph The code scheme or graph which the entity belongs to
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ subClassOf [/span> 0..* im:EntityShape An entity that this entity inherits from, both semantically and structurally
IriAlias
(subtype of IrirRef)
An IRI with a name and an alias (for use as variables for reference
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23alias/ alias [/span> 0..1 xsd:string 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.

Shape Property Card. Value type Comment
QueryShape
(subtype of Entity shape)
targetClass Fixed :im:Query A query that is stored as an entity in a query library
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23query/ query [/span> 0..1 QueryDefinition The query definition itself
Query definition
(subtype of ClauseHeading)
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%23resultFormat/ resultFormat [/span> 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
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23usePrefixes/ usePrefixes [/span> 0..1 xsd:boolean true if you want the results to use IRI prefixes
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23activeOnly/ activeOnly [/span> 0..1 xsd:boolean Whether only active entities are included in the match clauses or select clauses
or
1..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23select/ select [/span> 1..1 SelectClause Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ask/ ask [/span>

0..1 MatchClause If the query is a boolean true or false use match clauses as an ask
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23mainEntity/ mainEntity [/span> 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)
ClauseHeading
(subtype of Entity shape)
General headings such as name description and alias
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23alias/ alias [/span> 1..1 xsd:string An alias or reference term that can be used throughout a query as shorthand for the result set
SelectClause
(subtype of ClauseHeading)
Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and subselsects for column groups
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23count/ count [/span> 0..1 xsd:boolean If the query result is simply a sum of the main entities found. equivalent to COUNT(id)
or
0..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ property [/span> 1..* 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

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathToTarget/ pathToTarget [/span>

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
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23match/ match [/span> 0..* MatchClause The match pattern to which the select clause must comply. Equivalent to a where/filter in SPARQL and JOIN/WHERE in SQL
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23distinct/ distinct [/span> 0..1 xsd:boolean Whether the entity objects returned should be distinct
or
0..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityType/ entityType [/span> 1..1 ConceptReference The entity type for instances this select clause operates on. Options include including subtypes.

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityId/ entityId [/span>

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

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityIn/ entityIn [/span>

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.
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23groupBy/ groupBy [/span> 0..* PropertySelectClause If the results need to be grouped, the grouping properties.
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderLimit/ orderLimit [/span> 0..* OrderLimitClause Ordering of instances via a property value and limiting th enumber returned.
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23subselect/ subselect [/span> 0..* SelectClause For a query with column groups such as a list report, the select query for each group
MatchClause
(subtype of ClauseHeading)
A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.
Supports graph traversal filtering and inference for subsumption query
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathTo/ pathTo [/span> 0..1 rdfs:Resource A convenient way of traversing properties and objects to get to the match object, avoiding excessive nesting.
The properties are listed and thus traversed in strict order
or
0..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23or/ or [/span> 2..* MatchClause Boolean operator OR on subclauses

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23and/ and [/span>

2..* MatchClause Boolean operator AND on subclauses
or
0..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityType/ entityType [/span> 1..1 ConceptReference The entity type that matched instances must be (including subtypes). Options include including subtypes.

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityId/ entityId [/span>

1..1 ConceptReference 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
or
0..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityInSet/ entityInSet [/span> 1..1 rdfs:Resource The concept set, value set, or query result set that the instances must be in to match.
on which the select clause operates. e.g. a parent cohort.

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entityNotInSet/ entityNotInSet [/span>

1..1 rdfs:Resource The concept set, value set, or query result set that the instances must NOT be in to match.
on which the select clause operates. e.g. a parent cohort.
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ graph [/span> 0..1 im:Graph The iri of a graph if the query is limied to a particular data set
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ property [/span> 0..* PropertyValueClause Properties and their values required to match (or not match), including any nesting of objects (joins).
The default assumption is the AND operator on the properties. Use orProperty for or operator
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orProperty/ orProperty [/span> 2..* PropertyValueClause Properties and their values one of which is required to match (or not match), including any nesting of objects (joins).
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notExist/ notExist [/span> 0..1 xsd:boolean Negation indicator for this entire clause. i.e. for the instance to be included it must NOT match.
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderLimit/ orderLimit [/span> 0..1 OrderLimitClause Ability to order and limit the match before the select or matchstatement operates.
Crucially, this is processed before the application of a test or check, enabling things like latest or earliest, max or min
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23testProperty/ testProperty [/span> 0..* PropertyValueClause Further test applied to the result of an ordered limited match.
The rest of the match clause then becomes a sub select query on which these tests operate. Implicit operator is AND
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23displayText/ displayText [/span> 0..1 xsd:string Optional text for display in query viewer if dfferent from the match clause name
PropertySelectClause
(subtype of ConceptReference)
null
or
0..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sum/ sum [/span> 0..1 xsd:boolean Whether the result is a summation of this property's values

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23average/ average [/span>

0..1 xsd:boolean Whether the result is an average of this property's values

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23max/ max [/span>

0..1 xsd:boolean Whether the result is the maximum of this property's values
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23select/ select [/span> 0..1 SelectClause Nested select clause for graphql style results format
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inverseOf/ inverseOf [/span> 0..1 xsd:boolean Indicates if true that the selected property is an inverse relationship with the target object
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ function [/span> 0..1 im:Function 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
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ argument [/span> 0..* Argument Arguments to pass into the function
PathTargetClause
(subtype of IrirRef)
Information about the target of a path query, including the IRI of the target and the number of hops processed.
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23depth/ depth [/span> 0..1 xsd:integer How many hops to be taken in the graph between source and target
ConceptReference
(subtype of IriAlias)
null
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23includeSubtypes/ includeSubtypes [/span> 0..1 xsd:boolean Whether to include the subtypes of the entites selected or matched
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23includeSupertypes/ includeSupertypes [/span> 0..1 xsd:boolean Whether to include the supertypes of the entity in a match clause. Used for ascending the hierarch to look for properties inherited
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23excludeSelf/ excludeSelf [/span> 0..1 xsd:boolean Whether to exclude this entity when either include supbtypes or include suprtypes is set. Rarely used but sometimes found in ECL definitions
OrderLimitClause Orders the value of the property (property as represented by the iri and alias)
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderBy/ orderBy [/span> 1..1 IriAlias The property or property variable to order the results by
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23direction/ direction [/span> 1..1 xsd:string ASCENDING or DESCENDING to indicate the order direction
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23limit/ limit [/span> 0..1 xsd:integer The count of instances to return after ordering
PropertyValueClause
(subtype of ConceptReference)
A property (as a concept reference) and value filter supporting ranges sets and functions,
As a result of the concept references, supports sub properties as well as inferred values
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathTo/ pathTo [/span> 0..1 rdfs:Resource A convenient way of traversing properties and objects to get to a property, avoiding excessive nesting.
The properties are listed and thus traversed in strict order
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inverseOf/ inverseOf [/span> 0..1 xsd:boolean Tests the property as an inverse property (inbound relationship)
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notExist/ notExist [/span> 0..1 xsd:boolean The property match must not exist. This is negatation at a more granular level than the match clause.
For example to test for a null field or absent property
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23optional/ optional [/span> 0..1 xsd:boolean Optional match for this property, used to enable IF a present then A must have X,Y.
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
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ function [/span> 1..1 FunctionClause 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.
Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ argument [/span> 0..1 Argument Arguments to pass into a function when the property is a function property.
Note that if the test is a function then the argument list would be in the function clause
or
0..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23value/ value [/span> 1..1 CompareClause If testing a property value as equal greater than ete. use compare

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inSet/ inSet [/span>

1..* ConceptReference The value of the property must be in the concept set IRI.
For teesting simple lists or single concepts use isConcept

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notInSet/ notInSet [/span>

1..* ConceptReference The value of the property must NOT be in the concept set IRI.
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.
For testing simple lists of concepts use isNotConcept

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isConcept/ isConcept [/span>

1..* ConceptReference The value of the property be this concept (and otionally its sub types).
Used for inline sets or single concepts

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isNotConcept/ isNotConcept [/span>

1..* ConceptReference The value of the property must NOT be this concept (and otionally its sub types).
Used for inline sets or single concepts.
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.

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inRange/ inRange [/span>

1..1 RangeClause Test foe a value being between two absolute or relative values

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueMatch/ valueMatch [/span>

1..1 MatchClause The match clause operating on the property value object.
Equivalent to a join in SQL or '.' in sparql
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23displayText/ displayText [/span> 0..1 xsd:string Optional text for display in query viewer if dfferent from the match clause name
Argument A named parameter and a value for passing into a function
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ parameter [/span> 1..1 xsd:string Parameter name for a function or the parameter name for an argument
or
1..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueData/ valueData [/span> 1..1 xsd:string Vaue that is a literal such as a string or number

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueVariable/ valueVariable [/span>

1..1 xsd:string argumenT value which is a variable name to be resolved at run time

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueSelect/ valueSelect [/span>

1..1 SelectClause Argument value that is the result of a select query

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueIri/ valueIri [/span>

1..1 im:IriRef Argument value that is an iri
FunctionClause
(subtype of IrirRef)
A function used in a query consisting of the function iri and one or more arguments to pass in at run time
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ argument [/span> 0..* Argument Arguments to pass into the function. They should match the parameter definitions of the function
CompareClause Tests a value, whether equal, greater than, less than etc.
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23comparison/ comparison [/span> 1..1 xsd:string Comparison operators : EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, NOT_EQUAL
or
1..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueData/ valueData [/span> 1..1 xsd:string 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

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueVariable/ valueVariable [/span>

1..1 xsd:string 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

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueSelect/ valueSelect [/span>

1..1 SelectClause The result to compare the property value against is derived from a select sub query
RangeClause A range for use in property value testing
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23from/ from [/span> 1..1 CompareClause The value comparison for lower end of the range
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23to/ to [/span> 1..1 CompareClause The value comparison of upper end of the range
FunctionShape
(subtype of Entity shape)
targetClass Fixed :im:Function null
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ parameter [/span> 0..* Parameter A list of parameters and data types used in this function
Parameter null
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ label [/span> 1..1 xsd:string The name of the parameter
or
1..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23datatype/ datatype [/span> 1..1 rdfs:Resource The iri of The data type of the parameter when the data type is a literal

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23class/ class [/span>

1..1 rdfs:Resource The iri of the class of the parameter when the argument is an object

Data Model shapes

These shapes are the meta classes of the data modelling entities within the information model.

Shape Property Card. Value type Comment
Data model shape
(subtype of Entity shape)
targetClass Fixed :NodeShape/ sh: NodeShape The shape of a SHACL node shape
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23property/ property [/span> 0..* PropertyNodeShape
PropertyNodeShape
(subtype of Entity shape)
The data model of a shacl node shape describing a property of a data model entity
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23path/ path [/span> 1..1 rdf:Property The iri of the property
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23minCount/ minCount [/span> 0..1 xsd:integer Minimum cardinality,if null assuming any number including zero
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23maxCount/ maxCount [/span> 0..1 xsd:integer The maximum number allowed. If null then any number
or
1..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23class/ class [/span> 1..1 rdfs:Resource The iri for the class range of the property. The range of this property is a subclass of this class

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23datatype/ datatype [/span>

1..1 rdfs:Resource The range of the property is a data type of this type

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23node/ node [/span>

1..1 rdfs:Resource The property points to a node shape
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ comment [/span> 0..1 xsd:string Description of the property
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23name/ name [/span> 0..1 xsd:string The name of the property used for ease of recognition
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23order/ order [/span> 0..1 xsd:integer The property order for display

Concept shapes

These shapes are the meta classes of the terminology concepts used within the information model.

Shape Property Card. Value type Comment
Concept shape
(subtype of Entity shape)
targetClass Fixed :im:Concept data model for terminology concepts
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23code/ code [/span> 1..1 xsd:string The code for this concept, which may be a local code if local concept, or a core code such as a snomed identifier
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23hasTermCode/ hasTermCode [/span> 0..* TermCodeShape Alternative terms or synonyms for this concept. A term may also have a description id.
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23weighting/ weighting [/span> 0..1 xsd:integer A number indicating a weighting for this concept which can be used in free text search
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definitionalStatus/ definitionalStatus [/span> 0..1 im:VSET_Definitionalstatus Indicates the authoring status of this concept, whether necessary only, or both necessary and sufficient. OWL would use Equivalent class axiom to indicate this.
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23hasMap/ hasMap [/span> 0..* xsd:string Any backward maps from core to legacy. This is limited to complex maps rather than simple matches and are 'backward' matches not suitable for automatic inclusion in subsumption queries
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23usageTotal/ usageTotal [/span> 0..1 xsd:integer The approximate number of times this concept has been used in around 1 million primary care and acute care records
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23im1Id/ im1Id [/span> 0..1 xsd:string pointer the original identifer in IM1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23matchedTo/ matchedTo [/span> 0..* im:VSET_Unspecified For a legacy concept, one or more concept this concept matches to. A query for the matched to concepts would entail this concept normally, but NOT the children of this concept
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceContext/ sourceContext [/span> 0..* SourceContextShape The source context object for this concept indicating the system, table, field and organisation that published this legacy concept
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fsnomed.info%2Fsct%23370124000/ 370124000 [/span> 0..* im:Concept Indicates the concepts that this concept has been replaced by
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isChildOf/ isChildOf [/span> 0..* im:Concept points to the parent legacy concept that this concept is in. Note that it may or may not be a true subtype. Reflects the original taxonomy
Term code shape data model for a term code
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ label [/span> 0..* xsd:string
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23code/ code [/span> 0..* xsd:string
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ status [/span> 0..* im:Status
Source context shape
(subtype of Entity shape)
Data model for source context for a concept e.g. source system, field etc
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceSystem/ sourceSystem [/span> 1..* im:ComputerSystem
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourcePublisher/ sourcePublisher [/span> 1..* im:Organisation
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceSchema/ sourceSchema [/span> 1..* xsd:string
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceTable/ sourceTable [/span> 1..* xsd:string
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceField/ sourceField [/span> 1..* xsd:string
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceRegex/ sourceRegex [/span> 1..* xsd:string
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceHeading/ sourceHeading [/span> 1..* xsd:string
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceText/ sourceText [/span> 1..* xsd:string
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceValue/ sourceValue [/span> 1..* xsd:string
Refined concept shape
(subtype of Concept shape)
A concept with role groups with roles
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23roleGroup/ roleGroup [/span> 0..* RoleGroupShape Zero or many role groups, each group containing one or more roles. These represent constraints on the super types i.e. more specific. Generated by inference making sure to remove duplicate properties or super properties.
Role group shape data model for a role group
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ Property [/span> 0..* im:Concept
im:ConceptPropertyShape
(subtype of Concept shape)
A concept that is a role in another concept and as a property may have domains and ranges

Transactional shapes

These shapes form the meta classes for structures pass into APIs for query of, or filing into, the model or health records.

Shape Property Card. Value type Comment
EntityFileTransaction
(subtype of Entity shape)
An entity with the additional CRUD indicators to enable deletes updates, adding quads etc
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23crud/ crud [/span> 1..1 im:CrudOperation Indicates the nature of the CRUD transaction which must be one of im:DeleteAll, im:AddQuads (adds in additional triples), im:UpdateAll (replaces all the predicates for this entity in the graph with te ones submitted), im:UpdatePredicates ( replaces all the objects of these submitted predicates for this graph
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ graph [/span> 1..1 im:Graph The graph to which these triples apply.
This means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph
EntityDocument A document containing any number of triples to file as a batch.
Note that if the document is sent as Json-LD with prefixed iris, a @context object will be required
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23crud/ crud [/span> 1..1 im:CrudOperation Indicates the nature of the default CRUD transaction for entities in thisdocument. Thes can be overridden in each entity. Must be one of: im:DeleteAll, im:AddQuads (adds in additional triples), im:UpdateAll (replaces all the predicates for this entity in the graph with te ones submitted), im:UpdatePredicates ( replaces all the objects of these submitted predicates for this graph
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ graph [/span> 1..1 im:Graph The graph to which these entities apply by default.
This may be overridden by the entities
This means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entities/ entities [/span> 1..* EntityShape Set of entities to file. If the entities do not have crud or graphs oftheir own then the default from the document are used
Query Request A request for data sent as a body (json in local name format) to the /queryIM API.
Contains either a query or query iri with run time variable values for use in the query
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23page/ page [/span> 0..1 PageInformation optional page number and size if the client is looking for paged results
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23textSearch/ textSearch [/span> 0..1 xsd:string If a free text search is part of the query
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ argument [/span> 0..* Argument arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs
or
1..1
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23query/ query [/span> 1..1 QueryDefinition The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach

[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23queryIri/ queryIri [/span>

1..1 im:Query The IRI of a predefined query in the information model. i.e. request the system to run query X
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23referenceDate/ referenceDate [/span> 0..1 im:DateTime reference date for date ranges that use reference date. Note that it could be passed in as an argeument
PageInformation Information about paging if the client wishes to page results, including page number and page size
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pageNumber/ pageNumber [/span> 1..1 xsd:integer Page number (starting at 1)
[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pageSize/ pageSize [/span> 1..1 xsd:integer number of entries per page