Meta model class specification: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 8: Line 8:




<br />


== Basic shapes ==
== Basic shapes ==
Line 34: Line 28:
|}
|}
{{Note| Example <br>{"@id" : "sn:29857009", "name" : "Chest pain (finding)"} }}
{{Note| Example <br>{"@id" : "sn:29857009", "name" : "Chest pain (finding)"} }}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/ Entity shape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Entity/ Entity] ===
Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Entity/ Entity]
The abstract super class and data model for all named entities in the model i.e. the data model of the entities that are labelled with iri label and status
The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 66: Line 59:
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span>
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span>
|1..1
|1..1
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span>
|<span title="Core graphs for core ontologies and taxonomies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span>
|The code scheme or graph which the entity belongs to
|The code scheme or graph which the entity belongs to
|-
|-
|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>
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isContainedIn/ <span style="color:green">isContainedIn ]</span></span>
|0..*
|0..*
|<span title="The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/ im:EntityShape]</span>
|<span title="Folder containing subfolders or entities">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Folder/ im:Folder]</span>
|An entity that this entity inherits from, both semantically and structurally, this is also used for sub properties as properties are classes of properties
|An entity that this entity inherits from, both semantically and structurally, this is also used for sub properties as properties are classes of properties
|-
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fsnomed.info%2Fsct%23370124000/ <span style="color:green">370124000 ]</span></span>
|0..*
|<span title="The abstract super class and data model for all named entities 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%23Entity/ im:Entity]</span>
|When a status is inactive, the entity that replaces this entity (if any)
|-
|-


Line 93: Line 91:
|The column name in a select clause for this property, or a variable used to reference the result set of the values matched
|The column name in a select clause for this property, or a variable used to reference the result set of the values matched
|-
|-
|colspan="2"|<span title="The name of a variable, passed as an argument to the query, which is resolved to the IRI">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23variable/ <span style="color:green">variable ]</span></span>
|colspan="2"|<span title="The name of a variable, passed as an argument to a function. Assumed to be a collection">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23variable/ <span style="color:green">variable ]</span></span>
|0..1
|0..1
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
Line 114: Line 112:
|-
|-
|rowspan="2"|or<br>0..1
|rowspan="2"|or<br>0..1
|<span title="If the query results are derived from instances of certain type (or types) then set this flag to true.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isType/ <span style="color:green">isType ]</span></span>
|<span title="In cases where it is ambiguous whether an iri refers to an instance or type, then set this to true if a type">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isType/ <span style="color:green">isType ]</span></span>
|0..1
|0..1
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
Line 128: Line 126:


|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyShape/ Property shape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriVariable/ IriVariable] ===
Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ Property]


Is a subtype of [[#Entity shape|Entity shape]]
Is a subtype of [[#IrirRef|IrirRef]]


data model for properties
A variable, usually passed in as a parameter to a function, with an optional IRI and whether the iri is an instance or type iri (if ambiguous)
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|colspan="2"|<span title="The name of a variable, passed as an argument to a function. Assumed to be a collection">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23variable/ <span style="color:green">variable ]</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 a variable, passed as an argument to a function. Assumed to be a collection
|-
|colspan="2"|<span title="In cases where it is ambiguous whether an iri refers to an instance or type, then set this to true if a type">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isType/ <span style="color:green">isType ]</span></span>
|0..1
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|In cases where it is ambiguous whether an iri refers to an instance or type, then set this to true if a type
|-
 
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Property/ Property] ===
 
Is a subtype of [[#Entity|Entity]]
 
A property data model
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 143: Line 164:
|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>
|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..*
|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>
|<span title="The class of properties">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ rdf:Property]</span>
|A property that this property is an inverse of
|A property that this property is an inverse of
|-
|-
Line 155: Line 176:
|<span title="The class of classes.">[[#Class|Class]]</span>
|<span title="The class of classes.">[[#Class|Class]]</span>
|the type of value for this property.
|the type of value for this property.
|-
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Folder/ Folder] ===
Is a subtype of [[#Entity|Entity]]
Folder containing subfolders or entities
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntitySelector/ Entity selector] ===
Is a subtype of [[#Entity|Entity]]
A list of entities to select at particular points in a business process.
{| 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%23list/ <span style="color:green">list ]</span></span>
|0..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The list of entities by iri to select from
|-
|}
== Data Model shapes ==
These shapes are the meta classes of the data modelling entities within the information model.
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23NodeShape/ Data model/Node shape ] ===
Is a subtype of [[#Entity|Entity]]
The meta class for shapes, those shapes defining a type i.e the shape of a shape
{| 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%23isContainedIn/ <span style="color:green">isContainedIn ]</span></span>
|0..*
|<span title="Folder containing subfolders or entities">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Folder/ im:Folder]</span>
|
|-
|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="The meta class for shapes, those shapes defining a type i.e the shape of a shape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23NodeShape/ sh:NodeShape]</span>
|
|-
|colspan="2"|<span title="Parameter name for a function or the parameter name for an argument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23property/ <span style="color:green">property ]</span></span>
|0..*
|<span title="A meta class defining the shape of a property definition in a node shape.  Not to be confused with a property concept">[[#PropertyShape|PropertyShape]]</span>
|The list of properties for this shape
|-
|}
== Concept shapes ==
These shapes are the meta classes of the terminology concepts used within the information model.
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ Terminology concept] ===
Is a subtype of [[#Entity|Entity]]
data model for terminology concepts
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|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="data model for terminology concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span>
|The concept this concept is a sub type of
|-
|colspan="2"|<span title="a code for a 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">[[#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">[[#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="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fsnomed.info%2Fsct%23370124000/ <span style="color:green">370124000 ]</span></span>
|0..*
|<span title="data model for terminology 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="data model for terminology 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
|-
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23TermCodeShape/ Term code shape] ===
data model for a term code
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|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>
|The term or synonym for the concept
|-
|colspan="2"|<span title="a code for a 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>
|Descriptionid or code for this particular term
|-
|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>
|The status of this particular term code, may be active or inactive
|-
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SourceContextShape/ Source context shape] ===
Is a subtype of [[#Entity|Entity]]
Data model for source context for a concept e.g. source system, field etc
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|colspan="2"|<span title="A reference identifier (usually an iri) to a source IT system, perhaps name and version. This needs only be sufficient for context">[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>
|the name of the system that was responsible for sending the message or extract, usually referring to the health care record system
|-
|colspan="2"|<span title="A reference identifier (usually an iri) to a source publisher">[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>
|The organisation (usually a provider) that was the source of this message or extract
|-
|colspan="2"|<span title="A reference identifier (usually an iri) to a source schema or extract model. This needs only be sufficient for context, not meant to be an 'official' data model">[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>
|The schema or data set or other identifier that identifies the format of this extract
|-
|colspan="2"|<span title="A reference identifier (usually an iri) to a source table or message or resource. This needs only be sufficient for context, not meant to be an 'official' reference">[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>
|If a table or message the name of the source table or source message type
|-
|colspan="2"|<span title="A reference identifier (usually an iri) to a source field, or property. This needs only be sufficient for context">[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>
|The source field containing this data item
|-
|colspan="2"|<span title="Regex pattern to apply to any text entry that may not be coded">[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>
|In the case of text, the nature of a regex expression or nlp algorithm used to parse the source text
|-
|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>
|For an item that depends on the context in which it appears, the heading which provides context
|-
|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>
|Source text or term for coded or non coded data
|-
|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>
|The value or code for this concept. Note that a scheme for the code can be inferred from the other context information. In the event of a scheme/code pair, use different fields in the source context
|-
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RefinedConcept/ Refined concep] ===
Is a subtype of [[#null|null]]
A concept with role groups with roles
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|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">[[#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.
|-
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptShape/ null] ===
null
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RoleGroupShape/ Role group shape] ===
data model for a role group
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|colspan="2"|<span title="The class of properties">[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="data model for terminology concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span>
|The concept identifier of the concept that is the role. Role Groups are unique in that their properties are any properties from an ontology,usually concepts
|-
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23CodeableConcept/ null] ===
Is a subtype of [[#IrirRef|IrirRef]]
null
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|colspan="2"|<span title="the common model concept to which an original code has been matched to, used within a codeable concept when preserving original code">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23matchedConcept/ <span style="color:green">matchedConcept ]</span></span>
|0..1
|<span title="A reference to resource with an iri and optional name to enable readability">[[#IriRef|IriRef]]</span>
|The core concept iri that this codeable concept has been matched to in this instance
|-
|colspan="2"|<span title="a code as originally entered in the system">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23originalCode/ <span style="color:green">originalCode ]</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 original code entered in the publication system which may be mapped to a code concept
|-
|colspan="2"|<span title="the scheme of a  code as originally entered in the system, may be a url or OID">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23originalScheme/ <span style="color:green">originalScheme ]</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 original code scheme identifier, may be a url or a OID or informal identifier
|-
|colspan="2"|<span title="a code term usually from a look up  from the original entered system. This may or may not be the same as the text displayed to the user">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23originalCodeTerm/ <span style="color:green">originalCodeTerm ]</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 original display term for this code usually as a reference. Should not be confused with original text as seen by the user, which may be different depending on the context
|-
|colspan="2"|<span title="Where original codes have been qualified as a result of text e.g a text result such as negative">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23originalQualifierTerm/ <span style="color:green">originalQualifierTerm ]</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>
|A qualifier term in the original system which may result in a different concept map. For Example 'negative' or 'positive' or a block of text
|-
|-


Line 161: Line 494:
== Query Model and Set definition shapes ==
== Query Model and Set definition shapes ==
These shapes form the model for defining sets (also known as query definitions) for retrieving data from the IM or health records.
These shapes form the model for defining sets (also known as query definitions) for retrieving data from the IM or health records.
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryShape/ Query /Set shape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/ Query] ===
Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/ Query]


Is a subtype of [[#Entity shape|Entity shape]]
Is a subtype of [[#Entity|Entity]]


A query that is stored as an entity in a query library
A query that is stored as an entity in a query library
Line 181: Line 513:


|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryDefinition/ Query /Set definition] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryDefinition/ Query definition] ===


Is a subtype of [[#IriAlias|IriAlias]]
Is a subtype of [[#IriAlias|IriAlias]]
Line 232: Line 564:
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|Number of entities to return. Normally used with order by
|Number of entities to return. Normally used with order by
|-
|colspan="2"|<span title="Tests an aggregate result from the group clause for a value">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23having/ <span style="color:green">having ]</span></span>
|0..1
|<span title="A clause testing an aggregate function on a property usually one that is grouped">[[#HavingClause|HavingClause]]</span>
|Tests an aggregate result from the group clause for a value
|-
|-
|colspan="2"|<span title="SubQueries used to group columns in multi group reports. The sub queries are all subsets of the main query clauses">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23subQuery/ <span style="color:green">subQuery ]</span></span>
|colspan="2"|<span title="SubQueries used to group columns in multi group reports. The sub queries are all subsets of the main query clauses">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23subQuery/ <span style="color:green">subQuery ]</span></span>
Line 281: Line 618:
|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>
|colspan="2"|<span title="The graph to which these entities apply by default. This may be overridden by the entitiesThis means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ <span style="color:green">graph ]</span></span>
|0..1
|0..1
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span>
|<span title="Core graphs for core ontologies and taxonomies 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 limited to a particular data set
|The iri of a graph if the query is limited to a particular data set
|-
|-
|colspan="2"|<span title="A property path made up of space delimited iri strings, from the outer entity to the entity on which this clause operates.Equivalent to an inner join in SQL">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23path/ <span style="color:green">path ]</span></span>
|colspan="2"|<span title="A property type path made up of space delimitediri strings, from the outer entity to the entity on which this clause operates. Alternates property and typeEquivalent to an inner join in SQL">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23pathTo/ <span style="color:green">pathTo ]</span></span>
|0..1
|0..1
|<span title="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>
|<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 property path made up of space delimited iri strings, from the outer entity to the entity on which this clause operates.<br>Equivalent to an inner join in SQL
|A property type path made up of space delimitediri strings, from the outer entity to the entity on which this clause operates. Alternates property and type<br>Equivalent to an inner join in SQL
|-
|-
|colspan="2"|<span title="Points to a nested where clause. If the nested clause returns results then the entity referenced by the outer where clause is excluded.In other words, for the outer entity to be included, the nested entity must have no results. This contrasts with 'not'">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notExist/ <span style="color:green">notExist ]</span></span>
|colspan="2"|<span title="Points to a nested where clause. If the nested clause returns results then the entity referenced by the outer where clause is excluded.In other words, for the outer entity to be included, the nested entity must have no results. This contrasts with 'not'">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23notExist/ <span style="color:green">notExist ]</span></span>
Line 304: Line 641:
|Boolean operator AND on subclauses
|Boolean operator AND on subclauses
|-
|-
|colspan="2"|<span title="The property of the objects in the result set (as indicated by the alias) to test">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
|colspan="2"|<span title="The property on which the aggregate function operates">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
|0..*
|0..*
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
Line 326: Line 663:
|colspan="2"|<span title="A function that operates on the property value (and other parameters) prior to a compare or range or inclusion test. For example a time difference function operating on the date and a reference date.Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ <span style="color:green">function ]</span></span>
|colspan="2"|<span title="A function that operates on the property value (and other parameters) prior to a compare or range or inclusion test. For example a time difference function operating on the date and a reference date.Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ <span style="color:green">function ]</span></span>
|1..1
|1..1
|<span title="A function used in a query consisting of the function iri and one or more arguments to pass in at run time">[[#FunctionClause|FunctionClause]]</span>
|<span title="A call to a function used in a query consisting of the function iri and one or more arguments to pass in at run time">[[#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.
|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. They should match the parameter definitions of the function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23argument/ <span style="color:green">argument ]</span></span>
|rowspan="2"|or<br>0..1
|<span title="Where the value is within a range of another valueNote that if the test is a function then the argument list would be in the function clause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23within/ <span style="color:green">within ]</span></span>
|0..1
|0..1
|<span title="A named parameter and a value for passing into a function">[[#Argument|Argument]]</span>
|<span title="">[[#Within|Within]]</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
|Where the value is within a range of another value<br>Note that if the test is a function then the argument list would be in the function clause
|-
|-
|colspan="2"|<span title="The value of the property used in a test. 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%23value/ <span style="color:green">value ]</span></span>
 
|
<span title="The value of the aggregate result to be tested">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23value/ <span style="color:green">value ]</span></span>
|1..1
|1..1
|<span title="Tests a value, whether equal, greater than, less than etc. optionally including a value to compare against">[[#ValueClause|ValueClause]]</span>
|<span title="Tests a value, whether equal, greater than, less than etc. optionally including a value to compare against">[[#ValueClause|ValueClause]]</span>
|If testing a property value as equal greater than ete. use compare
|If testing a property value as equal greater than ete. use compare
|-
|-
|colspan="2"|<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%23range/ <span style="color:green">range ]</span></span>
|colspan="2"|<span title="The test is for a range of values against another value">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23range/ <span style="color:green">range ]</span></span>
|1..1
|1..1
|<span title="A range for use in property value testing">[[#RangeClause|RangeClause]]</span>
|<span title="A range for use in property value testing">[[#RangeClause|RangeClause]]</span>
Line 375: Line 715:
|Description
|Description
|-
|-
|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>
|colspan="2"|<span title="A property path made up of space delimited iri strings, from the outer entity to the entity on which this clause operates. Shortcut for nested selects">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23path/ <span style="color:green">path ]</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)
|-
|colspan="2"|<span title="A property path made up of space delimited iri strings, from the outer entity to the entity on which this clause operates.Equivalent to an inner join in SQL">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23path/ <span style="color:green">path ]</span></span>
|0..1
|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>
|<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 property path made up of space delimited iri strings, from the outer entity to the entity on which this clause operates.<br> Shortcut for nested selects
|A property path made up of space delimited iri strings, from the outer entity to the entity on which this clause operates.<br> Shortcut for nested selects
|-
|-
|colspan="2"|<span title="The property of the objects in the result set (as indicated by the alias) to test">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
|colspan="2"|<span title="The property on which the aggregate function operates">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
|1..1
|1..1
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
Line 400: Line 735:
|Nested where clause operating on the values of this select's property<br>Enables multi- level filtering as used in JOIN where clauses in SQL
|Nested where clause operating on the values of this select's property<br>Enables multi- level filtering as used in JOIN where clauses in SQL
|-
|-
|rowspan="3"|or<br>0..1
|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>
|<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..*
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|If the results need to be grouped, the grouping properties.
|-
|colspan="2"|<span title="Ordering of instances via a property value in order to further test in another where clause.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23orderBy/ <span style="color:green">orderBy ]</span></span>
|0..*
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|Ordering of instances via a property value returned.
|-
|colspan="2"|<span title="direction of ordering (DESC or ASC) .">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23direction/ <span style="color:green">direction ]</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>
|direction of ordering (DESC or ASC) .
|-
|colspan="2"|<span title="Number of entities to return. Normally used with order by">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23limit/ <span style="color:green">limit ]</span></span>
|0..1
|0..1
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|Whether the result is a summation of this property's values
|Number of entities to return. Normally used with order by
|-
|-
 
|colspan="2"|<span title="Tests an aggregate result from the group clause for a value">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23having/ <span style="color:green">having ]</span></span>
|
<span title="Whether the result is an average of this property's values">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23average/ <span style="color:green">average ]</span></span>
|0..1
|0..1
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|<span title="A clause testing an aggregate function on a property usually one that is grouped">[[#HavingClause|HavingClause]]</span>
|Whether the result is an average of this property's values
|Tests an aggregate result from the group clause for a value
|-
|-
 
|colspan="2"|<span title="Name of the aggregate function e.g. MAX,MIN,COUNT,SUM, AVERAGE">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23aggregate/ <span style="color:green">aggregate ]</span></span>
|
<span title="Whether the result is the maximum of this property's values">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23max/ <span style="color:green">max ]</span></span>
|0..1
|0..1
|<span title="boolean true or false">[https://www.w3.org/TR/xmlschema-2/#boolean xsd:boolean]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|Whether the result is the maximum of this property's values
|Name of an aggregate function to operate on the property
|-
|-
|colspan="2"|<span title="A function that operates on the property value (and other parameters) prior to a compare or range or inclusion test. For example a time difference function operating on the date and a reference date.Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ <span style="color:green">function ]</span></span>
|colspan="2"|<span title="A function that operates on the property value (and other parameters) prior to a compare or range or inclusion test. For example a time difference function operating on the date and a reference date.Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23function/ <span style="color:green">function ]</span></span>
|0..1
|0..1
|<span title="A function definition with optional parameters">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/ im:Function]</span>
|<span title="A call to a function used in a query consisting of the function iri and one or more arguments to pass in at run time">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionClause/ im:FunctionClause]</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
|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
|-
|-
Line 429: Line 774:
|<span title="A named parameter and a value for passing into a function">[[#Argument|Argument]]</span>
|<span title="A named parameter and a value for passing into a function">[[#Argument|Argument]]</span>
|Arguments to pass into the function
|Arguments to pass into the function
|-
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23HavingClause/ Having clause] ===
A clause testing an aggregate function on a property usually one that is grouped
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|colspan="2"|<span title="Name of the aggregate function e.g. MAX,MIN,COUNT,SUM, AVERAGE">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23aggregate/ <span style="color:green">aggregate ]</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>
|Name of the aggregate function e.g. MAX,MIN,COUNT,SUM, AVERAGE
|-
|colspan="2"|<span title="The property on which the aggregate function operates">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
|0..1
|<span title="">[[#IriAlas|IriAlas]]</span>
|The property on which the aggregate function operates
|-
|colspan="2"|<span title="The value of the aggregate result to be tested">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23value/ <span style="color:green">value ]</span></span>
|0..1
|<span title="Tests a value, whether equal, greater than, less than etc. optionally including a value to compare against">[[#ValueClause|ValueClause]]</span>
|The value of the aggregate result to be tested
|-
|-


Line 457: Line 828:
Is a subtype of [[#IrirRef|IrirRef]]
Is a subtype of [[#IrirRef|IrirRef]]


A function used in a query consisting of the function iri and one or more arguments to pass in at run time
A call to a function used in a query consisting of the function iri and one or more arguments to pass in at run time
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 472: Line 843:


|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Argument/ Argument] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Within/ null] ===
A named parameter and a value for passing into a function
null
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 480: Line 851:
|Value type
|Value type
|Description
|Description
|-
|colspan="2"|<span title="A list of parameters and data types used in this function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter ]</span></span>
|1..1
|<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="2"|or<br>1..1
|<span title="Value that is a literal such as a string or number">[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>
|Value that is a literal such as a string or number
|-
|
<span title="argument value which is a variable name to be resolved at run time">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%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
|-
|colspan="2"|<span title="Passes in the result set from a previous where clause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueFrom/ <span style="color:green">valueFrom ]</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>
|Passes in the result set from a previous where clause
|-
|-


Line 520: Line 868:
|Comparison operators : =, <, <=, >, >=
|Comparison operators : =, <, <=, >, >=
|-
|-
|colspan="2"|<span title="The value of the property used in a test. 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%23value/ <span style="color:green">value ]</span></span>
|rowspan="2"|or<br>1..1
|<span title="The value of the aggregate result to be tested">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23value/ <span style="color:green">value ]</span></span>
|1..1
|1..1
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The value of the property used in a test. This is a string which will be cast to a number or date, depending on the data type of the property value
|The value of the property used in a test. This is a string which will be cast to a number or date, depending on the data type of the property value
|-
|-
|colspan="2"|<span title="When the range values are relative to another value , information about the other value (e.g. variable or property of the results defined in another clause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23relativeTo/ <span style="color:green">relativeTo ]</span></span>
 
|
<span title="The value is the value of a variable or property set elsewhere in the query">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueOf/ <span style="color:green">valueOf ]</span></span>
|0..1
|0..1
|<span title="">[[#CompareClause|CompareClause]]</span>
|<span title="When comparing a value to another variable's value this defines the target to compare against. Might be property, alias of a property, or a variable value">[[#CompareClause|CompareClause]]</span>
|The result to compare the property value against is derived from a variable value or property of an object (identified by its alias) defined another where clause
|The value is the value of a variable or property set elsewhere in the query
|-
|colspan="2"|<span title="When the target value or value of is a date and the value is a number then the units of time e.g. years or months as a parameter to a function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23unitOfTime/ <span style="color:green">unitOfTime ]</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>
|When the target value or value of is a date and the value is a number then the units of time e.g. years or months as a parameter to a function
|-
|-


Line 551: Line 907:
|The value comparison of upper end of the range
|The value comparison of upper end of the range
|-
|-
|colspan="2"|<span title="When the range values are relative to another value , information about the other value (e.g. variable or property of the results defined in another clause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23relativeTo/ <span style="color:green">relativeTo ]</span></span>
 
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Argument/ Argument] ===
A named parameter and a value for passing into a function
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|colspan="2"|<span title="A list of parameters and data types used in this function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter ]</span></span>
|1..1
|<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="2"|or<br>1..1
|<span title="Value that is a literal such as a string or number">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueData/ <span style="color:green">valueData ]</span></span>
|1..1
|1..1
|<span title="">[[#CompareClause|CompareClause]]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|When the range values are relative to another value , information about the other value (e.g. variable or property of the results defined in another clause
|Value that is a literal such as a string or number
|-
 
|
<span title="argument value which is a variable name to be resolved at run time">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%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
|-
|colspan="2"|<span title="Passes in the result set from a previous where clause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueFrom/ <span style="color:green">valueFrom ]</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>
|Passes in the result set from a previous where clause
|-
|colspan="2"|<span title="Function specific paylod object, normally a json object deserialized to object as determined by the function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23valueObject/ <span style="color:green">valueObject ]</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>
|Function specific paylod object, normally a json object deserialized to object as determined by the function
|-
 
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriAlas/ null] ===
null
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|-


|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23CompareClause/ CompareClause] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23CompareClause/ CompareClause] ===
null
When comparing a value to another variable's value this defines the target to compare against. Might be property, alias of a property, or a variable value
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 572: Line 973:
|The alias of the result set from another where clause
|The alias of the result set from another where clause
|-
|-
|colspan="2"|<span title="The property of the objects in the result set (as indicated by the alias) to test">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
|colspan="2"|<span title="The property on which the aggregate function operates">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23property/ <span style="color:green">property ]</span></span>
|0..1
|0..1
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|The property of the objects in the result set (as indicated by the alias) to test
|The property of the objects in the result set (as indicated by the alias) to test
|-
|-
|colspan="2"|<span title="The name of a variable, passed as an argument to the query, which is resolved to the IRI">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23variable/ <span style="color:green">variable ]</span></span>
|colspan="2"|<span title="The name of a variable, passed as an argument to a function. Assumed to be a collection">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23variable/ <span style="color:green">variable ]</span></span>
|0..1
|0..1
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
Line 584: Line 985:


|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionShape/ FunctionShape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/ Function] ===
Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/ Function]


Is a subtype of [[#Entity shape|Entity shape]]
Is a subtype of [[#Entity|Entity]]


null
A meta class (shape) of a  function i.e. models the parameters. A query that calls a function uses a function clause that uses this function definition to name each argument passed in
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 599: Line 999:
|colspan="2"|<span title="A list of parameters and data types used in this function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter ]</span></span>
|colspan="2"|<span title="A list of parameters and data types used in this function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter ]</span></span>
|0..*
|0..*
|<span title="">[[#Parameter|Parameter]]</span>
|<span title="Models a named parameter used in function or other clauses. The parameter name and data type of the parameter (if literal) or class (if on object) ">[[#Parameter|Parameter]]</span>
|A list of parameters and data types used in this function
|A list of parameters and data types used in this function
|-
|-
Line 605: Line 1,005:
|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Parameter/ Parameter] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Parameter/ Parameter] ===
null
Models a named parameter used in function or other clauses. The parameter name and data type of the parameter (if literal) or class (if on object)
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 631: Line 1,031:
|The iri of the class of the parameter when the argument is an object
|The iri of the class of the parameter when the argument is an object
|-
|-
 
|colspan="2"|<span title="The iri of the query used to generate the value of the parameter passed as an argument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23query/ <span style="color:green">query ]</span></span>
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PathQueryShape/ PathQueryShape] ===
Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PathQuery/ Path query]
A query that returns a set pf paths between a source and target entity, traversing to a certain level
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|colspan="2"|<span title="the source entity at the start of the path.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23source/ <span style="color:green">source ]</span></span>
|1..1
|<span title="A reference to resource with an iri and optional name to enable readability">[[#IriRef|IriRef]]</span>
|the source entity at the start of the path.
|-
|colspan="2"|<span title="the target entity at the end of the path.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23target/ <span style="color:green">target ]</span></span>
|1..1
|<span title="A reference to resource with an iri and optional name to enable readability">[[#IriRef|IriRef]]</span>
|the target entity at the end of the path.
|-
|colspan="2"|<span title="How many hops to be taken in the graph between source and target">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23depth/ <span style="color:green">depth ]</span></span>
|0..1
|0..1
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|<span title="A query that is stored as an entity in a query library">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Query/ im:Query]</span>
|How many hops to be taken in the graph between source and target
|The iri of the query used to generate the value of the parameter passed as an argument
|-
|-


|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SetShape/ Set shape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionShape/ FunctionShape] ===
Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptSet/ Concept Set]
Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionClause/ FunctionClause]


Is a subtype of [[#Query /Set shape|Query /Set shape]]
Is a subtype of [[#null|null]]


data model for concept sets and value sets
Data model of a function i.e. models the parameters. A query that calls a function uses a function clause that uses this function definition to name each argument passed in
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 673: Line 1,051:
|Description
|Description
|-
|-
|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>
|colspan="2"|<span title="A list of parameters and data types used in this function">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23parameter/ <span style="color:green">parameter ]</span></span>
|0..*
|0..*
|<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span>
|<span title="Models a named parameter used in function or other clauses. The parameter name and data type of the parameter (if literal) or class (if on object) ">[[#Parameter|Parameter]]</span>
|The flat list of leaf concepts when generated from the definition, or for many national sets, simple list of concepts
|A list of parameters and data types used in this function
|-
|-


|}
|}
 
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/ null] ===
== Data Model shapes ==
null
These shapes are the meta classes of the data modelling entities within the information model.
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DataModelShape/ Data model shape] ===
Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23NodeShape/ Node shape]
 
Is a subtype of [[#Entity shape|Entity shape]]
 
The meta class for a data model type, using a SHACL node shape for both definition and validation
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 695: Line 1,066:
|Value type
|Value type
|Description
|Description
|-
|colspan="2"|<span title="Parameter name for a function or the parameter name for an argument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23property/ <span style="color:green">property ]</span></span>
|0..*
|<span title="The data model of a shacl node shape describing a property of a data model entity">[[#PropertyNodeShape|PropertyNodeShape]]</span>
|The list of properties for this shape
|-
|-


|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyNodeShape/ PropertyNodeShape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PathQuery/ Path Query] ===
 
A query that returns a set pf paths between a source and target entity, traversing to a certain level
Is a subtype of [[#Entity shape|Entity shape]]
 
The data model of a shacl node shape describing a property of a data model entity
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 715: Line 1,078:
|Description
|Description
|-
|-
|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>
|colspan="2"|<span title="Input parameter representing one or more source objects. Usually a variable name from an outer group or map, and may or may not be typed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23source/ <span style="color:green">source ]</span></span>
|1..1
|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>
|<span title="A reference to resource with an iri and optional name to enable readability">[[#IriRef|IriRef]]</span>
|The iri of the property
|the source entity at the start of the path.
|-
|-
|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>
|colspan="2"|<span title="Input parameter representing one or more target objects. Usually a variable name from an outer group or map, and may or may not be typed. The net result of a group is the population of the target objects with data. Targets are not modelled as return values and therefore should be pre-created unless the rule creates an instance as a property value of a group object">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23target/ <span style="color:green">target ]</span></span>
|0..1
|1..1
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|<span title="A reference to resource with an iri and optional name to enable readability">[[#IriRef|IriRef]]</span>
|Minimum cardinality,if null assuming any number including zero
|the target entity at the end of the path.
|-
|-
|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>
|colspan="2"|<span title="How many hops to be taken in the graph between source and target">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23depth/ <span style="color:green">depth ]</span></span>
|0..1
|0..1
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|The maximum number allowed. If null then any number
|How many hops to be taken in the graph between source and target
|-
|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>
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Set/ Set] ===
|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>
Is a subtype of [[#Entity|Entity]]
|The range of the property is a data type of this type
|-


|
data model for concept sets and value sets
<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>
{| class="wikitable"
|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>
|colspan="2"|Property
|The property points to a node shape
|Card.
|Value type
|Description
|-
|-
|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>
|colspan="2"|<span title="The query definition itself">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definition/ <span style="color:green">definition ]</span></span>
|0..1
|0..1
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="A set definition holding the logical definition of a set. Usually referred to as a Query as these are used to retrieve data.Includes most of  the main logical query constructs used in mainstream query languages, thus is a constrained version of mainstream languages that is schema independent.">[[#QueryDefinition|QueryDefinition]]</span>
|Description of the property
|The query definition itself
|-
|-
|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>
|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..1
|0..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="data model for terminology concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span>
|The name of the property used for ease of recognition
|The flat list of leaf concepts when generated from the definition, or for many national sets, simple list of concepts
|-
|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
|-
|colspan="2"|<span title="The shape that this property is inherited from (used in the inferred instance of the information model">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23inheritedFrom/ <span style="color:green">inheritedFrom ]</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.">[[#NodeShape|NodeShape]]</span>
|The shape that this property is inherited from (used in the inferred instance of the information model
|-
|-


|}
|}


== Concept shapes ==
== Transform map shapes ==
These shapes are the meta classes of the terminology concepts used within the information model.
These shapes form the model for transformation maps used by a engine to transform from a source to destination data model. Based on FHIR mapping language
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptShape/ Concept shape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23TransformMap/ Transform map] ===
Defines the shape of an instance of the target class : [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ Terminology Concept]


Is a subtype of [[#Entity shape|Entity shape]]
Is a subtype of [[#Entity|Entity]]


data model for terminology concepts
An entity containing a definition of a transform map
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 788: Line 1,134:
|Description
|Description
|-
|-
|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>
|colspan="2"|<span title="The query definition itself">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definition/ <span style="color:green">definition ]</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">[[#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
|0..1
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span>
|<span title="A map that describes how one set of source objects can be transformed to a set of target objects, subject to source and target objects being directed acyclic graphs (in any physical format). The design has been heavily influenced by FHIR Mapping language <a href="https://build.fhir.org/mapping-language">https://build.fhir.org/mapping-language</a>   and RML <a href="https://rml.io/specs/rml/">https://rml.io/specs/rml/<a>">[[#TransformMapDefinition|TransformMapDefinition]]</span>
|A number indicating a weighting for this concept which can be used in free text search
|The map definition itself
|-
|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">[[#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="">[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
|-
|-


|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23TermCodeShape/ Term code shape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23TransformMapDefinition/ Transform map definition] ===
data model for a term code
A map that describes how one set of source objects can be transformed to a set of target objects, subject to source and target objects being directed acyclic graphs (in any physical format).<br> The design has been heavily influenced by FHIR Mapping language [https://build.fhir.org/mapping-language https://build.fhir.org/mapping-language]  and RML [https://rml.io/specs/rml/ https://rml.io/specs/rml/]>
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 854: Line 1,150:
|Description
|Description
|-
|-
|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>
|colspan="2"|<span title="Input parameter representing one or more source objects. Usually a variable name from an outer group or map, and may or may not be typed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23source/ <span style="color:green">source ]</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>
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|The term or synonym for the concept
|Meta data for the map (e.g. to enable caching). One or more source types (class/ structured definition etc) identified by their iri.
|-
|colspan="2"|<span title="Input parameter representing one or more target objects. Usually a variable name from an outer group or map, and may or may not be typed. The net result of a group is the population of the target objects with data. Targets are not modelled as return values and therefore should be pre-created unless the rule creates an instance as a property value of a group object">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23target/ <span style="color:green">target ]</span></span>
|1..1
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|Meta data for the map (e.g to enable caching). One or more target types (class/ structured definition etc) identified by their iri.<br> At run time actual sources and targets are passed in by reference, so instances created in the engine under map instructions must have a means of adding the new instances to an outer object.
|-
|-
|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>
|colspan="2"|<span title="Map imports so that groups from other maps can be used directly">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23imports/ <span style="color:green">imports ]</span></span>
|0..*
|0..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|Descriptionid or code for this particular term
|Map imports so that groups from other maps can be used directly
|-
|-
|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>
|colspan="2"|<span title="A named reusable set of transformation rules executed in order">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23group/ <span style="color:green">group ]</span></span>
|0..*
|1..*
|<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span>
|<span title="A named group containing one or more transformation rules. The group can be called by a map, a group, or a target transform from a path. Their names are in contect and are variables within the scope of a map and its imports">[[#MapGroup|MapGroup]]</span>
|The status of this particular term code, may be active or inactive
|A named reusable set of transformation rules executed in order
|-
|-


|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SourceContextShape/ Source context shape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23MapGroup/ Transform map group] ===
 
A named group containing one or more transformation rules. The group can be called by a map, a group, or a target transform from a path. Their names are in contect and are variables within the scope of a map and its imports
Is a subtype of [[#Entity shape|Entity shape]]
 
Data model for source context for a concept e.g. source system, field etc
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 883: Line 1,181:
|Description
|Description
|-
|-
|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>
|colspan="2"|<span title="optional name for debugging purposes. Is not used in the query process">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23name/ <span style="color:green">name ]</span></span>
|1..*
|0..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>
|the name of the system that was responsible for sending the message or extract, usually referring to the health care record system
|-
|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>
|The organisation (usually a provider) that was the source of this message or extract
|-
|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>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The schema or data set or other identifier that identifies the format of this extract
|The name of a group by its variable
|-
|-
|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>
|colspan="2"|<span title="The name of a group that this group inherits rules from">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23extends/ <span style="color:green">extends ]</span></span>
|1..*
|0..1
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|If a table or message the name of the source table or source message type
|The name of a group that this group inherits rules from
|-
|-
|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>
|colspan="2"|<span title="Optional description for clause">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23description/ <span style="color:green">description ]</span></span>
|1..*
|0..1
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|The source field containing this data item
|A description of what the group does
|-
|-
|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>
|colspan="2"|<span title="Input parameter representing one or more source objects. Usually a variable name from an outer group or map, and may or may not be typed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23source/ <span style="color:green">source ]</span></span>
|1..*
|1..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|In the case of text, the nature of a regex expression or nlp algorithm used to parse the source text
|Input parameter representing one or more source objects. Usually a variable name from an outer group or map, and may or may not be typed
|-
|-
|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>
|colspan="2"|<span title="Input parameter representing one or more target objects. Usually a variable name from an outer group or map, and may or may not be typed. The net result of a group is the population of the target objects with data. Targets are not modelled as return values and therefore should be pre-created unless the rule creates an instance as a property value of a group object">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23target/ <span style="color:green">target ]</span></span>
|1..*
|1..*
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|<span title="An IRI with a name and an optional alias  and a variable name when the iri is passed in as an argument (e.g. $this">[[#IriAlias|IriAlias]]</span>
|For an item that depends on the context in which it appears, the heading which provides context
|Input parameter representing one or more target objects. Usually a variable name from an outer group or map, and may or may not be typed.<br> The net result of a group is the population of the target objects with data. Targets are not modelled as return values and therefore should be pre-created unless the rule creates an instance as a property value of a group object
|-
|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>
|Source text or term for coded or non coded data
|-
|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>
|The value or code for this concept. Note that a scheme for the code can be inferred from the other context information. In the event of a scheme/code pair, use different fields in the source context
|-
 
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RefinedConceptShape/ Refined concept shape] ===
 
Is a subtype of [[#Concept shape|Concept shape]]
 
A concept with role groups with roles
{| class="wikitable"
|+
|colspan="2"|Property
|Card.
|Value type
|Description
|-
|-
|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>
|colspan="2"|<span title="A list of rules within the group that does the actual transformation.  Rules may call groups creating a hierarchy or modularisation.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23rule/ <span style="color:green">rule ]</span></span>
|0..*
|0..*
|<span title="data model for a role group">[[#RoleGroupShape|RoleGroupShape]]</span>
|<span title="">[[#MapRule|MapRule]]</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.
|A list of rules within the group that does the actual transformation. Rules may call groups creating a hierarchy or modularisation.
|-
|-


|}
|}
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RoleGroupShape/ Role group shape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23MapRule/ null] ===
data model for a role group
null
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 957: Line 1,221:
|Value type
|Value type
|Description
|Description
|-
|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>
|The concept identifier of the concept that is the role. Role Groups are unique in that their properties are any properties from an ontology,usually concepts
|-
|-


Line 970: Line 1,229:
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityFileTransaction/ EntityFileTransaction] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityFileTransaction/ EntityFileTransaction] ===


Is a subtype of [[#Entity shape|Entity shape]]
Is a subtype of [[#null|null]]


An entity with the additional CRUD indicators to enable deletes updates, adding quads etc
An entity with the additional CRUD indicators to enable deletes updates, adding quads etc
Line 987: Line 1,246:
|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>
|colspan="2"|<span title="The graph to which these entities apply by default. This may be overridden by the entitiesThis means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ <span style="color:green">graph ]</span></span>
|1..1
|1..1
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span>
|<span title="Core graphs for core ontologies and taxonomies 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 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
|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
|-
|-
Line 1,008: Line 1,267:
|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>
|colspan="2"|<span title="The graph to which these entities apply by default. This may be overridden by the entitiesThis means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23graph/ <span style="color:green">graph ]</span></span>
|1..1
|1..1
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span>
|<span title="Core graphs for core ontologies and taxonomies 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
|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>
|colspan="2"|<span title="Set of entities to file. If the entities do not have crud or graphs oftheir own then the default from the document are used">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23entities/ <span style="color:green">entities ]</span></span>
|1..*
|1..*
|<span title="The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status">[[#EntityShape|EntityShape]]</span>
|<span title="">[[#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
|Set of entities to file. If the entities do not have crud or graphs oftheir own then the default from the document are used
|-
|-
Line 1,048: Line 1,307:
|-
|-
|rowspan="1"|or<br>1..1
|rowspan="1"|or<br>1..1
|<span title="The requested query, either by iri reference or inline definition If the query is already defined, use the queryIri. Arguments may be used in eoither approach">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23query/ <span style="color:green">query ]</span></span>
|<span title="The iri of the query used to generate the value of the parameter passed as an argument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23query/ <span style="color:green">query ]</span></span>
|1..1
|1..1
|<span title="A set definition holding the logical definition of a set. Usually referred to as a Query as these are used to retrieve data.Includes most of  the main logical query constructs used in mainstream query languages, thus is a constrained version of mainstream languages that is schema independent.">[[#QueryDefinition|QueryDefinition]]</span>
|<span title="A set definition holding the logical definition of a set. Usually referred to as a Query as these are used to retrieve data.Includes most of  the main logical query constructs used in mainstream query languages, thus is a constrained version of mainstream languages that is schema independent.">[[#QueryDefinition|QueryDefinition]]</span>

Revision as of 12:51, 5 January 2023

The information model's meta model is a small set of relatively simple classes capable of holding huge sophisticated ontologies, an extensible data model, as well as set and query definitions.

The main classes are illustrated here on the right, and the class definitions and subclasses are specified in text, the text being auto generated from the IM SHACL shapes.



Basic shapes

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

IrirRef

A reference to resource with an iri and optional name to enable readability

Property Card. Value type Description
name 1..1 xsd:string The name of the entity
Example
{"@id" : "sn:29857009", "name" : "Chest pain (finding)"}

Entity

The abstract super class and data model for all named entities in the model i.e. the data model of the entities that are labelled with iri label and status

Property Card. Value type Description
label 1..1 xsd:string The preferred full name of the entity
type 1..1 rdfs:Resource The base type of the entity i.e. one of the high level entity types
comment 0..1 xsd:string The description of the entity
status 1..1 im:Status The status of the entity being active, inactive, draft or unassigned
scheme 1..1 im:Graph The code scheme or graph which the entity belongs to
isContainedIn 0..* im:Folder An entity that this entity inherits from, both semantically and structurally, this is also used for sub properties as properties are classes of properties
370124000 0..* im:Entity When a status is inactive, the entity that replaces this entity (if any)

IriAlias

Is a subtype of IrirRef

An IRI with a name and an optional alias and a variable name when the iri is passed in as an argument (e.g. $this

Property Card. Value type Description
alias 0..1 xsd:string The column name in a select clause for this property, or a variable used to reference the result set of the values matched
variable 0..1 xsd:string The name of a variable, passed as an argument to the query, which is resolved to the IRI
inverse 0..1 xsd:boolean When used as a property, whether this is an inverse object property i.e. an inbound connection to this entity
includeSubtypes 0..1 xsd:boolean When used in a with or where clause, whether to include the subtypes of this entity
includeSupertypes 0..1 xsd:boolean When used in a with or where clause, whether to include the supertypes of this entity e.g. when ascending a hierrchy to look for a property
or
0..1
isType 0..1 xsd:boolean If the query results are derived from instances of certain type (or types) then set this flag to true.

isSet

0..1 xsd:boolean If the query results derived the result set of a concept set, value set or query result then set this flag to true.

IriVariable

Is a subtype of IrirRef

A variable, usually passed in as a parameter to a function, with an optional IRI and whether the iri is an instance or type iri (if ambiguous)

Property Card. Value type Description
variable 0..1 xsd:string The name of a variable, passed as an argument to a function. Assumed to be a collection
isType 0..1 xsd:boolean In cases where it is ambiguous whether an iri refers to an instance or type, then set this to true if a type

Property

Is a subtype of Entity

A property data model

Property Card. Value type Description
inverseOf 0..* rdf:Property A property that this property is an inverse of
domain 0..* rdfs:Class The classes or concepts that may have this property as a property, or a role, or a role within a role group
range 0..* Class the type of value for this property.

Folder

Is a subtype of Entity

Folder containing subfolders or entities

Property Card. Value type Description

Entity selector

Is a subtype of Entity

A list of entities to select at particular points in a business process.

Property Card. Value type Description
list 0..* xsd:string The list of entities by iri to select from

Data Model shapes

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

Data model/Node shape

Is a subtype of Entity

The meta class for shapes, those shapes defining a type i.e the shape of a shape

Property Card. Value type Description
isContainedIn 0..* im:Folder
subClassOf 0..* sh:NodeShape
property 0..* PropertyShape The list of properties for this shape

Concept shapes

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

Terminology concept

Is a subtype of Entity

data model for terminology concepts

Property Card. Value type Description
subClassOf 0..* im:Concept The concept this concept is a sub type of
code 1..1 xsd:string The code for this concept, which may be a local code if local concept, or a core code such as a snomed identifier
hasTermCode 0..* TermCodeShape Alternative terms or synonyms for this concept. A term may also have a description id.
weighting 0..1 xsd:integer A number indicating a weighting for this concept which can be used in free text search
definitionalStatus 0..1 im:VSET_Definitionalstatus Indicates the authoring status of this concept, whether necessary only, or both necessary and sufficient. OWL would use Equivalent class axiom to indicate this.
hasMap 0..* xsd:string Any backward maps from core to legacy. This is limited to complex maps rather than simple matches and are 'backward' matches not suitable for automatic inclusion in subsumption queries
usageTotal 0..1 xsd:integer The approximate number of times this concept has been used in around 1 million primary care and acute care records
im1Id 0..1 xsd:string pointer the original identifer in IM1
matchedTo 0..* im:VSET_Unspecified For a legacy concept, one or more concept this concept matches to. A query for the matched to concepts would entail this concept normally, but NOT the children of this concept
sourceContext 0..* SourceContextShape The source context object for this concept indicating the system, table, field and organisation that published this legacy concept
370124000 0..* im:Concept Indicates the concepts that this concept has been replaced by
isChildOf 0..* im:Concept points to the parent legacy concept that this concept is in. Note that it may or may not be a true subtype. Reflects the original taxonomy

Term code shape

data model for a term code

Property Card. Value type Description
label 0..* xsd:string The term or synonym for the concept
code 0..* xsd:string Descriptionid or code for this particular term
status 0..* im:Status The status of this particular term code, may be active or inactive

Source context shape

Is a subtype of Entity

Data model for source context for a concept e.g. source system, field etc

Property Card. Value type Description
sourceSystem 1..* im:ComputerSystem the name of the system that was responsible for sending the message or extract, usually referring to the health care record system
sourcePublisher 1..* im:Organisation The organisation (usually a provider) that was the source of this message or extract
sourceSchema 1..* xsd:string The schema or data set or other identifier that identifies the format of this extract
sourceTable 1..* xsd:string If a table or message the name of the source table or source message type
sourceField 1..* xsd:string The source field containing this data item
sourceRegex 1..* xsd:string In the case of text, the nature of a regex expression or nlp algorithm used to parse the source text
sourceHeading 1..* xsd:string For an item that depends on the context in which it appears, the heading which provides context
sourceText 1..* xsd:string Source text or term for coded or non coded data
sourceValue 1..* xsd:string The value or code for this concept. Note that a scheme for the code can be inferred from the other context information. In the event of a scheme/code pair, use different fields in the source context

Refined concep

Is a subtype of null

A concept with role groups with roles

Property Card. Value type Description
roleGroup 0..* RoleGroupShape Zero or many role groups, each group containing one or more roles. These represent constraints on the super types i.e. more specific. Generated by inference making sure to remove duplicate properties or super properties.

null

null

Property Card. Value type Description

Role group shape

data model for a role group

Property Card. Value type Description
Property 0..* im:Concept The concept identifier of the concept that is the role. Role Groups are unique in that their properties are any properties from an ontology,usually concepts

null

Is a subtype of IrirRef

null

Property Card. Value type Description
matchedConcept 0..1 IriRef The core concept iri that this codeable concept has been matched to in this instance
originalCode 0..1 xsd:string The original code entered in the publication system which may be mapped to a code concept
originalScheme 0..1 xsd:string The original code scheme identifier, may be a url or a OID or informal identifier
originalCodeTerm 0..1 xsd:string The original display term for this code usually as a reference. Should not be confused with original text as seen by the user, which may be different depending on the context
originalQualifierTerm 0..1 xsd:string A qualifier term in the original system which may result in a different concept map. For Example 'negative' or 'positive' or a block of text

Query Model and Set definition shapes

These shapes form the model for defining sets (also known as query definitions) for retrieving data from the IM or health records.

Query

Is a subtype of Entity

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

Property Card. Value type Description
definition 0..1 QueryDefinition The query definition itself

Query definition

Is a subtype of IriAlias

A set definition holding the logical definition of a set. Usually referred to as a Query as these are used to retrieve data.
Includes most of the main logical query constructs used in mainstream query languages, thus is a constrained version of mainstream languages that is schema independent.

Property Card. Value type Description
description 0..1 xsd:string Optional description of the query definition for support purposes.
from 0..* IriAlias The base cohort/ set or type(s), or instance(s) on which all the subsequent where or filter clauses operate. If more than one this is treated as an OR list.
where 0..1 WhereClause Tests properties and property paths and applies filters. Equivalent to SQL Join/ Where and SPARQL Where
Bollean where clauses supported.
select 1..1 SelectClause Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability
groupBy 0..* IriAlias If the results need to be grouped, the grouping properties.
orderBy 0..* IriAlias Ordering of instances via a property value returned.
direction 0..1 xsd:string direction of ordering (DESC or ASC) .
limit 0..1 xsd:integer Number of entities to return. Normally used with order by
having 0..1 HavingClause Tests an aggregate result from the group clause for a value
subQuery 0..* QueryDefinition SubQueries used to group columns in multi group reports. The sub queries are all subsets of the main query clauses
prefix 0..0 PrefixShape list of prefix to namespace expansion to enable readability of iris
usePrefixes 0..1 xsd:boolean true if you want the results to use IRI prefixes
activeOnly 0..1 xsd:boolean Whether only active entities are included in the match clauses or select clauses

WhereClause

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

Property Card. Value type Description
alias 0..1 xsd:string Used to define the clause with a readable term and also used in other clauses for further refinement
description 0..1 xsd:string Optional description for clause
from 0..* IriAlias Refers
a) to the alias of another where clause to indicate the set of objects defined by the referenced clause, which will be further refined by this where clause.
Equivalent to accessing a temporary or derived table in SQL.
(b) One or more instance objects to test properties of
(c) or instances of a certain type(s)
(d) external result set (e.g. a base cohort population)
If more than one it is considered an OR List.
Represents a subject of a triple or entity. Should be used with caution in IM query
graph 0..1 im:Graph The iri of a graph if the query is limited to a particular data set
pathTo 0..1 rdfs:Resource A property type path made up of space delimitediri strings, from the outer entity to the entity on which this clause operates. Alternates property and type
Equivalent to an inner join in SQL
notExist 0..1 WhereClause Points to a nested where clause. If the nested clause returns results then the entity referenced by the outer where clause is excluded.
In other words, for the outer entity to be included, the nested entity must have no results. This contrasts with 'not'
or 2..* WhereClause Boolean operator OR on subclauses
and 2..* WhereClause Boolean operator AND on subclauses
property 0..* IriAlias a property tgo test. Note that this is applied to the entity after the path has been resolved.
in 0..* IriRef Whether the value is in this list of sets or concepts (including any sub types)
is 0..* IriAlias Whether the value is this concept (and optionally if set to include sub or supertypes)
not 0..1 xsd:boolean Testing for the value as a not. Note that this filters out the instances but does not exclude the outer entity (see not exist)
function 1..1 FunctionClause A function that operates on the property value (and other parameters) prior to a compare or range or inclusion test. For example a time difference function operating on the date and a reference date.
Note that properties that ARE functions do not need functions included for example age. For these simply supply the arguments.
or
0..1
within 0..1 Within Where the value is within a range of another value
Note that if the test is a function then the argument list would be in the function clause

value

1..1 ValueClause If testing a property value as equal greater than ete. use compare
range 1..1 RangeClause Test foe a value being between two absolute or relative values
where 1..1 WhereClause A chained where clause operating on the property value object.
Equivalent to a join in SQL or '.' in sparql
orderBy 0..* IriAlias Ordering of instances via a property value in order to further test in another where clause.
direction 0..1 xsd:string direction of ordering (DESC or ASC) .
limit 0..1 xsd:integer Number of entities to return. Normally used with order by

SelectClause

Defines the objects and properties to retrieve from a graph, subject to a mach clause. Supports graphql type nesting and sub selects for column groups

Property Card. Value type Description
path 0..1 rdfs:Resource A property path made up of space delimited iri strings, from the outer entity to the entity on which this clause operates.
Shortcut for nested selects
property 1..1 IriAlias Information about a property or field to include in the results. Property select supports nesting with selects for the objects that may be values of the property
select 0..* SelectClause Nested select property clauses from the objects that are values of this select's property Note that if the value is null then this select would be absent
where 0..* WhereClause Nested where clause operating on the values of this select's property
Enables multi- level filtering as used in JOIN where clauses in SQL
groupBy 0..* IriAlias If the results need to be grouped, the grouping properties.
orderBy 0..* IriAlias Ordering of instances via a property value returned.
direction 0..1 xsd:string direction of ordering (DESC or ASC) .
limit 0..1 xsd:integer Number of entities to return. Normally used with order by
having 0..1 HavingClause Tests an aggregate result from the group clause for a value
aggregate 0..1 xsd:string Name of an aggregate function to operate on the property
function 0..1 im:FunctionClause 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
argument 0..* Argument Arguments to pass into the function

Having clause

A clause testing an aggregate function on a property usually one that is grouped

Property Card. Value type Description
aggregate 0..1 xsd:string Name of the aggregate function e.g. MAX,MIN,COUNT,SUM, AVERAGE
property 0..1 IriAlas The property on which the aggregate function operates
value 0..1 ValueClause The value of the aggregate result to be tested

Prefix shape

The model of a class containing an iri prefix map

Property Card. Value type Description
prefix 1..1 xsd:string Prefixe used in the rest of the document
iri 1..1 xsd:string The iri or namespace or graph iri this prefix refers to

FunctionClause

Is a subtype of IrirRef

A call to a function used in a query consisting of the function iri and one or more arguments to pass in at run time

Property Card. Value type Description
argument 0..* Argument Arguments to pass into the function. They should match the parameter definitions of the function

null

null

Property Card. Value type Description

ValueClause

Tests a value, whether equal, greater than, less than etc. optionally including a value to compare against

Property Card. Value type Description
<span title="Comparison operators : =, <, <=, >, >=">comparison 1..1 xsd:string Comparison operators : =, <, <=, >, >=
or
1..1
value 1..1 xsd:string The value of the property used in a test. This is a string which will be cast to a number or date, depending on the data type of the property value

valueOf

0..1 CompareClause The value is the value of a variable or property set elsewhere in the query
unitOfTime 1..1 xsd:string When the target value or value of is a date and the value is a number then the units of time e.g. years or months as a parameter to a function

RangeClause

A range for use in property value testing

Property Card. Value type Description
from 1..1 ValueClause The value comparison for lower end of the range
to 1..1 ValueClause The value comparison of upper end of the range

Argument

A named parameter and a value for passing into a function

Property Card. Value type Description
parameter 1..1 xsd:string Parameter name for a function or the parameter name for an argument
or
1..1
valueData 1..1 xsd:string Value that is a literal such as a string or number

valueVariable

1..1 xsd:string argument value which is a variable name to be resolved at run time
valueFrom 1..1 xsd:string Passes in the result set from a previous where clause
valueObject 0..1 xsd:string Function specific paylod object, normally a json object deserialized to object as determined by the function

null

null

Property Card. Value type Description

CompareClause

When comparing a value to another variable's value this defines the target to compare against. Might be property, alias of a property, or a variable value

Property Card. Value type Description
alias 0..1 xsd:string The alias of the result set from another where clause
property 0..1 IriAlias The property of the objects in the result set (as indicated by the alias) to test
variable 0..1 xsd:string If a value is being compared against a variable passed in as an argument, the name of the variable

Function

Is a subtype of Entity

A meta class (shape) of a function i.e. models the parameters. A query that calls a function uses a function clause that uses this function definition to name each argument passed in

Property Card. Value type Description
parameter 0..* Parameter A list of parameters and data types used in this function

Parameter

Models a named parameter used in function or other clauses. The parameter name and data type of the parameter (if literal) or class (if on object)

Property Card. Value type Description
label 1..1 xsd:string The name of the parameter
or
1..1
datatype 1..1 rdfs:Resource The iri of The data type of the parameter when the data type is a literal

class

1..1 rdfs:Resource The iri of the class of the parameter when the argument is an object
query 0..1 im:Query The iri of the query used to generate the value of the parameter passed as an argument

FunctionShape

Defines the shape of an instance of the target class : FunctionClause

Is a subtype of null

Data model of a function i.e. models the parameters. A query that calls a function uses a function clause that uses this function definition to name each argument passed in

Property Card. Value type Description
parameter 0..* Parameter A list of parameters and data types used in this function

null

null

Property Card. Value type Description

Path Query

A query that returns a set pf paths between a source and target entity, traversing to a certain level

Property Card. Value type Description
source 1..1 IriRef the source entity at the start of the path.
target 1..1 IriRef the target entity at the end of the path.
depth 0..1 xsd:integer How many hops to be taken in the graph between source and target

Set

Is a subtype of Entity

data model for concept sets and value sets

Property Card. Value type Description
definition 0..1 QueryDefinition The query definition itself
hasMember 0..* im:Concept The flat list of leaf concepts when generated from the definition, or for many national sets, simple list of concepts

Transform map shapes

These shapes form the model for transformation maps used by a engine to transform from a source to destination data model. Based on FHIR mapping language

Transform map

Is a subtype of Entity

An entity containing a definition of a transform map

Property Card. Value type Description
definition 0..1 <span title="A map that describes how one set of source objects can be transformed to a set of target objects, subject to source and target objects being directed acyclic graphs (in any physical format). The design has been heavily influenced by FHIR Mapping language <a href="https://build.fhir.org/mapping-language">https://build.fhir.org/mapping-language</a> and RML <a href="https://rml.io/specs/rml/">https://rml.io/specs/rml/<a>">TransformMapDefinition The map definition itself

Transform map definition

A map that describes how one set of source objects can be transformed to a set of target objects, subject to source and target objects being directed acyclic graphs (in any physical format).
The design has been heavily influenced by FHIR Mapping language https://build.fhir.org/mapping-language and RML https://rml.io/specs/rml/>

Property Card. Value type Description
source 1..* IriAlias Meta data for the map (e.g. to enable caching). One or more source types (class/ structured definition etc) identified by their iri.
target 1..1 IriAlias Meta data for the map (e.g to enable caching). One or more target types (class/ structured definition etc) identified by their iri.
At run time actual sources and targets are passed in by reference, so instances created in the engine under map instructions must have a means of adding the new instances to an outer object.
imports 0..* IriAlias Map imports so that groups from other maps can be used directly
group 1..* MapGroup A named reusable set of transformation rules executed in order

Transform map group

A named group containing one or more transformation rules. The group can be called by a map, a group, or a target transform from a path. Their names are in contect and are variables within the scope of a map and its imports

Property Card. Value type Description
name 0..1 xsd:string The name of a group by its variable
extends 0..1 xsd:string The name of a group that this group inherits rules from
description 0..1 xsd:string A description of what the group does
source 1..* IriAlias Input parameter representing one or more source objects. Usually a variable name from an outer group or map, and may or may not be typed
target 1..* IriAlias Input parameter representing one or more target objects. Usually a variable name from an outer group or map, and may or may not be typed.
The net result of a group is the population of the target objects with data. Targets are not modelled as return values and therefore should be pre-created unless the rule creates an instance as a property value of a group object
rule 0..* MapRule A list of rules within the group that does the actual transformation. Rules may call groups creating a hierarchy or modularisation.

null

null

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

Is a subtype of null

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

Property Card. Value type Description
crud 1..1 im:CrudOperation Indicates the nature of the CRUD transaction which must be one of im:DeleteAll, im:AddQuads (adds in additional triples), im:UpdateAll (replaces all the predicates for this entity in the graph with te ones submitted), im:UpdatePredicates ( replaces all the objects of these submitted predicates for this graph
graph 1..1 im:Graph The graph to which these triples apply.
This means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph

EntityDocument

A document containing any number of triples to file as a batch.
Note that if the document is sent as Json-LD with prefixed iris, a @context object will be required

Property Card. Value type Description
crud 1..1 im:CrudOperation Indicates the nature of the default CRUD transaction for entities in thisdocument. Thes can be overridden in each entity. Must be one of: im:DeleteAll, im:AddQuads (adds in additional triples), im:UpdateAll (replaces all the predicates for this entity in the graph with te ones submitted), im:UpdatePredicates ( replaces all the objects of these submitted predicates for this graph
graph 1..1 im:Graph The graph to which these entities apply by default.
This may be overridden by the entities
This means you can add predicates to any entity without affecting the original authored entity, those predicates belonging only to this module or graph
entities 1..* EntityShape Set of entities to file. If the entities do not have crud or graphs oftheir own then the default from the document are used

Query Request

A request for data sent as a body (json in local name format) to the /queryIM API.
Contains a query as an iri or inline query with run time variable values as arguments for use in the query

Property Card. Value type Description
name 0..1 xsd:string optional name for debugging purposes. Is not used in the query process
page 0..1 PageInformation optional page number and size if the client is looking for paged results
textSearch 0..1 xsd:string If a free text search is part of the query
argument 0..* Argument arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs
or
1..1
query 1..1 QueryDefinition The requested query, either by iri reference or inline definition If the query is already defined, use the queryIri. Arguments may be used in eoither approach
referenceDate 0..1 im:DateTime reference date for date ranges that use reference date. (Note that it could be passed in as an argument)

PageInformation

Information about paging if the client wishes to page results, including page number and page size

Property Card. Value type Description
pageNumber 1..1 xsd:integer Page number (starting at 1)
pageSize 1..1 xsd:integer number of entries per page