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. | ||
=== IrirRef === | |||
=== | === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/ IriRef] === | ||
</span>A resource with an iri and name | |||
</span> | |||
A resource with an iri and name | |||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
Line 23: | Line 18: | ||
|} | |} | ||
=== Entity shape === | === Entity shape === | ||
=== [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 | |||
</span>{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
!colspan="2"|Property | !colspan="2"|Property | ||
Line 39: | Line 34: | ||
|} | |} | ||
=== IriAlias === | === 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 | |||
</span>{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
!colspan="2"|Property | !colspan="2"|Property | ||
Line 55: | Line 50: | ||
|} | |} | ||
=== Property shape === | === Property shape === | ||
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyShape/ PropertyShape] === | |||
</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 === | ||
=== [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 | |||
</span>{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
!colspan="2"|Property | !colspan="2"|Property | ||
Line 90: | Line 85: | ||
|} | |} | ||
=== Query definition === | === Query definition === | ||
=== [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 | |||
</span>{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
!colspan="2"|Property | !colspan="2"|Property | ||
Line 106: | Line 101: | ||
|} | |} | ||
=== FunctionShape === | === FunctionShape === | ||
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionShape/ FunctionShape] === | |||
</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 === | ||
=== [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 | |||
</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 === | ||
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptShape/ ConceptShape] === | |||
</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 === | ||
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RefinedConceptShape/ RefinedConceptShape] === | |||
</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 === | ||
=== [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 | |||
</span>{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
!colspan="2"|Property | !colspan="2"|Property | ||
Line 192: | Line 187: | ||
|} | |} | ||
=== Set shape === | === Set shape === | ||
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SetShape/ SetShape] === | |||
</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 === | ||
=== [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 | |||
</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>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" | |||
|+ | |+ | ||
!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>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" | |||
|+ | |+ | ||
!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 | ||||