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