DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
Line 3: | Line 3: | ||
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/ IriRef] === | === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23IriRef/ IriRef] === | ||
A reference to resource with an iri and optional name to enable readability | A reference to resource with an iri and optional name to enable readability | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
Line 11: | Line 10: | ||
|Description | |Description | ||
|- | |- | ||
|colspan="2"|<span title="The name of the | |colspan="2"|<span title="The name of the property used for ease of recognition">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23name/ <span style="color:green">name ]</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> | ||
Line 18: | Line 17: | ||
|} | |} | ||
{{Note| Example <br>{"@id" : "sn:29857009", "name" : "Chest pain (finding)"} }} | |||
=== [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Entity/ Entity] === | === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Entity/ 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 | 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 | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 30: | Line 27: | ||
|Description | |Description | ||
|- | |- | ||
|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 preferred full name of the entity | ||
|- | |- | ||
|colspan="2"|<span title="">[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="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span> | |<span title="">[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 | |The base type of the entity i.e. one of the high level entity types | ||
|- | |- | ||
|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="Status of relationship">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23status/ <span style="color:green">status ]</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="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..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> | |<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 | |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 | |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 code scheme or graph which the entity belongs to | |The code scheme or graph which the entity belongs to | ||
|- | |- | ||
|colspan="2"|<span title="">[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="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="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 | |An entity that this entity inherits from, both semantically and structurally, this is also used for sub properties as properties are classes of properties | ||
|- | |- | ||
Line 102: | Line 84: | ||
|} | |} | ||
=== | === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23PropertyNodeShape/ PropertyNodeShape] === | ||
Is a subtype of [[#class_Entity shape|Entity shape]] | |||
| | |||
The data model of a shacl node shape describing a property of a data model entity | The data model of a shacl node shape describing a property of a data model entity | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 172: | Line 101: | ||
|The iri of the property | |The iri of the property | ||
|- | |- | ||
|colspan="2"|<span title="Minimum cardinality,if null assuming any number including zero">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23minCount/ <span style="color:green">minCount ]</span></span> | |||
|0..1 | |0..1 | ||
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span> | |<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span> | ||
|Minimum cardinality,if null assuming any number including zero | |Minimum cardinality,if null assuming any number including zero | ||
|- | |- | ||
|colspan="2"|<span title="The maximum number allowed. If null then any number">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23maxCount/ <span style="color:green">maxCount ]</span></span> | |||
|0..1 | |0..1 | ||
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span> | |<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span> | ||
|The maximum number allowed. If null then any number | |The maximum number allowed. If null then any number | ||
|- | |- | ||
rowspan="3"||or<br>1..1 | |||
|<span title="The iri for the class range of the property. The range of this property is a subclass of this class">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23class/ <span style="color:green">class ]</span></span> | |<span title="The iri for the class range of the property. The range of this property is a subclass of this class">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23class/ <span style="color:green">class ]</span></span> | ||
|1..1 | |1..1 | ||
Line 205: | Line 131: | ||
|The property points to a node shape | |The property points to a node shape | ||
|- | |- | ||
|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="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> | ||
|Description of the property | |Description of the property | ||
|- | |- | ||
|colspan="2"|<span title="The name of the property used for ease of recognition">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23name/ <span style="color:green">name ]</span></span> | |||
|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 name of the property used for ease of recognition | |The name of the property used for ease of recognition | ||
|- | |- | ||
|colspan="2"|<span title="The property order for display">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23order/ <span style="color:green">order ]</span></span> | |||
|0..1 | |0..1 | ||
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span> | |<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span> | ||
Line 245: | Line 168: | ||
|The code for this concept, which may be a local code if local concept, or a core code such as a snomed identifier | |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> | |||
|0..* | |0..* | ||
|<span title="data model for a term code">[[#class_TermCodeShape|TermCodeShape]]</span> | |<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. | |Alternative terms or synonyms for this concept. A term may also have a description id. | ||
|- | |- | ||
|colspan="2"|<span title="weighting to help in search retrieval">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23weighting/ <span style="color:green">weighting ]</span></span> | |||
|0..1 | |0..1 | ||
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span> | |<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 | |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 | |0..1 | ||
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Definitionalstatus/ im:VSET_Definitionalstatus]</span> | |<span title="">[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. | ||
|- | |- | ||
|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..* | |0..* | ||
|<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> | ||
|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 | |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 | |0..1 | ||
|<span title="whole number">[https://www.w3.org/TR/xmlschema-2/#integer xsd:integer]</span> | |<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 | |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 | |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> | ||
|pointer the original identifer in IM1 | |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..* | |0..* | ||
|<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23VSET_Unspecified/ im:VSET_Unspecified]</span> | |<span title="">[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 | ||
|- | |- | ||
|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..* | |0..* | ||
|<span title="Data model for source context for a concept e.g. source system, field etc">[[#class_SourceContextShape|SourceContextShape]]</span> | |<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 | |The source context object for this concept indicating the system, table, field and organisation that published this legacy concept | ||
|- | |- | ||
|colspan="2"|<span title="">[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> | ||
|Indicates the concepts that this concept has been replaced by | |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..* | |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 307: | Line 220: | ||
|} | |} | ||
=== | === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23TermCodeShape/ TermCodeShape] === | ||
data model for a term code | data model for a term code | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 484: | Line 234: | ||
| | | | ||
|- | |- | ||
|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> | |||
|0..* | |0..* | ||
|<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> | ||
| | | | ||
|- | |- | ||
|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> | |||
|0..* | |0..* | ||
|<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> | |<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> | ||
Line 498: | Line 246: | ||
|} | |} | ||
=== | === [https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23SourceContextShape/ SourceContextShape] === | ||
Is a subtype of [[#class_Entity shape|Entity shape]] | |||
Data model for source context for a concept e.g. source system, field etc | Data model for source context for a concept e.g. source system, field etc | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 512: | Line 263: | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title="Points to the source organisation that published this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourcePublisher/ <span style="color:green">sourcePublisher ]</span></span> | |||
|1..* | |1..* | ||
|<span title="A record of an organisation and its relationships. Named collections of people that have come together to achieve an objective">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Organisation/ im:Organisation]</span> | |<span title="A record of an organisation and its relationships. Named collections of people that have come together to achieve an objective">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23Organisation/ im:Organisation]</span> | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title="Points to the source extract or message type that published this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceSchema/ <span style="color:green">sourceSchema ]</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> | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title="Points to the source table or resource or message segment that published this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceTable/ <span style="color:green">sourceTable ]</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> | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title="Points to the source field, element or message field that published this concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceField/ <span style="color:green">sourceField ]</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> | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title="Points to the source regex or other pattern match used when creating the concept from a mix of code and term">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceRegex/ <span style="color:green">sourceRegex ]</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> | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title="the source code or term that acts as the heading for a text qualifier such as negative or positive">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceHeading/ <span style="color:green">sourceHeading ]</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> | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title="the source text for a text map">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceText/ <span style="color:green">sourceText ]</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> | ||
| | | | ||
|- | |- | ||
|colspan="2"|<span title="The orignal field value used to create the concept">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23sourceValue/ <span style="color:green">sourceValue ]</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> |
Revision as of 07:53, 21 September 2022
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
Property | Card. | Value type | Description | |
name | 1..1 | xsd:string | The name of the entity |
Example {"@id" : "sn:29857009", "name" : "Chest pain (finding)"} |
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
Property | Card. | Value type | Description | |
label | 1..1 | xsd:string | The preferred full name of the entity | |
type | 1..1 | rdfs:Resource | The base type of the entity i.e. one of the high level entity types | |
comment | 0..1 | xsd:string | The description of the entity | |
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, this is also used for sub properties as properties are classes of properties |
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
Property | Card. | Value type | Description | |
property | 0..* | PropertyNodeShape |
PropertyNodeShape
Is a subtype of Entity shape
The data model of a shacl node shape describing a property of a data model entity
rowspan="3"||or1..1
Property | Card. | Value type | Description | |
path | 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 | |
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
Property | Card. | Value type | Description | |
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 |
TermCodeShape
data model for a term code
Property | Card. | Value type | Description | |
label | 0..* | xsd:string | ||
code | 0..* | xsd:string | ||
status | 0..* | im:Status |
SourceContextShape
Is a subtype of Entity shape
Data model for source context for a concept e.g. source system, field etc
Property | Card. | Value type | Description | |
sourceSystem | 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.