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.
In practice
Attributes
7 attributes, 6 of them required by the USDM API schema.
| Attribute | Type | Card. | Definition |
|---|---|---|---|
| idrequired | string | cardinality 1 | The identifier of this object, unique within the file. |
| coderequired | string | cardinality 1 | The literal value of a code. |
| codeSystemrequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) of the system used to assign and/or manage codes. |
| codeSystemVersionrequired | string | cardinality 1 | The version of the code system. |
| decoderequired | string | cardinality 1 | Standardized or dictionary-derived human readable text associated with a code. |
| extensionAttributes | ExtensionAttribute | cardinality 0..* | Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model. |
| instanceTyperequired | string | cardinality 1 | The 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.
- Address.countrynested
- AdministrableProduct.sourcingnested
- AdministrableProduct.productDesignationnested
- AdministrableProduct.pharmacologicClassnested
- AdministrableProductProperty.typenested
- AliasCode.standardCodenested
- AliasCode.standardCodeAliasesnested
- CommentAnnotation.codesnested
- EligibilityCriterion.categorynested
- Encounter.typenested
- Encounter.environmentalSettingsnested
- Encounter.contactModesnested
- Endpoint.levelnested
- ExtensionAttribute.valueCodenested
- GeographicScope.typenested
- GovernanceDate.typenested
- Indication.codesnested
- Ingredient.rolenested
- InterventionalStudyDesign.modelnested
- InterventionalStudyDesign.subTypesnested
- InterventionalStudyDesign.intentTypesnested
- MedicalDevice.sourcingnested
- MedicalDeviceIdentifier.typenested
- Objective.levelnested
- ObservationalStudyDesign.modelnested
- ObservationalStudyDesign.subTypesnested
- ObservationalStudyDesign.timePerspectivenested
- ObservationalStudyDesign.samplingMethodnested
- Organization.typenested
- PopulationDefinition.plannedSexnested
- Procedure.codenested
- ProductOrganizationRole.codenested
- ReferenceIdentifier.typenested
- ResponseCode.codenested
- StudyAmendmentImpact.typenested
- StudyAmendmentReason.codenested
- StudyArm.typenested
- StudyArm.dataOriginTypenested
- StudyDefinitionDocument.typenested
- StudyDefinitionDocument.languagenested
- StudyDefinitionDocumentVersion.statusnested
- StudyDesign.therapeuticAreasnested
- StudyDesign.studyTypenested
- StudyDesign.characteristicsnested
- StudyEpoch.typenested
- StudyIntervention.rolenested
- StudyIntervention.typenested
- StudyIntervention.codesnested
- StudyRole.codenested
- StudySite.countrynested
- StudyTitle.typenested
- StudyVersion.businessTherapeuticAreasnested
- Substance.codesnested
- Timing.typenested
- Timing.relativeToFromnested
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"
}
Related classes
Other classes in codes, quantities and extensions: