...
The code comprises the following three sub-elements. The Type sub-element is required in all cases, other elements are required where relevant and otherwise omitted.
| Caption label |
|---|
| CapId | filetype-element-sub-elements-and-permitted-values |
|---|
| CapType | Table |
|---|
|
FileType Element - Sub-elements and Permitted Values |
| Table width manager |
|---|
|
| Sub-element | Values | Description | | Status | <blank> | General release file | | x | Provisional release file (e.g. part of an | Gloss |
|---|
| PreSpace | false |
|---|
| t | alpha |
|---|
| GlosTerm | alpha release package |
|---|
|
or | Gloss |
|---|
| PreSpace | false |
|---|
| t | beta release package |
|---|
|
). | | z | Archival or unsupported file | | Type | sct | Terminology Data File | | der | Derivative Work Data File (e.g. Reference set release file) | | doc | Documentation | | res | Implementation Resource Data File (e.g. a data file not following a SNOMED CT standard release file format) | | tls | Implementation Resource Tool (e.g. scripts or other software made available to process a release file) | | Format | 1 | Release Format 1 | | 2 | Release Format 2 | | <blank> | Not specific to a release version |
|
...
The content of this element depends on the first element (FileType) of the filename, as described below:
| Caption label |
|---|
| CapId | contenttype-element-permitted-values-for-filetype-sct- |
|---|
| CapType | Table |
|---|
|
ContentType Element - Permitted Values for FileType "sct" |
| Table width manager |
|---|
|
| Table width manager |
|---|
|
| Value | Usage | | Concept | The file conforms to the 4.2.1 Concept File Specification and contains data related to a set of . | | Relationship | The file conforms to the 4.2.3 Relationship File Specification and contains | Gloss |
|---|
| PreSpace | false |
|---|
| t | relationships |
|---|
|
that represent the | Gloss |
|---|
| PreSpace | false |
|---|
| t | distribution normal form |
|---|
|
| Gloss |
|---|
| PreSpace | false |
|---|
| t | inferred view |
|---|
|
of a set of concept definitions. | | sRefset | The file conform to the single string reference set format. This only applies to the OWL Expression Reference Set and followed by the content sub-element _OWLExpression which contains stated represented as and additional information. | | Description | The file conforms to the 4.2.2 Description File Specification and contains at set of | Gloss |
|---|
| PreSpace | false |
|---|
| t | descriptions |
|---|
|
with description types | Concept |
|---|
| ShowParts | term |
|---|
| t | 900000000000013009 Synonym |
|---|
|
and | Concept |
|---|
| ShowParts | term |
|---|
| t | 900000000000003001 Fully specified name |
|---|
|
. Note that both these description types have a maximum length of 255 characters. | | TextDefinition | The file conforms to the 4.2.2 Description File Specification and contains at set of | Gloss |
|---|
| PreSpace | false |
|---|
| t | descriptions |
|---|
|
with description type . Note: This description type has a maximum length of 4096 characters. | | StatedRelationship | The file conforms to the 4.2.3 Relationship File Specification and contains | Gloss |
|---|
| PreSpace | false |
|---|
| t | relationships |
|---|
|
that represent the | Gloss |
|---|
| PreSpace | false |
|---|
| t | stated view |
|---|
|
of a set of concept definitions. Note: It is likely this file will be phased out and replaced with a reference set containing a richer OWL representation of stated concept definition. | | Identifier | The file conforms to the 4.2.4 Identifier File Specification. Note: This file does not contain any data rows in the International Edition. |
|
| captiontable-width-labelmanager |
|---|
| CapId | contenttype-element-permitted-values-for-filetype-der- |
|---|
| CapType | Table |
|---|
|
ContentType Element - Permitted Values for FileType "der" |
|
| Table width manager |
|---|
|
| Value | Description | | Refset | The file conforms to the 5.2.1.1 Simple Reference Set specification and contains the members of one or more simple reference sets. | | <pattern>Refset | The file conforms to the 5.1.1 Basic Reference Set Member File Format and include one or more additional columns, The number and order of the columns and their basic data types are specified by the <pattern> which precedes Refset. The <pattern> consists of a sequence of lowercase letters each of which represent an additional column with a datatype specified by the letter as listed below | Pattern letter | | | c | A SNOMED CT component identifier ( ) referring to a concept, description or relationship. | | i | A signed integer. | | s | | | Examples | |
|
| Caption label |
|---|
| CapId | contenttype-element-permitted-values-for-filetypes-doc-res-and-tls- |
|---|
| CapType | Table |
|---|
|
ContentType Element - Permitted Values for FileTypes "doc","res" and "tls" |
...
| Table width manager |
|---|
|
| FileType | Value and Description | | doc | The title of the document in CamelCase, abbridges if necessary to fit within the length constraint. Note: Abbreviations should not be used unless they are essential to fit the title within the available length. Examples of ContentType for Documents - doc_SnomedDecisionSupport_Current-en-US_INT_20170331.pdf (Title: Decision Support with SNOMED CT)
- doc_SearchDataEntryGuide_Current-en-US_INT_20171122 (Title: SNOMED CT Search and Data Entry Guide)
| res tls | The value of the ContentType element may be determined on a case-by-case basis but, in conjunction with the ContentSubType element, should be adequate to identify the content and purpose of the file. |
|
ContentSubType Element
The ContentSubType element is mandatory for all FileTypes. It provides additional information to describe the content and purpose of the file, including the
/ , where appropriate. Its format is 2-48 alphanumeric characters in camel case (except for the capitalization rules specified below for ...
The title of the document in CamelCase, abbridges if necessary to fit within the length constraint.
Note: Abbreviations should not be used unless they are essential to fit the title within the available length.
Examples of ContentType for Documents
- doc_SnomedDecisionSupport_Current-en-US_INT_20170331.pdf (Title: Decision Support with SNOMED CT)
- doc_SearchDataEntryGuide_Current-en-US_INT_20171122 (Title: SNOMED CT Search and Data Entry Guide)
...
res
tls
...
ContentSubType Element
The ContentSubType element is mandatory for all FileTypes. It provides additional information to describe the content and purpose of the file, including the
/ , where appropriate. Its format is 2-48 alphanumeric characters in camel case (except for the capitalization rules specified below for code). Hyphen (" - ") is code). Hyphen (" - ") is a permitted character in conjunction with a language code, as described below.| Caption label |
|---|
| CapId | sct-content-subtype-element |
|---|
| CapType | Table |
|---|
|
ContentSubType Element - Sub-elements and Permitted Values for FileTypes "sct" and "der" |
| table-width-table-width-manager |
|---|
|
| Sub-elements | Values | Description | | Summary |
| An optional short camel case summary of the usage of the file. The value of this sub-element may be determined on a case-by-case basis but, in conjunction with the ContentType element, should be adequate to identify the content and purpose of the file. Examples: - For references sets a brief indication about the type or purpose the reference set(s) in the file.
Note: If there is a summary the ReleaseType or DocStatus follows this Summary sub-element immediately without a space or other separator. | | ReleaseType | Full | The file contains the Full view of the components or refset members within its scope (i.e. every version ever released). | | Snapshot | The file contains the Snapshot view of the components or refset members within its scope (i.e. only the most recent version released). | | Delta | The file contains the Delta view of the components or refset members within its scope (i.e. only additions/changes since previous release). | | LanguageCode | | Where it is necessary to specify the language or dialect used in a file, the appropriate language code must be included as the final sub-element of the ContentSubType. If a Summary or DocStatus sub-element is also included, the LanguageCode must be added after the last of those sub-elements and must be separated from it by a hyphen. Representation of the LanguageCode The language is specified with a 2 character ISO 639-1 language code (e.g. es = Spanish, fr = French, da = Danish). If necessary, a dialect code is added after the langauge language code and seperated separated from it by a hyphen. Depending on the specificity required the dialect code comes from one of two sources: If the dialect is general to an entire country, the two-letter ISO-3166 alpha-2 country code is used to specify the dialect (e.g. en-US = US English, en-GB British English) If dialect is less common or not country specific, the IANA language subtag should be used. Note this code consists strings of lower case letres letters. IANA is the Internet Assigned Numbers Authority.
This approach follows Internet conventions. |
|
| captiontable-width-label |
|---|
| CapId | contentsubtype-element-sub-elements-and-permitted-values-for-filetype-doc- |
|---|
| CapType | Table |
|---|
|
ContentSubType Element - Sub-elements and Permitted Values for FileType "doc" |
| manager |
|---|
| Table width manager |
|---|
|
| Sub-elements | Values | Description | | Summary |
| An optional short camel case addition to the ContentType title. If there is a Summary the DocStatus follows this Summary sub-element immediately without a space or other separator. | | DocStatus | Current | The document is up-to-date and complete for the current release of SNOMED CT, as indicated by the VersionDate element. | | Draft | The document is a draft version; it may be incomplete and has not been approved in a final version. | | Review | The document has been released for review and comments from SNOMED International Members, Affiliates and other stakeholders. | | LanguageCode |
| Where it is necessary to specify the language or dialect used in a file, the appropriate language code must be included as the final sub-element of the ContentSubType. If a Summary or DocStatus sub-element is also included, the LanguageCode must be added after the last of those sub-elements and must be separated from it by a hyphen. Representation of the LangageCode is described in detail in the final row of | Caption reference |
|---|
| CapRefId | sct-content-subtype-element |
|---|
| CapRefType | Table |
|---|
|
. |
|
| Caption label |
|---|
| CapId | contentsubtype-element-sub-elements-and-permitted-values-for-filetypes-res-and-tls- |
|---|
| CapType | Table |
|---|
|
as the final sub-element of the ContentSubType. If a Summary or DocStatus sub-element is also included, the LanguageCode must be added after the last of those sub-elements and must be separated from it by a hyphen. Representation of the LangageCode is described in detail in the final row of . |
|
| Table width manager |
|---|
|
| Sub-elements | Values and Description | | Summary | The value of this sub-element may be determined on a case-by-case basis but, in conjunction with the ContentType element, should be adequate to identify the content and purpose of the file. | | LanguageCode | If it is necessary to specify the language or dialect used in a resource data file or tool, the appropriate language code must be included as the final sub-element of the ContentSubType. If a Summary sub-element is also included, the LanguageCode must be added after the Summary sub-element and must be separated from it by a hyphen. hyphen. Representation of the LangageCode is described in detail in the final row of Representation of the LangageCode is described in detail in the final row of | Caption reference |
|---|
| CapRefId | sct-content-subtype-element |
|---|
| CapRefType | Table |
|---|
|
. |
|
Examples of ContentSubType
...
The CountryNamespace element is mandatory for all FileTypes. It identifies the organization responsible for developing and maintaining the file. It is a string of 2 to 10 alphanumeric characters consisting of the two sub-elements described below. At least one of these two sub-elements must be present.
| Gloss |
|---|
| PreSpace | false |
|---|
| t | SNOMED International |
|---|
|
or a | Gloss |
|---|
| PreSpace | false |
|---|
| t | National Release Center (NRC) |
|---|
| GlosTerm | National Release Center |
|---|
|
may optionally include both sub-elements where they consider this to be appropriate....
| CapId | countrynamespace-element-sub-elements-and-permitted-values |
|---|
| CapType | Table |
|---|
...
may optionally include both sub-elements where they consider this to be appropriate.
| Table width manager |
|---|
|
| Sub-element | Values | Description | | CountryCode | INT | The file is maintained and distributed by SNOMED International. | AA to ZZ | The file is maintained and distributed by the | Gloss |
|---|
| PreSpace | false |
|---|
| t | NRC |
|---|
| GlosTerm | National Release Center |
|---|
|
for the country represented by this ISO-3166 alpha-2 country code. The code consists of exactly two uppercase characters from the latin alphabet. | | <blank> | The file is maintained and released by an SNOMED CT extension provider that is not an NRC. | | NamespaceId | 0000000 to 9999999 | The file is maintained and released by an SNOMED CT extension provider that is not an NRC. In which case, this value is a 7 digit | Gloss |
|---|
| PreSpace | false |
|---|
| t | namespace identifier |
|---|
|
allocated to that organization by SNOMED International. The file is maintained and distributed by either SNOMED International or an NRC and the distributing organization has chosen to include the namespace identifier to indicate that this is part of a release restricted to content in a single namespace. | | <blank> | The file is maintained and distributed by either SNOMED International or an NRC and the distributing organization has not chosen to include the namespace identifier to indicate that this is part of a release restricted to content in a single namespace. |
|
...
The extension element of the filename identifies the file format (encoding convention) of the file, such as " txt ", " pdf " or " zip ". It has a format of 1-4 alphanumeric characters.
...
| CapId | file-extensions-applicable-to-different-filetypes |
|---|
| CapType | Table |
|---|
...
| Table width manager |
|---|
|
| FileType | Values | Description | sct or der | txt | All RF2 formatted release files are distributed as plain text UTF-8 files with the .txt suffix. | | doc | pdf | Portable Document Format is the default format for documents distributed and made available for download in a format suitable for local viewing or printing. | | <other> | Other document formats including plain text (.txt) and HTML (.html) may be used where deemed appropriate. In all cases the file extension (suffix) used should be one of the widely recognized format. Unless there are exceptional requirements, the format should be accessible using freely available software. | | res | txt | Most resources should be provided as plain text UTF-8 files with the .txt suffix. | zip
| Where appropriate a resource file, or a collection of such files, may be distributed as zip archive. | | <other> | Other data formats may be used where appropriate. | | tls | <any> | No specific statements are made about the file extsions to be used for tooling files. However, in general such tools should be provided in a format that does not compromise system security. In most cases, tools should be provided through an interface such as GitHub and should not be included as part of general releases of the terminology. |
|
...