Code

A coded value: the code, the system it comes from, the version of that system and the human-readable decode.

Kind
Concrete class
Attributes
7, 6 required
NCI code
C25162

Official definition

A symbol or combination of symbols which is assigned to the members of a collection.
Code, CDISC USDM 4.0, NCI C25162

In practice

Attributes

7 attributes, 6 of them required by the USDM API schema.

AttributeTypeCard.Definition
idrequiredstringcardinality 1The identifier of this object, unique within the file.
coderequiredstringcardinality 1The literal value of a code.
codeSystemrequiredstringcardinality 1The literal identifier (i.e., distinctive designation) of the system used to assign and/or manage codes.
codeSystemVersionrequiredstringcardinality 1The version of the code system.
decoderequiredstringcardinality 1Standardized or dictionary-derived human readable text associated with a code.
extensionAttributesExtensionAttributecardinality 0..*Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model.
instanceTyperequiredstringcardinality 1The name of the class, carried by every object in a USDM JSON file. Added by the API; not part of the logical model.

Smallest valid Code

The attributes a JSON file must carry for a Code, and the kind of value each takes. This is the shape, with types named in place of values. Everything else in the table above is optional.

Code, required attributes only
{
  "id": "Code_1",
  "code": string,
  "codeSystem": string,
  "codeSystemVersion": string,
  "decode": string,
  "instanceType": "Code"
}

Where Code is used

These classes hold or point to a Code.

Example

A Code from the example study. Coded values are shortened to one line.

Code_3
{
  "id": "Code_3",
  "code": "C207616",
  "codeSystem": "http://www.cdisc.org",
  "codeSystemVersion": "2026-03-27",
  "decode": "Official Study Title",
  "instanceType": "Code"
}

Other classes in codes, quantities and extensions:

← All 86 classes