Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Note that this page has been copied from http://build.fhir.org/snomedct.html purely for the purpose of review and consolidating feedback. It would be acceptable to modify this document however, so we have a 'complete' draft to return to HL7.   We'll be able to track the changes through Confluence document history.

Source

SNOMED CT is used in FHIR international standards and resources. SNOMED CT is owned, maintained and distributed

by IHTSDO 
IHTSDO

SNOMED International is

an international organization with countries as members. IHTSDO publishes the international release of SNOMED CT (which is used in FHIR international standards and resources). Each of the IHTSDO member countries

the organization which publishes the International Edition of SNOMED CT. SNOMED International Members may also distribute their own SNOMED CT

edition

National Edition, which contains the international release plus local extension content and derivatives.

System
The URI http://snomed.info/sct Image Modified identifies the SNOMED CT code system.
Version

Where a code system version is used, it should be specified as a

full

URI that represents

the specific distribution (International Release, or National Release and version

a specific SNOMED CT Edition published on a particular date (e.g. the International Edition or a National Edition, with a version date), following the SNOMED CT URI Specification Image Modified (see note below)

Code

The following SNOMED CT artifacts are valid in the code element for the http://snomed.info/sct namespace: Concept

IDs Image RemovedExpressions Image Removed (grammar Image Removed) and SNOMED Legacy codes Image Removed
(
Ids)

Identifiers are not valid as codes in FHIR, nor are other

alternate

alternative identifiers associated with SNOMED CT Concepts

using the RF2 identifier infrastructure. Expressions SHOULD NOT contain terms, only concept IDs (note that when SNOMED CT terms must be exchanged, use

.

Note: when SNOMED CT terms must be exchanged, use the Description Id Extension

)
Display

The correct display for a SNOMED CT concept is one of the

synonyms for the

terms associated with that concept. The best display is the preferred term in the relevant language or dialect, as specified in the associated language reference set

(if applicable). Preferred terms are case sensitive. The Fully Specified Name is not an appropriate choice. The source of preferred name comes from a Language Reference Set. SNOMED CT does not define displays for expressions; if no display has been associated with the expression through a value set or other mechanism, the full expression syntax with preferred terms embedded may be usedInactiveInactive codes are identified using the 'inactive' property (see below)SubsumptionSNOMED CT Subsumption testing is based in the |is a| relationship defined by SNOMED CTFilter PropertiesSeveral properties are defined as described below

This specification publishes a canonical SNOMED CT code system resource. See also the SNOMED CT Usage Summary.

Note: The IHTSDO glossary Image Removed explains some of these SNOMED CT specific terms.

. SNOMED CT synonyms may be case sensitive.

SNOMED International does not define terms for expressions. If a SNOMED terminology producer publishes human-readable terms for expressions in an expression repository, this term may be used as the display. Similarly, if a SNOMED terminology producer publishes an official template for generating terms from an expression, a term generated using the template may be used as the display. If no term or description template has been published, the full expression with terms embedded may be used.

Note that Display is not intended to contain terms entered by the user that have not been officially published by a SNOMED CT Terminology Producer.

InactiveInactive codes are identified using the 'inactive' property (see below).
SubsumptionSNOMED CT Subsumption testing for concepts is based on the |is a| relationship defined by SNOMED CT.
Filter PropertiesSeveral filter properties are defined, as described below.

This specification publishes a canonical SNOMED CT code system resource. See also the SNOMED CT Usage Summary.

Note: The SNOMED International glossary Image Added explains some of these SNOMED CT specific terms.

...

There is no single distribution that contains all defined SNOMED CT codes in all contexts of use. Instead the international release International Edition contains all concepts shared and agreed to be internationally relevant and each national release centre National Release Centre distributes this international release International Edition plus additional national content (to extend that the international set). In addition, other Other release authorities may also be designated. The SNOMED CT URI Specification  describes how to unambiguously reference a particular version of a distributionSNOMED CT edition:

  http://snomed.info/sct/[sctid]/version/[YYYYMMDD]

where [sctid] is the concept id of that identifies the given SNOMED CT distribution (e.g. 32506021000036107 for Australiaedition (based on the identifier of the most dependent module), and the tail "YYYYMMDD" is the date of release. Examples of sctids that identify a specific edition are listed here.


4.2.1.0.3 SNOMED CT Expressions

SNOMED CT Expression is a structured combination of one or more clinical concepts, stated using Compositional Grammar Syntax.

Expressions may optionally contain display terms.


4.2.1.0.4 Copyright and Licenses Image AddedNote that many (by custom, this is usually the last day of the month). Note that many implementations are in the habit of simple simply using the date of release in the form YYYYMMDD (e.g. "20140531"), and assuming that the distribution edition is known. However this is not always safe, so implementations that populate the version element SHOULD must use the full URI form.

...

.

...

This specification includes content from SNOMED Clinical Terms® (SNOMED CT®) which is copyright of the International Health Terminology Standards Development Organisation (IHTSDO). Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact http://www.snomed.org/snomed-ct/get-snomed-ct  or info@snomed.org.

...

The IHTSDO SNOMED International URI specifications uses use the namespace http://snomed.info/sct for the code system, and the URI http://snomed.info/id for the individual concepts in the code system. This means that when a SNOMED CT concept is converted from the system::code pair, where the system is http://snomed.info/sct, to the RDF ontological form, the representation is http://snomed.info/id/[concept-id]. Expressions are represented the same way, except that for this use, expressions using the URI pattern http://snomed.info/scg/[expression]. Expressions represented in this way SHALL not contain whitespace, terms, or comments.

...

In addition to the standard properties, the following properties are defined for SNOMED CT:

Property NameData TypeComments
inactivebooleanWhether the code is active or not (defaults to false). This is derived from the active column in the Concept file of the RF2 Distribution (by inverting the value)
sufficientlyDefinedboolean

True if the description logic definition of the concept includes sufficient conditions

(i.e., if the concept is not primitive - found in the value of definitionStatusId in the concept file

. This is derived from the definitionStatusId value in the Concept file of the RF2 distribution (i.e. If 900000000000073002 |Sufficiently defined concept definition status| then true).

moduleIdcodeThe SNOMED CT concept id of the module that the concept belongs to.
normalFormstringGenerated Necessary Normal form expression for the provided code or expression, with terms. See http://snomed.org/nnf
normalFormTersestringGenerated Necessary Normal form expression for the provided code or expression, conceptIds only.

In addition, any SNOMED CT relationships, where the relationship type is subsumed by Attribute (246061005) 410662002 |Concept model attribute|, also automatically become properties. For example, laterality: Properties that represent SNOMED CT concept model attributes are referred to using their concept id, rather than their human readable term.

For example, the laterality property is represented using the concept id '272741003', rather than the term 'laterality':

Property NameData TypeComments
272741003
code

The value of the laterality attribute in the definition of the given code or expression.

The equivalent URI for the Laterality property

LateralitycodeIn this case, the URI (See the code system definition)

is http://snomed.info/id/272741003

, which can be used to unambiguously map to the underlying concept

(see the code system definition).

Note that when a $lookup operation is performed on a SNOMED CT concept, servers SHALL return the full URI for the edition and version being used (see above) in the version property. Other properties are at the discretion of the server and the client.

...

This section documents the property filters that can be used with the SNOMED CT code system in value set composition statements.

For implementer convenience, some of the property filters are documented in terms of the SNOMED CT Query Language Image RemovedExpression Constraint Language, but this does not imply that its use is required.

...

DescriptionSelect a set of concepts based on subsumption testing
Property Nameconcept
Operations Allowedis-a
Values Allowed[concept id]
CommentsIncludes all concept ids that have a transitive is-a relationship with the concept Id provided as the value (including the concept itself)
ExampleAdministration Methods
<< [concept]  (
or the long form
Long syntax: descendantOrSelfOf [concept])

...

DescriptionSelect a set of concepts based on their membership of a SNOMED CT reference set
Property Nameconcept
Operations Allowedin
Values Allowed[concept id]
CommentsIncludes all concept ids that are active members of the reference set identified by the concept Id provided as the value
^ [concept] 
(or
 
the
 
long
(Long 
form
syntax: memberOf [concept])

...

...

DescriptionSelect a set of concepts based on a formal expression
statement
constraint
Property Nameconstraint
Operations Allowed=
Values Allowed[expression constraint]
Comments

The result of the filter is the result of executing the given SNOMED CT Expression

(Expression Constraint Language) 

Constraint Image Modified
Example:

 "compose": {
  "include": [
    {
      "system": "http://snomed.info/sct",
      "filter": [
        {
          "property": "constraint",
          "op": "=",
          "value": "<< 30506011000036107 |Australian product|: 700000101000036108 |hasTP| = 17311000168105 |Panadol|"
        }
      ]
    }
  ]
}

   

...

...

DescriptionSpecify whether
post-coordination
postcoordination is allowed or not
Property Nameexpressions
Operations Allowed=
Values Allowedtrue or false
CommentsExpressions, if allowed, are subject to the same rules as
pre-coordinated
precoordinated concepts. (Note: simple reference sets do not include expressions
, but Query specification reference sets might
).
ExampleAdministration Methods
n/a

...

Implicit value sets are those whose specification can be predicted based on the grammar of the underlying code system, and the known structure of the URL that identifies them. SNOMED CT has two common sets of implicit value sets defined: By Subsumption, and By Reference Set. These implicit value sets do not use complex queries. This allows a single URL to serve as a value set definition that defines a value set, and can serve as the basis for the $expansion operation.

...

...

<ValueSet xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
     [Some HTML that describes this value set as all concepts in the reference set identified by conceptid]
    </div>
  </text>
  <url value="[edition/version]?fhir_vs=refset/[sctid]"/>
  <version value="[edition/version]"/>
  <name value="SNOMED CT Reference Set [conceptid]"/>
  <description value="All SNOMED CT concepts in the reference set [concept id or preferred description]"/>
  <copyright value="This value set includes content from SNOMED CT, which is copyright © 2002+ International Health Terminology Standards Development Organisation (IHTSDO), and distributed by agreement between IHTSDO and HL7. Implementer use of SNOMED CT is not covered by this agreement"/>
  <status value="active"/>
  <compose>
    <include>
      <system value="http://snomed.info/sct"/>
      <filter>
        <property value="concept"/>
        <op value="in"/>
        <value value="[conceptid]"/>
      </filter>
    </include>
  </compose>
</ValueSet>

...

Implicit concept maps are those whose specification can be predicted based on the grammar and/or content of the underlying code system, and the known structure of the URL that identifies them. This allows a single URL to serve as a concept map definition that defines a mapping between two sets of concepts, and which can serve as the basis for the $translate operation. SNOMED CT has two common sets of implicit concept maps defined:

...

Association Reference Sets  are part of the core SNOMED CT distribution. The following standard Association Reference sets are mapped to implicit Concept Maps:

NameConcept IdRelationship
POSSIBLY EQUIVALENT TO900000000000523009inexact
REPLACED BY900000000000526001equivalent
SAME AS900000000000527005equal
ALTERNATIVE900000000000530003inexact

If any concept map resources exist with an identifier that conforms to the URL pattern specified below, the content of the resource must conform to the template provided. Canonical references to concept maps are allowed to reference these concept maps directly by referring to their URI.

...

...

<ConceptMap xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
     [Some HTML that describes this concept map]
    </div>
  </text>
  <url value="[edition/version]?fhir_cm=[sctid]"/>
  <version value="[edition/version]"/>
  <name value="SNOMED CT [name] Concept Map"/>
  <description value="The concept map implicitly defined by the [name] Association Reference Set"/>
  <copyright value="This value set includes content from SNOMED CT, which is copyright © 2002+ International Health Terminology Standards Development Organisation (IHTSDO), and distributed by agreement between IHTSDO and HL7. Implementer use of SNOMED CT is not covered by this agreement"/>
  <status value="active"/>

  <sourceUri value="[edition/version]?fhir_vs"/>
  <targetUri value="[edition/version]?fhir_vs"/>
  <group>  <!-- 0..* Same source and target systems -->
    <source value="http://snomed.info/sct"/>
    <sourceVersion value="[edition/version]"/>
    <target value="http://snomed.info/sct"/>
    <targetVersion value="[edition/version]"/>

    <!-- a mapping for each member of the reference set -->
    <element>
      <code value="[member]"/>
      <target>
        <code value="[reference set value]"/>
        <equivalence value="[relationship]"/>
      </target>
    </element>
  </group>
</ConceptMap>

Simple Map Reference Sets  (reference sets which are descendants of 900000000000496009 "Simple map") also define an implicit concept map. However, at this time, these cannot be converted to Concept Maps because there is no source for the target code system. Another reference set has been proposed to IHTSDO, and this section will be revisited once it is adopted.implicit concept map. 


...


List of Substantive Changes to the above to discuss with HL7

Expressions

We've added a new section for Expressions.   Bringing other text on the page into line with SNOMED International's definition of what constitutes valid SNOMED CT compositional grammer, we've removed advice about including or not including text definitions - both are considered equally valid, although there may be an argument for including the orginal text selected by the end user.

New Sections - works in progress

These have been removed into their own pages while the text is agreed.   Since they are additional guidance, there is no reason to think that anything being added will 'break' the above.

4.2.1.0.3 Display