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.
| Attribute | Type | Card. | Definition |
|---|---|---|---|
| idrequired | string | cardinality 1 | The identifier of this object, unique within the file. |
| urlrequired | string | cardinality 1 | No definition in the release. |
| valueString | string | cardinality 0..1 | No definition in the release. |
| valueBoolean | boolean | cardinality 0..1 | No definition in the release. |
| valueInteger | integer | cardinality 0..1 | No definition in the release. |
| valueId | string | cardinality 0..1 | No definition in the release. |
| valueQuantity | Quantity | cardinality 0..1 | No definition in the release. |
| valueRange | Range | cardinality 0..1 | No definition in the release. |
| valueCode | Code | cardinality 0..1 | No definition in the release. |
| valueAliasCode | AliasCode | cardinality 0..1 | No definition in the release. |
| valueExtensionClass | ExtensionClass | cardinality 0..1 | No definition in the release. |
| 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 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.
- Abbreviation.extensionAttributesnested
- Activity.extensionAttributesnested
- Address.extensionAttributesnested
- AdministrableProduct.extensionAttributesnested
- AdministrableProductIdentifier.extensionAttributesnested
- AdministrableProductProperty.extensionAttributesnested
- Administration.extensionAttributesnested
- AliasCode.extensionAttributesnested
- AnalysisPopulation.extensionAttributesnested
- AssignedPerson.extensionAttributesnested
- BiomedicalConcept.extensionAttributesnested
- BiomedicalConceptCategory.extensionAttributesnested
- BiomedicalConceptProperty.extensionAttributesnested
- BiomedicalConceptSurrogate.extensionAttributesnested
- BiospecimenRetention.extensionAttributesnested
- Characteristic.extensionAttributesnested
- Code.extensionAttributesnested
- CommentAnnotation.extensionAttributesnested
- Condition.extensionAttributesnested
- ConditionAssignment.extensionAttributesnested
- DocumentContentReference.extensionAttributesnested
- Duration.extensionAttributesnested
- EligibilityCriterion.extensionAttributesnested
- EligibilityCriterionItem.extensionAttributesnested
- Encounter.extensionAttributesnested
- Endpoint.extensionAttributesnested
- Estimand.extensionAttributesnested
- ExtensionAttribute.extensionAttributesnested
- ExtensionClass.extensionAttributesnested
- GeographicScope.extensionAttributesnested
- GovernanceDate.extensionAttributesnested
- Indication.extensionAttributesnested
- Ingredient.extensionAttributesnested
- IntercurrentEvent.extensionAttributesnested
- InterventionalStudyDesign.extensionAttributesnested
- Masking.extensionAttributesnested
- MedicalDevice.extensionAttributesnested
- MedicalDeviceIdentifier.extensionAttributesnested
- NarrativeContent.extensionAttributesnested
- NarrativeContentItem.extensionAttributesnested
- Objective.extensionAttributesnested
- ObservationalStudyDesign.extensionAttributesnested
- Organization.extensionAttributesnested
- ParameterMap.extensionAttributesnested
- PersonName.extensionAttributesnested
- Procedure.extensionAttributesnested
- ProductOrganizationRole.extensionAttributesnested
- Quantity.extensionAttributesnested
- Range.extensionAttributesnested
- ReferenceIdentifier.extensionAttributesnested
- ResponseCode.extensionAttributesnested
- ScheduleTimeline.extensionAttributesnested
- ScheduleTimelineExit.extensionAttributesnested
- ScheduledActivityInstance.extensionAttributesnested
- ScheduledDecisionInstance.extensionAttributesnested
- Strength.extensionAttributesnested
- Study.extensionAttributesnested
- StudyAmendment.extensionAttributesnested
- StudyAmendmentImpact.extensionAttributesnested
- StudyAmendmentReason.extensionAttributesnested
- StudyArm.extensionAttributesnested
- StudyCell.extensionAttributesnested
- StudyChange.extensionAttributesnested
- StudyCohort.extensionAttributesnested
- StudyDefinitionDocument.extensionAttributesnested
- StudyDefinitionDocumentVersion.extensionAttributesnested
- StudyDesignPopulation.extensionAttributesnested
- StudyElement.extensionAttributesnested
- StudyEpoch.extensionAttributesnested
- StudyIdentifier.extensionAttributesnested
- StudyIntervention.extensionAttributesnested
- StudyRole.extensionAttributesnested
- StudySite.extensionAttributesnested
- StudyTitle.extensionAttributesnested
- StudyVersion.extensionAttributesnested
- SubjectEnrollment.extensionAttributesnested
- Substance.extensionAttributesnested
- SyntaxTemplateDictionary.extensionAttributesnested
- Timing.extensionAttributesnested
- TransitionRule.extensionAttributesnested
Related classes
Other classes in codes, quantities and extensions: