Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 1: Line 1:
== Basic shapes ==
== Basic shapes ==
These shapes are the meta classes of the named entities within the information model.
These shapes are the meta classes of the named entities within the information model.
 
=== IrirRef ===
=== [https://mediawiki.org IriRef] ===
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/ IriRef] ===
 
</span>A resource with an iri and name
<span id="class_IriRef">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/ <span style="color:navy"> '''IriRef''' </span>]
</span>
A resource with an iri and name
 
 
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 23: Line 18:
|}
|}
=== Entity shape ===
=== Entity shape ===
The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/ EntityShape] ===
<span id="class_EntityShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/ <span style="color:navy"> '''EntityShape'''</span>]
</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
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 39: Line 34:
|}
|}
=== IriAlias ===
=== IriAlias ===
An IRI with a name and an alias (for use as variables for reference
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriAlias/ IriAlias] ===
<span id="class_IriAlias">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriAlias/ <span style="color:navy"> '''IriAlias'''</span>]
</span>An IRI with a name and an alias (for use as variables for reference
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 55: Line 50:
|}
|}
=== Property shape ===
=== Property shape ===
data model for properties
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyShape/ PropertyShape] ===
<span id="class_PropertyShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyShape/ <span style="color:navy"> '''PropertyShape'''</span>]
</span>data model for properties
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 74: Line 69:
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 ===
=== QueryShape ===
A query that is stored as an entity in a query library
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryShape/ QueryShape] ===
<span id="class_QueryShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryShape/ <span style="color:navy"> '''QueryShape'''</span>]
</span>A query that is stored as an entity in a query library
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 90: Line 85:
|}
|}
=== Query definition ===
=== Query definition ===
A Query definition holding the logical definition of a query in a standard language
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryDefinition/ QueryDefinition] ===
<span id="class_QueryDefinition">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryDefinition/ <span style="color:navy"> '''QueryDefinition'''</span>]
</span>A Query definition holding the logical definition of a query in a standard language
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 106: Line 101:
|}
|}
=== FunctionShape ===
=== FunctionShape ===
null
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionShape/ FunctionShape] ===
<span id="class_FunctionShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionShape/ <span style="color:navy"> '''FunctionShape'''</span>]
</span>null
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 125: Line 120:
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 ===
=== Data model shape ===
The meta class for a data model type, using a SHACL node shape for both definition and validation
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DataModelShape/ DataModelShape] ===
<span id="class_DataModelShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DataModelShape/ <span style="color:navy"> '''DataModelShape'''</span>]
</span>The meta class for a data model type, using a SHACL node shape for both definition and validation
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 144: Line 139:
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 ===
=== Concept shape ===
data model for terminology concepts
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptShape/ ConceptShape] ===
<span id="class_ConceptShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptShape/ <span style="color:navy"> '''ConceptShape'''</span>]
</span>data model for terminology concepts
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 160: Line 155:
|}
|}
=== Refined concept shape ===
=== Refined concept shape ===
A concept with role groups with roles
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RefinedConceptShape/ RefinedConceptShape] ===
<span id="class_RefinedConceptShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RefinedConceptShape/ <span style="color:navy"> '''RefinedConceptShape'''</span>]
</span>A concept with role groups with roles
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 176: Line 171:
|}
|}
=== im:ConceptPropertyShape ===
=== im:ConceptPropertyShape ===
A concept that is a role in another concept and as a property may have domains and ranges
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptPropertyShape/ ConceptPropertyShape] ===
<span id="class_ConceptPropertyShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptPropertyShape/ <span style="color:navy"> '''ConceptPropertyShape'''</span>]
</span>A concept that is a role in another concept and as a property may have domains and ranges
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 192: Line 187:
|}
|}
=== Set shape ===
=== Set shape ===
data model for concept sets and value sets
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SetShape/ SetShape] ===
<span id="class_SetShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SetShape/ <span style="color:navy"> '''SetShape'''</span>]
</span>data model for concept sets and value sets
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 211: Line 206:
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 ===
=== EntityFileTransaction ===
An entity with the additional CRUD indicators to enable deletes updates, adding quads etc
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityFileTransaction/ EntityFileTransaction] ===
<span id="class_EntityFileTransaction">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityFileTransaction/ <span style="color:navy"> '''EntityFileTransaction'''</span>]
</span>An entity with the additional CRUD indicators to enable deletes updates, adding quads etc
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 227: Line 222:
|}
|}
=== EntityDocument ===
=== EntityDocument ===
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
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityDocument/ EntityDocument] ===
<span id="class_EntityDocument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityDocument/  <span style="color:navy"> '''EntityDocument'''</span>]
</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
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 243: Line 238:
|}
|}
=== Query Request ===
=== Query Request ===
A request for data sent as a  body (json in local name format) to the /queryIM API.<br>Contains either a query or query iri with run time variable values for use in the query
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/ QueryRequest] ===
<span id="class_QueryRequest">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/  <span style="color:navy"> '''QueryRequest'''</span>]
</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
</span>{| class="wikitable"
{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property

Revision as of 19:50, 20 September 2022

Basic shapes

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

IrirRef

IriRef

A resource with an iri and name

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

Entity shape

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

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

Property shape

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

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

Query definition

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

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.

Data model shape

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.

Concept shape

ConceptShape

data model for terminology concepts

Property Card. Value type Description
data model for terminology concepts

Refined concept shape

RefinedConceptShape

A concept with role groups with roles

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

im:ConceptPropertyShape

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

Set shape

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

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

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

Query Request

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
Retrieved from ‘https://wiki.endeavourhealth.org/index.php?title=Test&oldid=6490’
Last modified
This page was last modified on 20 September 2022, at 19:50.