GeographicScope
Where something applies: globally, in a region or in a country, with the code for the region or country.
- Kind
- Concrete class
- Attributes
- 5, 3 required
- NCI code
- C207591
Official definition
The extent or range related to the physical location of an entity.
In practice
In a protocol document: Country-specific amendments and approval dates.
Attributes
5 attributes, 3 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. |
| typerequired | Code | cardinality 1 | A characterization or classification of the geographic scope.USDM codelist C207412, 3 values |
| code | AliasCode | cardinality 0..1 | A symbol or combination of symbols which is assigned to the geographic scope.Values: External dictionaries: Standard code is ISO-3166; Alias codes drawn from GENC, UN Region Codes, etc. |
| 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 GeographicScope that use a codelist defined by USDM, with every value in it. A file carries the code; the term is its decode.
typecodelist C207412, not extensible
| Code | Term | Definition |
|---|---|---|
| C25464 | Country | A sovereign nation occupying a distinct territory and ruled by an autonomous government. |
| C68846 | Global | Covering or affecting the whole of a system. |
| C41129 | Region | An area or portion of something with more or less definite boundaries designed or specified according to some established criteria. |
Smallest valid GeographicScope
The attributes a JSON file must carry for a GeographicScope, 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": "GeographicScope_1",
"type": Code,
"instanceType": "GeographicScope"
}
Where GeographicScope is used
These classes hold or point to a GeographicScope.
- GovernanceDate.geographicScopesnested
- StudyAmendment.geographicScopesnested
- SubjectEnrollment.forGeographicScopenested
Example
A GeographicScope from the example study. Coded values are shortened to one line.
{
"id": "GeographicScope_1",
"type": { "code": "C68846", "decode": "Global", … },
"instanceType": "GeographicScope"
}
Related classes
Other classes in study, versions and amendments: