ExtensionAttribute

The standard's own escape hatch. Any object can carry extension attributes, each identified by a URL, to hold information USDM does not define.

Kind
Concrete class
Attributes
13, 3 required

In practice

Attributes

13 attributes, 3 of them required by the USDM API schema.

AttributeTypeCard.Definition
idrequiredstringcardinality 1The identifier of this object, unique within the file.
urlrequiredstringcardinality 1No definition in the release.
valueStringstringcardinality 0..1No definition in the release.
valueBooleanbooleancardinality 0..1No definition in the release.
valueIntegerintegercardinality 0..1No definition in the release.
valueIdstringcardinality 0..1No definition in the release.
valueQuantityQuantitycardinality 0..1No definition in the release.
valueRangeRangecardinality 0..1No definition in the release.
valueCodeCodecardinality 0..1No definition in the release.
valueAliasCodeAliasCodecardinality 0..1No definition in the release.
valueExtensionClassExtensionClasscardinality 0..1No definition in the release.
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 ExtensionAttribute

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

ExtensionAttribute, required attributes only
{
  "id": "ExtensionAttribute_1",
  "url": string,
  "instanceType": "ExtensionAttribute"
}

Where ExtensionAttribute is used

These classes hold or point to a ExtensionAttribute.

Other classes in codes, quantities and extensions:

← All 86 classes