Administration
How an intervention is given: dose, route, frequency and duration.
- Kind
- Concrete class
- Attributes
- 13, 4 required
- NCI code
- C25409
Official definition
The act of dispensing, applying, or tendering a product, agent, or therapy.
In practice
In a protocol document: The dose and administration rows of the study interventions table.
Attributes
13 attributes, 4 of them required by the USDM API schema and 2 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. |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) for the administration of a product, agent, or therapy. |
| label | string | cardinality 0..1 | The short descriptive designation for the administration of a product, agent, or therapy. |
| description | string | cardinality 0..1 | A narrative representation for the administration of a product, agent, or therapy. |
| dose | Quantity | cardinality 0..1 | The value representing the amount of an agent given to an individual at one time. |
| frequency | AliasCode | cardinality 0..1 | The number of doses administered per a specific interval.CDISC SDTM codelist C71113 (NCI EVS) |
| route | AliasCode | cardinality 0..1 | The pathway by which a substance is administered in order to reach the site of action in the body.CDISC SDTM codelist C66729 (NCI EVS) |
| durationrequired | Duration | cardinality 1 | The amount of time elapsed during the administration of an agent. |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the administration of the product, agent, or therapy. |
| administrableProductId | AdministrableProductby id | cardinality 0..1 | A USDM relationship between the Administration and AdministrableProductDefinition classes which identifies the administrable product associated with the administration of the product, agent, or therapy. |
| medicalDeviceId | MedicalDeviceby id | cardinality 0..1 | A USDM relationship between the Administration and MedicalDevice classes which identifies the medical device associated with an instance of product, agent, or therapy administration. |
| 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 Administration
The attributes a JSON file must carry for a Administration, 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.
Administration, required attributes only
{
"id": "Administration_1",
"name": string,
"duration": Duration,
"instanceType": "Administration"
}
Where Administration is used
These classes hold or point to a Administration.
- StudyIntervention.administrationsnested
Example
A Administration from the example study. Coded values are shortened to one line.
Administration_1
{
"id": "Administration_1",
"name": "EX-101 10 mg once daily",
"duration": {
"id": "Duration_1",
"text": "12 weeks",
"quantity": {
"id": "Quantity_1",
"value": 12,
"unit": { "standardCode": { "code": "C29844", "decode": "Week", … }, … },
"instanceType": "Quantity"
},
"durationWillVary": false,
"instanceType": "Duration"
},
"route": { "standardCode": { "code": "C38288", "decode": "Oral Route of Administration", … }, … },
"frequency": { "standardCode": { "code": "C25473", "decode": "Daily", … }, … },
"dose": {
"id": "Quantity_2",
"value": 10,
"unit": { "standardCode": { "code": "C28253", "decode": "Milligram", … }, … },
"instanceType": "Quantity"
},
"instanceType": "Administration"
}
Related classes
Other classes in interventions and products: