ParameterMap

One entry in a syntax template dictionary: a tag name and what it stands for, either a reference to a value held elsewhere in the study or a fixed string.

Kind
Concrete class
Attributes
5, 4 required
NCI code
C207456

Official definition

The paired name and value for a given parameter.
Parameter Map, CDISC USDM 4.0, NCI C207456

In practice

Attributes

5 attributes, 4 of them required by the USDM API schema.

AttributeTypeCard.Definition
idrequiredstringcardinality 1The identifier of this object, unique within the file.
tagrequiredstringcardinality 1Character strings bounded by angle brackets that act as containers for programming language elements.
referencerequiredstringcardinality 1The reference for a tag used in programming languages, such as a markup language (e.g., HTML, XML), to store attributes and elements.
extensionAttributesExtensionAttributecardinality 0..*Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model.
instanceTyperequiredstringcardinality 1The 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 ParameterMap

The attributes a JSON file must carry for a ParameterMap, 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.

ParameterMap, required attributes only
{
  "id": "ParameterMap_1",
  "tag": string,
  "reference": string,
  "instanceType": "ParameterMap"
}

Where ParameterMap is used

These classes hold or point to a ParameterMap.

Other classes in documents and narrative:

← All 86 classes