ReferenceIdentifier
An identifier of something the study refers to, such as a paediatric investigation plan or a clinical development plan, with the organization that issued it.
- Kind
- Concrete class
- Attributes
- 6, 5 required
- NCI code
- C82531
Official definition
A sequence of characters used to identify, name, or characterize the reference.
Inheritance
ReferenceIdentifier is a kind of Identifier and inherits its attributes. Wherever the model asks for a Identifier, a ReferenceIdentifier can be used.
Attributes
6 attributes, 5 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 reference identifier.Inherited from Identifier |
| scopeIdrequired | Organizationby id | cardinality 1 | A USDM relationship between the ReferenceIdentifier and Organization classes which provides the details associated with each organization that has assigned the reference identifier.Inherited from Identifier |
| typerequired | Code | cardinality 1 | A characterization or classification of the reference identifier.USDM codelist C215478, 2 values |
| 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. |
Allowed values
The coded attributes of ReferenceIdentifier that use a codelist defined by USDM, with every value in it. A file carries the code; the term is its decode.
typecodelist C215478, extensible
| Code | Term | Definition |
|---|---|---|
| C215674 | Pediatric Investigation Planalso: PIP | A development plan aimed at ensuring that the necessary data are obtained to support the authorisation of a medicine for children, through studies in children. (EMA) |
| C142424 | Clinical Development Planalso: CDP | A document that describes the collection of clinical studies that are to be performed in sequence, or in parallel, with a particular active substance, device, procedure, or treatment strategy, typically with the intention of submitting them as part of an application for a marketing authorization. (CDISC Glossary) |
Smallest valid ReferenceIdentifier
The attributes a JSON file must carry for a ReferenceIdentifier, 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": "ReferenceIdentifier_1",
"text": string,
"scopeId": id of Organization,
"type": Code,
"instanceType": "ReferenceIdentifier"
}
Where ReferenceIdentifier is used
These classes hold or point to a ReferenceIdentifier.
- StudyVersion.referenceIdentifiersnested
Related classes
Other classes in study, versions and amendments: