StudyAmendment
A formal change to the plan: its number, summary, primary and secondary reasons, what changed and who is affected.
- Kind
- Concrete class
- Attributes
- 17, 8 required
- NCI code
- C207594
Official definition
A written description of a change(s) to, or formal clarification of, a study.
In practice
In a protocol document: The amendment summary of changes and the amendment history table.
Attributes
17 attributes, 8 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. |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) of the study amendment. |
| label | string | cardinality 0..1 | The short descriptive designation for the study amendment. |
| description | string | cardinality 0..1 | A narrative representation of the study amendment. |
| numberrequired | string | cardinality 1 | A string of numerals that uniquely identifies a protocol amendment. |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the study amendment. |
| summaryrequired | string | cardinality 1 | A short narrative representation describing the changes introduced in the current version of the protocol. |
| geographicScopesrequired | GeographicScope | cardinality 1..* | A USDM relationship between the StudyAmendment and GeographicScope classes which identifies the set of geographic scopes associated with the study amendment. |
| dateValues | GovernanceDate | cardinality 0..* | A USDM relationship between the StudyAmendment and GovernanceDate classes which provides the set of governance dates associated with the study amendment. |
| impacts | StudyAmendmentImpact | cardinality 0..* | A USDM relationship between the StudyAmendment and StudyAmendmentImpact classes which identifies the set of impacts that the study amendment has on the study or study subjects. |
| enrollments | SubjectEnrollment | cardinality 0..* | A USDM relationship between the StudyAmendment and SubjectEnrollment classes which provides the set of subject enrollments associated with the study amendment. |
| secondaryReasons | StudyAmendmentReason | cardinality 0..* | A USDM relationship between the StudyAmendment and StudyAmendmentReason classes which identifies the set of secondary reasons for issuing the study amendment. |
| changesrequired | StudyChange | cardinality 1..* | A USDM relationship between the StudyAmendment and StudyChange classes which identifies the set of changes associated with the study amendment. |
| previousId | StudyAmendmentby id | cardinality 0..1 | A USDM relationship within the StudyAmendment class which identifies the study amendment that chronologically precedes the current study amendment. |
| primaryReasonrequired | StudyAmendmentReason | cardinality 1 | A USDM relationship between the StudyAmendment and StudyAmendmentReason classes which identifies the primary reason for issuing the study amendment. |
| 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 StudyAmendment
The attributes a JSON file must carry for a StudyAmendment, 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.
StudyAmendment, required attributes only
{
"id": "StudyAmendment_1",
"name": string,
"number": string,
"summary": string,
"geographicScopes": [GeographicScope, …],
"changes": [StudyChange, …],
"primaryReason": StudyAmendmentReason,
"instanceType": "StudyAmendment"
}
Where StudyAmendment is used
These classes hold or point to a StudyAmendment.
- StudyAmendment.previousIdby id
- StudyVersion.amendmentsnested
Related classes
Other classes in study, versions and amendments: