CTS2/doc/Entity Example SNOMED CT

From HL7Wiki
Jump to navigation Jump to search

The following example shows how the SNOMED CT lexical description of Perinatal epistaxis could be represented in the CTS2 format.

Minimal XML

The XML below represents the minimum amount of information that would be needed to completely represent the basic information about a concept from SNOMED CT.

<?xml version="1.0" ?>
<EntityDescription xmlns="http://schema.omg.org/spec/CTS2/1.0/Entity"
                   xmlns:core="http://schema.omg.org/spec/CTS2/1.0/Core">
    <classDescription entryState="ACTIVE" about="http://id.ihtsdo.org/sctid/206421002" descriptionState="PRIMITIVE">
        <entityID>
            <core:namespace>sctid</core:namespace>
            <core:name>206421002</core:name>
        </entityID>
        <alternateEntityID>
            <core:namespace>sctfsn</core:namespace>
            <core:name>Perinatal epistaxis (disorder)</core:name>
        </alternateEntityID>
        <describingCodeSystemVersion>
            <core:version uri="http://id.ihtsdo.org/sctid/900000000000207008/20120131"/>
        </describingCodeSystemVersion>
        <designation externalIdentifier="316560014" designationRole="PREFERRED">
            <core:value>Perinatal epistaxis</core:value>
            <core:language>US English</core:language>
            <caseSignificance uri="http://id.ihtsdo.org/sctid/900000000000020002"/>
        </designation>
        <designation externalIdentifier="316561013" designationRole="ALTERNATIVE">
            <core:value>Perinatal nose hemorrhage</core:value>
            <core:language>US English</core:language>
            <caseSignificance uri="http://id.ihtsdo.org/sctid/900000000000020002"/>
        </designation>
        <entityType uri="http://www.w3.org/2002/07/owl#Class"/>
    </classDescription>
</EntityDescription>

JSON Equivalent

{  "EntityDescription": {
        "classDescription": {
            "entryState": "ACTIVE",
            "descriptionState": "PRIMITIVE",
            "designation": [
                {   "value": "Perinatal epistaxis",
                    "designationRole": "PREFERRED",
                    "externalIdentifier": 316560014,
                    "language": {
                        "content": "US English"
                    },
                    "caseSignificance": {
                        "uri": "http://id.ihtsdo.org/sctid/900000000000020002"
                    }
                },
                {   "assertedInCodeSystemVersion": "SNOMED CT core_20120131",
                    "value": "Perinatal nose hemorrhage",
                    "designationRole": "ALTERNATIVE",
                    "externalIdentifier": 316561013,
                    "language": {
                        "content": "US English"
                    },
                    "caseSignificance": {
                        "uri": "http://id.ihtsdo.org/sctid/900000000000020002"
                    }
                }
            ],
            "about": "http://id.ihtsdo.org/sctid/206421002",
            "alternateEntityID": {
                "name": "Perinatal epistaxis (disorder)",
                "namespace": "sctfsn"
            },
            "entityType": {
                "uri": "http://www.w3.org/2002/07/owl#Class",
            },
            "describingCodeSystemVersion": {
                "version": {
                    "uri": "http://id.ihtsdo.org/sctid/900000000000207008/20120131"
                }
            },
            "entityID": {
                "name": 206421002,
                "namespace": "sctid"
            }
        },
        "xmlns": "http://schema.omg.org/spec/CTS2/1.0/Entity"
    }
}

Service Enhanced XML

One of the values that a CTS2 Service implementation adds to a resource is that it "completes the picture" inserting URI's, names and hyperlinks to additional information it knows about. The above example, when retrieved from the URL could return something that looked like the output below.

<?xml version="1.0" encoding="UTF-8"?>
<EntityDescriptionMsg xmlns="http://schema.omg.org/spec/CTS2/1.0/Entity"
    xmlns:core="http://schema.omg.org/spec/CTS2/1.0/Core"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://schema.omg.org/spec/CTS2/1.0/Entity 
    http://www.omg.org/spec/CTS2/130601/entity/Entity.xsd">
    <heading xmlns="http://schema.omg.org/spec/CTS2/1.0/Core">
        <resourceRoot>codesystems/SNOMED_CT_core/version20120131/entity/206421002</resourceRoot>
        <resourceURI>http://informatics.mayo.edu/cts2/rest/codesystems/SNOMED_CT_core/version20120131/entity/206421002</resourceURI>
        <accessDate>2012-07-13T15:02:05.909Z</accessDate>
    </heading>
    <EntityDescription>
        <classDescription entryState="ACTIVE" about="http://id.ihtsdo.org/sctid/206421002" descriptionState="PRIMITIVE">
            <entityID>
                <core:namespace>sctid</core:namespace>
                <core:name>206421002</core:name>
            </entityID>
            <alternateEntityID>
                <core:namespace>sctfsn</core:namespace>
                <core:name>Perinatal epistaxis (disorder)</core:name>
            </alternateEntityID>
            <describingCodeSystemVersion>
                <core:version uri="http://id.ihtsdo.org/sctid/900000000000207008/20120131" 
                    href="http://informatics.mayo.edu/cts2/rest/codesystem/SNOMED_CT_core/version/20120131">SNOMED CT core_20120131</core:version>
                <core:codeSystem uri="http://id.ihtsdo.org/sctid/900000000000207008" 
                    href="http://informatics.mayo.edu/cts2/rest/codesystem/SNOMED_CT_core">SNOMED CT core</core:codeSystem>
            </describingCodeSystemVersion>
            <designation assertedInCodeSystemVersion="SNOMED CT core_20120131" externalIdentifier="316560014" designationRole="PREFERRED">
                <core:value>Perinatal epistaxis</core:value>
                <core:language uri="http://www.omg.org/spec/LNG#en-us" 
                    href="http://informatics.mayo.edu/cts2/rest/codesystem/LNG/version/2012/entity/en-us">US English</core:language>
                <caseSignificance uri="http://id.ihtsdo.org/sctid/900000000000020002"
                    href="http://informatics.mayo.edu/cts2/rest/codesystems/SNOMED_CT_model_component/version20120131/entity/900000000000020002">Initial character case insensitive</caseSignificance>
            </designation>
            <designation assertedInCodeSystemVersion="SNOMED CT core_20120131" externalIdentifier="316561013" designationRole="ALTERNATIVE">
                <core:value>Perinatal nose hemorrhage</core:value>
                <core:language uri="http://www.omg.org/spec/LNG#en-us"
                    href="http://informatics.mayo.edu/cts2/rest/codesystem/LNG/version/2012/entity/en-us">US English</core:language>
                <caseSignificance uri="http://id.ihtsdo.org/sctid/900000000000020002"
                    href="http://informatics.mayo.edu/cts2/rest/codesystems/SNOMED_CT_model_component/version20120131/entity/900000000000020002">Initial character case insensitive</caseSignificance>
            </designation>
            <subjectOf>http://informatics.mayo.edu/cts2/rest/codesystems/SNOMED_CT_core/version20120131/entity/206421002/subjectof</subjectOf>
            <targetOf>http://informatics.mayo.edu/cts2/rest/codesystems/SNOMED_CT_core/version20120131/entity/206421002/targetof</targetOf>
            <parent uri="http://id.ihtsdo.org/sctid/111467008" href="http://informatics.mayo.edu/cts2/rest/codesystems/SNOMED_CT_core/version20120131/entity/111467008">
                <core:namespace>sctfsn</core:namespace>
                <core:name>Fetal OR neonatal hemorrhage (disorder)</core:name>
            </parent>
            <parent uri="http://id.ihtsdo.org/sctid/12441001"  href="http://informatics.mayo.edu/cts2/rest/codesystems/SNOMED_CT_core/version20120131/entity/12441001">
                <core:namespace>sctfsn</core:namespace>
                <core:name>Epistaxis (disorder)</core:name>
            </parent>
            <children>http://informatics.mayo.edu/cts2/rest/codesystems/SNOMED_CT_core/version20120131/entity/206421002/targetof</children>
            <entityType uri="http://www.w3.org/2002/07/owl#Class" href="http://informatics.mayo.edu/cts2/rest/codesystem/owl/version/20091027/entity/Class">
                <core:namespace>owl</core:namespace>
                <core:name>Class</core:name>
            </entityType>
        </classDescription>
    </EntityDescription>
</EntityDescriptionMsg>

Navigation – Common Terminology Services (CTS2)

   Home
About CTS2
   Purpose
   CTS2 History
   Business Case
How it works
   Federation
   Functionality
Implementing CTS2
   Architecture
   Development
Resources
   Purpose
   FAQ
   Business Case
   Glossary of Terms
Specification
   REST
   SOAP
   HL7 SFM
Development
   CTS2 Development Framework
   Implementations
  Github Page
Community
   Who is Using CTS2?
   Get Help
   Links