Basic shapes
These shapes are the meta classes of the named entities within the information model.
IriRef
A reference to resource with an iri and optional name to enable readability
| Example {@id : sn:29857009, name : Chest pain (finding)} |
| Property | Card. | Value type | Description | |
| label | 1..1 | xsd:string | The name of the entity | |
Entity
Is a subtype of IrirRef) 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"|comment|
Card. |
Value type |
Description |
||
| 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 | |
IrirRef
A reference to resource with an iri and optional name to enable readability
colspan="2"|label|
Card. |
Value type |
Description |
|
| 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.
Data Model shapes
These shapes are the meta classes of the data modelling entities within the information model.
NodeShape
Is a subtype of Entity shape) The meta class for a data model type, using a SHACL node shape for both definition and validation
colspan="2"|property|
Card. |
Value type |
Description |
|
| 0..* | PropertyNodeShape |
IrirRef
A reference to resource with an iri and optional name to enable readability
colspan="2"|label|
Card. |
Value type |
Description |
|
| 1..1 | xsd:string | The name of the entity |
Entity shape
The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status
colspan="2"|comment|
Card. |
Value type |
Description |
||
| 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 | |
PropertyNodeShape
The data model of a shacl node shape describing a property of a data model entity
colspan="2"|path|
Card. |
Value type |
Description |
||
| 1..1 | rdf:Property | The iri of the property | ||
| minCount | 0..1 | xsd:integer | Minimum cardinality,if null assuming any number including zero | |
| maxCount | 0..1 | xsd:integer | The maximum number allowed. If null then any number | |
| or 1..1 |
class | 1..1 | rdfs:Resource | The iri for the class range of the property. The range of this property is a subclass of this class |
| 1..1 | rdfs:Resource | The range of the property is a data type of this type | ||
| 1..1 | rdfs:Resource | The property points to a node shape | ||
| comment | 0..1 | xsd:string | Description of the property | |
| name | 0..1 | xsd:string | The name of the property used for ease of recognition | |
| order | 0..1 | xsd:integer | The property order for display | |
Concept shapes
These shapes are the meta classes of the terminology concepts used within the information model.
Concept
Is a subtype of Entity shape) data model for terminology concepts
colspan="2"|code|
Card. |
Value type |
Description |
||
| 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 | |
IrirRef
A reference to resource with an iri and optional name to enable readability
colspan="2"|label|
Card. |
Value type |
Description |
|
| 1..1 | xsd:string | The name of the entity |
Entity shape
The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status
colspan="2"|comment|
Card. |
Value type |
Description |
||
| 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 | |
PropertyNodeShape
The data model of a shacl node shape describing a property of a data model entity
colspan="2"|path|
Card. |
Value type |
Description |
||
| 1..1 | rdf:Property | The iri of the property | ||
| minCount | 0..1 | xsd:integer | Minimum cardinality,if null assuming any number including zero | |
| maxCount | 0..1 | xsd:integer | The maximum number allowed. If null then any number | |
| or 1..1 |
class | 1..1 | rdfs:Resource | The iri for the class range of the property. The range of this property is a subclass of this class |
| 1..1 | rdfs:Resource | The range of the property is a data type of this type | ||
| 1..1 | rdfs:Resource | The property points to a node shape | ||
| comment | 0..1 | xsd:string | Description of the property | |
| name | 0..1 | xsd:string | The name of the property used for ease of recognition | |
| order | 0..1 | xsd:integer | The property order for display | |
Entity shape
The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status
colspan="2"|comment|
Card. |
Value type |
Description |
||
| 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 | |
Term code shape
data model for a term code
colspan="2"|label|
Card. |
Value type |
Description |
||
| 0..* | xsd:string | |||
| code | 0..* | xsd:string | ||
| status | 0..* | im:Status | ||
Source context shape
Data model for source context for a concept e.g. source system, field etc
colspan="2"|sourceSystem|
Card. |
Value type |
Description |
||
| 1..* | im:ComputerSystem | |||
| sourcePublisher | 1..* | im:Organisation | ||
| sourceSchema | 1..* | xsd:string | ||
| sourceTable | 1..* | xsd:string | ||
| sourceField | 1..* | xsd:string | ||
| sourceRegex | 1..* | xsd:string | ||
| sourceHeading | 1..* | xsd:string | ||
| sourceText | 1..* | xsd:string | ||
| sourceValue | 1..* | xsd:string | ||
Transactional shapes
These shapes form the meta classes for structures pass into APIs for query of, or filing into, the model or health records.