StudyIdentifier
An identifier for the study together with the organization that issued it. The sponsor protocol number and the registry number are two StudyIdentifiers with different scopes.
- Kind
- Concrete class
- Attributes
- 5, 4 required
- NCI code
- C83082
Official definition
A sequence of characters used to identify, name, or characterize the study.
In practice
In a protocol document: Protocol number, NCT number, EU CT number, IND number.
Inheritance
StudyIdentifier is a kind of Identifier and inherits its attributes. Wherever the model asks for a Identifier, a StudyIdentifier can be used.
Attributes
5 attributes, 4 of them required by the USDM API schema and 1 holding the id of another object instead of the object itself (marked by id).
| Attribute | Type | Card. | Definition |
|---|---|---|---|
| idrequired | string | cardinality 1 | The identifier of this object, unique within the file.Inherited from Identifier |
| textrequired | string | cardinality 1 | An instance of structured text that represents the study identifier.Inherited from Identifier |
| scopeIdrequired | Organizationby id | cardinality 1 | A USDM relationship between the StudyIdentifier and Organization classes which provides the details associated with each organization that has assigned the study identifier.Inherited from Identifier |
| 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 StudyIdentifier
The attributes a JSON file must carry for a StudyIdentifier, 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.
{
"id": "StudyIdentifier_1",
"text": string,
"scopeId": id of Organization,
"instanceType": "StudyIdentifier"
}
Where StudyIdentifier is used
These classes hold or point to a StudyIdentifier.
- StudyVersion.studyIdentifiersnested
Example
A StudyIdentifier from the example study. Coded values are shortened to one line.
{
"id": "StudyIdentifier_1",
"text": "EX101-201",
"scopeId": "Organization_1",
"instanceType": "StudyIdentifier"
}
Related classes
Other classes in study, versions and amendments: