Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 1: Line 1:
The first bit of the text
{{TOC left}}
== Basic shapes ==
== Basic shapes ==
These shapes are the meta classes of the named entities within the information model.
These shapes are the meta classes of the named entities within the information model.
=== IrirRef ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/ IriRef] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/ IriRef] ===
</span>A resource with an iri and name
A resource with an iri and name
{{Note| Example <br> {@id : sn:12345, name : Chest pain }}}
 
 
 
<br />
 
<syntaxhighlight>
Example
{@id : sn:12345, name : Chest pain }
</syntaxhighlight>
 
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 31: Line 16:
|-
|-
|}
|}
=== Entity shape ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/ EntityShape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/ EntityShape] ===
</span>The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status
The 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 47: Line 31:
|-
|-
|}
|}
=== IriAlias ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriAlias/ IriAlias] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriAlias/ IriAlias] ===
</span>An IRI with a name and an alias (for use as variables for reference
An IRI with a name and an alias (for use as variables for reference
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 63: Line 46:
|-
|-
|}
|}
=== Property shape ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyShape/ PropertyShape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyShape/ PropertyShape] ===
</span>data model for properties
data model for properties
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 82: Line 64:
== Query language shapes ==
== Query language shapes ==
These shapes form the query language DSL for retrieving data from the IM or health records.
These shapes form the query language DSL for retrieving data from the IM or health records.
=== QueryShape ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryShape/ QueryShape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryShape/ QueryShape] ===
</span>A query that is stored as an entity in a query library
A query that is stored as an entity in a query library
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 98: Line 79:
|-
|-
|}
|}
=== Query definition ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryDefinition/ QueryDefinition] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryDefinition/ QueryDefinition] ===
</span>A Query definition holding the logical definition of a query in a standard language
A Query definition holding the logical definition of a query in a standard language
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 114: Line 94:
|-
|-
|}
|}
=== FunctionShape ===
=== [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%23FunctionShape/ FunctionShape] ===
</span>null
null
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 133: Line 112:
== Data Model shapes ==
== Data Model shapes ==
These shapes are the meta classes of the data modelling entities within the information model.
These shapes are the meta classes of the data modelling entities within the information model.
=== Data model shape ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DataModelShape/ DataModelShape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DataModelShape/ DataModelShape] ===
</span>The meta class for a data model type, using a SHACL node shape for both definition and validation
The meta class for a data model type, using a SHACL node shape for both definition and validation
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 152: Line 130:
== Concept shapes ==
== Concept shapes ==
These shapes are the meta classes of the terminology concepts used within the information model.
These shapes are the meta classes of the terminology concepts used within the information model.
=== Concept shape ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptShape/ ConceptShape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptShape/ ConceptShape] ===
</span>data model for terminology concepts
data model for terminology concepts
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 168: Line 145:
|-
|-
|}
|}
=== Refined concept shape ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RefinedConceptShape/ RefinedConceptShape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RefinedConceptShape/ RefinedConceptShape] ===
</span>A concept with role groups with roles
A concept with role groups with roles
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 184: Line 160:
|-
|-
|}
|}
=== im:ConceptPropertyShape ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptPropertyShape/ ConceptPropertyShape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptPropertyShape/ ConceptPropertyShape] ===
</span>A concept that is a role in another concept and as a property may have domains and ranges
A concept that is a role in another concept and as a property may have domains and ranges
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 200: Line 175:
|-
|-
|}
|}
=== Set shape ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SetShape/ SetShape] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SetShape/ SetShape] ===
</span>data model for concept sets and value sets
data model for concept sets and value sets
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 219: Line 193:
== Transactional shapes ==
== Transactional shapes ==
These shapes form the meta classes for structures pass into APIs for query of, or  filing into, the model or health records.
These shapes form the meta classes for structures pass into APIs for query of, or  filing into, the model or health records.
=== EntityFileTransaction ===
=== [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] ===
</span>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
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 235: Line 208:
|-
|-
|}
|}
=== EntityDocument ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityDocument/ EntityDocument] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityDocument/ EntityDocument] ===
</span>A document containing any number of triples to file as a batch.<br>Note that if the document is sent as Json-LD with prefixed iris, a @context object will be required
A document containing any number of triples to file as a batch.<br>Note that if the document is sent as Json-LD with prefixed iris, a @context object will be required
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 251: Line 223:
|-
|-
|}
|}
=== Query Request ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/ QueryRequest] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/ QueryRequest] ===
</span>A request for data sent as a  body (json in local name format) to the /queryIM API.<br>Contains either a query or query iri with run time variable values for use in the query
A request for data sent as a  body (json in local name format) to the /queryIM API.<br>Contains either a query or query iri with run time variable values for use in the query
{| class="wikitable"
{| class="wikitable"
|+
|+

Revision as of 20:24, 20 September 2022

Basic shapes

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

IriRef

A resource with an iri and name

Property Card. Value type Description
A resource with an iri and name

EntityShape

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

Property Card. Value type Description
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

IriAlias

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

Property Card. Value type Description
An IRI with a name and an alias (for use as variables for reference

PropertyShape

data model for properties

Property Card. Value type Description
data model for properties

Query language shapes

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

QueryShape

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

Property Card. Value type Description
A query that is stored as an entity in a query library

QueryDefinition

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

Property Card. Value type Description
A Query definition holding the logical definition of a query in a standard language

FunctionShape

null

Property Card. Value type Description
null

Data Model shapes

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

DataModelShape

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

Property Card. Value type Description
The meta class for a data model type, using a SHACL node shape for both definition and validation

Concept shapes

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

ConceptShape

data model for terminology concepts

Property Card. Value type Description
data model for terminology concepts

RefinedConceptShape

A concept with role groups with roles

Property Card. Value type Description
A concept with role groups with roles

ConceptPropertyShape

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

Property Card. Value type Description
A concept that is a role in another concept and as a property may have domains and ranges

SetShape

data model for concept sets and value sets

Property Card. Value type Description
data model for concept sets and value sets

Transactional shapes

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

EntityFileTransaction

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

Property Card. Value type Description
An entity with the additional CRUD indicators to enable deletes updates, adding quads etc

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
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

QueryRequest

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

Property Card. Value type Description
A request for data sent as a body (json in local name format) to the /queryIM API.
Contains either a query or query iri with run time variable values for use in the query