Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
Line 3: Line 3:
=== IrirRef ===
=== IrirRef ===
A resource with an iri and name
A resource with an iri and name
{| class="wikitable"
<span id="class_IriRef">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/  <span style="color:navy"> '''IriRef'''</span>]
|+
</span>{| class="wikitable"
|-
|Inherited from | Something
|-
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 15: Line 12:
|-
|-


|A resource with an iri and name
|-
|
|-
|}
|}
=== 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
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"
<span id="class_EntityShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/  <span style="color:navy"> '''EntityShape'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 27: Line 28:
|-
|-


|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
An IRI with a name and an alias (for use as variables for reference
{| class="wikitable"
<span id="class_IriAlias">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriAlias/  <span style="color:navy"> '''IriAlias'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 38: Line 44:
|-
|-


|An IRI with a name and an alias (for use as variables for reference
|-
|
|-
|}
|}
=== Property shape ===
=== Property shape ===
data model for properties
data model for properties
{| class="wikitable"
<span id="class_PropertyShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyShape/  <span style="color:navy"> '''PropertyShape'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 49: Line 60:
|-
|-


|data model for properties
|-
|
|-
|}
|}


Line 55: Line 70:
=== QueryShape ===
=== QueryShape ===
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"
<span id="class_QueryShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryShape/  <span style="color:navy"> '''QueryShape'''</span>]
|+
</span>{| class="wikitable"
!colspan="4" |Inheritance
|-
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 66: Line 79:
|-
|-


|A query that is stored as an entity in a query library
|-
|
|-
|}
|}
=== Query definition ===
=== Query definition ===
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"
<span id="class_QueryDefinition">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryDefinition/  <span style="color:navy"> '''QueryDefinition'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 78: Line 95:
|-
|-


|A Query definition holding the logical definition of a query in a standard language
|-
|
|-
|}
|}
=== FunctionShape ===
=== FunctionShape ===
null
null
{| class="wikitable"
<span id="class_FunctionShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionShape/  <span style="color:navy"> '''FunctionShape'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 89: Line 111:
|-
|-


|null
|-
|
|-
|}
|}


Line 95: Line 121:
=== Data model shape ===
=== Data model shape ===
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"
<span id="class_DataModelShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DataModelShape/  <span style="color:navy"> '''DataModelShape'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 103: Line 130:
|-
|-


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


Line 109: Line 140:
=== Concept shape ===
=== Concept shape ===
data model for terminology concepts
data model for terminology concepts
{| class="wikitable"
<span id="class_ConceptShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptShape/  <span style="color:navy"> '''ConceptShape'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 117: Line 149:
|-
|-


|data model for terminology concepts
|-
|
|-
|}
|}
=== Refined concept shape ===
=== Refined concept shape ===
A concept with role groups with roles
A concept with role groups with roles
{| class="wikitable"
<span id="class_RefinedConceptShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RefinedConceptShape/  <span style="color:navy"> '''RefinedConceptShape'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 128: Line 165:
|-
|-


|A concept with role groups with roles
|-
|
|-
|}
|}
=== im:ConceptPropertyShape ===
=== im:ConceptPropertyShape ===
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"
<span id="class_ConceptPropertyShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptPropertyShape/  <span style="color:navy"> '''ConceptPropertyShape'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 139: Line 181:
|-
|-


|A concept that is a role in another concept and as a property may have domains and ranges
|-
|
|-
|}
|}
=== Set shape ===
=== Set shape ===
data model for concept sets and value sets
data model for concept sets and value sets
{| class="wikitable"
<span id="class_SetShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SetShape/  <span style="color:navy"> '''SetShape'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 150: Line 197:
|-
|-


|data model for concept sets and value sets
|-
|
|-
|}
|}


Line 156: Line 207:
=== EntityFileTransaction ===
=== EntityFileTransaction ===
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"
<span id="class_EntityFileTransaction">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityFileTransaction/  <span style="color:navy"> '''EntityFileTransaction'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 164: Line 216:
|-
|-


|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.<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"
<span id="class_EntityDocument">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityDocument/  <span style="color:navy"> '''EntityDocument'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 175: Line 232:
|-
|-


|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
|-
|
|-
|}
|}
=== 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
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"
<span id="class_QueryRequest">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/  <span style="color:navy"> '''QueryRequest'''</span>]
</span>{| class="wikitable"
|+
|+
!colspan="2"|Property
!colspan="2"|Property
Line 186: Line 248:
|-
|-


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

Revision as of 16:45, 20 September 2022

Basic shapes

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

IrirRef

A resource with an iri and name IriRef {| class="wikitable" |+ !colspan="2"|Property !Card. !Value type !Description |-

|A resource with an iri and name |- | |- |}

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

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

Property shape

data model for properties PropertyShape {| class="wikitable" |+ !colspan="2"|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 QueryShape {| class="wikitable" |+ !colspan="2"|Property !Card. !Value type !Description |-

|A query that is stored as an entity in a query library |- | |- |}

Query definition

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

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

FunctionShape

null FunctionShape {| class="wikitable" |+ !colspan="2"|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

The meta class for a data model type, using a SHACL node shape for both definition and validation DataModelShape {| class="wikitable" |+ !colspan="2"|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

data model for terminology concepts ConceptShape {| class="wikitable" |+ !colspan="2"|Property !Card. !Value type !Description |-

|data model for terminology concepts |- | |- |}

Refined concept shape

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

|A concept with role groups with roles |- | |- |}

im:ConceptPropertyShape

A concept that is a role in another concept and as a property may have domains and ranges ConceptPropertyShape {| class="wikitable" |+ !colspan="2"|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

data model for concept sets and value sets SetShape {| class="wikitable" |+ !colspan="2"|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 EntityFileTransaction {| class="wikitable" |+ !colspan="2"|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 EntityDocument {| class="wikitable" |+ !colspan="2"|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

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 QueryRequest {| class="wikitable" |+ !colspan="2"|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=6482’
Last modified
This page was last modified on 20 September 2022, at 16:45.