SyntaxTemplateDictionary
A lookup table for templated text: each entry maps a tag used in the text to a value held elsewhere in the study.
- Kind
- Concrete class
- Attributes
- 7, 4 required
- NCI code
- C207597
Official definition
A reference source that provides a listing of valid parameter names and values used in syntax template text strings.
In practice
In a protocol document: Nothing visible. It is what lets a sentence say between 18 and 75 years while the two numbers live in one place.
Attributes
7 attributes, 4 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. |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) of the syntax template dictionary. |
| label | string | cardinality 0..1 | The short descriptive designation for the syntax template dictionary. |
| description | string | cardinality 0..1 | A narrative representation of the syntax template dictionary. |
| parameterMapsrequired | ParameterMap | cardinality 1..* | A USDM relationship between the SyntaxTemplateDictionary and ParameterMap classes which identifies the set of parameter maps (parameter map entries) associated with a syntax template dictionary. |
| 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 SyntaxTemplateDictionary
The attributes a JSON file must carry for a SyntaxTemplateDictionary, 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.
SyntaxTemplateDictionary, required attributes only
{
"id": "SyntaxTemplateDictionary_1",
"name": string,
"parameterMaps": [ParameterMap, …],
"instanceType": "SyntaxTemplateDictionary"
}
Where SyntaxTemplateDictionary is used
These classes hold or point to a SyntaxTemplateDictionary.
- StudyVersion.dictionariesnested
- SyntaxTemplate.dictionaryIdby id
Related classes
Other classes in documents and narrative: