DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
Line 13: | Line 13: | ||
|A resource with an iri and name | |A resource with an iri and name | ||
|- | |- | ||
| | ||rowspan="7"|<span id="class_Entity shape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityShape/ <span style="color:navy"> '''Entity shape'''</span>]<br> (subtype of [[#class_IrirRef|IrirRef]])</span> | ||
|rowspan=" | |||
|colspan="2"|<span title="Points to the type that this shape defines"><span style="color:green">targetClass</span></span> | |colspan="2"|<span title="Points to the type that this shape defines"><span style="color:green">targetClass</span></span> | ||
| | | | ||
Line 24: | Line 19: | ||
|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 | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | ||
| | |1..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
|The | |The name of the entity | ||
|- | |- | ||
| | |||
|- | |- | ||
|rowspan=" | |rowspan="3"|<span id="class_IriAlias">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriAlias/ <span style="color:navy"> '''IriAlias'''</span>]<br> (subtype of [[#class_IrirRef|IrirRef]])</span> | ||
|colspan="4"| | |colspan="4"| | ||
|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 | ||
|- | |- | ||
|colspan="2"|<span title="The | |colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | ||
| | |1..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
|The | |The name of the entity | ||
|- | |- | ||
| | |||
|- | |- | ||
Line 81: | Line 54: | ||
!Comment | !Comment | ||
|- | |- | ||
|rowspan=" | |rowspan="8"|<span id="class_QueryShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryShape/ <span style="color:navy"> '''QueryShape'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span> | ||
|colspan="2"|<span title="Points to the type that this shape defines"><span style="color:green">targetClass</span></span> | |colspan="2"|<span title="Points to the type that this shape defines"><span style="color:green">targetClass</span></span> | ||
| | | | ||
Line 87: | Line 60: | ||
|A query that is stored as an entity in a query library | |A query that is stored as an entity in a query library | ||
|- | |- | ||
|colspan="2"|<span title="The | |colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | ||
| | |1..1 | ||
|<span title=" | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
|The | |The name of the entity | ||
|- | |- | ||
|colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | |||
|colspan="2"|<span title=" | |||
|0..1 | |0..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
| | |The description of the entity | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | ||
|1..1 | |1..1 | ||
|<span title=" | |<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | ||
| | |The base type of the entity i.e. one of the high level entity types | ||
|- | |- | ||
|colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | |||
|colspan="2"|<span title=" | |||
|1..1 | |1..1 | ||
|<span title=" | |<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | ||
| | |The status of the entity being active, inactive, draft or unassigned | ||
|- | |- | ||
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | |||
|colspan="2"|<span title=" | |||
|1..1 | |1..1 | ||
|<span title=" | |<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | ||
| | |The code scheme or graph which the entity belongs to | ||
|- | |- | ||
|colspan="2"|<span title="The | |colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | ||
|0..* | |0..* | ||
|<span title=" | |<span title="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/ im:EntityShape]</span> | ||
|An entity that this entity inherits from, both semantically and structurally | |||
| | |||
|- | |- | ||
| | | | ||
|- | |- | ||
|- | |- | ||
|- | |- | ||
|rowspan="14"|<span id="class_Query definition">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryDefinition/ <span style="color:navy"> '''Query definition'''</span>]<br> (subtype of [[#class_ClauseHeading|ClauseHeading]])</span> | |||
| | |colspan="4"| | ||
|A Query definition holding the logical definition of a query in a standard language | |||
| | |||
|- | |- | ||
|colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | |||
|colspan="2"|<span title=" | |1..1 | ||
| | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
|<span title=" | |The name of the entity | ||
| | |||
|- | |- | ||
|colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | |||
|colspan="2"|<span title=" | |||
|0..1 | |0..1 | ||
|<span title="">[https:// | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
|The description of the entity | |||
| | |||
|- | |- | ||
| | |colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | ||
|<span title="The | |||
|1..1 | |1..1 | ||
|<span title="">[ | |<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | ||
|The entity | |The base type of the entity i.e. one of the high level entity types | ||
|- | |- | ||
| | |colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | ||
<span title=" | |||
|1..1 | |1..1 | ||
|<span title="">[ | |<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | ||
| | |The status of the entity being active, inactive, draft or unassigned | ||
|- | |- | ||
| | |colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | ||
|<span title=" | |||
|1..1 | |1..1 | ||
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | |<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | ||
|The | |The code scheme or graph which the entity belongs to | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | ||
|0..* | |0..* | ||
|<span title=" | |<span title="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/ im:EntityShape]</span> | ||
| | |An entity that this entity inherits from, both semantically and structurally | ||
|- | |- | ||
|colspan="2"|<span title="The column name in a select clause for this property, or a variable used to reference the result set of the values matched">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23alias/ <span style="color:green">alias ]</span></span> | |||
|1..1 | |||
|colspan="2"|<span title="The | |||
| | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
| | |An alias or reference term that can be used throughout a query as shorthand for the result set | ||
|- | |- | ||
| | | | ||
|- | |- | ||
|- | |- | ||
|- | |- | ||
|rowspan="8"|<span id="class_ClauseHeading">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ClauseHeading/ <span style="color:navy"> '''ClauseHeading'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span> | |||
|rowspan=" | |||
|colspan="4"| | |colspan="4"| | ||
| | |General headings such as name description and alias | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | ||
|1..1 | |1..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
| | |The name of the entity | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | ||
|0..1 | |0..1 | ||
|<span title=" | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
|The | |The description of the entity | ||
|- | |- | ||
|colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | |||
|1..1 | |||
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | |||
|The base type of the entity i.e. one of the high level entity types | |||
|- | |- | ||
|colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | |||
|colspan="2"|<span title=" | |||
|1..1 | |1..1 | ||
|<span title="A | |<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | ||
| | |The status of the entity being active, inactive, draft or unassigned | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | ||
|1..1 | |1..1 | ||
|<span title=" | |<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | ||
| | |The code scheme or graph which the entity belongs to | ||
|- | |- | ||
| | |colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | ||
<span title="The | |0..* | ||
| | |<span title="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/ im:EntityShape]</span> | ||
|<span title="">[ | |An entity that this entity inherits from, both semantically and structurally | ||
| | |||
|- | |- | ||
| | | | ||
|- | |- | ||
|- | |- | ||
|rowspan="8"|<span id="class_FunctionShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23FunctionShape/ <span style="color:navy"> '''FunctionShape'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span> | |||
|colspan="2"|<span title="Points to the type that this shape defines"><span style="color:green">targetClass</span></span> | |||
| | | | ||
<span title=" | |Fixed :<span title="A function definition with optional parameters">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Function/ im:Function]</span> | ||
|null | |||
| | |||
|- | |- | ||
|colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | |||
| | |||
<span title=" | |||
|1..1 | |1..1 | ||
|<span title=" | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
| | |The name of the entity | ||
|- | |- | ||
|colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | |||
|colspan="2"|<span title=" | |||
|0..1 | |0..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
| | |The description of the entity | ||
|- | |- | ||
|colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | |||
|1..1 | |||
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | |||
|The base type of the entity i.e. one of the high level entity types | |||
|- | |- | ||
|colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | |||
|colspan="2"|<span title=" | |||
|1..1 | |1..1 | ||
|<span title=" | |<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | ||
| | |The status of the entity being active, inactive, draft or unassigned | ||
|- | |- | ||
| | |colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | ||
|<span title=" | |||
|1..1 | |1..1 | ||
|<span title=" | |<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | ||
| | |The code scheme or graph which the entity belongs to | ||
|- | |- | ||
| | |colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | ||
<span title="The | |0..* | ||
| | |<span title="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/ im:EntityShape]</span> | ||
|<span title=" | |An entity that this entity inherits from, both semantically and structurally | ||
| | |||
|- | |- | ||
| | | | ||
|- | |- | ||
|- | |- | ||
Line 579: | Line 252: | ||
|- | |- | ||
|} | |||
== Data Model shapes == | |||
These shapes are the meta classes of the data modelling entities within the information model. | |||
{| class="wikitable" | |||
|+ | |||
!Shape | |||
!colspan="2"|Property | |||
!Card. | |||
!Value type | |||
!Comment | |||
|- | |- | ||
|rowspan=" | |rowspan="8"|<span id="class_Data model shape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DataModelShape/ <span style="color:navy"> '''Data model shape'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span> | ||
|colspan=" | |colspan="2"|<span title="Points to the type that this shape defines"><span style="color:green">targetClass</span></span> | ||
| | | | ||
|Fixed :<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23+NodeShape/ sh:+NodeShape]</span> | |||
|The shape of a SHACL node shape | |||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | ||
|1..1 | |1..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
| | |The name of the entity | ||
|- | |- | ||
| | |colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | ||
|<span title=" | |0..1 | ||
| | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
|The | |The description of the entity | ||
|- | |- | ||
| | |colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | ||
<span title="The | |||
|1..1 | |1..1 | ||
|<span title=" | |<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | ||
|The | |The base type of the entity i.e. one of the high level entity types | ||
|- | |- | ||
| | |colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | ||
<span title=" | |||
|1..1 | |1..1 | ||
|<span title=" | |<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | ||
|The | |The status of the entity being active, inactive, draft or unassigned | ||
|- | |- | ||
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | |||
|colspan="2"|<span title=" | |||
|1..1 | |1..1 | ||
|<span title=" | |<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | ||
|The code scheme or graph which the entity belongs to | |||
|The | |||
|- | |- | ||
|colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | |||
|0..* | |||
|<span title="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/ im:EntityShape]</span> | |||
|An entity that this entity inherits from, both semantically and structurally | |||
|- | |- | ||
| | | | ||
|- | |- | ||
Line 745: | Line 318: | ||
|- | |- | ||
|- | |- | ||
Line 778: | Line 324: | ||
|} | |} | ||
== | == Concept shapes == | ||
These shapes are the meta classes of the | These shapes are the meta classes of the terminology concepts used within the information model. | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
Line 788: | Line 334: | ||
!Comment | !Comment | ||
|- | |- | ||
|rowspan=" | |rowspan="18"|<span id="class_Concept shape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptShape/ <span style="color:navy"> '''Concept shape'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span> | ||
|colspan="2"|<span title="Points to the type that this shape defines"><span style="color:green">targetClass</span></span> | |colspan="2"|<span title="Points to the type that this shape defines"><span style="color:green">targetClass</span></span> | ||
| | | | ||
|Fixed :<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F% | |Fixed :<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span> | ||
| | |data model for terminology concepts | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | ||
| | |1..1 | ||
|<span title=" | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
| | |The name of the entity | ||
|- | |- | ||
|colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | |||
|0..1 | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
|The description of the entity | |||
|- | |- | ||
|colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | |||
|1..1 | |||
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | |||
|The base type of the entity i.e. one of the high level entity types | |||
|- | |- | ||
|colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | |||
|1..1 | |||
|<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | |||
|The status of the entity being active, inactive, draft or unassigned | |||
|- | |- | ||
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | |||
|1..1 | |||
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | |||
|The code scheme or graph which the entity belongs to | |||
|- | |- | ||
|colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | |||
|0..* | |||
|<span title="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/ im:EntityShape]</span> | |||
|An entity that this entity inherits from, both semantically and structurally | |||
|- | |- | ||
| | |||
|- | |- | ||
Line 825: | Line 392: | ||
|- | |- | ||
|rowspan="19"|<span id="class_Refined concept shape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23RefinedConceptShape/ <span style="color:navy"> '''Refined concept shape'''</span>]<br> (subtype of [[#class_Concept shape|Concept shape]])</span> | |||
|rowspan=" | |||
|colspan="4"| | |colspan="4"| | ||
| | |A concept with role groups with roles | ||
|- | |- | ||
|colspan="2"|<span title="The | |colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | ||
|1..1 | |1..1 | ||
|<span title="">[https:// | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
|The | |The name of the entity | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | ||
|0..1 | |0..1 | ||
|<span title=" | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
|The description of the entity | |||
|The | |||
|- | |- | ||
| | |colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | ||
|<span title="The | |||
|1..1 | |1..1 | ||
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | |<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | ||
|The | |The base type of the entity i.e. one of the high level entity types | ||
|- | |- | ||
| | |colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | ||
<span title=" | |||
|1..1 | |1..1 | ||
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F% | |<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | ||
|The | |The status of the entity being active, inactive, draft or unassigned | ||
|- | |- | ||
| | |colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | ||
<span title=" | |||
|1..1 | |1..1 | ||
|<span title=" | |<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | ||
|The code scheme or graph which the entity belongs to | |||
|The | |||
|- | |- | ||
|colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | |||
|0..* | |||
|<span title="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/ im:EntityShape]</span> | |||
|An entity that this entity inherits from, both semantically and structurally | |||
|- | |- | ||
|colspan="2"|<span title="a code for a codeable concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23code/ <span style="color:green">code ]</span></span> | |colspan="2"|<span title="a code for a codeable concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23code/ <span style="color:green">code ]</span></span> | ||
|1..1 | |1..1 | ||
Line 956: | Line 452: | ||
|colspan="2"|<span title="Points to the definitional status of this entity e.g. full defined as an equivalent class">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definitionalStatus/ <span style="color:green">definitionalStatus ]</span></span> | |colspan="2"|<span title="Points to the definitional status of this entity e.g. full defined as an equivalent class">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definitionalStatus/ <span style="color:green">definitionalStatus ]</span></span> | ||
|0..1 | |0..1 | ||
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Definitionalstatus/ im:VSET_Definitionalstatus]</span> | |<span title="Value set for Concept shape / definitional status">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Definitionalstatus/ im:VSET_Definitionalstatus]</span> | ||
|Indicates the authoring status of this concept, whether necessary only, or both necessary and sufficient. OWL would use Equivalent class axiom to indicate this. | |Indicates the authoring status of this concept, whether necessary only, or both necessary and sufficient. OWL would use Equivalent class axiom to indicate this. | ||
|- | |- | ||
Line 980: | Line 476: | ||
|colspan="2"|<span title="Points to a match between the concept and a legacy concept as part of a map">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23matchedTo/ <span style="color:green">matchedTo ]</span></span> | |colspan="2"|<span title="Points to a match between the concept and a legacy concept as part of a map">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23matchedTo/ <span style="color:green">matchedTo ]</span></span> | ||
|0..* | |0..* | ||
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Unspecified/ im:VSET_Unspecified]</span> | |<span title="Value set place holder for unmodelled property value sets">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Unspecified/ im:VSET_Unspecified]</span> | ||
|For a legacy concept, one or more concept this concept matches to. A query for the matched to concepts would entail this concept normally, but NOT the children of this concept | |For a legacy concept, one or more concept this concept matches to. A query for the matched to concepts would entail this concept normally, but NOT the children of this concept | ||
|- | |- | ||
Line 990: | Line 486: | ||
|- | |- | ||
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fsnomed.info%2Fsct%23370124000/ <span style="color:green">370124000 ]</span></span> | |colspan="2"|<span title="REPLACED BY (attribute)">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fsnomed.info%2Fsct%23370124000/ <span style="color:green">370124000 ]</span></span> | ||
|0..* | |0..* | ||
|<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span> | |<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span> | ||
Line 1,002: | Line 498: | ||
|- | |- | ||
| | |||
|- | |- | ||
Line 1,019: | Line 516: | ||
|- | |- | ||
|rowspan="4"|<span id="class_Term code shape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23TermCodeShape/ <span style="color:navy"> '''Term code shape'''</span>]</span> | |||
|colspan="4"| | |||
|data model for a term code | |||
|- | |- | ||
| | |||
|- | |- | ||
|rowspan="16"|<span id="class_Source context shape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SourceContextShape/ <span style="color:navy"> '''Source context shape'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span> | |||
|colspan="4"| | |||
|Data model for source context for a concept e.g. source system, field etc | |||
|- | |- | ||
|colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | |||
|1..1 | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
|The name of the entity | |||
|- | |- | ||
|colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | |||
|0..1 | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
|The description of the entity | |||
|- | |- | ||
|colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | |||
|1..1 | |||
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | |||
|The base type of the entity i.e. one of the high level entity types | |||
|- | |- | ||
|colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | |||
|1..1 | |||
|<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | |||
|The status of the entity being active, inactive, draft or unassigned | |||
|- | |- | ||
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | |||
|1..1 | |||
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | |||
|The code scheme or graph which the entity belongs to | |||
|- | |- | ||
|colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | |||
|0..* | |||
|<span title="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/ im:EntityShape]</span> | |||
|An entity that this entity inherits from, both semantically and structurally | |||
|- | |- | ||
| | |||
|- | |- | ||
|- | |- | ||
|rowspan="28"|<span id="class_im:ConceptPropertyShape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23ConceptPropertyShape/ <span style="color:navy"> '''im:ConceptPropertyShape'''</span>]<br> (subtype of [[#class_Property shape|Property shape]])</span> | |||
|colspan="4"| | |||
|A concept that is a role in another concept and as a property may have domains and ranges | |||
|- | |- | ||
|colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | |||
|- | |1..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
|The name of the entity | |||
|- | |- | ||
|colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | |||
|0..1 | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
|The description of the entity | |||
|- | |- | ||
|colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | |||
|1..1 | |||
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | |||
|The base type of the entity i.e. one of the high level entity types | |||
|- | |- | ||
|colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | |||
|1..1 | |||
|<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | |||
|The status of the entity being active, inactive, draft or unassigned | |||
|- | |- | ||
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | |||
|1..1 | |||
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | |||
|The code scheme or graph which the entity belongs to | |||
|- | |- | ||
|colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | |||
|colspan="2"|<span title="The | |||
|0..* | |0..* | ||
|<span title=" | |<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span> | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The property that determines that two given properties are inverse.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2002%2F07%2Fowl%23inverseOf/ <span style="color:green">inverseOf ]</span></span> | ||
|0..* | |0..* | ||
|<span title=" | |<span title="The class of RDF properties, used for Data properties (object properties are generally owl:ObjectProperties">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ rdf:Property]</span> | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="A domain of the subject property.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23domain/ <span style="color:green">domain ]</span></span> | ||
|0..* | |0..* | ||
|<span title=" | |<span title="The class of classes.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Class/ rdfs:Class]</span> | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title="A range of the subject property.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23range/ <span style="color:green">range ]</span></span> | |||
|0..* | |||
|<span title="The class of classes.">[[#class_Class|Class]]</span> | |||
|colspan="2"|<span title=" | |||
| | |||
|<span title=" | |||
| | | | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | ||
|1..1 | |||
|1.. | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
| | |The name of the entity | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | ||
| | |0..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
| | |The description of the entity | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | ||
|1.. | |1..1 | ||
|<span title=" | |<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | ||
| | |The base type of the entity i.e. one of the high level entity types | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | ||
|1.. | |1..1 | ||
|<span title=" | |<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | ||
| | |The status of the entity being active, inactive, draft or unassigned | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | ||
|1.. | |1..1 | ||
|<span title=" | |<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | ||
| | |The code scheme or graph which the entity belongs to | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | ||
| | |0..* | ||
|<span title=" | |<span title="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/ im:EntityShape]</span> | ||
| | |An entity that this entity inherits from, both semantically and structurally | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="a code for a codeable concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23code/ <span style="color:green">code ]</span></span> | ||
|1.. | |1..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
| | |The code for this concept, which may be a local code if local concept, or a core code such as a snomed identifier | ||
|- | |- | ||
|colspan="2"|<span title="links a an alternative term code to a concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23hasTermCode/ <span style="color:green">hasTermCode ]</span></span> | |||
|colspan="2"|<span title=" | |||
|0..* | |0..* | ||
|<span title="data model for a | |<span title="data model for a term code">[[#class_TermCodeShape|TermCodeShape]]</span> | ||
| | |Alternative terms or synonyms for this concept. A term may also have a description id. | ||
|- | |- | ||
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23weighting/ <span style="color:green">weighting ]</span></span> | |||
|0..1 | |||
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span> | |||
|A number indicating a weighting for this concept which can be used in free text search | |||
|- | |- | ||
|colspan="2"|<span title="Points to the definitional status of this entity e.g. full defined as an equivalent class">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23definitionalStatus/ <span style="color:green">definitionalStatus ]</span></span> | |||
|0..1 | |||
|<span title="Value set for Concept shape / definitional status">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Definitionalstatus/ im:VSET_Definitionalstatus]</span> | |||
|Indicates the authoring status of this concept, whether necessary only, or both necessary and sufficient. OWL would use Equivalent class axiom to indicate this. | |||
|- | |- | ||
|colspan="2"|<span title="points to one or more maps that matches this concept to another concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23hasMap/ <span style="color:green">hasMap ]</span></span> | |||
|0..* | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
|Any backward maps from core to legacy. This is limited to complex maps rather than simple matches and are 'backward' matches not suitable for automatic inclusion in subsumption queries | |||
|- | |- | ||
|colspan="2"|<span title="usage total for a stats report">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23usageTotal/ <span style="color:green">usageTotal ]</span></span> | |||
|0..1 | |||
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span> | |||
|The approximate number of times this concept has been used in around 1 million primary care and acute care records | |||
|- | |- | ||
|colspan="2"|<span title="the old identifier from im1">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23im1Id/ <span style="color:green">im1Id ]</span></span> | |||
|0..1 | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
|pointer the original identifer in IM1 | |||
|- | |- | ||
|colspan="2"|<span title="Points to a match between the concept and a legacy concept as part of a map">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23matchedTo/ <span style="color:green">matchedTo ]</span></span> | |||
|0..* | |||
|<span title="Value set place holder for unmodelled property value sets">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Unspecified/ im:VSET_Unspecified]</span> | |||
|For a legacy concept, one or more concept this concept matches to. A query for the matched to concepts would entail this concept normally, but NOT the children of this concept | |||
|- | |- | ||
|colspan="2"|<span title="Points to the context object holding information about the source of this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceContext/ <span style="color:green">sourceContext ]</span></span> | |||
|0..* | |||
|<span title="Data model for source context for a concept e.g. source system, field etc">[[#class_SourceContextShape|SourceContextShape]]</span> | |||
|The source context object for this concept indicating the system, table, field and organisation that published this legacy concept | |||
|- | |- | ||
|colspan="2"|<span title="REPLACED BY (attribute)">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fsnomed.info%2Fsct%23370124000/ <span style="color:green">370124000 ]</span></span> | |||
|0..* | |||
|<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span> | |||
|Indicates the concepts that this concept has been replaced by | |||
|- | |- | ||
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23isChildOf/ <span style="color:green">isChildOf ]</span></span> | |||
|0..* | |||
|<span title="Top level information concept for all codeable concepts">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Concept/ im:Concept]</span> | |||
|points to the parent legacy concept that this concept is in. Note that it may or may not be a true subtype. Reflects the original taxonomy | |||
|- | |- | ||
| | |||
|- | |- | ||
Line 1,196: | Line 750: | ||
|- | |- | ||
|rowspan="11"|<span id="class_Property shape">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyShape/ <span style="color:navy"> '''Property shape'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span> | |||
|colspan="2"|<span title="Points to the type that this shape defines"><span style="color:green">targetClass</span></span> | |||
| | |||
|Fixed :<span title="The class of RDF properties, used for Data properties (object properties are generally owl:ObjectProperties">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23Property/ rdf:Property]</span> | |||
|data model for properties | |||
|- | |- | ||
|colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | |||
|- | |1..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
| | |The name of the entity | ||
|- | |||
| | |||
|- | |- | ||
|colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | |||
|0..1 | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
|The description of the entity | |||
|- | |- | ||
|colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | |||
|1..1 | |||
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | |||
|The base type of the entity i.e. one of the high level entity types | |||
|- | |- | ||
|colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | |||
|1..1 | |||
|<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | |||
|The status of the entity being active, inactive, draft or unassigned | |||
|- | |- | ||
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | |||
|1..1 | |||
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | |||
|The code scheme or graph which the entity belongs to | |||
|- | |- | ||
| | |||
|- | |- | ||
|<span id="class_Class">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Class/ <span style="color:navy"> '''Class'''</span>]<br> (subtype of [[#class_Resource|Resource]])</span> | |||
|colspan="4"| | |colspan="4"| | ||
| | |The class of classes. | ||
|- | |- | ||
| | | | ||
|- | |||
|- | |- | ||
|- | |- | ||
|<span id=" | |<span id="class_Resource">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ <span style="color:navy"> '''Resource'''</span>]</span> | ||
|colspan="4"| | |colspan="4"| | ||
| | |The class resource, everything in RDF/OWL/SHACL/RDFS. | ||
|- | |- | ||
| | | | ||
|- | |- | ||
|- | |- | ||
Line 1,323: | Line 817: | ||
!Comment | !Comment | ||
|- | |- | ||
|rowspan=" | |rowspan="9"|<span id="class_EntityFileTransaction">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23EntityFileTransaction/ <span style="color:navy"> '''EntityFileTransaction'''</span>]<br> (subtype of [[#class_Entity shape|Entity shape]])</span> | ||
|colspan="4"| | |colspan="4"| | ||
|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 | ||
|- | |- | ||
|colspan="2"|<span title=" | |colspan="2"|<span title="The name of the parameter">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label/ <span style="color:green">label ]</span></span> | ||
|1..1 | |1..1 | ||
|<span title=" | |<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | ||
|The name of the entity | |||
|The | |||
|- | |- | ||
|colspan="2"|<span title="Description of the property">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23comment/ <span style="color:green">comment ]</span></span> | |||
|0..1 | |||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
|The description of the entity | |||
|- | |- | ||
|colspan="2"|<span title="The subject is an instance of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23type/ <span style="color:green">type ]</span></span> | |||
|1..1 | |||
|<span title="The class resource, everything in RDF/OWL/SHACL/RDFS.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | |||
|The base type of the entity i.e. one of the high level entity types | |||
|- | |- | ||
|colspan="2"|<span title="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</span></span> | |||
|1..1 | |||
|<span title="A status that is in active or active">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Status/ im:Status]</span> | |||
|The status of the entity being active, inactive, draft or unassigned | |||
|- | |- | ||
|colspan="2"|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23scheme/ <span style="color:green">scheme ]</span></span> | |||
|1..1 | |||
|<span title="Core graphs for core ontologies such as the health information model, Discovery and Snomed">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Graph/ im:Graph]</span> | |||
|The code scheme or graph which the entity belongs to | |||
|- | |- | ||
|colspan="2"|<span title="The subject is a subclass of a class.">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23subClassOf/ <span style="color:green">subClassOf ]</span></span> | |||
|0..* | |||
|<span title="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/ im:EntityShape]</span> | |||
|An entity that this entity inherits from, both semantically and structurally | |||
|- | |- | ||
| | |||
|- | |- | ||
Line 1,416: | Line 895: | ||
|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 | ||
|- | |- | ||
| | | | ||
|- | |- | ||
Line 1,511: | Line 933: | ||
|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 | ||
|- | |- | ||
| | | | ||
|- | |- | ||
Line 1,585: | Line 964: | ||
|- | |- | ||
|- | |- | ||
Revision as of 07:45, 30 August 2022
Basic shapes
These shapes are the meta classes of the named entities within the information model.
Shape | Property | Card. | Value type | Comment | |
---|---|---|---|---|---|
IrirRef | A resource with an iri and name | ||||
rowspan="7"| Entity shape (subtype of IrirRef) |
targetClass | Fixed :im:Entity | 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 | ||
label | 1..1 | xsd:string | The name of the entity | ||
IriAlias (subtype of IrirRef) |
An IRI with a name and an alias (for use as variables for reference | ||||
label | 1..1 | xsd:string | The name of the entity | ||
Query language shapes
These shapes form the query language DSL for retrieving data from the IM or health records.
Shape | Property | Card. | Value type | Comment | |
---|---|---|---|---|---|
QueryShape (subtype of Entity shape) |
targetClass | Fixed :im:Query | A query that is stored as an entity in a query library | ||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:EntityShape | An entity that this entity inherits from, both semantically and structurally | ||
Query definition (subtype of ClauseHeading) |
A Query definition holding the logical definition of a query in a standard language | ||||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:EntityShape | An entity that this entity inherits from, both semantically and structurally | ||
alias | 1..1 | xsd:string | An alias or reference term that can be used throughout a query as shorthand for the result set | ||
ClauseHeading (subtype of Entity shape) |
General headings such as name description and alias | ||||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:EntityShape | An entity that this entity inherits from, both semantically and structurally | ||
FunctionShape (subtype of Entity shape) |
targetClass | Fixed :im:Function | null | ||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:EntityShape | An entity that this entity inherits from, both semantically and structurally | ||
Data Model shapes
These shapes are the meta classes of the data modelling entities within the information model.
Shape | Property | Card. | Value type | Comment | |
---|---|---|---|---|---|
Data model shape (subtype of Entity shape) |
targetClass | Fixed :sh:+NodeShape | The shape of a SHACL node shape | ||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:EntityShape | An entity that this entity inherits from, both semantically and structurally | ||
Concept shapes
These shapes are the meta classes of the terminology concepts used within the information model.
Shape | Property | Card. | Value type | Comment | |
---|---|---|---|---|---|
Concept shape (subtype of Entity shape) |
targetClass | Fixed :im:Concept | data model for terminology concepts | ||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:EntityShape | An entity that this entity inherits from, both semantically and structurally | ||
Refined concept shape (subtype of Concept shape) |
A concept with role groups with roles | ||||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:EntityShape | An entity that this entity inherits from, both semantically and structurally | ||
code | 1..1 | xsd:string | The code for this concept, which may be a local code if local concept, or a core code such as a snomed identifier | ||
hasTermCode | 0..* | TermCodeShape | Alternative terms or synonyms for this concept. A term may also have a description id. | ||
weighting | 0..1 | xsd:integer | A number indicating a weighting for this concept which can be used in free text search | ||
definitionalStatus | 0..1 | im:VSET_Definitionalstatus | Indicates the authoring status of this concept, whether necessary only, or both necessary and sufficient. OWL would use Equivalent class axiom to indicate this. | ||
hasMap | 0..* | xsd:string | Any backward maps from core to legacy. This is limited to complex maps rather than simple matches and are 'backward' matches not suitable for automatic inclusion in subsumption queries | ||
usageTotal | 0..1 | xsd:integer | The approximate number of times this concept has been used in around 1 million primary care and acute care records | ||
im1Id | 0..1 | xsd:string | pointer the original identifer in IM1 | ||
matchedTo | 0..* | im:VSET_Unspecified | For a legacy concept, one or more concept this concept matches to. A query for the matched to concepts would entail this concept normally, but NOT the children of this concept | ||
sourceContext | 0..* | SourceContextShape | The source context object for this concept indicating the system, table, field and organisation that published this legacy concept | ||
370124000 | 0..* | im:Concept | Indicates the concepts that this concept has been replaced by | ||
isChildOf | 0..* | im:Concept | points to the parent legacy concept that this concept is in. Note that it may or may not be a true subtype. Reflects the original taxonomy | ||
Term code shape | data model for a term code | ||||
Source context shape (subtype of Entity shape) |
Data model for source context for a concept e.g. source system, field etc | ||||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:EntityShape | An entity that this entity inherits from, both semantically and structurally | ||
im:ConceptPropertyShape (subtype of Property shape) |
A concept that is a role in another concept and as a property may have domains and ranges | ||||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:Concept | |||
inverseOf | 0..* | rdf:Property | |||
domain | 0..* | rdfs:Class | |||
range | 0..* | Class | |||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:EntityShape | An entity that this entity inherits from, both semantically and structurally | ||
code | 1..1 | xsd:string | The code for this concept, which may be a local code if local concept, or a core code such as a snomed identifier | ||
hasTermCode | 0..* | TermCodeShape | Alternative terms or synonyms for this concept. A term may also have a description id. | ||
weighting | 0..1 | xsd:integer | A number indicating a weighting for this concept which can be used in free text search | ||
definitionalStatus | 0..1 | im:VSET_Definitionalstatus | Indicates the authoring status of this concept, whether necessary only, or both necessary and sufficient. OWL would use Equivalent class axiom to indicate this. | ||
hasMap | 0..* | xsd:string | Any backward maps from core to legacy. This is limited to complex maps rather than simple matches and are 'backward' matches not suitable for automatic inclusion in subsumption queries | ||
usageTotal | 0..1 | xsd:integer | The approximate number of times this concept has been used in around 1 million primary care and acute care records | ||
im1Id | 0..1 | xsd:string | pointer the original identifer in IM1 | ||
matchedTo | 0..* | im:VSET_Unspecified | For a legacy concept, one or more concept this concept matches to. A query for the matched to concepts would entail this concept normally, but NOT the children of this concept | ||
sourceContext | 0..* | SourceContextShape | The source context object for this concept indicating the system, table, field and organisation that published this legacy concept | ||
370124000 | 0..* | im:Concept | Indicates the concepts that this concept has been replaced by | ||
isChildOf | 0..* | im:Concept | points to the parent legacy concept that this concept is in. Note that it may or may not be a true subtype. Reflects the original taxonomy | ||
Property shape (subtype of Entity shape) |
targetClass | Fixed :rdf:Property | data model for properties | ||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
Class (subtype of Resource) |
The class of classes. | ||||
Resource | The class resource, everything in RDF/OWL/SHACL/RDFS. | ||||
Transactional shapes
These shapes form the meta classes for structures pass into APIs for query of, or filing into, the model or health records.
Shape | Property | Card. | Value type | Comment | |
---|---|---|---|---|---|
EntityFileTransaction (subtype of Entity shape) |
An entity with the additional CRUD indicators to enable deletes updates, adding quads etc | ||||
label | 1..1 | xsd:string | The name of the entity | ||
comment | 0..1 | xsd:string | The description of the entity | ||
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | ||
status | 1..1 | im:Status | The status of the entity being active, inactive, draft or unassigned | ||
scheme | 1..1 | im:Graph | The code scheme or graph which the entity belongs to | ||
subClassOf | 0..* | im:EntityShape | An entity that this entity inherits from, both semantically and structurally | ||
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 | ||||
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 | ||||