Codable Concept

A standard set of named attributes are used to represent Codable Concept types. Where the code is the main code of the corresponding resource, the attribute name used is as shown. Where the code is a secondary code, a prefix to be utilised will also be specified which is then prefixed to form the specified name e.g. a secondary code of reaction may be specified with a prefix of 'reaction' short code r. This would result in attributes in the form 'reaction_snomed_concept_id' long name and r-cid short name.

Table 1. Codable_Concept
Database Field Name Field Description Sensitive Field Identifiable Field Field Type Field Length Optionality Rules
ctv3_code The CTV3 code Yes No String min an5 max an5 O The code system http://read.info/ctv3 can be inferred
other_code The code in the other code system Yes No String min an1 max an18 O Where ‘other’ coded information is supplied. All of ‘other_code_system', 'other_code’ and ‘other_display’ must be present
other_code_system OID or URL identifying the proprietary or legacy code system Yes No String min an1 max an255 O Where ‘other’ coded information is supplied. All of ‘other_code_system', 'other_code’ and ‘other_display’ must be present
other_display The term text for the code in the other code system Yes No String min an1 max an255 O Where ‘other’ coded information is supplied. All of ‘other_code_system', 'other_code’ and ‘other_display’ must be present
other_expession Proprietary qualifier expression in proprietary form qualifying the proprietary code Yes No String min an1 max an1024 O May appear standalone without accompanying other_code, other_code_system, other_display
readv2_code The Read V2 code with concatenated term id Yes No String min an7 max an7 O The code system http://read.info/readv2 can be inferred
rubric Conveys the actual term/rubric displayed to users. Only supplied if the term/rubric displayed to users of the system is not already represented by term corresponding to the supplied code Yes No String min an1 max an255 M Should always be supplied
snomed_concept_id The SNOMED CT concept identifier Yes No String min n6 max n18 O A pre-coordinated Snomed Concept Identifier in the form of a 'plain code symbol' from the SNOMED CT terminology and not an expression. Where SNOMED CT coded information is supplied, both the concept id and description id should be present where possible. The code system http://snomed.info/sct can be inferred
snomed_description_id The SNOMED CT description ID Yes No String min n6 max n18 O Where SNOMED CT coded information is supplied. Can only be supplied if the Snomed Concept ID is supplied. The code system http://snomed.info/sct can be inferred
snomed_expression A SNOMED CT expression Yes No String min an1 max an1024 O A SNOMED CT expression describing the concept and associated qualifiers and attributes expressed in SNOMED CT compositional grammar syntax (https://confluence.ihtsdotools.org/display/DOCSCG). Depending on the associated record type, the specification may also specify qualifiers explicitly as attributes in the extract. These qualifiers should still be extracted i.e. conveying qualifiers in the snomed_expression field does not replace the need to express qualifiers as other fields in the extract where specified. Can only be supplied if the snomed_concept_id attribute is present Must only qualify the code carried in snomed_concept_id and cannot modify it's meaning. The root concept in the expression must be the same as the concept carried by snomed_concept_id For concise expression term text should not be provided
user_selected Identifies the coded attribute which is the code system actually used to record the coded concept in the original system. One of sct, read, ctv3, other Yes No String min an3 max an5 M Explicitly differentiates between the source code and code system employed and supplied translations - equivalent of userSelected in FHIR. Should only be used where it can be reliably identified that a code was originally recorded by a user in a given code system.