DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) 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. | ||
=== | === <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 | 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 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" | </span> | ||
{| class="wikitable" | |||
|+ | |+ | ||
!colspan="2"|Property | !colspan="2"|Property |
Revision as of 16:48, 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 IriRef
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
|-
|
|-
|}