R4 Ballot #1 (Mixed Normative/Trial use)
TerminologyThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R4B R4 R3 R2
| Vocabulary Work Group | Maturity Level: 5 | Ballot Status: Trial Use |
| Source | SNOMED CT is owned, maintained and distributed by SNOMED International .
SNOMED International is the organization which publishes the International Edition of SNOMED CT. SNOMED International Members may also distribute their own SNOMED CT National Edition, which contains the international release plus local extension content and derivatives.
|
| System | The URI http://snomed.info/sct identifies the SNOMED CT code system. |
| Version | Where a code system version is used, it should be specified as a URI that represents 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 (see note below).
|
| Code | The following SNOMED CT artifacts are valid in the code element for the http://snomed.info/sct namespace:
Concept IDs and
SNOMED CT Expressions (using SNOMED CT Compositional Grammar ). SNOMED CT Terms and Description Identifiers are not valid as codes in FHIR, nor are other alternative identifiers associated with SNOMED CT Concepts.
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 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. 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. |
| Inactive | Inactive codes are identified using the 'inactive' property (see below) |
| Subsumption | SNOMED CT Subsumption testing is based in the |is a| relationship defined by SNOMED CT |
| Filter Properties | Several 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 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 Edition contains all concepts shared and agreed to be
internationally relevant and each National Release Centre distributes this
International Edition plus additional national content (to extend the
international set). Other release authorities may also be designated. The SNOMED CT URI Specification describes how to
unambiguously reference a particular version of a SNOMED CT edition:
http://snomed.info/sct/[sctid]/version/[YYYYMMDD]
where [sctid] is the concept id that identifies the given SNOMED CT edition
(based on the identifier of the most dependent module), and
"YYYYMMDD" is the date of release. Examples of sctids that identify a specific edition
are listed here .
Note that many implementations are in the habit of simply using the date of release in the form YYYYMMDD (e.g. "20140531"), and assuming that the distribution is known. However this is not always safe, so implementations that populate the version element SHOULD use the URI form (as shown above). Note also that in future SNOMED CT releases the date format may be extended to a timestamp as YYMMDDThhmmssZ (allowed per the SNOMED CT URI Specification).
Servers SHOULD regard provision of the date only for the version (without an sctid) as an error, and refuse to process the interaction or operation. At minimum the URI SHOULD contain the sctid of the SNOMED CT distribution:
http://snomed.info/sct/[sctid]
Implementers must note, if no version URI is provided when utilizing SNOMED CT, the Terminology Service may default to the most recent version of the SNOMED CT International Edition available on the service (or the latest available of another edition that may be preferred for the locale). Further, if the date of release is not provided, the Terminology Service may default to the most recent version of the named SNOMED CT distribution (e.g. 32506021000036107 for Australia).
This specification includes content from SNOMED Clinical Terms® (SNOMED CT®) which is copyright of the
International Health Terminology Standards
Development Organisation (IHTSDO) (trading as SNOMED International). 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.
A SNOMED
CT Expression is a structured combination of one or more clinical
concepts, stated using Compositional Grammar
Syntax .
Note that expressions may optionally contain display terms.
The SNOMED International URI specification uses 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 SHALL NOT contain whitespace, terms, or comments.
In addition to the standard properties, the following properties are defined for SNOMED CT:
| Property Name | Data Type | Comments |
| inactive | boolean | Whether 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). |
| sufficientlyDefined | boolean | True if the description logic definition of the concept includes sufficient conditions. 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). |
| moduleId | code | The SNOMED CT concept id of the module that the concept belongs to. |
| normalForm | string | Generated Normal Form expression for the provided code or expression. |
SNOMED CT relationships, where the relationship type is subsumed by 410662002 |Concept model attribute|, also automatically become properties. 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 Name | Data Type | Comments |
| 272741003 | code |
The equivalent URI for the Laterality property is |
Note that when a $lookup operation is performed on a SNOMED CT concept,
servers SHALL return the 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 Expression Constraint Language , but this does not imply that its use is required.
| Description | Select a set of concepts based on subsumption testing |
| Property Name | concept |
| Operations Allowed | is-a |
| Values Allowed | [concept id] |
| Comments | Includes all concept ids that have a transitive is-a relationship with the concept Id provided as the value (including the concept itself) |
| Example | Administration Methods |
| SCT ECL | << [concept] (Long syntax: descendantOrSelfOf [concept]) |
| Description | Select a set of concepts based on their membership of a SNOMED CT reference set |
| Property Name | concept |
| Operations Allowed | in |
| Values Allowed | [concept id] |
| Comments | Includes all concept ids that are active members of the reference set identified by the concept Id provided as the value |
| SCT ECL | ^ [concept] (Long syntax: memberOf [concept]) |
| Description | Select a set of concepts based on a formal expression constraint |
| Property Name | constraint |
| Operations Allowed | = |
| Values Allowed | [expression constraint] |
| Comments |
The result of the filter is the result of executing the given SNOMED CT Expression Constraint .
Example:
"compose": {
"include": [
{
"system": "http://snomed.info/sct",
"filter": [
{
"property": "constraint",
"op": "=",
"value": "<< 30506011000036107 |Australian product|: 700000101000036108 |hasTP| = 17311000168105 |Panadol|"
}
]
}
]
}
|
| Description | Specify whether postcoordination is allowed or not |
| Property Name | expressions |
| Operations Allowed | = |
| Values Allowed | true or false |
| Comments | Expressions, if allowed, are subject to the same rules as precoordinated concepts. [Note: Simple reference sets do not include expressions.] |
| Example | Administration Methods |
| SCT ECL | 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. Implicit value sets can also be defined using an expression constraint. The implicit value set capability allows a single URL to serve as a value set definition, and can serve as the basis for the $expand operation and for other value set references.
If any value set resources exist with an identifier that conforms to the URL patterns specified below, the content of the resource must conform to the template provided. Profiles and other value set references are allowed to reference these value sets directly (by reference as a URI, rather than by a literal value set reference).
A SNOMED CT implicit value set URL has two parts:
, or the URI for the edition version, in the format specified by SNOMED International in the SNOMED CT URI Specification
The URL http://snomed.info/sct should be understood to mean an unspecified edition/version. This defines an incomplete value set whose
actual membership will depend on the particular edition used when it is expanded. If no version or edition is specified, the terminology
service SHALL use the latest version available for its default edition (or the International Edition, if no other edition is the default).
For the second part of the URL (the query part), the 5 possible values are:
, this means all possible SNOMED CT conceptsA value set with a URL that follows the pattern "[edition/version]?fhir_vs=isa/[sctid]" follows this template:
<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 subsumed by sctid]
</div>
</text>
<url value="[edition/version]?fhir_vs=isa/[sctid]"/>
<version value="[edition/version]"/>
<name value="SNOMED CT Concept [sctid] and descendants"/>
<description value="All SNOMED CT concepts for [sctid or preferred description]"/>
<copyright value="This value set includes content from SNOMED CT, which is copyright © 2002+ International Health Terminology Standards Development Organisation (SNOMED International), and distributed by agreement between SNOMED International 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="is-a"/>
<value value="[sctid]"/>
</filter>
</include>
</compose>
</ValueSet>
The value set with a url that follows the pattern "[edition/version]?fhir_vs=refset" follows this template:
<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 with associated reference sets]
</div>
</text>
<url value="[edition/version]?fhir_vs=refset"/>
<version value="[edition/version]"/>
<name value="SNOMED CT Reference Sets"/>
<description value="All SNOMED CT concepts associated with a reference set"/>
<copyright value="This value set includes content from SNOMED CT, which is copyright © 2002+ International Health Terminology Standards Development Organisation (SNOMED International), and distributed by agreement between SNOMED International and HL7. Implementer use of SNOMED CT is not covered by this agreement"/>
<status value="active"/>
<compose>
<include>
<system value="http://snomed.info/sct"/>
<!-- repeat: one concept element with a code for each concept that has an associated reference set -->
<concept>
<code value="[sctid]"/>
</concept>
<!-- end repeat -->
</include>
</compose>
</ValueSet>
For each concept that is associated with a reference set, there will be one 'concept' element with a contained 'code' element that contains the sctid.
A value set with a url that follows the pattern "[edition/version]?fhir_vs=refset/[sctid]" follows this template:
<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 sctid]
</div>
</text>
<url value="[edition/version]?fhir_vs=refset/[sctid]"/>
<version value="[edition/version]"/>
<name value="SNOMED CT Reference Set [sctid]"/>
<description value="All SNOMED CT concepts in the reference set [sctid or preferred description]"/>
<copyright value="This value set includes content from SNOMED CT, which is copyright © 2002+ International Health Terminology Standards Development Organisation (SNOMED International), and distributed by agreement between SNOMED International 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="[sctid]"/>
</filter>
</include>
</compose>
</ValueSet>
A value set with a url that follows the pattern "[edition/version]?fhir_vs=ecl/[ecl]" follows this template:
<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 that match the expression constraint ecl]
</div>
</text>
<url value="[edition/version]?fhir_vs=ecl/[ecl]"/>
<version value="[edition/version]"/>
<name value="SNOMED CT Concepts matching [ecl]"/>
<description value="All SNOMED CT concepts that match the expression constraint [ecl]"/>
<copyright value="This value set includes content from SNOMED CT, which is copyright © 2002+ International Health Terminology Standards Development Organisation (SNOMED International), and distributed by agreement between SNOMED International 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="constraint"/>
<op value="="/>
<value value="[ecl]"/>
</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 can be used for implicit
concept maps:
| Name | Concept Id | Relationship |
| POSSIBLY EQUIVALENT TO | 900000000000523009 | inexact |
| REPLACED BY | 900000000000526001 | equivalent |
| SAME AS | 900000000000527005 | equal |
| ALTERNATIVE | 900000000000530003 | inexact |
Simple Map Reference Sets
(reference sets which are descendants of 900000000000496009 "Simple map") also define an implicit concept map.
A SNOMED CT implicit concept map URL has two parts:
, or the URI for the edition version, in the format specified by SNOMED International in the SNOMED CT URI Specification
The URL http://snomed.info/sct should be understood to mean an unspecified edition/version. This defines an incomplete concept map whose actual membership will depend on the particular edition being used. If no version or edition is specified, the terminology service SHALL use the latest version available for its default edition (or the International Edition, if no other edition is the default).
For the second part of the URL (the query part), there is only one possible value:
A concept map with a URL that follows the pattern "[edition/version]?fhir_cm=[sctid]" follows this template, where [name], [sctid] and [relationship] are taken from the table above:
<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 (SNOMED International), and distributed by agreement between SNOMED International 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>
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:19+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change