AdministrableProductIdentifier
An identifier for an administrable product, with the organization that issued it.
- Kind
- Concrete class
- Attributes
- 5, 4 required
- NCI code
- C215493
Official definition
A sequence of characters used to identify, name, or characterize the administrable product.
Inheritance
AdministrableProductIdentifier is a kind of Identifier and inherits its attributes. Wherever the model asks for a Identifier, a AdministrableProductIdentifier can be used.
Attributes
5 attributes, 4 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.Inherited from Identifier |
| textrequired | string | cardinality 1 | An instance of structured text that represents the administrable product.Inherited from Identifier |
| scopeIdrequired | Organizationby id | cardinality 1 | A USDM relationship between the AdministrableProductIdentifier and Organization class which provides the details associated with which provides the details associated with each organization that has assigned the administrable product identifier.Inherited from Identifier |
| 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 AdministrableProductIdentifier
The attributes a JSON file must carry for a AdministrableProductIdentifier, 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.
AdministrableProductIdentifier, required attributes only
{
"id": "AdministrableProductIdentifier_1",
"text": string,
"scopeId": id of Organization,
"instanceType": "AdministrableProductIdentifier"
}
Where AdministrableProductIdentifier is used
These classes hold or point to a AdministrableProductIdentifier.
- AdministrableProduct.identifiersnested
Related classes
Other classes in interventions and products: