É sabido que membros e afiliados que desenvolvem conjuntos de referências têm a necessidade de criar versões legíveis dos conjuntos de referências. Conjuntos de referências legíveis por humanos são usados para permitir que conjuntos de referências sejam inspecionados sem precisar que um sistema de software decifre as ids referenciadas no conjunto de referências.

Apoiar a legibilidade do conjunto de referências é particularmente importante para:

• Revisão
  • Por exemplo, especialistas no assunto em questão que estão envolvidos na revisão do conteúdo do conjunto de referências

•  Educação e disseminação

  
  
  •  Por exemplo, ao explicar a estrutura e o conteúdo dos conjuntos de referências

Propósito dos conjuntos de referências legíveis por humanos

A SNOMED International especifica um formato recomendado para conjuntos de referências legíveis por humanos para

• Impedir que pessoas reinventem e surjam com soluções diferentes
• Permitir uma representação normatizada dos conjuntos de referências compartilhados como parte dos acordos com outros organismos de normatização
• Permitir o suporte a ferramentas (internamente ou externamente desenvolvidas)

Formato

Uma coluna é adicionada para a versão legível por humanos de um atributo com a adição de “term” ao nome do atributo. Exemplos incluem:

• A coluna legível correspondente para o atributo refsetId é refsetId_term
• A coluna legível correspondente para o atributo referencedComponentId é referencedComponentId_term.
• A coluna legível correspondente para o atributo acceptabilityId é acceptabilityId_term
  
  

Tabela 5.9-1: Um exemplo de um formato normatizado de conjunto de referências de idioma

It is acknowledged that members and affiliates developing reference sets have the need to create human-readable versions of the reference sets. Human readable reference sets are used to allow reference sets to be inspected without requiring a software-service to resolve the id's referenced in the reference set.

Supporting the readability of reference sets is particularly important for:

• Review
  • I.e. Subject matter experts who are involved with reviewing the content of reference sets
• Educational and dissemination
  • I.e. when explaining the structure and content of reference sets

Purpose of Human Readable Reference Sets

SNOMED International specify a recommended format for human-readable reference sets to

• Avoid people reinventing and coming out with different solutions

• Allow a standard representation of reference sets shared as part of agreements with other standards bodies

• Allow tooling support (whether internally or externally developed)

Format 

A column is added for the human-readable version of an attribute, with the addition of '_term' to the attribute name.

Examples of this include

• The corresponding human-readable column for the attribute refsetId is refsetId_term
• The corresponding human-readable column for the attribute referencedComponentId id referencedComponentId_term.
• The corresponding human-readable column for the attribute acceptabilityId is acceptabilityId_term

Tabela 5.9-2: Um exemplo de uma versão legível por humanos de conjunto de referências de idioma

Characteristics of the Term

When creating a human-readable refset it should be considered which term to include for each of the human-readable attributes. It is often preferable to include the  Simple reference sets  from an appropriate dialect within the expressions to improve the human-readability of the attribute value. However, if it is required to disambiguate which hierarchy the concepts come from then the FSN can be used. 

Human-readable Annotations to Reference Set Attributes and/or Members

Sometimes it may be relevant to add one or more columns to function as a placeholder for comments related to either specific attributes, or for the reference set member (row) as a whole. To enable that these columns can be automatically identified as non-standard specific, we recommend to use following naming convention for these columns.

The '_'-symbol is used to represent that this column represent comments, or information, which shouldn't be included when the reference set is used as part of a SNOMED CT implementation.

Características do Termo

Ao criar um conjunto de referências legíveis, é preciso considerar qual termo incluir para cada um dos atributos legíveis por humanos. Muitas vezes é preferível incluir os  conjuntos de referências simples para um dialeto apropriado dentro das expressões para melhorar a legibilidade do valor do atributo. Contudo, se for preciso desfazer a ambiguidade de qual hierarquia os conceitos são provenientes, então o Nome Totalmente Especificado (FSN) pode ser usado. 

Anotações Legíveis por Humanos para Atributos e/ou Membros de Conjuntos de Referências

Muitas vezes pode ser relevante adicionar uma ou mais colunas que podem funcionar como espaço reservado para comentários relacionados a atributos específicos ou ao membro do conjunto de referências (linha) como um todo. Para permitir que essas colunas possam ser automaticamente identificadas como um específico não padronizado, recomendamos usar a seguinte convenção de nomenclatura para essas colunas.

O símbolo '_' é usado para representar que essa coluna representa comentários ou informações que não devem ser incluídos quando o conjunto de referências for usado como parte de uma implementação do SNOMED CT.

É importante, portanto, que os campos que contenham comentários não sejam usados para propósitos importantes para o uso do conjunto de referências. Se a coluna for central para a versão eletronicamente processável do conjunto de referências, então ela deve ser especificada como um atributo específico de referência em um conjunto de referências customizado It is therefore important that fields holding comments are not used for purposes important for use of the reference set. If the column is central for the machine-processable version of the reference set, then the column should be specified as a reference-specific attribute in a customized reference set   ( 4.3. Conjuntos de referências predefinidos e customizados) and identified in the reference set descriptor  e identificada no descritor de conjunto de referências( 4.1. Reference Set Types and DescriptorsTipos e descritores de conjuntos de referências).

The O símbolo '_' -symbol is used as a prefix in front of a self-determined string. I.e the string can be any term which make sense for the actual situation, e.g. '_comment' can be used to allow reviewers to provide a comment to the specific attribute, or '_alternatives' may be used to suggest alternative members or member values, which can be used for proposals as part of a review process while the refset is under development.

SNOMED International recommends two uses of the '_'-symbol:

...

é usado como um prefixo que antecede um string autodeterminado. Ou seja,  o string pode ser qualquer termo que faça sentido para a situação em questão. Por exemplo, '_comment' pode ser usado para permitir que revisores insiram um comentário sobre o atributo específico, ou '_alternatives' pode ser usado para sugerir membros alternativos ou valores de membros que podem ser usados para propostas como parte do processo de revisão enquanto o conjunto de referências está em desenvolvimento.

A SNOMED International recomenda dois usos do símbolo  '_':

• <attributename>_<string> é usado para se referir a um valor de atributo específico
• _<string> é usado para se referir a uma linha inteira de um conjunto de referências, isto é, uma versão específica de um membro do conjunto de referências.
  
  

Tabela 5.9-2: Exemplo de comentários relacionados com valores de atributos específicos

...

...

Considerations for Use of the Human-Readable Reference Set

Considerações para o Uso dos Conjuntos de Referências Legíveis por Humanos

Em todos os usos de conjuntos de referências legíveis por humanos e o uso de anotações adicionais, é muito importante que usuários não incluam informações que afetem o uso de conjuntos de referências dentro das colunas legíveis (colunas com o prefixo  '_'). Todas as informações relevantes para a implementação e processamento do conjunto de referências devem ser representadas de acordo ao formato padronizado, eletronicamente processável. Em conseguinte, todas as colunas com o prefixo '_' devem poder ser ignoradas quando o conjunto de referências for implementadoFor all uses of human-readable reference sets and use of additional annotations it is very important that users do not include information which affects the use of the reference set within the human-readable columns (columns with the '_' prefix). All information relevant for implementation, processing and processing of the reference set should be represented according to the standard, machine-processable format. Consequently, all columns with the '_'-prefix should be able to be ignored when the reference set is implemented. 

...