Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
(Replaced content with "== Basic shapes == These shapes are the meta classes of the named entities within the information model. === IrirRef === A resource with an iri and name {| class="wikitabl...")
Tag: Replaced
Line 1: Line 1:
== Basic shapes ==
== Basic shapes ==
These shapes are the meta classes of the named entities within the information model.
These shapes are the meta classes of the named entities within the information model.
=== IrirRef ===
A resource with an iri and name
{| class="wikitable"
{| class="wikitable"
|+
|+
!Shape
!colspan="2"|Property
!colspan="2"|Property
!Card.
!Card.
!Value type
!Value type
!Comment
!Description
|-
|rowspan="2"|<span id="class_IriRef">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/  <span style="color:navy"> '''IriRef'''</span>]</span>
|colspan="4"|
|A resource with an iri and name
|-
|colspan="2"|<span title="A human-readable name for the subject.">[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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The name of the entity
|-
|rowspan="6"|<span id="class_Entity">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Entity/  <span style="color:navy"> '''Entity'''</span>]<br> (subtype of [[#class_IrirRef|IrirRef]])</span>
|colspan="4"|
|The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status
|-
|colspan="2"|<span title="A description of the subject resource.">[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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The description of the entity
|-
|-


|colspan="2"|<span title="The subject is an instance of a class.">[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
=== Entity shape ===
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
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 base type of the entity i.e. one of the high level entity types
{| class="wikitable"
|+
!colspan="2"|Property
!Card.
!Value type
!Description
|-
|-


|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
=== IriAlias ===
|<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>
An IRI with a name and an alias (for use as variables for reference
|The status of the entity being active, inactive, draft or unassigned
{| class="wikitable"
|+
!colspan="2"|Property
!Card.
!Value type
!Description
|-
|-


|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
=== Property shape ===
|<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>
data model for properties
|The code scheme or graph which the entity belongs to
{| class="wikitable"
|-
|+
 
!colspan="2"|Property
|colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span>
!Card.
|0..*
!Value type
|<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>
!Description
|An entity that this entity inherits from, both semantically and structurally
|-
 
|
|-
|rowspan="2"|<span id="class_IriAlias">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriAlias/  <span style="color:navy"> '''IriAlias'''</span>]<br> (subtype of [[#class_IrirRef|IrirRef]])</span>
|colspan="4"|
|An IRI with a name and an alias (for use as variables for reference
|-
|colspan="2"|<span 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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The column name in a select clause for this property, or a variable used to reference the result set of the values matched
|-
 
|
|-
 
|-
|rowspan="5"|<span id="class_Property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/  <span style="color:navy"> '''Property'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span>
|colspan="4"|
|data model for properties
|-
|colspan="2"|<span title="The subject is a subclass of a class.">[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..*
|<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>
|
|-
 
|colspan="2"|<span title="The property that determines that two given properties are inverse.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2002%2F07%2Fowl%23inverseOf/ <span style="color:green">inverseOf ]</span></span>
|0..*
|<span title="The class of RDF properties, used for Data properties (object properties are generally owl:ObjectProperties">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ rdf:Property]</span>
|
|-
 
|colspan="2"|<span title="A domain of the subject property.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23domain/ <span style="color:green">domain ]</span></span>
|0..*
|<span title="The class of classes.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Class/ rdfs:Class]</span>
|
|-
 
|colspan="2"|<span title="A range of the subject property.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23range/ <span style="color:green">range ]</span></span>
|0..*
|<span title="The class of classes.">[[#class_Class|Class]]</span>
|
|-
 
|
|-
 
|-
 
|-
|<span id="class_Class">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Class/  <span style="color:navy"> '''Class'''</span>]<br> (subtype of [[#class_Resource|Resource]])</span>
|colspan="4"|
|The class of classes.
|-
|
|-
|-
|<span id="class_Resource">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/  <span style="color:navy"> '''Resource'''</span>]</span>
|colspan="4"|
|The class resource, everything in RDF/OWL/SHACL/RDFS.
|-
|
|-
|-
|-


Line 121: Line 48:
== Query language shapes ==
== Query language shapes ==
These shapes form the query language DSL for retrieving data from the IM or health records.
These shapes form the query language DSL for retrieving data from the IM or health records.
=== QueryShape ===
A query that is stored as an entity in a query library
{| class="wikitable"
{| class="wikitable"
|+
|+
!Shape
!colspan="2"|Property
!colspan="2"|Property
!Card.
!Card.
!Value type
!Value type
!Comment
!Description
|-
|rowspan="2"|<span id="class_Query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/  <span style="color:navy"> '''Query'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span>
|colspan="4"|
|A query that is stored as an entity in a query library
|-
|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
|<span title="A Query definition holding the logical definition of a query in a standard language">[[#class_QueryDefinition|QueryDefinition]]</span>
|The query definition itself
|-
 
|
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|rowspan="7"|<span id="class_QueryDefinition">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryDefinition/  <span style="color:navy"> '''QueryDefinition'''</span>]<br> (subtype of [[#class_ClauseHeading|ClauseHeading]])</span>
|colspan="4"|
|A Query definition holding the logical definition of a query in a standard language
|-
|colspan="2"|<span 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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|Whether the result set is required flat select style json or a nested graphql json object style 'RELATIONAL' or 'OBJECT. Default is OBJECT
|-
 
|colspan="2"|<span 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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|true if you want the results to use IRI prefixes
|-
 
|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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether only active entities are included in the match clauses or select clauses
|-
 
|rowspan="2"|or<br>1..1
|<span 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
|<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>
|Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability
|-
 
|
<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
|<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>
|If the query is a boolean true or false use match clauses as an ask
|-
 
|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
|<span title="A node shape is a shape that specifies constraint that need to be met with respect to focus nodes.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23NodeShape/ sh:NodeShape]</span>
|The main entity to which all matches must be related e.g. Patient or organisation. i.e. the IRI of a data model entity (SHACL shape)
|-
 
|
|-
|rowspan="2"|<span id="class_ClauseHeading">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ClauseHeading/  <span style="color:navy"> '''ClauseHeading'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span>
|colspan="4"|
|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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23alias/ <span style="color:green">alias ]</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>
|An alias or reference term that can be used throughout a query as shorthand for the result set
|-
 
|
|-
|rowspan="12"|<span id="class_SelectClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SelectClause/  <span style="color:navy"> '''SelectClause'''</span>]<br> (subtype of [[#class_ClauseHeading|ClauseHeading]])</span>
|colspan="4"|
|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)">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23count/ <span style="color:green">count ]</span></span>
|0..1
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|If the query result is simply a sum of the main entities found. equivalent to COUNT(id)
|-
 
|rowspan="2"|or<br>0..1
|<span 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..*
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
|Information about a  property or field to includein the results. Property select supports nesting with selects for the objects that may be values of the property
|-
 
|
<span 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
|<span title="Information about the target of a path query, including the IRI of the target and the number of hops processed.">[[#class_PathTargetClause|PathTargetClause]]</span>
|Special function for path query. Information about the target entity when the query is looking to return paths between a source and a target. Both are likely to be passed in as parameters
|-
 
|colspan="2"|<span 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..*
|<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>
|The match pattern to which the select clause must comply. Equivalent to a where/filter in SPARQL and JOIN/WHERE in SQL
|-
 
|colspan="2"|<span 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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether the entity objects returned should be distinct
|-
 
|rowspan="3"|or<br>0..1
|<span 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
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|The entity type for instances this select clause operates on. Options include including subtypes.
|-
 
|
<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
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|An instance of an enttu for which this select clause operates. As in entity type, optionally to include subtypes, where the entity id is a concept
|-
 
|
<span 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
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|The consept set, value set, or query result set that forms the base population of instances on which the select clause operates. e.g. a parent cohort.
|-
 
|colspan="2"|<span 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..*
|<span title="">[[#class_PropertySelectClause|PropertySelectClause]]</span>
|If the results need to be grouped, the grouping properties.
|-
 
|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..*
|<span title="Orders the value of the property (property as represented by the iri and alias)">[[#class_OrderLimitClause|OrderLimitClause]]</span>
|Ordering of instances via a property value and limiting th enumber returned.
|-
 
|colspan="2"|<span 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..*
|<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>
|For a query with column groups such as a list report, the select query for each group
|-
 
|
|-
|rowspan="15"|<span id="class_MatchClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23MatchClause/  <span style="color:navy"> '''MatchClause'''</span>]<br> (subtype of [[#class_ClauseHeading|ClauseHeading]])</span>
|colspan="4"|
|A clause containing criteria which the objects must conform to. Equivalent to a from/join where clause in SQL and where/filter in sparql.<br>Supports graph traversal filtering and inference for subsumption query
|-
|colspan="2"|<span 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
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|A convenient way of traversing properties and objects to get to the match object, avoiding excessive nesting.<br>The properties are listed and thus traversed in strict order
|-
 
|rowspan="2"|or<br>0..1
|<span 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..*
|<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>
|Boolean operator OR on subclauses
|-
 
|
<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..*
|<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>
|Boolean operator AND on subclauses
|-
 
|rowspan="2"|or<br>0..1
|<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
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|The entity type that matched instances must be (including subtypes). Options include including subtypes.
|-
 
|
<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
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|An instance of an entitu for which this match clause operates on.  As in entity type, optionally to include subtypes, where the entity id is a concept
|-
 
|rowspan="2"|or<br>0..1
|<span 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
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|The concept set, value set, or query result set that the instances must be in to match.<br>on which the select clause operates. e.g. a parent cohort.
|-
 
|
<span 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
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|The concept set, value set, or query result set that the instances must NOT be in to match.<br>on which the select clause operates. e.g. a parent cohort.
|-
 
|colspan="2"|<span 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
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span>
|The iri of a graph if the query is limied to a particular data set
|-
 
|colspan="2"|<span 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..*
|<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>
|Properties and their values required to match (or not match), including any nesting of objects (joins).<br>The default assumption is the AND operator on the properties. Use orProperty for or operator
|-
 
|colspan="2"|<span 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..*
|<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>
|Properties and their values one of which is required to match (or not match), including any nesting of objects (joins).
|-
 
|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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Negation indicator for this entire clause. i.e. for the instance to be included it must NOT match.
|-
 
|colspan="2"|<span 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
|<span title="Orders the value of the property (property as represented by the iri and alias)">[[#class_OrderLimitClause|OrderLimitClause]]</span>
|Ability to order and limit the match before the select or matchstatement operates.<br> Crucially, this is processed before the application of a test or check, enabling things like latest or earliest, max or min
|-
 
|colspan="2"|<span 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..*
|<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>
|Further test applied to the result of an ordered limited match.<br> The rest of the match clause then becomes a sub select query on which these tests operate. Implicit operator is AND
|-
 
|colspan="2"|<span 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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|Optional text for display in query viewer if dfferent from the match clause name
|-
 
|
|-
 
|-
 
|-
|rowspan="8"|<span id="class_PropertySelectClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertySelectClause/  <span style="color:navy"> '''PropertySelectClause'''</span>]<br> (subtype of [[#class_ConceptReference|ConceptReference]])</span>
|colspan="4"|
|null
|-
|rowspan="3"|or<br>0..1
|<span 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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether the result is a summation of this property's values
|-
 
|
<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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether the result is an average of this property's values
|-
 
|
<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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether the result is the maximum of this property's values
|-
 
|colspan="2"|<span 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
|<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>
|Nested select clause for graphql style results format
|-
 
|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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Indicates if true that the selected property is an inverse relationship with the target object
|-
 
|colspan="2"|<span 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
|<span title="A function definition with optional parameters">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/ im:Function]</span>
|The iri of a function indicating that the result is the result of a function operating on the property values, and any arguments passed in
|-
 
|colspan="2"|<span 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..*
|<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span>
|Arguments to pass into the function
|-
 
|
|-
|rowspan="2"|<span id="class_PathTargetClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PathTargetClause/  <span style="color:navy"> '''PathTargetClause'''</span>]<br> (subtype of [[#class_IrirRef|IrirRef]])</span>
|colspan="4"|
|Information about the target of a path query, including the IRI of the target and the number of hops processed.
|-
|colspan="2"|<span 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
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|How many hops to be taken in the graph between source and target
|-
 
|
|-
|rowspan="4"|<span id="class_ConceptReference">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptReference/  <span style="color:navy"> '''ConceptReference'''</span>]<br> (subtype of [[#class_IriAlias|IriAlias]])</span>
|colspan="4"|
|null
|-
|colspan="2"|<span 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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether to include the subtypes of the entites selected or matched
|-
 
|colspan="2"|<span 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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether to include the supertypes of the entity in a match clause. Used for ascending the hierarch to look for properties inherited
|-
 
|colspan="2"|<span 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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Whether to exclude this entity when either include supbtypes or include suprtypes is set. Rarely used but sometimes found in ECL definitions
|-
 
|
|-
|rowspan="4"|<span id="class_OrderLimitClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23OrderLimitClause/  <span style="color:navy"> '''OrderLimitClause'''</span>]</span>
|colspan="4"|
|Orders the value of the property (property as represented by the iri and alias)
|-
|colspan="2"|<span 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
|<span title="An IRI with a name and an alias (for use as variables for reference">[[#class_IriAlias|IriAlias]]</span>
|The property or property variable to order the results by
|-
 
|colspan="2"|<span 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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|ASCENDING or DESCENDING to indicate the order direction
|-
 
|colspan="2"|<span 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
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|The count of instances to return after ordering
|-
 
|-
 
|-
|rowspan="15"|<span id="class_PropertyValueClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyValueClause/  <span style="color:navy"> '''PropertyValueClause'''</span>]<br> (subtype of [[#class_ConceptReference|ConceptReference]])</span>
|colspan="4"|
|A property (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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathTo/ <span style="color:green">pathTo ]</span></span>
|0..1
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|A convenient way of traversing properties and objects to get to a property, avoiding excessive nesting.<br>The properties are listed and thus traversed in strict order
|-
 
|colspan="2"|<span 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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Tests the property as an inverse property (inbound relationship)
|-
 
|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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|The property match must not exist. This is negatation at a more granular level than the match clause.<br>For example to test for a null field or absent property
|-
 
|colspan="2"|<span 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
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|Optional match for this property, used to enable IF a present then A must have X,Y.<br> N.B for SPARQL experts the OPTIONAL is generally generated automatically from SELECT,  so optional need only be set when a test is to be applied to a linked object
|-
 
|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
|<span title="A function used in a query consisting of the function iri and one or more arguments to pass in at run time">[[#class_FunctionClause|FunctionClause]]</span>
|A function that operates on the property value (and other parameters) prior to a compare or range or inclusion test. For example a time difference function operating on the date and a reference date.<br>Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.
|-
 
|colspan="2"|<span 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
|<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span>
|Arguments to pass into a function when the property is a function property.<br>Note that if the test is a function then the argument list would be in the function clause
|-
 
|rowspan="7"|or<br>0..1
|<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
|<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
|If testing a property value as equal greater than ete. use compare
|-
 
|
<span 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..*
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|The value of the property must be in the concept set IRI.<br>For teesting simple lists or single concepts use isConcept
|-
 
|
<span 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..*
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|The value of the property must NOT be in the concept set IRI.<br> Note that this is not negation of the entire match, only the negation of this entry instance when tested. Equivalent to SPARQL filter not in.<br> For testing simple lists of concepts use isNotConcept
|-
 
|
<span 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..*
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|The value of the property be this concept (and otionally its sub types).<br> Used for inline sets or single concepts
|-
 
|
<span 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..*
|<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|The value of the property must NOT be this concept (and otionally its sub types).<br> Used for inline sets or single concepts.<br>Note that this is not negation of the entire match, only the negation of this entry instance when tested. Equivalent to SPARQL filter not in.
|-
 
|
<span 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
|<span title="A range for use in property value testing">[[#class_RangeClause|RangeClause]]</span>
|Test foe a value being between two absolute or relative values
|-
 
|
<span 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
|<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>
|The match clause operating on the property value object.<br> Equivalent to a join in SQL or '.' in sparql
|-
 
|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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|Optional text for display in query viewer if dfferent from the match clause name
|-
 
|
|-
 
|-
|rowspan="6"|<span id="class_Argument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Argument/  <span style="color:navy"> '''Argument'''</span>]</span>
|colspan="4"|
|A named parameter and a value for passing into a function
|-
|colspan="2"|<span title="The parameters of a function or constraint component.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter ]</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>
|Parameter name for a function or the parameter name for an argument
|-
 
|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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueData/ <span style="color:green">valueData ]</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>
|Vaue that is a literal such as a string or number
|-
 
|
<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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|argumenT value which is a variable name to be resolved at run time
|-
 
|
<span 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
|<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>
|Argument value that is the result of a select query
|-
 
|
<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
|<span title="A resource with an iri and name">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/ im:IriRef]</span>
|Argument value that is an iri
|-
 
|-
 
|-
 
|-
 
|-
|rowspan="2"|<span id="class_FunctionClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionClause/  <span style="color:navy"> '''FunctionClause'''</span>]<br> (subtype of [[#class_IrirRef|IrirRef]])</span>
|colspan="4"|
|A function used in a query consisting of the function iri and one or more arguments to pass in at run time
|-
|colspan="2"|<span 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..*
|<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span>
|Arguments to pass into the function. They should match the parameter definitions of the function
|-
 
|
|-
|rowspan="5"|<span id="class_CompareClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23CompareClause/  <span style="color:navy"> '''CompareClause'''</span>]</span>
|colspan="4"|
|Tests a value, whether equal, greater than, less than etc.
|-
|colspan="2"|<span 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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|Comparison operators : EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, NOT_EQUAL
|-
 
|rowspan="3"|or<br>1..1
|<span 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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The value to compare against. This is a string which will be cast to a number or date, depending on the data type of the property value
|-
 
|
<span 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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The variable (alias) to compare against. The variable may be an argument to the query (e.g. $reference date or an alias in this query or another query. Use the $ prefix to make it clear
|-
 
|
<span 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
|<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>
|The result to compare the property value against is derived from a select sub query
|-
 
|-
|rowspan="3"|<span id="class_RangeClause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RangeClause/  <span style="color:navy"> '''RangeClause'''</span>]</span>
|colspan="4"|
|A range for use in property value testing
|-
|colspan="2"|<span 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
|<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
|The value comparison for lower end of the range
|-
 
|colspan="2"|<span 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
|<span title="Tests a value, whether equal, greater than, less than etc.">[[#class_CompareClause|CompareClause]]</span>
|The value comparison of upper end of the range
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|-


|}
=== Query definition ===
A Query definition holding the logical definition of a query in a standard language
{| class="wikitable"
|+
!colspan="2"|Property
!Card.
!Value type
!Description
|-
|-


|-
|}
 
=== FunctionShape ===
|-
null
 
{| class="wikitable"
|-
|+
|rowspan="2"|<span id="class_Function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/  <span style="color:navy"> '''Function'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span>
!colspan="2"|Property
|colspan="4"|
!Card.
|null
!Value type
|-
!Description
|colspan="2"|<span title="The parameters of a function or constraint component.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter ]</span></span>
|0..*
|<span title="">[[#class_Parameter|Parameter]]</span>
|A list of parameters and data types used in this function
|-
 
|
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|rowspan="4"|<span id="class_Parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Parameter/  <span style="color:navy"> '''Parameter'''</span>]</span>
|colspan="4"|
|null
|-
|colspan="2"|<span title="A human-readable name for the subject.">[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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The name of the parameter
|-
 
|rowspan="2"|or<br>1..1
|<span title="Specifies an RDF datatype that all value nodes must have.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23datatype/ <span style="color:green">datatype ]</span></span>
|1..1
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|The iri of The data type of the parameter when the data type is a literal
|-
 
|
<span title="The type that all value nodes must have.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23class/ <span style="color:green">class ]</span></span>
|1..1
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|The iri of the class of the parameter when the argument is an object
|-
 
|-
|-


Line 853: Line 84:
== Data Model shapes ==
== Data Model shapes ==
These shapes are the meta classes of the data modelling entities within the information model.
These shapes are the meta classes of the data modelling entities within the information model.
=== Data model shape ===
The meta class for a data model type, using a SHACL node shape for both definition and validation
{| class="wikitable"
{| class="wikitable"
|+
|+
!Shape
!colspan="2"|Property
!colspan="2"|Property
!Card.
!Card.
!Value type
!Value type
!Comment
!Description
|-
|rowspan="2"|<span id="class_NodeShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23NodeShape/  <span style="color:navy"> '''NodeShape'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span>
|colspan="4"|
|The meta class for a data model type, using a SHACL node shape for both definition and validation
|-
|colspan="2"|<span title="Links a shape to its property shapes.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23property/ <span style="color:green">property ]</span></span>
|0..*
|<span title="The data model of a shacl node shape describing a property of a data model entity">[[#class_PropertyNodeShape|PropertyNodeShape]]</span>
|
|-
 
|
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|rowspan="10"|<span id="class_PropertyNodeShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyNodeShape/  <span style="color:navy"> '''PropertyNodeShape'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span>
|colspan="4"|
|The data model of a shacl node shape describing a property of a data model entity
|-
|colspan="2"|<span title="Specifies the property path of a property shape.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23path/ <span style="color:green">path ]</span></span>
|1..1
|<span title="The class of RDF properties, used for Data properties (object properties are generally owl:ObjectProperties">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ rdf:Property]</span>
|The iri of the property
|-
 
|colspan="2"|<span title="Specifies the minimum number of values in the set of value nodes.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23minCount/ <span style="color:green">minCount ]</span></span>
|0..1
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|Minimum cardinality,if null assuming any number including zero
|-
 
|colspan="2"|<span title="Specifies the maximum number of values in the set of value nodes.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23maxCount/ <span style="color:green">maxCount ]</span></span>
|0..1
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|The maximum number allowed. If null then any number
|-
 
|rowspan="3"|or<br>1..1
|<span title="The type that all value nodes must have.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23class/ <span style="color:green">class ]</span></span>
|1..1
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|The iri for the class range of the property. The range of this property is a subclass of this class
|-
 
|
<span title="Specifies an RDF datatype that all value nodes must have.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23datatype/ <span style="color:green">datatype ]</span></span>
|1..1
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|The range of the property is a data type of this type
|-
 
|
<span title="Specifies the node shape that all value nodes must conform to.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23node/ <span style="color:green">node ]</span></span>
|1..1
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|The property points to a node shape
|-
 
|colspan="2"|<span title="A description of the subject resource.">[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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|Description of the property
|-
 
|colspan="2"|<span title="Human-readable labels for the property in the context of the surrounding shape.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23name/ <span style="color:green">name ]</span></span>
|0..1
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The name of the property used for ease of recognition
|-
 
|colspan="2"|<span title="Specifies the relative order of this compared to its siblings. For example use 0 for the first, 1 for the second.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23order/ <span style="color:green">order ]</span></span>
|0..1
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|The property order for display
|-
 
|
|-
 
|-
|-


Line 1,001: Line 98:
== Concept shapes ==
== Concept shapes ==
These shapes are the meta classes of the terminology concepts used within the information model.
These shapes are the meta classes of the terminology concepts used within the information model.
=== Concept shape ===
data model for terminology concepts
{| class="wikitable"
{| class="wikitable"
|+
|+
!Shape
!colspan="2"|Property
!colspan="2"|Property
!Card.
!Card.
!Value type
!Value type
!Comment
!Description
|-
|rowspan="12"|<span id="class_Concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/  <span style="color:navy"> '''Concept'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span>
|colspan="4"|
|data model for terminology concepts
|-
|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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The code for this concept, which may be a local code if local concept, or a core code such as a snomed identifier
|-
 
|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..*
|<span title="data model for a term code">[[#class_TermCodeShape|TermCodeShape]]</span>
|Alternative terms or synonyms for this concept. A term may also have a description id.
|-
 
|colspan="2"|<span title="weighting to help in search retrieval">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23weighting/ <span style="color:green">weighting ]</span></span>
|0..1
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|A number indicating a weighting for this concept which can be used in free text search
|-
 
|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
|<span title="Value set for Concept shape / definitional status">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Definitionalstatus/ im:VSET_Definitionalstatus]</span>
|Indicates the authoring status of this concept, whether necessary only, or both necessary and sufficient. OWL would use Equivalent class axiom to indicate this.
|-
 
|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..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|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
|-
 
|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
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|The approximate number of times this concept has been used in around 1 million primary care and acute care records
|-
 
|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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|pointer the original identifer in IM1
|-
 
|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..*
|<span title="Value set place holder for unmodelled property value sets">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Unspecified/ im:VSET_Unspecified]</span>
|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
|-
 
|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..*
|<span title="Data model for source context for a concept e.g. source system, field etc">[[#class_SourceContextShape|SourceContextShape]]</span>
|The source context object for this concept indicating the system, table, field and organisation that published this legacy concept
|-
 
|colspan="2"|<span title="REPLACED BY (attribute)">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fsnomed.info%2Fsct%23370124000/ <span style="color:green">370124000 ]</span></span>
|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>
|Indicates the concepts that this concept has been replaced by
|-
 
|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..*
|<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>
|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
|-
 
|
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|rowspan="4"|<span id="class_TermCodeShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23TermCodeShape/  <span style="color:navy"> '''TermCodeShape'''</span>]</span>
|colspan="4"|
|data model for a term code
|-
|colspan="2"|<span title="A human-readable name for the subject.">[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..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</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..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</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..*
|<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>
|
|-
 
|-
|rowspan="10"|<span id="class_SourceContextShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SourceContextShape/  <span style="color:navy"> '''SourceContextShape'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span>
|colspan="4"|
|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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceSystem/ <span style="color:green">sourceSystem ]</span></span>
|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>
|
|-
 
|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..*
|<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>
|
|-
 
|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..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</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..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</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..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</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..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</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..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</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..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</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..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|
|-
 
|
|-
 
|-
|rowspan="2"|<span id="class_RefinedConceptShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RefinedConceptShape/  <span style="color:navy"> '''RefinedConceptShape'''</span>]<br> (subtype of [[#class_Concept shape|Concept shape]])</span>
|colspan="4"|
|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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23roleGroup/ <span style="color:green">roleGroup ]</span></span>
|0..*
|<span title="data model for a role group">[[#class_RoleGroupShape|RoleGroupShape]]</span>
|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.
|-
 
|
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|rowspan="2"|<span id="class_RoleGroupShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RoleGroupShape/  <span style="color:navy"> '''RoleGroupShape'''</span>]</span>
|colspan="4"|
|data model for a role group
|-
|colspan="2"|<span title="The class of RDF properties, used for Data properties (object properties are generally owl:ObjectProperties">[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..*
|<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 id="class_ConceptPropertyShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptPropertyShape/  <span style="color:navy"> '''ConceptPropertyShape'''</span>]<br> (subtype of [[#class_Property shape|Property shape]])</span>
|colspan="4"|
|A concept that is a role in another concept and as a property may have domains and ranges
|-
|
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|rowspan="4"|<span id="class_ConceptSet">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptSet/  <span style="color:navy"> '''ConceptSet'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span>
|colspan="4"|
|data model for concept sets and value sets
|-
|colspan="2"|<span title="Points to something that defines the entity content">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definition/ <span style="color:green">definition ]</span></span>
|0..1
|<span title="A query that is stored as an entity in a query library">[[#class_QueryShape|QueryShape]]</span>
|A definition of set content using the subset of the query language that aligns to Expression constraint language
|-
 
|colspan="2"|<span title="points to a member of the set">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23hasMember/ <span style="color:green">hasMember ]</span></span>
|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>
|The flat list of leaf concepts when generated from the definition, or for many national sets, simple list of concepts
|-
 
|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..*
|<span title="data model for a term code">[[#class_TermCodeShape|TermCodeShape]]</span>
|
|-
 
|
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|-


|}
=== Refined concept shape ===
A concept with role groups with roles
{| class="wikitable"
|+
!colspan="2"|Property
!Card.
!Value type
!Description
|-
|-


|}
=== im:ConceptPropertyShape ===
A concept that is a role in another concept and as a property may have domains and ranges
{| class="wikitable"
|+
!colspan="2"|Property
!Card.
!Value type
!Description
|-
|-


|}
=== Set shape ===
data model for concept sets and value sets
{| class="wikitable"
|+
!colspan="2"|Property
!Card.
!Value type
!Description
|-
|-


Line 1,516: Line 145:
== Transactional shapes ==
== Transactional shapes ==
These shapes form the meta classes for structures pass into APIs for query of, or  filing into, the model or health records.
These shapes form the meta classes for structures pass into APIs for query of, or  filing into, the model or health records.
=== EntityFileTransaction ===
An entity with the additional CRUD indicators to enable deletes updates, adding quads etc
{| class="wikitable"
{| class="wikitable"
|+
|+
!Shape
!colspan="2"|Property
!colspan="2"|Property
!Card.
!Card.
!Value type
!Value type
!Comment
!Description
|-
|rowspan="3"|<span id="class_EntityFileTransaction">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityFileTransaction/  <span style="color:navy"> '''EntityFileTransaction'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span>
|colspan="4"|
|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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23crud/ <span style="color:green">crud ]</span></span>
|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>
|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
|-
|-


|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
=== EntityDocument ===
|<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>
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
|The graph to which these triples apply. <br>This means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph
{| class="wikitable"
|-
|+
 
!colspan="2"|Property
|
!Card.
|-
!Value type
 
!Description
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|rowspan="4"|<span id="class_EntityDocument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityDocument/  <span style="color:navy"> '''EntityDocument'''</span>]</span>
|colspan="4"|
|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">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23crud/ <span style="color:green">crud ]</span></span>
|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>
|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
|-
 
|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
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span>
|The graph to which these entities apply by default. <br>This may be overridden by the entities<br>This means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph
|-
 
|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..*
|<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>
|Set of entities to file. If the entities do not have crud or graphs oftheir own then the default from the document are used
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|rowspan="7"|<span id="class_QueryRequest">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/  <span style="color:navy"> '''QueryRequest'''</span>]</span>
|colspan="4"|
|A request for data sent as a  body (json in local name format) to the /queryIM API.<br>Contains either a query or query iri with run time variable values for use in the query
|-
|colspan="2"|<span 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
|<span title="Information about paging if the client wishes to page results, including page number and page size">[[#class_PageInformation|PageInformation]]</span>
|optional page number and size if the client is looking for paged results
|-
 
|colspan="2"|<span 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
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|If a free text search is part of the query
|-
 
|colspan="2"|<span 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..*
|<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span>
|arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs
|-
 
|rowspan="2"|or<br>1..1
|<span 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
|<span title="A Query definition holding the logical definition of a query in a standard language">[[#class_QueryDefinition|QueryDefinition]]</span>
|The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach
|-
 
|
<span 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
|<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>
|The IRI of a predefined query in the information model. i.e. request the system to run query X
|-
 
|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
|<span title="im date time format">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DateTime/ im:DateTime]</span>
|reference date for date ranges that use reference date. Note that it could be passed in as an argeument
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
 
|-
|rowspan="3"|<span id="class_PageInformation">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PageInformation/  <span style="color:navy"> '''PageInformation'''</span>]</span>
|colspan="4"|
|Information about paging if the client wishes to page results, including page number and page size
|-
|colspan="2"|<span 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
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|Page number (starting at 1)
|-
 
|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
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|number of entries per page
|-
|-


|}
=== Query Request ===
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
{| class="wikitable"
|+
!colspan="2"|Property
!Card.
!Value type
!Description
|-
|-


|}
|}

Revision as of 16:34, 20 September 2022

Basic shapes

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

IrirRef

A resource with an iri and name

Property Card. Value type Description

Entity shape

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

Property Card. Value type Description

IriAlias

An IRI with a name and an alias (for use as variables for reference

Property Card. Value type Description

Property shape

data model for properties

Property Card. Value type Description

Query language shapes

These shapes form the query language DSL for retrieving data from the IM or health records.

QueryShape

A query that is stored as an entity in a query library

Property Card. Value type Description

Query definition

A Query definition holding the logical definition of a query in a standard language

Property Card. Value type Description

FunctionShape

null

Property Card. Value type Description

Data Model shapes

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

Data model shape

The meta class for a data model type, using a SHACL node shape for both definition and validation

Property Card. Value type Description

Concept shapes

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

Concept shape

data model for terminology concepts

Property Card. Value type Description

Refined concept shape

A concept with role groups with roles

Property Card. Value type Description

im:ConceptPropertyShape

A concept that is a role in another concept and as a property may have domains and ranges

Property Card. Value type Description

Set shape

data model for concept sets and value sets

Property Card. Value type Description

Transactional shapes

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

EntityFileTransaction

An entity with the additional CRUD indicators to enable deletes updates, adding quads etc

Property Card. Value type Description

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

Property Card. Value type Description

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

Property Card. Value type Description
Retrieved from ‘https://wiki.endeavourhealth.org/index.php?title=Test&oldid=6473’
Last modified
This page was last modified on 20 September 2022, at 16:34.