Versionable

Adds the attribute identifying this as a versionable object as well as the MaintainableObject. All versionable objects should provide their contextual information, the identity of their maintainable parent. The deprecated form of the URN contains all the information to identify and object and its context. A Canonical URN scoped to the Maintainable contains the ID of the Maintainable as part of its structure. To provide full contextual information use the MaintainableObject structure. The use of the Canonical URN scoped to the agency or the identification sequence alone requires the content of the MaintainableObject to provide full contextual information. All content of Versionable is considered to be administrative metadata. Note that changes to the administrative metadata does not drive a change in the version of the parent objects. See DDI 3.2 Technical Documentation: Part I for further details.

Properties

Name	Type		Description
URN	string	1..1
Agency	string	1..1
ID	string	1..1
Version	string	1..1
UserID	UserIDType	0..n	Allows for the specification of identifiers other than the specified DDI identification of the object. This may be a legacy ID from DDI-C, a system specific ID such as for a database or registry, or a non-DDI unique identifier. As the identifier is specific to a system the system must be identified with the UserID structure.
UserAttributePair	StandardKeyValuePairType	0..n	A system specific user defined property of the object expressed as a key/value pair. As this is specific to an individual system the use of controlled vocabularies for the key is strongly recommended.
VersionResponsibility	string	0..1	Person or organization within the MaintenanceAgency responsible for the version change. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, it may be included in this notation. This is primarily intended for internal use.
VersionResponsibilityReference	Agent	0..1	Reference person or organization within the MaintenanceAgency responsible for the version change, as described in an OrganizationScheme. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, a Relation should be created between the individual referenced here and his/her organization. This is primarily intended for internal use.
VersionRationale	VersionRationaleType	0..1	Textual description of the rationale/purpose for the version change and a coded value to provide an internal processing flag within and organization or system. Note that versioning can only take place on objects owned by the specified DDI Agency. If you are creating a local instance of an object from another agency for current or future modification use BasedOnObject. If the changes being made result in what you determine to be new object rather than a version of a previous object, i.e. the change is too extensive to consider it a version of the existing object, create a new object and use BasedOnObject to provide a link to the object or objects that were a basis for the new object.
BasedOnObject	BasedOnObjectType	0..1	Use when creating an object that is based on an existing object or objects that are managed by a different agency or when the new object is NOT simply a version change but you wish to maintain a reference to the object that served as a basis for the new object. BasedOnObject may contain references to any number of objects which serve as a basis for this object, a BasedOnRationalDescription of how the content of the referenced object was incorporated or altered, and a BasedOnRationalCode to allow for specific typing of the BasedOnReference according to an external controlled vocabulary.
RelatedOtherMaterialReference	OtherMaterial	0..n	The inclusion of an existing OtherMaterial by reference. Use for any type of OtherMaterial not specifically addressed by an inline description for such as ExternalAid in QuestionItem.
VersionDate	cogsDate	0..1	Date of version using the union set BaseDateType. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
IsPublished	boolean	0..1	Indicates that the maintainable will not be changed without versioning, and is a stable target for referencing.

Item Type Hierarchy

• Versionable

  • Agent

  • ApprovalReview

  • BaseRecordLayout

  • Category

  • CategoryGroup

  • CodeListGroup

  • Concept

  • ConceptGroup

  • ConceptualVariable

  • ConceptualVariableGroup

  • ControlConstruct

  • ControlConstructGroup

  • DataCaptureDevelopment

  • DataRelationship

  • Describable

  • DevelopmentActivity

  • DevelopmentActivityGroup

  • DevelopmentImplementation

  • DevelopmentPlan

  • DevelopmentResults

  • GenericMap

  • GeographicLocation

  • GeographicLocationGroup

  • GeographicStructure

  • GeographicStructureGroup

  • Instruction

  • InstructionGroup

  • Instrument

  • InstrumentGroup

  • Maintainable

  • ManagedRepresentation

  • ManagedRepresentationGroup

  • MeasurementGroup

  • MeasurementItem

  • Methodology

  • NCube

  • NCubeGroup

  • OrganizationGroup

  • OtherMaterial

  • OtherMaterialGroup

  • PhysicalStructure

  • PhysicalStructureGroup

  • ProcessingEvent

  • ProcessingEventGroup

  • ProcessingInstruction

  • ProcessingInstructionGroup

  • QualityStandard

  • QualityStandardGroup

  • QualityStatement

  • QualityStatementGroup

  • Question

  • QuestionGroup

  • RecordLayoutGroup

  • Relation

  • RepresentationMap

  • RepresentedVariable

  • RepresentedVariableGroup

  • Sample

  • SampleFrame

  • SamplingInformationGroup

  • SamplingPlan

  • SubUniverseClass

  • UnitTypeGroup

  • Universe

  • UniverseGroup

  • Variable

  • VariableGroup

  • VariableStatistics

  • Weighting

  • WeightingMethodology

Relationships

The following types reference this type.

• ApprovalReview

• BasedOnObjectType

• ItemMapType

• LinkingMapType

• RelationshipType

• ResourceUsedType