BiomedicalConceptSurrogate
A placeholder for data an activity collects when no standard biomedical concept exists for it yet: a name, a description and an optional reference.
- Kind
- Concrete class
- Group
- Biomedical concepts
- Attributes
- 8, 3 required
- NCI code
- C207590
Official definition
A concept that substitutes for a standard biomedical concept from the designated source.
In practice
Attributes
8 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. |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) of the biomedical concept surrogate. |
| label | string | cardinality 0..1 | The short descriptive designation for the biomedical concept surrogate. |
| description | string | cardinality 0..1 | A narrative representation of the biomedical concept surrogate. |
| reference | string | cardinality 0..1 | A citation to an authoritative source for a biomedical concept surrogate. |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the biomedical concept surrogate. |
| 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 BiomedicalConceptSurrogate
The attributes a JSON file must carry for a BiomedicalConceptSurrogate, 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.
BiomedicalConceptSurrogate, required attributes only
{
"id": "BiomedicalConceptSurrogate_1",
"name": string,
"instanceType": "BiomedicalConceptSurrogate"
}
Where BiomedicalConceptSurrogate is used
These classes hold or point to a BiomedicalConceptSurrogate.
- Activity.bcSurrogateIdsby id
- Condition.appliesToIdsby id
- StudyVersion.bcSurrogatesnested
Related classes
Other classes in biomedical concepts: