AgentAssociation | ||
│ | Full name of the contributor. Language equivalents should be expressed within the International String structure. | |
├▻agentName | ⇩InternationalString | ? |
│ │ | The affiliation of this person to an organization. This is generally an organization or sub-organization name and should be related to the specific role within which the individual is being listed. | |
│ └▭affiliation | xsd:string | ? |
│ | The role of the of the Agent within the context of the parent property name with information on the extent to which the role applies. Allows for use of external controlled vocabularies. Reference should be made to the vocabulary within the structure of the role. Recommended role for contributors can be found in the CASRAI Contributor Roles Vocabulary (CRediT) http://dictionary.casrai.org/Contributor_Roles, or the OPENRIF contribution ontology https://github.com/openrif/contribution-ontology | |
├▻role | PairedExternalControlledVocabularyEntry | * |
│ | Reference to an agent as described by any object that is a member of the abstract type Agent. | |
└▻associatedAgent | Agent | ? |
Provides annotation information on the object to support citation and crediting of the creator(s) of the object.
r:CitationType
Annotation | ||
│ | Full authoritative title. List any additional titles for this item as AlternativeTitle. | |
├▻title | InternationalString | ? |
│ | Secondary or explanatory title. | |
├▻subTitle | InternationalString | * |
│ | An alternative title by which a data collection is commonly referred, or an abbreviation for the title. | |
├▻alternativeTitle | InternationalString | * |
│ | Person, corporate body, or agency responsible for the substantive and intellectual content of the described object. | |
├▻creator | AgentAssociation | * |
│ | Person or organization responsible for making the resource available in its present form. | |
├▻publisher | AgentAssociation | * |
│ | The name of a contributing author or creator, who worked in support of the primary creator given above. | |
├▻contributor | AgentAssociation | * |
│ | A date associated with the annotated object (not the coverage period). Use typeOfDate to specify the type of date such as Version, Publication, Submitted, Copyrighted, Accepted, etc. | |
├▻date | AnnotationDate | * |
│ | Language of the intellectual content of the described object. Multiple languages are supported by the structure itself as defined in the transformation to specific bindings. Use language codes supported by xs:language which include the 2 and 3 character and extended structures defined by RFC4646 or its successors. Supports multiple language codes. | |
├▭languageOfObject | xsd:language | * |
│ | An identifier or locator. Contains identifier and Managing agency (ISBN, ISSN, DOI, local archive). Indicates if it is a URI. | |
├▻identifier | InternationalIdentifier | * |
│ | The copyright statement. | |
├▻copyright | InternationalString | * |
│ | Provide the type of the resource. This supports the use of a controlled vocabulary. It should be appropriate to the level of the annotation. | |
├▻typeOfResource | ExternalControlledVocabularyEntry | * |
│ | The name or identifier of source information for the annotated object. | |
├▻informationSource | InternationalString | * |
│ | Means of identifying the current version of the annotated object. | |
├▭versionIdentification | xsd:string | ? |
│ | The agent responsible for the version. May have an associated role. | |
├▻versioningAgent | AgentAssociation | * |
│ | A summary description (abstract) of the annotated object. | |
├▻summary | InternationalString | ? |
│ | Provide the identifier, managing agency, and type of resource related to this object. Use to specify related resources similar to Dublin Core isPartOf and hasPart to indicate collection/series membership for objects where there is an identifiable record. If not an identified object use the relationship to ExternalMaterial using a type that indicates a series description. | |
├▻relatedResource | ⇩InternationalIdentifier | * |
│ │ | The type of relationship between the annotated object and the related resource. Standard usage may include: describesDate, isDescribedBy, isFormatOf, isPartOf, isReferencedBy, isReplacedBy, isRequiredBy, isVersionOf, references, replaces, requires, etc. | |
│ └▻typeOfRelatedResource | ExternalControlledVocabularyEntry | * |
│ | A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. | |
├▻provenance | InternationalString | * |
│ | Information about rights held in and over the resource. Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights. | |
├▻rights | InternationalString | * |
│ | Date the record was created | |
├▻recordCreationDate | IsoDateType | ? |
│ | Date the record was last revised | |
└▻recordLastRevisionDate | IsoDateType | ? |
A generic date type for use in Annotation which provides the standard date structure plus a property to define the date type (Publication date, Accepted date, Copyrighted date, Submitted date, etc.).
Equivalent of http://purl.org/dc/elements/1.1/date where the type of date may identify the Dublin Core refinement term.
AnnotationDate | ⇩Date | |
│ | Use to specify the type of date. This may reflect the refinements of dc:date such as dateAccepted, dateCopyrighted, dateSubmitted, etc. | |
└▻typeOfDate | ExternalControlledVocabularyEntry | * |
Binds two parameters together to direct flow of data through a process
From the output of an InstanceQuestion to the input of a ComputationAction
Binding is used to define the flow of data into, out of, and within a process. It is separate from the flow of a process. When used in the workflow of a data capture process most data may go from a capture to an instance variable, but when needed as a check sum in a loop, a recoding process, or conditional content for DynamicText, Binding provides the means for explicitly directing the movement of data from one point to another in the process.
Binding | ||
│ | Parameter supplying the data | |
├▻fromParameter | Parameter | |
│ | Parameter accepting the data as input to the process step | |
└▻toParameter | Parameter |
A BusinessProcess precondition or post condition which describes the condition which must be met to begin (pre) or exit (post) a process. It may use a specified LogicalRecord. The Logical Record has SQL that describes it, rejectionCriteria against which its adequacy may be tested and an optional annotation that describes its provenance.
BusinessProcessCondition | ||
│ | SQL SELECT statement that describes the selection of the LogicalRecord from the Dataset | |
├▭sql | xsd:string | ? |
│ | Criteria for failing an input dataset | |
├▻rejectionCriteria | CommandCode | ? |
│ | Provides an alternative to or supplements the SQL data description. | |
├▻dataDescription | InternationalStructuredString | * |
│ | A Logical Record used by the BusinessProcessCondition in defining the condition. | |
└▻usesLogicalRecord | LogicalRecord | ? |
Contains information on the command used for processing data. Contains a description of the command which should clarify for the user the purpose and process of the command, an in-line provision of the command itself, and a reference to an external version of the command such as a coding script.
r:CommandCodeType
CommandCode | ||
│ | A description of the purpose and use of the command code provided. Supports multiple languages. | |
├▻description | InternationalStructuredString | ? |
│ | Identifies and provides a link to an external copy of the command, for example, a SAS Command Code script. Designates the programming language of the command file as well as the URI for the file. | |
├▻usesCommandFile | * | |
│ │ | Designates the programming language used for the command. Supports the use of a controlled vocabulary. | |
│ ├▻programLanguage | ExternalControlledVocabularyEntry | ? |
│ │ | A description of the location of the file. This may not be machine actionable. It supports a description expressed in multiple languages. | |
│ ├▻location | InternationalString | ? |
│ │ | The URL or URN of the command file. | |
│ └▭uri | iri | ? |
│ | This is an in-line provision of the command itself. It provides the programming language used as well as the command. | |
└▻usesCommand | * | |
│ | Designates the programming language used for the command. Supports the use of a controlled vocabulary. | |
├▻programLanguage | ExternalControlledVocabularyEntry | ? |
│ | Content of the command itself expressed in the language designated in Programming Language. | |
└▭commandContent | xsd:string | ? |
Text which has a changeable value depending on a stated condition, response to earlier questions, or as input from a set of metrics (pre-supplied data). The command code indicates the condition and/or calculation used to determine the content of the text.
d:ConditionalTextType
ConditionalText | ⇩DynamicTextContent | |
│ | The condition on which the associated text varies expressed by a command code. For example, a command that inserts an age by calculating the difference between today’s date and a previously defined date of birth. | |
└▻expression | CommandCode | ? |
Contact information for the individual or organization including location specification, address, web site, phone numbers, and other means of communication access. Address, location, telephone, and other means of communication can be repeated to express multiple means of a single type or change over time. Each major piece of contact information contains the element EffectiveDates in order to date stamp the period for which the information is valid.
a:ContactInformationType
ContactInformation | ||
│ | The URL of the Agent's website | |
├▻website | * | |
│ │ | Set to "true" if this is the preferred URL. | |
│ ├▭isPreferred | xsd:boolean | ? |
│ │ | Normally a URL | |
│ ├▭uri | iri | ? |
│ │ | The type of URL for example personal, project, organization, division, etc. | |
│ ├▻typeOfWebsite | ExternalControlledVocabularyEntry | ? |
│ │ | The period for which this URL is valid. | |
│ ├▻effectiveDates | DateRange | ? |
│ │ | Indicates the privacy level of this URL | |
│ └▻privacy | ExternalControlledVocabularyEntry | ? |
│ | Email contact information | |
├▻hasEmail | * | |
│ │ | The email address expressed as a string (should follow the Internet format specification - RFC 5322) e.g. user@server.ext, more complex and flexible examples are also supported by the format. | |
│ ├▭internetEmail | xsd:string | ? |
│ │ | Code indicating the type of e-mail address. Supports the use of an external controlled vocabulary. (e.g. home, office) | |
│ ├▻typeOfEmail | ExternalControlledVocabularyEntry | ? |
│ │ | Time period for which the e-mail address is valid. | |
│ ├▻effectiveDates | DateRange | ? |
│ │ | Indicates the level of privacy | |
│ ├▻privacy | ExternalControlledVocabularyEntry | ? |
│ │ | Set to true if this is the preferred email | |
│ └▭isPreferred | xsd:boolean | ? |
│ | Electronic messaging other than email | |
├▻electronicMessaging | * | |
│ │ | Account identification for contacting | |
│ ├▭contactAddress | xsd:string | ? |
│ │ | Indicates the type of service used. Supports the use of a controlled vocabulary. | |
│ ├▻typeOfService | ExternalControlledVocabularyEntry | ? |
│ │ | Time period during which the account is valid. | |
│ ├▻effectiveDates | DateRange | ? |
│ │ | Specify the level privacy for the address as public, restricted, or private. Supports the use of an external controlled vocabulary. | |
│ ├▻privacy | ExternalControlledVocabularyEntry | ? |
│ │ | Set to "true" if this is the preferred address. | |
│ └▭isPreferred | xsd:boolean | ? |
│ | The address for contact. | |
├▻hasAddress | * | |
│ │ | Indicates address type (i.e. home, office, mailing, etc.) | |
│ ├▻typeOfAddress | ExternalControlledVocabularyEntry | ? |
│ │ | Number and street including office or suite number. May use multiple lines. | |
│ ├▭line | xsd:string | * |
│ │ | City, place, or local area used as part of an address. | |
│ ├▭cityPlaceLocal | xsd:string | ? |
│ │ | A major subnational division such as a state or province used to identify a major region within an address. | |
│ ├▭stateProvince | xsd:string | ? |
│ │ | Postal or ZIP Code | |
│ ├▭postalCode | xsd:string | ? |
│ │ | Country of the location | |
│ ├▻countryCode | ExternalControlledVocabularyEntry | ? |
│ │ | Time zone of the location expressed as code. | |
│ ├▻timeZone | ExternalControlledVocabularyEntry | ? |
│ │ | Clarifies when the identification information is accurate. | |
│ ├▻effectiveDates | DateRange | ? |
│ │ | Specify the level privacy for the address as public, restricted, or private. Supports the use of an external controlled vocabulary | |
│ ├▻privacy | ExternalControlledVocabularyEntry | ? |
│ │ | Set to "true" if this is the preferred location for contacting the organization or individual. | |
│ ├▭isPreferred | xsd:boolean | ? |
│ │ | Geographic coordinates corresponding to the address. | |
│ ├▻geographicPoint | SpatialPoint | ? |
│ │ | The region covered by the agent at this address | |
│ ├▻regionalCoverage | ExternalControlledVocabularyEntry | ? |
│ │ | The type or purpose of the location (i.e. regional office, distribution center, home) | |
│ ├▻typeOfLocation | ExternalControlledVocabularyEntry | ? |
│ │ | Name of the location if applicable. | |
│ └▻locationName | ObjectName | ? |
│ | Telephone for contact | |
└▻hasTelephone | * | |
│ | The telephone number including country code if appropriate. | |
├▭telephoneNumber | xsd:string | ? |
│ | Indicates type of telephone number provided (home, fax, office, cell, etc.). Supports the use of a controlled vocabulary. | |
├▻typeOfTelephone | ExternalControlledVocabularyEntry | ? |
│ | Time period during which the telephone number is valid. | |
├▻effectiveDates | DateRange | ? |
│ | Specify the level privacy for the telephone number as public, restricted, or private. Supports the use of an external controlled vocabulary. | |
├▻privacy | ExternalControlledVocabularyEntry | ? |
│ | Set to "true" if this is the preferred telephone number for contact. | |
└▭isPreferred | xsd:boolean | ? |
Identifies the difference between the date applied to the data as a whole and this specific item such as previous year's income or residence 5 years ago. A value of true for the attribute isNegativeOffset indicates that the offset is the specified number of declared units prior to the date of the data as a whole and false indicates information regarding a future state.
r:ContentDateOffsetType
ContentDateOffset | ⇩ExternalControlledVocabularyEntry | |
│ | The number of units to off-set the date for this item expressed as a decimal. | |
├▭numberOfUnits | xsd:double | ? |
│ | If set to "true" the date is offset the number of units specified PRIOR to the default date of the data. A setting of "false" indicates a date the specified number of units in the FUTURE from the default date of the data. | |
└▭isNegativeOffset | xsd:boolean | ? |
Describes the commonalities and differences between two members using a textual description of both commonalities and differences plus an optional coding of the type of commonality.
cm:CorrespondenceType
CorrespondenceType | ||
│ | A description of the common features of the two items using a StructuredString to support multiple language versions of the same content as well as optional formatting of the content. | |
├▻commonality | InternationalStructuredString | ? |
│ | A description of the differences between the two items using a StructuredString to support multiple language versions of the same content as well as optional formatting of the content. | |
├▻difference | InternationalStructuredString | ? |
│ | Commonality expressed as a term or code. Supports the use of an external controlled vocabulary. If repeated, clarify each external controlled vocabulary used. | |
├▻commonalityTypeCode | ExternalControlledVocabularyEntry | * |
│ | Allows specification of exact match, close match, or disjoint. These relationships can be further defined by describing commonalities or differences or providing additional controlled vocabulary description of relationship. | |
└▻hasMappingRelation | MappingRelation | ? |
Provides the structure of a single Date expressed in an ISO date structure along with equivalent expression in any number of non-ISO formats. While it supports the use of the ISO time interval structure this should only be used when the exact date is unclear (i.e. occurring at some point in time between the two specified dates) or in specified applications. Ranges with specified start and end dates should use the DateRange as a datatype. Commonly uses property names include: eventDate, issueDate, and releaseDate.
Date allows one of a set of date-time (YYYY-MM-DDThh:mm:ss), date (YYYY-MM-DD), year-month (YYYY-MM), year (YYYY), time (hh:mm:ss) and duration (PnYnMnDnHnMnS), or time interval (YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss, YYYY-MM-DDThh:mm:ss/PnYnMnDnHnMnS, PnYnMnDnHnMnS/ YYYY-MM-DDThh:mm:ss) which is formatted according to ISO 8601 and backed supported by regular expressions in the BaseDateType. Time Zone designation and negative/positive prefixes are allowed as are dates before and after 0000 through 9999.
r:DateType
Date | ||
│ | Strongly recommend that ALL dates be expressed in an ISO format at a minimum. A single point in time expressed in an ISO standard structure. Note that while it supports an ISO date range structure this should be used in Date only when the single date is unclear i.e. occurring at some time between two dates. | |
├▻isoDate | IsoDateType | ? |
│ | A simple date expressed in a non-ISO date format, including a specification of the date format and calendar used. | |
└▻nonIsoDate | * | |
│ | This is the date expressed in a non-ISO compliant structure. Primarily used to retain legacy content or to express non-Gregorian calender dates. | |
├▭dateContent | xsd:string | |
│ | Indicate the structure of the date provided in NonISODate. For example if the NonISODate contained 4/1/2000 the Historical Date Format would be mm/dd/yyyy. The use of a controlled vocabulary is strongly recommended to support interoperability. | |
├▻nonIsoDateFormat | ExternalControlledVocabularyEntry | ? |
│ | Specifies the type of calendar used (e.g., Gregorian, Julian, Jewish). | |
└▻calendar | ExternalControlledVocabularyEntry | ? |
Expresses a date/time range using a start date and end date (both with the structure of Date and supporting the use of ISO and non-ISO date structures). Use in all locations where a range of dates is required, i.e. validFor, embargoPeriod, collectionPeriod, etc.
r:DateType
DateRange | ||
│ | The date (time) designating the beginning of the period or range. | |
├▻startDate | Date | ? |
│ | The date (time) designating the end of the period or range. | |
└▻endDate | Date | ? |
Describes a bounding value for a number range expressed as an xs:double.
r:DoubleNumberRangeValueType
DoubleNumberRangeValue | ||
│ | Indicates that the value is included in the range. Set to false if the range includes numbers up to but no including the designated value. | |
├▭isInclusive | xsd:boolean | ? |
│ | The bounding value expressed as an xs:double | |
└▭doubleValue | xsd:double | ? |
Structure supporting the use of dynamic text, where portions of the textual content change depending on external information (pre-loaded data, response to an earlier query, environmental situations, etc.).
Purpose: Provide customized number of hours within a question text Input is the OutputParameter from Question "What time did you take this medication?" Literal Text: "During the past " [0] Conditional Text / Command: PastTime=Input; Round PastTime to nearest hour; Round CurrentTime to nearest hour; CurrentTime - PastTime = HOURS; content=HOURS [1] Literal Text: " hours which of the following symptoms have you experienced?" [2]
Result in question text for a PastTime= 06:10; CurrentTime=14:54 "During the past 9 hours which of the following symptoms have you experienced?"
d:DynamicTextType
DynamicText | ||
│ | This is the head of a substitution group and is never used directly as an element name. Instead it is replaced with either LiteralText or ConditionalText. | |
├▻textContent | DynamicTextContent | + |
│ | If textual structure (e.g. size, color, font, etc.) is required to understand the meaning of the content change value to "true". | |
├▭isStructureRequired | xsd:boolean | ? |
│ | Specifies the language of the intended audience. This is particularly important for clarifying the primary language of a mixed language textual string, for example when language testing and using a foreign word withing the question text. Supports the inclusion of multiple languages. | |
└▭audienceLanguage | xsd:language | * |
Abstract type existing as the head of a substitution group. May be replaced by any valid member of the substitution group TextContent. Provides the common property of purpose to all members using TextContent as an extension base. Provides a Purpose for the content and ordering information within the Dynamic Text. May be a LiteralText or ConditionalText.
d:TextContentType
DynamicTextContent | ||
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured tex | |
├▻purpose | InternationalStructuredString | ? |
│ | Provides the relative order of TextContent objects in a dynamic text with more than one TextContent object. Uses integer value. | |
└▭orderPosition | xsd:integer | ? |
Allows for unstructured content which may be an entry from an externally maintained controlled vocabulary.If the content is from a controlled vocabulary provide the code value of the entry, as well as a reference to the controlled vocabulary from which the value is taken. Provide as many of the identifying attributes as needed to adequately identify the controlled vocabulary. Note that DDI has published a number of controlled vocabularies applicable to several locations using the ExternalControlledVocabularyEntry structure. If the code portion of the controlled vocabulary entry is language specific (i.e. a list of keywords or subject headings) use language to specify that language. In most cases the code portion of an entry is not language specific although the description and usage may be managed in one or more languages. Use of shared controlled vocabularies helps support interoperability and machine actionability.
r:CodeValueType
ExternalControlledVocabularyEntry | ||
│ | The ID of the code list (controlled vocabulary) that the content was taken from. | |
├▭controlledVocabularyID | xsd:string | ? |
│ | The name of the code list. | |
├▭controlledVocabularyName | xsd:string | ? |
│ | The name of the agency maintaining the code list. | |
├▭controlledVocabularyAgencyName | xsd:string | ? |
│ | The version number of the code list (default is 1.0). | |
├▭controlledVocabularyVersionID | xsd:string | ? |
│ | If the value of the string is "Other" or the equivalent from the codelist, this attribute can provide a more specific value not found in the codelist. | |
├▭otherValue | xsd:string | ? |
│ | The URN or URL of the controlled vocabulary | |
├▭uri | iri | ? |
│ | The value of the entry of the controlled vocabulary. If no controlled vocabulary is used the term is entered here and none of the properties defining the controlled vocabulary location are used. | |
├▭content | xsd:string | ? |
│ | Language of the content value if applicable | |
└▭language | xsd:language | ? |
The static portion of the text expressed as a StructuredString with the ability to preserve whitespace if critical to the understanding of the content.
d:TextType
FixedText | ⇩LanguageSpecificStructuredStringType | |
│ | The default setting states that leading and trailing white space will be removed and multiple adjacent white spaces will be treated as a single white space. If the existance of any of these white spaces is critical to the understanding of the content, change the value of this attribute to "preserve". | |
└▻whiteSpace | WhiteSpaceRule | ? |
A reference to an image, with a description of its properties and type.
r:ImageType
Image | ||
│ | A reference to the location of the image using a URI. | |
├▭uri | iri | ? |
│ | Brief description of the image type. Supports the use of an external controlled vocabulary. | |
├▻typeOfImage | ExternalControlledVocabularyEntry | ? |
│ | Provides the resolution of the image in dots per inch to assist in selecting the appropriate image for various uses. | |
├▭dpi | xsd:integer | ? |
│ | Language of image. Supports the indication of multiple languages. Supports use of codes defined by the RFC 1766. | |
└▭languageOfImage | xsd:language | * |
Allows for the identification of the InstanceVariable specifically as a member and optionally provides an index for the member within an ordered array.
Note if multiple types of Variables may be included in a collection use VariableIndicator.
InstanceVariableIndicator | ||
│ | Provides an index for the member within an ordered array | |
├▭index | xsd:integer | ? |
│ | Member of the collection | |
└▻member | InstanceVariable |
An identifier whose scope of uniqueness is broader than the local archive. Common forms of an international identifier are ISBN, ISSN, DOI or similar designator. Provides both the value of the identifier and the agency who manages it.
For use in Annotation or other citation format.
r:InternationalIdentifierType
InternationalIdentifier | ||
│ | An identifier as it should be listed for identification purposes. | |
├▭identifierContent | xsd:string | ? |
│ | The identification of the Agency which assigns and manages the identifier, i.e., ISBN, ISSN, DOI, etc. | |
├▻managingAgency | ExternalControlledVocabularyEntry | ? |
│ | Set to "true" if Identifier is a URI | |
└▭isURI | xsd:boolean | ? |
Packaging structure for multiple language versions of the same string content. Where an element of this type is repeatable, the expectation is that each repetition contains different content, each of which can be expressed in multiple languages. The language designation goes on the individual String.
r:InternationalStringType
InternationalString | ||
│ | A non-formatted string of text with an attribute that designates the language of the text. Repeat this object to express the same content in another language. | |
└▻languageSpecificString | LanguageSpecificStringType | * |
Packaging structure for multiple language versions of the same string content, for objects that allow for internal formatting using XHTML tags. Where an element of this type is repeatable, the expectation is that each repetition contains different content, each of which can be expressed in multiple languages.
r:StructuredStringType
InternationalStructuredString | ||
│ | Supports the optional use of XHTML formatting tags within the string structure. In addition to the language designation and information regarding translation, the attribute isPlain can be set to true to indicate that the content should be treated as plain unstructured text, including any XHTML formatting tags. Repeat the content element to provide multiple language versions of the same content. | |
└▻languageSpecificStructuredString | LanguageSpecificStructuredStringType | + |
A structured display label. Label provides display content of a fully human readable display for the identification of the object.
r:LabelType
LabelForDisplay | ⇩InternationalStructuredString | |
│ | Indicate the locality specification for content that is specific to a geographic area. May be a country code, sub-country code, or area name. | |
├▻locationVariant | ExternalControlledVocabularyEntry | ? |
│ | Allows for the specification of a starting date and ending date for the period that this label is valid. | |
├▻validDates | DateRange | ? |
│ | A positive integer indicating the maximum number of characters in the label. | |
└▭maxLength | xsd:integer | ? |
Allows for non-formatted language specific strings that may be translations from other languages, or that may be translatable into other languages. Only one string per language/scope type is allowed. LanguageSpecificString contains the following attributes, xmlang to designate the language, isTranslated with a default value of false to designate if an object is a translation of another language, isTranslatable with a default value of true to designate if the content can be translated, translationSourceLanguage to indicate the source languages used in creating this translation, translationDate, and scope which can be used to define intended audience or use such as internal, external, etc.
r:StringType
LanguageSpecificStringType | ||
│ | Value of this string | |
├▭content | xsd:string | |
│ | Indicates the language of content. Note that language allows for a simple 2 or 3 character language code or a language code extended by a country code , for example en-au for English as used in Australia. | |
├▭language | xsd:language | ? |
│ | Indicates whether content is a translation (true) or an original (false). | |
├▭isTranslated | xsd:boolean | ? |
│ | Indicates whether content is translatable (true) or not (false). An example of something that is not translatable would be a MNEMONIC of an object or a number. | |
├▭isTranslatable | xsd:boolean | ? |
│ | List the language code of the source. Repeat of multiple language sources are used. | |
├▭translationSourceLanguage | xsd:language | * |
│ | The date the content was translated. Provision of translation date allows user to verify if translation was available during data collection or other time linked activity. | |
├▭translationDate | xsd:double | ? |
│ | Supports specification of scope for the contained content. Use with the language specification to filter application of content. | |
└▭scope | xsd:string | ? |
Supports the optional use of formatting tags expressed with escape characters within the string structure. Language of the string is defined by the attribute language. Scope of the string is defined by scope. Language and Scope are used to filter selection and use of content based on unique combinations of these two properties. The content can be identified as translated (isTranslated), subject to translation (isTranslatable), the result of translation from one or more languages (translationSourceLanguages), carry an indication whether or not it should be treated as plain text (isPlain), identification of the structure used (structureUsed) which is an internal enumeration, and the ability to identify a structure not available in the enumeration by declaring structureUsed="Other" and specifying the other structure (otherDefined).
The content:
a bit of text
with some specialties highlighted
Would be entered as:
with some specialties highlighted
r:ContentType
LanguageSpecificStructuredStringType | ⇩LanguageSpecificStringType | |
│ | Indicates that the content is to be treated as plain text (no formatting). You may use DDIProfile to fix the value of this attribute to 'true' in cases where you wish to indicate that your system treats all content should be treated as plain text. | |
├▭isPlainText | xsd:boolean | ? |
│ | Uses a enumerated value to specify the structuring elements used. | |
├▻structureUsed | StringStructureType | ? |
│ | If the value of structureUsed is Other enter the structue type. | |
└▭otherDefined | xsd:string | ? |
Literal (static) text to be used in an instrument. The value is a LanguageSpecificStruccturedString with the addition of an attribute allowing for the specification that white space is to be preserved.
The text string " Comment vous appelez-vous?" with the leading spaces included, described as being in French.
d:LiteralTextType
LiteralText | ⇩DynamicTextContent | |
│ | The value of the static text string. Supports the optional use of XHTML formatting tags within the string structure. If the content of a literal text contains more than one language, i.e. "What is your understanding of the German word 'Gesundheit'?", the foreign language element should be placed in a separate LiteralText component with the appropriate xmlang value and, in this case, isTranslatable set to "false". If the existence of white space is critical to the understanding of the content (such as inclusion of a leading or trailing white space), set the attribute of Text xml:space to "preserve". | |
└▻text | LanguageSpecificStructuredStringType | ? |
Name of the location using the DDI Name structure and the ability to add an effective date.
a:LocationNameType
LocationName | ⇩ObjectName | |
│ | The time period for which this name is accurate and in use. | |
└▻effectiveDates | DateRange | ? |
Describes the correspondence between concepts in a correspondence table related to one or more Statistical Classifications.
A Map is the pairing of similar Concepts. Each Concept in the Map belongs to a different Collection. The collection of maps for all the Concepts in corresponding Collections is a Correspondence Table.
A simple example might map the following 2 martial status category sets: MS1 - single married widowed divorced
MS2 - single married
So, a correspondence table between these 2 category sets might look like this: MS1 MS2 single single widowed " divorced " married married
Map
Map | ||
│ | Date from which the Map became valid. The date must be defined if the Map belongs to a floating CorrespondenceTable. Date at which the Map became invalid. The date must be defined if the Map belongs to a floating Correspondence Table and is no longer valid. | |
├▻validDates | DateRange | ? |
│ | Type of correspondence in terms of commonalities and differences between two members. | |
├▻hasCorrespondenceType | CorrespondenceType | ? |
│ | A display label for the OrderedMemberCorrespondence. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
├▻displayLabel | LabelForDisplay | ? |
│ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
├▻usage | InternationalStructuredString | ? |
│ | Concept or any subtype of concepts | |
├▻source | Concept | + |
│ | Concept or any subtype of concept | |
└▻target | Concept | + |
Describes a bounding value for a number range expressed as an xs:demical.
r:NumberRangeValueType
NumberRangeValue | ||
│ | Indicates that the value is included in the range. Set to false if the range includes numbers up to but no including the designated value. | |
├▭isInclusive | xsd:boolean | ? |
│ | Bounding value expressed as an xs:double | |
└▭decimalValue | xsd:double | ? |
A standard means of expressing a Name for a class object. A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles.
USE in Model: In general the property name should be "name" as it is the name of the class object which contains it. Use a specific name (i.e. xxxName) only when naming something other than the class object which contains it.
r:NameType
ObjectName | ||
│ | The expressed name of the object. | |
├▭content | xsd:string | ? |
│ | A name may be specific to a particular context, i.e., a type of software, or a section of a registry. Identify the context related to the specified name. | |
└▻context | ExternalControlledVocabularyEntry | ? |
A tightly bound pair of items from an external controlled vocabulary. The extent property describes the extent to which the parent term applies for the specific case.
When used to assign a role to an actor within a specific activity this term would express the degree of contribution. Contributor with Role=Editor and extent=Lead.
Alternatively. the term might be a controlled vocabulary from a list of controlled vocabularies, e.g. the Generic Longitudinal Business Process Model (GLBPM) in a list that could include other business process model frameworks. In this context the extent becomes the name of a business process model task, e.g. "integrate data" from the GLBPM.
PairedExternalControlledVocabularyEntry | ||
│ | The term attributed to the parent class, for example the role of a Contributor. | |
├▻term | ExternalControlledVocabularyEntry | |
│ | Describes the extent to which the parent term applies for the specific case using an external controlled vocabulary. When associated with a role from the CASRAI Contributor Roles Taxonomy an appropriate vocabulary should be specified as either ‘lead’, ‘equal’, or ‘supporting’. | |
└▻extent | ExternalControlledVocabularyEntry | ? |
A closed plane figure bounded by three or more line segments, representing a geographic area. Contains either the URI of the file containing the polygon, a specific link code for the shape within the file, and a file format, or a minimum of 4 points to describe the polygon in-line. Note that the first and last point must be identical in order to close the polygon. A triangle has 4 points.
r:PolygonType
Polygon | ||
│ | A URI for the boundary file containing the polygon | |
├▭uri | iri | ? |
│ | The PolygonLinkCode is the identifier of the specific polygon within the file. For example in an NHGIS file the LinkCodeForPolygon for Tract 101.01 in Hennepin County in Minnesota is 2700530010101. | |
├▭polygonLinkCode | xsd:string | ? |
│ | The format of the shape file existing at the location indicated by the sibling ExternalURI element. | |
├▻shapeFileFormat | ExternalControlledVocabularyEntry | ? |
│ | A geographic point defined by a latitude and longitude. A minimum of 4 points is required as the first and last point should be identical in order to close the polygon. Note that a triangle has three sides and requires 3 unique points plus a fourth point replicating the first point in order to close the polygon. | |
└▻point | SpatialPoint | {4,-1} |
Describes a bounding value of a string.
r:RangeValueType
RangeValue | ⇩ValueString | |
│ | Set to "true" if the value is included in the range. | |
└▭included | xsd:boolean | ? |
Lists the value and format type for the coordinate value. Note that this is a single value (X coordinate or Y coordinate) rather than a coordinate pair.
r:SpatialCoordinateType
SpatialCoordinate | ||
│ | The value of the coordinate expressed as a string. | |
├▭content | xsd:string | ? |
│ | Identifies the type of point coordinate system using a controlled vocabulary. Point formats include decimal degree, degrees minutes seconds, decimal minutes, meters, and feet. | |
└▻coordinateType | PointFormat | ? |
A geographic point consisting of an X and Y coordinate. Each coordinate value is expressed separately providing its value and format.
r:PointType
SpatialPoint | ||
│ | An X coordinate (latitudinal equivalent) value and format expressed using the Spatial Coordinate structure. | |
├▻xCoordinate | SpatialCoordinate | ? |
│ | A Y coordinate (longitudinal equivalent) value and format expressed using the Spatial Coordinate structure. | |
└▻yCoordinate | SpatialCoordinate | ? |
Used to specify a relationship between one spatial object and another. Includes definition of the spatial object types being related, the spatial relation specification, and the event date.
SpatialRelationship | ||
│ | Provides the types of the two spatial objects. | |
├▻hasSpatialObjectPair | SpatialObjectPairs | ? |
│ | Defines the relationship of the two spatial objects | |
├▻hasSpatialRelationSpecification | SpatialRelationSpecification | ? |
│ | The date of the relationship change. | |
├▻eventDate | Date | ? |
│ | The geographic unit related to by the parent geographic unit | |
└▻relatesTo | GeographicUnit | ? |
The value of the statistic expressed as an xs:decimal and/or xs:double. Indicates whether it is weighted value and the computation base.
pi:StatisticType
Statistic | ||
│ | Set to "true" if the statistic is weighted using the weight designated in VariableStatistics. | |
├▭isWeighted | xsd:boolean | ? |
│ | Defines the cases included in determining the statistic. The options are total=all cases, valid and missing (invalid); validOnly=Only valid values, missing (invalid) are not included in the calculation; missingOnly=Only missing (invalid) cases included in the calculation. | |
├▻computationBase | ComputationBaseList | ? |
│ | Indicate the type of numeric value as decimal, float, double | |
├▭typeOfNumericValue | xsd:string | ? |
│ | The value of the statistic expressed as a decimal, float, or double. | |
└▭content | xsd:double | ? |
TypedString combines a typeOfContent with a content defined as a simple string. May be used wherever a simple string needs to support a type definition to clarify its content
content is a regular expression and typeOfContent is used to define the syntax used.
This is a generic type + string where property name and documentation should be used to define any specification for the content. If international structured string content is required use TypedStructuredString
TypedString | ||
│ | Optional use of a controlled vocabulary to specifically type the associated content. | |
├▻typeOfContent | ExternalControlledVocabularyEntry | ? |
│ | Content of the property expressed as a simple string. | |
└▭content | xsd:string |
The Value expressed as an xs:string with the ability to preserve whitespace if critical to the understanding of the content.
r:ValueType
ValueString | ||
│ | The actual content of this value as a string | |
├▭content | xsd:string | ? |
│ | The usual setting "collapse" states that leading and trailing white space will be removed and multiple adjacent white spaces will be treated as a single white space. When setting to "replace" all occurrences of #x9 (tab), #xA (line feed) and #xD (carriage return) are replaced with #x20 (space) but leading and trailing spaces will be retained. If the existence of any of these white spaces is critical to the understanding of the content, change the value of this attribute to "preserve". | |
└▻whiteSpace | WhiteSpaceRule | ? |
A Concept whose role is to define and measure a characteristic.
Self-identified as "Male". "Extremely Satisfied" as a response category.
The Category is a Concept. It can have multiple name and display label properties as well as a definition and some descriptive text. As a "Signified" class there can be one or more "Sign" classes (e.g. a Code) that denotes it with some representation. The relationship is from the Code to the Category.
l:CategoryType
Category | ⇩Concept | |
│ | A short natural language account of the characteristics of the object. | |
└▻descriptiveText | InternationalStructuredString | ? |
Unit of thought differentiated by characteristics [GSIM 1.1]
Poverty, Income, Household relationship, Family, Gender, Business Establishment, Satisfaction, etc.
Many DDI4 classes are subtypes of the Concept class including Category, Universe, UnitType, ConceptualVariable. This class realizes the pattern class Signified and as such a Concept can be denoted by a Sign.
c:ConceptType
Concept
Concept | ⇩AnnotatedIdentifiable | |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Natural language statement conveying the meaning of a concept, differentiating it from other concepts. Supports the use of multiple languages and structured text. | |
├▻definition | InternationalStructuredString | ? |
│ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
└▻displayLabel | LabelForDisplay | * |
A set of Concepts structured by the relations among them. [GSIM 1.1]
1) Concept of Sex: Male, Female, Other 2) Concept of Household Relationship: Household Head, Spouse of Household Head, Child of Household Head, Unrelated Household Member, etc.
Note that this structure can be used to structure Concept, Classification, Universe, Population, Unit Type and any other class that extends from Concept.
c:ConceptSchemeType
Concept System
ConceptSystem | ⇩AnnotatedIdentifiable | |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | MemberIndicator Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to Concept or subtype of Concept | |
│ └▻member | Concept | |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | A structure containing specific relationships between members of the collection. | |
├▻isStructuredBy | ⇩Identifiable | * |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Restricted to ConceptRelation. ConceptRelations making up the relation structure. | |
│ └▻hasMemberRelation | * | |
│ │ | RelationSpecification Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Restricts source object to Concept for relationshp | |
│ ├▻source | Concept | |
│ │ | Restricts target object to Concept for relationshp | |
│ └▻target | Concept | |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
Relationship between 2 or more ConceptSystems described through mapping similarity relationships between their member Concepts.
Correspondence between the concepts used to define the populations in the censuses of two countries with similarity mapping of Concepts "Resident Population", "Labor Force", "Housing Unit", etc.
Describes correspondence with one or more Maps which identify a source and target concept and defines their commonality and difference using descriptive text and controlled vocabularies.
ConceptSystemCorrespondence | ⇩AnnotatedIdentifiable | |
│ | A display label for the CollectionCorrespondence. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
├▻displayLabel | LabelForDisplay | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
├▻usage | InternationalStructuredString | ? |
│ | Realization of correspondence in Comparison for mapping similar concepts. | |
├▻correspondence | Map | * |
│ | Realization of structures in Symmetric Relation. When Concepts of a single ConceptSystem are mapped, the Concept has to appear twice as target. | |
└▻maps | ConceptSystem | {2,-1} |
Set of Concepts, both sentinel and substantive, that can be described by either enumeration or by an expression.
Substantive: Housing Unit Tenure - Owned, Rented, Vacant; Sentinel: Non-response - Refused, Don't Know, Not Applicable
Intent of a Conceptual Domain is defining a set of concepts used to measure a broader concept. For effective use they should be discrete (non-overlapping) and provide exhaustive coverage of the broader concept.
ConceptualDomain | ⇩AnnotatedIdentifiable | |
│ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
├▻displayLabel | LabelForDisplay | * |
│ | A description of the concepts in the domain. A numeric domain might use a logical expression to be machine actionable a text domain might use a regular expression to describe strings that describe the concepts. | |
├▻describedConceptualDomain | ValueAndConceptDescription | ? |
│ | The set of categories containing the concepts in the domain. | |
└▻enumeratedConceptualDomain | ConceptSystem | ? |
The use of a Concept as a characteristic of a UnitType intended to be measured
Note that DDI varies from GSIM in the use of a UnitType rather than a Universe. "The use of a Concept as a characteristic of a Universe intended to be measured" [GSIM 1.1]
c:ConceptualVariableType
Variable
ConceptualVariable | ⇩Concept | |
│ | A short natural language account of the characteristics of the object. | |
├▻descriptiveText | InternationalStructuredString | ? |
│ | Reference to a Concept that is being used | |
├▻usesConcept | Concept | * |
│ | Identifies the ConceptualDomain containing the set of substantive concepts used to describe the ConceptualVariable. | |
├▻takesSubstantiveConceptsFrom | SubstantiveConceptualDomain | ? |
│ | Identifies the UnitType associated with the ConceptualVariable | |
├▻usesUnitType | UnitType | ? |
│ | Identifies the ConceptualDomain containing the set of sentinel concepts used to describe the ConceptualVariable. | |
└▻takesSentinelConceptsFrom | SentinelConceptualDomain | ? |
The use of a Represented Variable within a Data Set. The InstanceVariable describes actual instances of data that have been collected.
1) Gender: Dan Gillman has gender <m, male>, Arofan Gregory has gender<m, male>, etc. 2) Number of employees: Microsoft has 90,000 employees; IBM has 433,000 employees, etc. 3) Endowment: Johns Hopkins has endowment of <3, $1,000,000 and above>, Yale has endowment of <3, $1,000,000 and above>, etc.
Two InstanceVariables of a person's height reference the same RepresentedVariable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same SubstantativeValueDomain, use a SentinelValueDomain drawn from the same set of SentinelValueDomains, have the same sentinel (missing value) concepts, and draw their Population from the same Universe. In other words, the two InstanceVariables should be comparable.
The InstanceVariable class inherits all of the properties and relationships of the RepresentedVariable (RV) class and, in turn, the ConceptualVariable (CV) class. This means that an InstanceVariable can be completely populated without the need to create an associated RepresentedVariable or ConceptualVariable. If, however, a user wishes to indicate that a particular InstanceVariable is patterned after a particular RepresentedVariable or a particular ConceptualVariable that may be indicated by including a relationship to the RV and or CV. Including these references is an important method of indicating that multiple InstanceVariables have the same representation, measure the same concept, and are drawn from the same Universe. If two InstanceVariables of a person's height reference the same RepresentedVariable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same SubstantativeValueDomain, use a SentinelValueDomain drawn from the same set of SentinelValueDomains, have the same sentinel (missing value) concepts, and draw their Population from the same Universe. In other words, the two InstanceVariables should be comparable.
Instance Variable
InstanceVariable | ⇩RepresentedVariable | |
│ | Immutable characteristics of the variable such as, geographic designator, weight, temporal designation, etc. | |
├▻variableFunction | ExternalControlledVocabularyEntry | * |
│ | The data type of this variable. Supports the optional use of an external controlled vocabulary. | |
├▻physicalDataType | ExternalControlledVocabularyEntry | ? |
│ | This should match a platformType of the RepresentedVariable on which the InstanceVariable is based (if one exists). It is drawn from the same external controlled vocabulary used by the RepreentedVariable's platformType. A sample list for the external controlled vocabulary is: A sample list would be: • BlankString - A Blank string indicates missing. Comparison is based on lexical order. • EmptyString - An empty string indicates missing. Use in comparisons returns missing. • Rstyle - Codes drawn from NA and the IEEE 754 values of NaN -Inf +Inf. Comparisons return NA. • SASNumeric - codes drawn from . ._ .A .B .C .D .E .F .G .H .I .J .K .L .M .N .O .P .Q .R .S .T .U .V .W .X .Y .Z Sentinel code treated as less than any substantive value • SPSSstyle - System missing (a dot) a set of individual values drawn from the same datatype as the SubstantiveValueDomain, and a range of values drawn from the same datatype as the SubstantiveValueDomain. Comparisons return system missing. Some functions substitute with valid values (e.g. SUM replaces missing values with 0) • StataNumeric - codes drawn from . ._ .A .B .C .D .E .F .G .H .I .J .K .L .M .N .O .P .Q .R .S .T .U .V .W .X .Y .Z Sentinel code treated as greater than any substantive value • Unrestricted - No restrictions on codes for sentinel values. Use in comparisons is indeterminate. | |
├▻platformType | ExternalControlledVocabularyEntry | ? |
│ | Set of specific units (people, entities, objects, events), usually in a given time and geography, being measured. Can be a specialization of the Universe measured by a related RepresentedVariable. | |
├▻measures | Population | ? |
│ | The RepresentedVariable that can be shared by multiple InstanceVariables. Indicates comparability in substantive representation, Universe, and indirectly ConceptualDomain. If a relationship to a RepresentedVariable is defined there should be no relationship to a ConceptualVariable. | |
├▻basedOnRepresentedVariable | RepresentedVariable | ? |
│ | The ConceptualVariable that can be shared by multiple InstanceVariables. Indicates comparability ConceptualDomain and UnitType. If a relationship to a RepresentedVariable is defined there should be no relationship to a ConceptualVariable. | |
├▻basedOnConceptualVariable | ConceptualVariable | ? |
│ | The association to the possible sentinel (missing) values.These will be specific to one software platform. | |
├▻takesPlatformSpecificSentinelValues | SentinelValueDomain | ? |
│ | The source of capture for the values that populate this InstanceVariable. This may be any class using Capture as an extension base, currently RepresentedQuestion and RepresentedMeasurement. This is the direct source of capture for the content of the data. If a transformation is required the source is not multiple captures but the transformation. | |
├▻sourceCapture | Capture | ? |
│ | If generated directly through fielding an instrument use the instrument component containing the capture for the values that populate this InstanceVariable. A Capture is reusable and therefore it is important to know the specific use of the Capture within an Instrument. This may be any class using InstrumentComponent as an extension base, currently InstanceQuestion and InstanceMeasurement. If the content of the InstanceVariable was generated by a computation or other form of transformation with data processing, use the ComputationAction or similarly appropriate subclass of Act. If a sequence of Acts resulted in the InstanceVariable content indicate the final Act. | |
└▻generatedBy | Act | ? |
Set of specific units (people, entities, objects, events) with specification of time and geography.
Population is the most specific in the conceptually narrowing hierarchy of UnitType, Universe and Population. Several Populations having differing time and or geography may specialize the same Universe.
Population
Population | ⇩Universe | |
│ | The time period associated with the Population | |
├▻timePeriodOfPopulation | DateRange | * |
│ | Units in the Population | |
├▻composedOf | Unit | * |
│ | Reference to a Universe that the Population narrows | |
├▻narrowsUniverse | Universe | ? |
│ | The geographic location related to this population. May be repeated for inclusion of multiple locations. | |
└▻geographyOfPopulation | GeographicUnit | * |
A combination of a characteristic of a universe to be measured and how that measure will be represented.
The pair (Number of Employees, Integer), where "Number of Employees" is the characteristic of the population (Variable) and "Integer" is how that measure will be represented (Value Domain).
Extends from ConceptualVariable and can contain all descriptive fields without creating a ConceptualVariable. By referencing a ConceptualVariable it can indicate a common relationship with RepresentedVariables expressing the same characteristic of a universe measured in another way, such as Age of Persons in hours rather than years. RepresentedVariable constrains the coverage of the UnitType to a specific Universe. In the above case the Universe with the measurement of Age in hours may be constrained to Persons under 5 days (120 hours old). RepresentedVariable can define sentinel values for multiple storage systems which have the same conceptual domain but specialized value domains.
l:RepresentedVariableType
RepresentedVariable | ⇩ConceptualVariable | |
│ | The unit in which the data values are measured (kg, pound, euro). | |
├▭unitOfMeasurement | xsd:string | ? |
│ | The data type intended to be used by this variable. Supports the optional use of an external controlled vocabulary. | |
├▻hasIntendedDataType | ExternalControlledVocabularyEntry | ? |
│ | The substantive representation (SubstantiveValueDomain) of the variable. This is equivalent to the relationship "Measures" in GSIM although GSIM makes no distinction between substantive and sentinel values | |
├▻takesSubstantiveValuesFrom | ⇩ValueDomain | ? |
│ │ | Corresponding conceptual definition given by an SubstantiveConceptualDomain. | |
│ ├▻takesConceptsFrom | SubstantiveConceptualDomain | ? |
│ │ | A formal description of the set of valid values - for described value domains. | |
│ ├▻describedValueDomain | ValueAndConceptDescription | ? |
│ │ | Any subtype of an enumeration domain enumerating the set of valid values. | |
│ └▻enumeratedValueDomain | EnumerationDomain | ? |
│ | The defined class of people, entities, events, or objects to be measured. | |
├▻drawsFrom | Universe | ? |
│ | The ConceptualVariable that can be shared by a set of multiple RepresentedVariables. Indicates comparability in ConceptualDomain and UnitType. | |
├▻basedOnConceptualVariable | ConceptualVariable | ? |
│ | A RepresentedVariable may have more than one sets of SentinelValueDomains, one for each type of software platform on which related InstanceVariables might be instantiated. All of the SentinelValueDomains must have SentinelConceptualDomains that correspond exactly. This allows codes for missing values to be explicitly matched across platforms. | |
└▻takesPlatformSpecificSentinelValues | SentinelValueDomain | * |
Description or list of possible sentinel concepts , e.g. missing values.
Refused, Don't know, Lost in processing
missing categories
SentinelConceptualDomain | ⇩ConceptualDomain |
Set of valid Concepts. The Concepts can be described by either enumeration or by an expression.
An enumeration of concepts for a categorical variable like "male" and "female" for gender.
A ConceptualVariable links a UnitType to a SubstantiveConceptualDomain. The latter can be an enumeration or description of the values (Signified) that the variable may take on. In the enumerated case these are the categories in a CategorySet that can be values, not the codes that represent the values. An example might be the conceptual domain for a variable representing self-identified gender. An enumeration might include the concept of “male” and the concept of “female”. These, in turn, would be represented in a SubstantiveValueDomain by codes in a CodeList like “m” and “f”, or “0” and “1”. A conceptual domain might be described through a ValueAndConceptDescription’s description property of “a real number greater than 0” or through a more formal logicalExpression of “(all reals x such that x >0) “. Even in the described case, what is being described are conceptual, not the symbols used to represent the values. This may be a subtle distinction, but allows specifying that the same numeric value might be represented by 32 bits or by 64 bits or by an Arabic numeral or a Roman numeral.
Conceptual Domain
SubstantiveConceptualDomain | ⇩ConceptualDomain |
The object of interest in a process step related to the collection or use of observational data.
Here are 3 examples - 1. Individual US person (i.e., Arofan Gregory, Dan Gillman, Barack Obama, etc.) 2. Individual US computer companies (i.e., Microsoft, Apple, IBM, etc.) 3. Individual US universities (i.e., Johns Hopkins, University of Maryland, Yale, etc.) [GSIM 1.1]
In a traditional data table each column might represent some variable (measurement). Each row would represent the entity (Unit) to which those variables relate. Height measurements might be made on persons (UnitType) of primary school age (Universe) at Pinckney Elementary School on September 1, 2005 (Population). The height for Mary Roe (Unit) might be 139 cm. The Unit is not invariably tied to some value. A median income might be calculated for a block in the U.S. but then used as an attribute of a person residing on that block. For the initial measurement the Unit was the block. In the reuse the unit would be that specific person to which the value was applied. In a big data table each row represents a unit/variable double. Together a unit identifier and a variable identifier define the key. And for each key there is just one value – the measure of the unit on the variable. A big data table is sometimes referred to as a column-oriented data store whereas a traditional database is sometimes referred to as a row-oriented data store. The unit plays an identifier role in both types of data stores.
Unit
Unit | ⇩AnnotatedIdentifiable | |
│ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
├▻displayLabel | LabelForDisplay | * |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Natural language statement conveying the meaning of a concept, differentiating it from other concepts. Supports the use of multiple languages and structured text. | |
├▻definition | InternationalStructuredString | ? |
│ | The UnitType of the Unit | |
└▻hasUnitType | UnitType | * |
A Unit Type is a type or class of objects of interest.
Person, Establishment, Household, State, Country, Dog, Automobile
UnitType is the most general in the hierarchy of UnitType, Universe, and Population. It is a description of the basic characteristic for a general set of Units. A Universe is a set of entities defined by a more narrow specification than that of an underlying UnitType. A Population further narrows the specification to a specific time and geography. A Unit Type is used to describe a class or group of Units based on a single characteristic with no specification of time and geography. For example, the Unit Type of “Person” groups together a set of Units based on the characteristic that they are ‘Persons’. It concerns not only Unit Types used in dissemination, but anywhere in the statistical process. E.g. using administrative data might involve the use of a fiscal unit. [GSIM 1.1]
Object Class [ISO11179]
Unit Type
UnitType | ⇩Concept | |
│ | A short natural language account of the characteristics of the object. | |
├▻descriptiveText | InternationalStructuredString | ? |
│ | Reference to the Concept that is being used | |
└▻usesConcept | Concept | ? |
A defined set or class of people, entities, events, or objects, with no specification of time and geography, contextualizing a Unit Type
Universe sits in a hierarchy between UnitType and Population, with UnitType being most general and Population most specific. A Universe is a set of entities defined by a more narrow specification than that of an underlying UnitType. A Population further narrows the specification to a specific time and geography.
If the Universe consists of people, a number of factors may be used in defining membership in the Universe, such as age, sex, race, residence, income, veteran status, criminal convictions, etc. The universe may consist of elements other than persons, such as housing units, court cases, deaths, countries, etc. A universe may be described as "inclusive" or "exclusive".
Not to be confused with Population, which includes the specification of time and geography.
c:UniverseType
Population
Universe | ⇩Concept | |
│ | Default value is True. The description statement of a universe is generally stated in inclusive terms such as "All persons with university degree". Occasionally a universe is defined by what it excludes, i.e., "All persons except those with university degree". In this case the value would be changed to "false". | |
├▭isInclusive | xsd:boolean | ? |
│ | A short natural language account of the characteristics of the object. | |
├▻descriptiveText | InternationalStructuredString | ? |
│ | Reference to the Unit Type that the Universe definition narrows. | |
├▻narrowsUnitType | UnitType | ? |
│ | Reference to the Concept that is being used | |
└▻usesConcept | Concept | * |
High level, descriptive, human informative, algorithm statement used to describe the overall methodology.
This would most commonly be used in a Codebook along with a MethodologyOverview and a DesignOverview.The underlying properties of the algorithm or method rather than the specifics of any particular implementation. In short a description of the method in its simplest and most general representation.
AlgorithmOverview | ⇩AnnotatedIdentifiable | |
│ | A term identifying the subject of the algorithm being described. Supports the use of a controlled vocabulary | |
├▻subjectOfAlgorithm | ExternalControlledVocabularyEntry | ? |
│ | Short natural language account of the information obtained from the combination of properties and relationships associated with an object. Supports the use of multiple languages and structured text. | |
├▻overview | InternationalStructuredString | ? |
│ | An external document or other source that provides descriptive information on the object. | |
└▻isDescribedIn | ExternalMaterial | * |
High level, descriptive, human informative, design statement The design may be used to specify how a process will be performed in general. This would most commonly be used in a Codebook along with an AlgorithmOverview and a MethodologyOverview. The design informs a specific or implemented process as to its general parameters. Supports specification of any realization of Goal.
Allows for the use of any realized Process. The methodology, design, and algorithm of a specific realized process should be used if available. The use of a generic Process such as a WorkflowProcess containing an Act would be appropriate here. Restriction would be done by inclusion of the appropriate realized process class(es) in a Functional View.
DesignOverview | ⇩AnnotatedIdentifiable | |
│ | A term describing the subject of the design. Supports the use of an external controlled vocabulary | |
├▻subectOfDesign | ExternalControlledVocabularyEntry | ? |
│ | Short natural language account of the information obtained from the combination of properties and relationships associated with an object. Supports the use of multiple languages and structured text. | |
├▻overview | InternationalStructuredString | ? |
│ | An external document or other source that provides descriptive information on the object. | |
├▻isDescribedIn | ExternalMaterial | * |
│ | The description of a Precondition that must exist prior to the use of this design | |
├▻assumesPrecondition | ⇩BusinessFunction | * |
│ │ | Identifies material discussing the precondition. The material may be in DDI or other format. | |
│ ├▻isDiscussedIn | ExternalMaterial | * |
│ │ | The Precondition may be based on the Results of earlier Processes, indicated with this relationship. | |
│ └▻basedOnPriorResult | Result | * |
│ | A description of the goal of the design. The goal may be used to evaluate the design, or implementations of the design, in terms of its ability to meet the goal. | |
├▻specifiesGoal | Goal | * |
│ | The algorithm that is expressed by the design. Constraint of the pattern relationship expressesAlgorithm by limiting the target to a DescribedAlgorithm. | |
├▻expressesAlgorithm | AlgorithmOverview | * |
│ | The process used to implement the Design. WorkflowProcess is a generic realization of the ProcessPattern. | |
└▻implementedBy | WorkflowProcess | * |
High level, descriptive, human informative methodology statement used to describe the overall methodology, identify related design, algorithm, and process information. A methodology is normally informed by earlier research and clarifies how earlier research methods were incorporated into the current work.
The target of the relationship from Study: "hasMethodology"
This would most commonly be used in a Codebook along with an AlgorithmOverview and a DesignOverview. Note that Process may be described in more detail than a high level overview. Note that the algorithm may be implemented by multiple processes which are not limited to any specific type of Process. This can be constrained by the inclusion of only specific realizations of Process within a Functional View. Note that this MethodologyOverview can be used as a collective description of specific methodologies used by a Study or other broad set of metadata.
MethodologyOverview | ⇩AnnotatedIdentifiable | |
│ | A term describing the subject of the Methodology. Supports the use of a controlled vocabulary | |
├▻subjectOfMethodology | ExternalControlledVocabularyEntry | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided, provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
├▻usage | InternationalStructuredString | ? |
│ | Explanation of the reasons some decision was made or some object exists. Supports the use of multiple languages and structured text. | |
├▻rationale | InternationalStructuredString | ? |
│ | Short natural language account of the information obtained from the combination of properties and relationships associated with an object. Supports the use of multiple languages and structured text. | |
├▻overview | InternationalStructuredString | ? |
│ | An external document or other source that provides descriptive information on the object. | |
├▻isDescribedIn | ExternalMaterial | * |
│ | The design used by the methodology. A restriction of the Methdology class to constrain the target to DescribedDesign. | |
├▻hasDesign | DesignOverview | * |
│ | The algorithm which expresses the methodology. A restriction of the Methdology class to constrain the target to DescribedAlgorithm. | |
├▻isExpressedBy | AlgorithmOverview | * |
│ | A methodology which is a component part of this methodology. The target may be any realized Methodology. This allows the DescribedMethodology to incorporate more explicit or detailed methodologies for different forms of use without replicating the descriptive content. | |
└▻componentMethodology | MethodologyOverview | * |
Char | ||
... | {"type":"NodeConstraint","nodeKind":"Literal","annotations":[{"type":"Annotation","predicate":"http://www.w3.org/2000/01/rdf-schema#definedBy","object":"http://lion.ddialliance.org/ddiobjects/char"},{"type":"Annotation","predicate":"http://www.w3.org/ns/shex-xmi#package","object":{"value":"http://ddi-alliance.org/ns/#RegularExpressions"}}]} |
IsoDateType | ||
... | {"type":"NodeConstraint","nodeKind":"Literal","annotations":[{"type":"Annotation","predicate":"http://www.w3.org/2000/01/rdf-schema#definedBy","object":"http://lion.ddialliance.org/ddiobjects/isodatetype"},{"type":"Annotation","predicate":"http://www.w3.org/ns/shex-xmi#package","object":{"value":"http://ddi-alliance.org/ns/#RegularExpressions"}}]} |
A specific geographic unit of a defined Unit Type. A geographic unit may change its name, composition, or geographic extent over time. This may be tracked by versioning the content of the geographic unit. Normally a new version of a geographic unit would have a geographic (spatial) overlap with its previous version (a city annexing new area). A geographic unit ends when it is no longer a unit of the same unit type.
The State of Minnesota from 1858 to date where the Unit Type is a State as defined by the United States Census Bureau. It has a geographic extent and supersedes a portion of the Territory of Minnesota and a portion of the Territory of Wisconsin. Minnesota territory had both a broader geographic extent, different Unit Type, and earlier time period (1849-1858) as did the Territory of Wisconsin.
r:GeographicLocationType
GeographicUnit | ⇩Unit | |
│ | The period for which the Geographic Unit is valid. Note that the geographic extent, name, or composition change within the valid period of this unit. | |
├▻geographicTime | DateRange | ? |
│ | The Geographic Unit supercedes (follows immediately in time) the described geographic unit. Repeat for multiple geographic units. | |
├▻supercedes | SpatialRelationship | * |
│ | The Geographic Unit is superceded by (precedes immediately in time) the described geographic unit. Repeat for multiple geographic units. | |
├▻precedes | SpatialRelationship | * |
│ | Describes the geographic extent or coverage of the geographic unit during the specified period of time. | |
└▻hasGeographicExtent | ⇩AnnotatedIdentifiable | * |
│ | A description of the boundaries of the polygon either in-line or by a reference to an external file containing the boundaries. Repeatable to describe non-contiguous areas such as islands or Native American Reservations in some parts of the United States. | |
├▻boundingPolygon | Polygon | * |
│ | A description of a the boundaries of a polygon internal to the bounding polygon which should be excluded. For example, for the bounding polygon describing the State of Brandenburg in Germany, the Excluding Polygon would describe the boundary of Berlin, creating hole within Brandenburg which is occupied by Berlin. | |
├▻excludingPolygon | Polygon | * |
│ | A time for which the polygon is an accurate description of the area. This may be a range (without an end date if currently still valid) or a single date when the shape was know to be valid if a range is not available. | |
├▻geographicTime | DateRange | ? |
│ | Means of describing the area covered by the geographic extent either in its entirety (total area) or specific subsets (land, water, urban, rural, etc.) providing a definition and measurement. | |
├▻hasAreaCoverage | * | |
│ │ | Specify the type of area covered i.e. Total, Land, Water, etc. Supports the use of an external controlled vocabulary. | |
│ ├▻typeOfArea | ExternalControlledVocabularyEntry | ? |
│ │ | Records the measurement unit, for example, Square Kilometer, Square Mile. Supports the use of an external controlled vocabulary. | |
│ ├▻measurementUnit | ExternalControlledVocabularyEntry | ? |
│ │ | The area measure expressed as a decimal for the measurement unit designated. | |
│ └▭areaMeasure | xsd:double | ? |
│ | Identifies the centroid of a polygon as a specific point | |
├▻hasCentroid | SpatialPoint | ? |
│ | The geographic extent is a single point. | |
├▻locationPoint | SpatialPoint | ? |
│ | The geographic extent is a single line | |
├▻isSpatialLine | ? | |
│ │ | A URI for the spatial file containing the line | |
│ ├▭uri | iri | ? |
│ │ | The lineLinkCode is the identifier of the specific line within the file. | |
│ ├▭lineLinkCode | xsd:string | ? |
│ │ | The format of the shape file existing at the location indicated by the sibling ExternalURI element. | |
│ ├▻shapeFileFormat | ExternalControlledVocabularyEntry | ? |
│ │ | A geographic point defined by a latitude and longitude. A minimum of 2 points is required in order to define the line. | |
│ └▻point | SpatialPoint | {2,-1} |
│ | A Bounding Box (North, South Latitude and East, West Longitude) for the geographic extent. | |
└▻hasBoundingBox | BoundingBox | ? |
Describes the classification of specific geographic units into a classification system. As a subtype of Code List it can be used directly for the description of a value domain.
GeographicUnitClassification | ⇩EnumerationDomain | |
│ | Define the code and Unit Type that is a member of the Geographic Unit Classification. They may be unordered or ordered and assigned to a specific level. | |
├▻contains | * | |
│ │ | Index number expressed as an integer. The position of the member in an ordered array. Optional for unordered Collections. | |
│ ├▭index | xsd:integer | ? |
│ │ | Indicates the level within which the CodeItem resides | |
│ ├▭isInLevel | xsd:integer | ? |
│ │ | Member of the collection. | |
│ └▻member | GeographicUnit | |
│ | Date the Classification was released | |
├▻releaseDate | Date | ? |
│ | The date the classification enters production use and the date on which the Classification was superseded by a successor version or otherwise ceased to be valid. (Source: GSIM Statistical Classification) | |
├▻validDates | DateRange | ? |
│ | Indicates if the Classification is currently valid. | |
├▭isCurrent | xsd:boolean | ? |
│ | Indicates if the Classification is a floating classification. In a floating classification, a validity period should be defined for all Classification Items which will allow the display of the item structure and content at different points of time. (Source: GSIM StatisticalClassification/Floating) | |
├▭isFloating | xsd:boolean | ? |
│ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
├▻displayLabel | LabelForDisplay | * |
│ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
├▻usage | InternationalStructuredString | ? |
│ | May reference an existing concept system generally of Geographic Unit | |
├▻references | ConceptSystem | * |
│ | A relation structure used to describe complex relationships between the members | |
├▻isStructuredBy | ⇩Identifiable | ? |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship context for the relationship using an External Controlled Vocabulary. Examples might include "parent-child", or "immediate supervisee" | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Controlled Vocabulary to specify whether the relation is total, partial or unknown. | |
│ ├▻totality | TotalityType | ? |
│ │ | MemberRelation used to define the relationship of members within the collection | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides information on the spatial relationship between the parent and child. | |
│ ├▻hasSpatialRelationSpecification | SpatialRelationSpecification | ? |
│ │ | Provide a semantic that provides a context for the relationship using and External Controlled Vocabulary | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of its totality using an enumeration list. | |
│ ├▻totality | TotalityType | ? |
│ │ | The first member of the relationship. | |
│ ├▻source | GeographicUnit | ? |
│ │ | Second member in the relationship. Notes this could be realized as a collection supporting tuple relationship. | |
│ └▻target | GeographicUnit | * |
│ | Organization, agency, or group within an agency responsible for the maintenance and upkeep of the classification. | |
├▻isMaintainedBy | Organization | * |
│ | Geographic Unit Classification on which the current variant is based, and any subsequent versions of that Classification to which it is also applicable. | |
├▻variantOf | GeographicUnitClassification | ? |
│ | Geographic Unit Classification superseded by the actual Classification (for those Classifications that are versions or updates). | |
├▻replaces | GeographicUnitClassification | * |
│ | Geographic Unit Type Structure that supersedes the actual Statistical Classification (for those Statistical Classifications that are versions or updates). | |
└▻isReplacedBy | GeographicUnitClassification | * |
A structured collection of Unit Types defining a geographic structure. As a subtype of CodeList it may be used directly to describe a value domain.
Country--State--County
GeographicUnitTypeClassification | ⇩EnumerationDomain | |
│ | Define the code and Unit Type that is a member of the Geographic Unit Type Classification. They may be unordered or ordered and assigned to a specific level. | |
├▻contains | * | |
│ │ | Index number expressed as an integer. The position of the member in an ordered array. Optional for unordered Collections. | |
│ ├▭index | xsd:integer | ? |
│ │ | Indicates the level within which the CodeItem resides | |
│ ├▭isInLevel | xsd:integer | ? |
│ │ | Member of the collection. | |
│ └▻member | UnitType | |
│ | Date the Classification was released | |
├▻releaseDate | Date | ? |
│ | The date the statistical classification enters production use and the date on which the Classification was superseded by a successor version or otherwise ceased to be valid. (Source: GSIM Statistical Classification) | |
├▻validDates | DateRange | ? |
│ | Indicates if the Statistical Classification is currently valid. | |
├▭isCurrent | xsd:boolean | ? |
│ | Indicates if the Classification is a floating classification. In a floating statistical classification, a validity period should be defined for all Classification Items which will allow the display of the item structure and content at different points of time. (Source: GSIM StatisticalClassification/Floating) | |
├▭isFloating | xsd:boolean | ? |
│ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
├▻displayLabel | LabelForDisplay | * |
│ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
├▻usage | InternationalStructuredString | ? |
│ | May reference an existing concept system generally of Geographic Unit Types | |
├▻references | ConceptSystem | * |
│ | A relation structure used to describe complex relationships between the members | |
├▻isStructuredBy | ⇩Identifiable | ? |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship context for the relationship using an External Controlled Vocabulary. Examples might include "parent-child", or "immediate supervisee" | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Controlled Vocabulary to specify whether the relation is total, partial or unknown. | |
│ ├▻totality | TotalityType | ? |
│ │ | MemberRelation used to define the relationship of members within the collection | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides information on the spatial relationship between the parent and child. | |
│ ├▻hasSpatialRelationSpecification | SpatialRelationSpecification | ? |
│ │ | An aggregation of the units of the child Unit Type will result in exhaustive coverage of the parent Unit Type | |
│ ├▭isExhaustiveCoverage | xsd:boolean | ? |
│ │ | Provide a semantic that provides a context for the relationship using and External Controlled Vocabulary | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of its totality using an enumeration list. | |
│ ├▻totality | TotalityType | ? |
│ │ | The first member of the relationship. | |
│ ├▻source | UnitType | ? |
│ │ | Second member in the relationship. Notes this could be realized as a collection supporting tuple relationship. | |
│ └▻target | UnitType | * |
│ | Organization, agency, or group within an agency responsible for the maintenance and upkeep of the classification. | |
├▻isMaintainedBy | Organization | * |
│ | Geographic Unit Type Structure on which the current variant is based, and any subsequent versions of that Classification to which it is also applicable. | |
├▻variantOf | GeographicUnitTypeClassification | ? |
│ | Geographic Unit Type Structure superseded by the actual Classification (for those Classifications that are versions or updates). | |
├▻replaces | GeographicUnitTypeClassification | * |
│ | Geographic Unit Type Structure that supersedes the actual Classification (for those Classifications that are versions or updates), | |
└▻isReplacedBy | GeographicUnitTypeClassification | * |
The information needed for understanding the physical structure of data coming from a file or other source. A StructureDescription also points to the Data Store it physically represents.
The PhysicalDataProduct is the entry point for information about a file or other source. It includes information about the name of a file, the structure of segments in a file and the layout of segments.
Multiple styles of structural description are supported: including describing files as unit-record (UnitSegmentLayout) files; describing cubes; and describing event-history (spell) data.
p:PhysicalDataProductType
PhysicalDataSet | ⇩AnnotatedIdentifiable | |
│ | Short natural language account of the information obtained from the combination of properties and relationships associated with an object. Supports the use of multiple languages and structured text. | |
├▻overview | InternationalStructuredString | ? |
│ | Use when multiple physical segments are stored in a single file | |
├▭physicalFileName | xsd:string | ? |
│ | The number of segments in a Physical Data Product | |
├▭numberOfSegments | xsd:integer | ? |
│ | A physical description of the data store encompasses a description of its gross record structure. This structure consists of one or more PhysicalRecordSegments and their relationships. Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to PhysicalRecordSegment | |
│ └▻member | PhysicalRecordSegment | |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | Whether the dataset is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | An explanation of the purpose of the physical dataset | |
├▻purpose | InternationalStructuredString | ? |
│ | Data Store physically represented by the Structure Description. | |
├▻formatsDataStore | DataStore | * |
│ | Description of a complex structure for the Collection. A collection may be structured in more than one way for different uses. | |
├▻isStructuredBy | ⇩Identifiable | * |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Member relations that comprise the relation structure | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | first member in the relationship. Constrained to a single source | |
│ ├▻source | PhysicalRecordSegment | ? |
│ │ | second member in the relationship | |
│ └▻target | PhysicalRecordSegment | * |
│ | Variable Statistics related to the Physical Data Set. May be summary or category level statistics. | |
├▻hasVariableStatistics | ⇩Identifiable | * |
│ │ | The total number of responses to this variable. This element is especially useful if the number of responses does not match added case counts. It may also be used to sum the frequencies for variable categories. | |
│ ├▭totalResponses | xsd:integer | ? |
│ │ | Statistic that provides a summary value, filtered or unfiltered, weighted or unweighted, expressed as an xs:decimal or xs:double | |
│ ├▻hasSummaryStatistic | * | |
│ │ │ | Type of summary statistic, such as count, mean, mode, median, etc. Supports the use of an external controlled vocabulary. DDI strongly recommends the use of a controlled vocabulary. | |
│ │ ├▻typeOfSummaryStatistic | ExternalControlledVocabularyEntry | ? |
│ │ │ | The value of the statistics and whether it is weighted and/or includes missing values. May expressed as xs:decimal and/or xs:double | |
│ │ └▻hasStatistic | Statistic | * |
│ │ | Statistics that provides a category specific values, filtered or unfiltered, weighted or unweighted, expressed as an xs:decimal or xs:double | |
│ ├▻hasCategoryStatistic | * | |
│ │ │ | Type of category statistic. Supports the use of an external controlled vocabulary. DDI strongly recommends the use of a controlled vocabulary. | |
│ │ ├▻typeOfCategoryStatistic | ExternalControlledVocabularyEntry | ? |
│ │ │ | The value of the identified type of statistic for the category. May be repeated to provide unweighted or weighted values and different computation bases. | |
│ │ ├▻hasStatistic | Statistic | * |
│ │ │ | Value of the category to which the statistics apply | |
│ │ ├▻categoryValue | ValueString | ? |
│ │ │ | The value of the filter variable to which the category statistic is restricted | |
│ │ ├▻filterValue | ValueString | ? |
│ │ │ | For categorical representations the CodeItem describing the value (signifier) and category (signified) may be identified. | |
│ │ └▻forCodeItem | Designation | ? |
│ │ | Reference to the variable to which the statistics apply. | |
│ ├▻forInstanceVariable | InstanceVariable | ? |
│ │ | Reference to the StandardWeight value provided in Weighting. | |
│ ├▻usesStandardWeight | ⇩AnnotatedIdentifiable | ? |
│ │ │ | Provides the standard weight used for weighted analysis of data expressed as an xs:float. This element is referenced by the variable and/or statistics calculated using the standard weight. | |
│ │ └▭standardWeightValue | xsd:double | ? |
│ │ | Reference to a variable to use for weight in calculating the statistic. | |
│ ├▻applicableWeightVariable | InstanceVariable | ? |
│ │ | A variable that may be used to filter the summary and/or category statistics (for example by country or by gender) | |
│ └▻hasFilterVariable | InstanceVariable | ? |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
A description of each physical storage segment required to completely cover the logical record. A logical record may be stored in one or more segments housed hierarchically in a single file or in separate data files. All logical records have at least one segment.
The file below has four InstanceVariables: PersonId, SegmentId, AgeYr, HeightCm. The data for each person (identified by PersonId) is recorded in two segments (identified by SegmentId), "a" and "b". AgeYr is on physical segment a, and HeightCm is on segment b. These are the same data as described in the UnitSegmentLayout documentation. 1 a 22 1 b 183 2 a 45 2 b 175
p:PhysicalRecordSegmentType
PhysicalRecordSegment | ⇩AnnotatedIdentifiable | |
│ | Use when each physical segment is stored in its own file. | |
├▭physicalFileName | xsd:string | ? |
│ | A PhysicalRecordSegment has a sequence of DataPoints. Think of these as the cells in the row of a (spreadsheet) table. | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to DataPoint | |
│ └▻member | DataPoint | |
│ | The DataPointIndicators for this PhysicalRecordSegment have index values that indicate the order of the DataPoints. | |
├▭isOrdered | xsd:boolean | ? |
│ | A PhysicalRecordSegment is associated with a one or more reusable PhysicalLayouts | |
├▻hasPhysicalLayout | PhysicalSegmentLayout | ? |
│ | A record segment may represent a specific population or sub-population within a larger set of segments. Allows for the identification of this filter for membership in the segment. | |
├▻representsPopulation | Population | ? |
│ | Every DataRecord has at o..n PhysicalRecordSegments, It is possible to describe a PhysicalDataProduct and its RecordRecordSegment(s) without reference to a DataRecord | |
├▻mapTo | LogicalRecord | ? |
│ | There may be cases where there is a more complex structure to a sequence of DataPoints. A cell containing a list, for example, might be considered to have nested DataPoints that are the elements of the list. | |
├▻isStructuredBy | ⇩Identifiable | * |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Member relations that comprise the relation structure | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | First member in a relationship. | |
│ ├▻source | DataPoint | * |
│ │ | Second member in a relationship. | |
│ └▻target | DataPoint | * |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
The PhysicalSegmentLayout is an abstract class used as an extension point in the description of the different layout styles of data structure description.
Examples include UnitSegmentLayouts, event data layouts, and cube layouts (e.g. summary data).
A PhysicalLayout is a physical description (e.g. UnitSegmentLayout) of the associated Logical Record Layout consisting of a Collection of Value Mappings describing the physical interrelationship of each related ValueMapping and associated Instance Variable.
PhysicalSegmentLayout | ⇩AnnotatedIdentifiable | |
│ | Indicates that the data are in a delimited format. If not set to true, is FixedWitdh must be set to true. | |
├▭isDelimited | xsd:boolean | |
│ | The Delimiting character in the data. Must be used if isDelimited is true. "The separator between cells, set by the delimiter property of a dialect description. The default is ,." see https://www.w3.org/TR/tabular-data-model/#encoding From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect delimiter: “An atomic property that sets the delimiter flag to the single provided value, which MUST be a string. The default is ",".” From https://www.w3.org/TR/tabular-data-model/ 8 “The separator between cells, set by the delimiter property of a dialect description. The default is ,.” From http://specs.frictionlessdata.io/csv-dialect/ delimiter: “specifies a one-character string to use as the field separator. Default = ,” | |
├▭delimiter | xsd:string | ? |
│ | Set to true if the file is fixed-width. If true, isDelimited must be set to false. | |
├▭isFixedWidth | xsd:boolean | |
│ | "The string that is used to escape the quote character within escaped cells, or null" see https://www.w3.org/TR/tabular-data-model/#encoding From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect “ doupleQuote: A boolean atomic property that, if true, sets the escape character flag to ". If false, to \. The default is true.” From http://specs.frictionlessdata.io/csv-dialect/ doubleQuote: “controls the handling of quotes inside fields. If true, two consecutive quotes should be interpreted as one. Default = true” | |
├▭escapeCharacter | xsd:string | ? |
│ | "The strings that can be used at the end of a row, set by the lineTerminators property of a dialect description. The default is [CRLF, LF]." see https://www.w3.org/TR/tabular-data-model/#encoding From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect lineTerminators: “An atomic property that sets the line terminators flag to either an array containing the single provided string value, or the provided array. The default is ["\r\n", "\n"].” From http://specs.frictionlessdata.io/csv-dialect/ lineTerminator: “specifies the character sequence which should terminate rows. Default = \r\n” | |
├▭lineTerminator | xsd:string | * |
│ | The string that is used around escaped cells, or null, set by the quoteChar property of a dialect description. The default is ". see https://www.w3.org/TR/tabular-data-model/#encoding From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect quoteChar: “An atomic property that sets the quote character flag to the single provided value, which MUST be a string or null. If the value is null, the escape character flag is also set to null. The default is '"'.” From http://specs.frictionlessdata.io/csv-dialect/ quoteChar: “specifies a one-character string to use as the quoting character. Default = "” | |
├▭quoteCharacter | xsd:string | ? |
│ | A string used to indicate that an input line is a comment, a string which precedes a comment in the data file. From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect commentPrefix: “An atomic property that sets the comment prefix flag to the single provided value, which MUST be a string. The default is "#".” | |
├▭commentPrefix | xsd:string | ? |
│ | The character encoding of the represented data. From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect: encoding: “An atomic property that sets the encoding flag to the single provided string value, which MUST be a defined in [encoding]. The default is "utf-8".” From https://www.w3.org/TR/tabular-metadata/ 7.2 Encoding: “CSV files should be encoded using UTF-8, and should be in Unicode Normal Form C as defined in [UAX15]. If a CSV file is not encoded using UTF-8, the encoding should be specified through the charset parameter in the Content-Type header:” | |
├▻encoding | ExternalControlledVocabularyEntry | ? |
│ | True if the file contains a header containing column names. From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect header: “A boolean atomic property that, if true, sets the header row count flag to 1, and if false to 0, unless headerRowCount is provided, in which case the value provided for the header property is ignored. The default is true.” From http://specs.frictionlessdata.io/csv-dialect/ header: “indicates whether the file includes a header row. If true the first row in the file is a header row, not data. Default = true” | |
├▭hasHeader | xsd:boolean | ? |
│ | The number of lines in the header From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect headerRowCount: “A numeric atomic property that sets the header row count flag to the single provided value, which MUST be a non-negative integer. The default is 1.” | |
├▭headerRowCount | xsd:integer | ? |
│ | If True, blank rows are ignored. From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect skipBlankRows: “A boolean atomic property that sets the skip blank rows flag to the single provided boolean value. The default is false.” | |
├▭skipBlankRows | xsd:boolean | ? |
│ | The number of columns to skip at the beginning of the row. From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect skipColumns: “A numeric atomic property that sets the skip columns flag to the single provided numeric value, which MUST be a non-negative integer. The default is 0.” See also https://www.w3.org/TR/tabular-metadata/ 8 skip columns: “The number of columns to skip at the beginning of each row, set by the skipColumns property of a dialect description. The default is 0. A value other than 0 will mean that the source numbers of columns will be different from their numbers.” | |
├▭skipDataColumns | xsd:integer | ? |
│ | If true skip spaces at the beginning of a line or following a delimiter. From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect skipInitialSpace: “A boolean atomic property that, if true, sets the trim flag to "start" and if false, to false. If the trim property is provided, the skipInitialSpace property is ignored. The default is false.” From http://specs.frictionlessdata.io/csv-dialect/ skipInitialSpace: “specifies how to interpret whitespace which immediately follows a delimiter; if false, it means that whitespace immediately after a delimiter should be treated as part of the following field. Default = true” | |
├▭skipInitialSpace | xsd:boolean | ? |
│ | Number of input rows to skip preceding the header or data From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect skipRows: “A numeric atomic property that sets the skip rows flag to the single provided numeric value, which MUST be a non-negative integer. The default is 0.” From https://www.w3.org/TR/tabular-metadata/ 8 skip rows: “The number of rows to skip at the beginning of the file, before a header row or tabular data, set by the skipRows property of a dialect description. The default is 0. A value greater than 0 will mean that the source numbers of rows will be different from their numbers.” | |
├▭skipRows | xsd:integer | ? |
│ | Specifies which spaces to remove from a data value (start, end, both, neither) From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect trim: “An atomic property that, if the boolean true, sets the trim flag to true and if the boolean false to false. If the value provided is a string, sets the trim flag to the provided value, which MUST be one of "true", "false", "start", or "end". The default is true.” | |
├▻trim | TrimValues | ? |
│ | A string indicating a null value. From https://www.w3.org/TR/tabular-metadata/ 4.3 “null — the string or strings which cause the value of cells having string value matching any of these values to be null.” From Inherited 5.7 null: “An atomic property giving the string or strings used for null values within the data. If the string value of the cell is equal to any one of these values, the cell value is null. See Parsing Cells in [tabular-data-model] for more details. If not specified, the default for the null property is the empty string "". The value of this property becomes the null annotation for the described column.” From http://specs.frictionlessdata.io/csv-dialect/ nullSequence: “specifies the null sequence (for example \N). Not set by default” | |
├▭nullSequence | xsd:string | ? |
│ | If True, the case of the labels in the header is significant. From http://specs.frictionlessdata.io/csv-dialect/ caseSensitiveHeader: “indicates that case in the header is meaningful. For example, columns CAT and Cat should not be equated. Default = false” | |
├▭headerIsCaseSensitive | xsd:boolean | ? |
│ | Number cells, rows, columns starting from this value. This is a DDI notion allowing numbering of columns, rows, etc. from either 0 or 1. W3C appears to just use 1. From https://www.w3.org/TR/tabular-data-model/ 4.3 “number — the position of the column amongst the columns for the associated table, starting from 1.” | |
├▭arrayBase | xsd:integer | ? |
│ | If True, consecutive delimiters are treated the same way as a single delimiter, if false consiecutive delimiters indicate a missing value. From PHDD consecutiveDelimitersAsOne: “Indicates how consecutive delimiters should be handed by the software. Equivalent element in DDI 3.2: p:Delimiter/@treatConsecutiveDelimiterAsOne DDI 3.2 Documentation: http://www.ddialliance.org/Specification/DDI-Lifecycle/3.2/XMLSchema/FieldLevelDocumentation/schemas/reusable_xsd/complexTypes/DelimiterType.html#a6” | |
├▭treatConsecutiveDelimitersAsOne | xsd:boolean | ? |
│ | Short natural language account of the physical layout obtained from the combination of associated properties and relationships. Supports the use of multiple languages and structured text. | |
├▻overview | InternationalStructuredString | ? |
│ | Indicates the direction in which columns are arranged in each row. From https://www.w3.org/TR/tabular-metadata/ 5.3.2 tableDirection: “An atomic property that MUST have a single string value that is one of "rtl", "ltr", or "auto". Indicates whether the tables in the group should be displayed with the first column on the right, on the left, or based on the first character in the table that has a specific direction. The value of this property becomes the value of the table direction annotation for all the tables in the table group. See Bidirectional Tables in [tabular-data-model] for details. The default value for this property is "auto".” | |
├▻tableDirection | TableDirectionValues | ? |
│ | Indicates the reading order of text within cells. From https://www.w3.org/TR/tabular-metadata/ Inherited 5.7 textDirection: “An atomic property that MUST have a single string value that is one of "ltr", "rtl", "auto" or "inherit" (the default). Indicates whether the text within cells should be displayed as left-to-right text (ltr), as right-to-left text (rtl), according to the content of the cell (auto) or in the direction inherited from the table direction annotation of the table. The value of this property determines the text direction annotation for the column, and the text direction annotation for the cells within that column: if the value is inherit then the value of the text direction annotation is the value of the table direction annotation on the table, otherwise it is the value of this property. See Bidirectional Tables in [tabular-data-model] for details.” | |
├▻textDirection | TextDirectionValues | ? |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | The PhysicalLayout contains a description of the physical representation of each InstanceVariable in a ValueMapping. This relationship fills the role of "Contains" from the Collection pattern. Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to ValueMapping | |
│ └▻member | ValueMapping | |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | Logical Record physically represented by the Physical Layout. | |
├▻formatsLogicalRecord | LogicalRecord | ? |
│ | Description of a complex structure for the Collection. A collection may be structured in more than one way for different uses. | |
├▻isStructuredBy | ⇩Identifiable | * |
│ │ | Intensional definition of the order criteria (e.g. alphabetical, numerical, increasing, decreasing, etc.) | |
│ ├▻criteria | InternationalStructuredString | ? |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Specifics of relations between InstanceVariables in the PhysicalLayout | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Specialization of source to VariableMapping. The First Variableapping in the pair. | |
│ ├▻source | ValueMapping | |
│ │ | Specialization of target to VariableMapping. Restricts cardinality. The following VariableMapping in the pair. | |
│ └▻target | ValueMapping | |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
Among other things defines the location of a DataPoint in a PhysicalSegment (e.g. the location of the representation of a variable in a text file). This is abstract since there are many different ways to describe the location of a segment - character counts, start and end times, etc.
A segment of text in a plain text file beginning at character 3 and ending at character 123.
While this has no properties or relationships of its own, it is useful as a target of relationships where its extensions may serve.
PhysicalSegmentLocation | ⇩AnnotatedIdentifiable |
Defines the location of a segment of text through character, and optionally line, counts. An adequate description will always include a startCharacterPosition and then may include an endCharacterPosition or a characterLength. If StartLine is specified, the character counts begin within that line. An endCharacterPosition of 0 indicates that whole lines are specified
The segment beginning at line 3, character 4 and ending at line 27 character 13. Alternatively the segment beginning at character 257 and ending at character 1350 of the whole body of text. StartLine of 10, endLine of 12, startCharacterPosition of 1, endCharacterPosition of 0 means all of lines 10,11, and 12.
SegmentByText | ⇩PhysicalSegmentLocation | |
│ | The line number, where 1 is the first line, on which to begin counting characters. If missing this defaults to 1 (the first line). | |
├▭startLine | xsd:integer | ? |
│ | The last line on which to count characters. If missing this defaults to startLine. | |
├▭endLine | xsd:integer | ? |
│ | The character position of the first character of the segment, with the count beginning at character 1 of startLine. | |
├▭startCharacterPosition | xsd:integer | ? |
│ | The character position of the last character of the segment. If endLine is specified, the count begins at character 1 of endLine. If startLine and endLine are not specified, the count begins at character 1 of the first line of the resource and the count includes any line termination characters. The resulting segment may include text from multiple lines of the resource. | |
├▭endCharacterPosition | xsd:integer | ? |
│ | The number of characters in the segment. The segment may include text from multiple lines of the resource. If it does, the length includes any line termination characters. | |
└▭characterLength | xsd:integer | ? |
UnitSegmentLayout supports the description of unit-record ("wide") data sets, where each row in the data set provides the same group of values for variables all relating to a single unit. Each logical column will contain data relating to the values for a single variable.
A simple spreadsheet. Commonly the first row of the table will contain variable names or descriptions.
The following csv file has a rectangular layout and would import into a simple table in a spreadsheet: PersonId,AgeYr,HeightCm 1,22,183 2,45,175
This is the classic rectangular data table used by most statistical packages, with rows/cases/observations and columns/variables/measurements. Each cell (DataPoint) in the table is the intersection of a Unit (row) and an InstanceVariable.
UnitSegmentLayout | ⇩PhysicalSegmentLayout |
Provides physical characteristics for an InstanceVariable as part of a PhysicalSegmentLayout
A variable "age" might be represented in a file as a string with a maximum length of 5 characters and a number pattern of ##0.0
An InstanceVariable has details of value domain and datatype, but will not have the final details of how a value is physically represented in a data file. A variable for height, for example, may be represented as a real number, but may be represented as a string in multiple ways. The decimal separator might be, for example a period or a comma. The string representing the value of a payment might be preceded by a currency symbol. The same numeric value might be written as “1,234,567” or “1.234567 E6”. A missing value might be written as “.”, “NA”, “.R” or as “R”. The ValueMapping describes how the value of an InstanceVariable is physically expressed. The properties of the ValueMapping as intended to be compatible with the W3C Metadata Vocabulary for Tabular Data (https://www.w3.org/TR/tabular-metadata/ ) as well as common programming languages and statistical packages. The “format” property, for example can draw from an external controlled vocabulary such as the set of formats for Stata, SPSS, or SAS.
ValueMapping | ⇩Identifiable | |
│ | The base datatype of the physical representation. An integer InstanceVariable might, for example, be stored as a floating point number. From https://www.w3.org/TR/tabular-metadata/ Inherited 5.7 datatype: “An atomic property that contains either a single string that is the main datatype of the values of the cell or a datatype description object. If the value of this property is a string, it MUST be the name of one of the built-in datatypes defined in section 5.11.1 Built-in Datatypes and this value is normalized to an object whose base property is the original string value. If it is an object then it describes a more specialized datatype. If a cell contains a sequence (i.e. the separator property is specified and not null) then this property specifies the datatype of each value within that sequence. See 5.11 Datatypes and Parsing Cells in [tabular-data-model] for more details. The normalized value of this property becomes the datatype annotation for the described column. ” | |
├▻physicalDataType | ExternalControlledVocabularyEntry | ? |
│ | Default value is . (period). The string separating the integer part from the fractional part of a decimal or real number. In W3C part of the datatype format From https://www.w3.org/TR/tabular-metadata/ tabular 6.4.2 decimalChar: “A string whose value is used to represent a decimal point within the number. If the supplied value is not a string, implementations MUST issue a warning and proceed as if the property had not been specified.” | |
├▻defaultDecimalSeparator | Char | ? |
│ | Default value is null. A string separating groups of digits (for readability). In W3C part of the datatype format From https://www.w3.org/TR/tabular-metadata/ tabular 6.4.2 groupChar: “A string whose value is used to group digits within the number. If the supplied value is not a string, implementations MUST issue a warning and proceed as if the property had not been specified.” | |
├▻defaultDigitGroupSeparator | Char | ? |
│ | A pattern description of the format of a numeric value. In W3C part of the datatype format From https://www.w3.org/TR/tabular-metadata/ tabular 6.4.2 pattern: “A number format pattern as defined in [UAX35] http://www.unicode.org/reports/tr35/tr35-31/tr35-numbers.html#Number_Format_Patterns . Implementations MUST recognise number format patterns containing the symbols 0, #, the specified decimalChar (or "." if unspecified), the specified groupChar (or "," if unspecified), E, +, % and ‰. Implementations MAY additionally recognise number format patterns containing other special pattern characters defined in [UAX35]. If the supplied value is not a string, or if it contains an invalid number format pattern or uses special pattern characters that the implementation does not recognise, implementations MUST issue a warning and proceed as if the property had not been specified. f the datatype format annotation is a single string, this is interpreted in the same way as if it were an object with a pattern property whose value is that string. If the groupChar is specified, but no pattern is supplied, when parsing the string value of a cell against this format specification, implementations MUST recognise and parse numbers that consist of: an optional + or - sign, … Implementations MAY also recognise numeric values that are in any of the standard-decimal, standard-percent or standard-scientific formats listed in the Unicode Common Locale Data Repository. …” | |
├▭numberPattern | xsd:string | ? |
│ | A default string indicating the value to substitute for an empty string. From https://www.w3.org/TR/tabular-metadata/ Inherited 5.7 default “An atomic property holding a single string that is used to create a default value for the cell in cases where the original string value is an empty string. See Parsing Cells in [tabular-data-model] for more details. If not specified, the default for the default property is the empty string, "". The value of this property becomes the default annotation for the described column.” | |
├▻defaultValue | ValueString | ? |
│ | A string indicating a null value. From https://www.w3.org/TR/tabular-metadata/ 4.3 null — “the string or strings which cause the value of cells having string value matching any of these values to be null.” From Inherited 5.7 null: “An atomic property giving the string or strings used for null values within the data. If the string value of the cell is equal to any one of these values, the cell value is null. See Parsing Cells in [tabular-data-model] for more details. If not specified, the default for the null property is the empty string "". The value of this property becomes the null annotation for the described column.” | |
├▭nullSequence | xsd:string | ? |
│ | This defines the format of the physical representation of the value. From https://www.w3.org/TR/tabular-metadata/ 5.11.2 format: “An atomic property that contains either a single string or an object that defines the format of a value of this type, used when parsing a string value as described in Parsing Cells in [tabular-data-model]. The value of this property becomes the format annotation for the described datatype.” See https://www.w3.org/TR/tabular-metadata/ Tabular 6.4.2 ‘Formats for numeric datatypes’ this may include decimalChar, groupChar, pattern “By default, numeric values must be in the formats defined in [xmlschema11-2]. It is not uncommon for numbers within tabular data to be formatted for human consumption, which may involve using commas for decimal points, grouping digits in the number using commas, or adding percent signs to the number.” See https://www.w3.org/TR/tabular-metadata/ Tabular 6.4. Formats for Booleans ” Boolean values may be represented in many ways aside from the standard 1 and 0 or true and false.” See https://www.w3.org/TR/tabular-metadata/ 6.4.4. Formats for dates and times “By default, dates and times are assumed to be in the format defined in [xmlschema11-2]. However dates and times are commonly represented in tabular data in other formats.” See https://www.w3.org/TR/tabular-metadata/ 6.4.5 Formats for durations “Durations MUST be formatted and interpreted as defined in [xmlschema11-2], using the [ISO8601] format -?PnYnMnDTnHnMnS. For example, the duration P1Y1D is used for a year and a day; the duration PT2H30M for 2 hours and 30 minutes.” See https://www.w3.org/TR/tabular-metadata/ 6.4.6 Formats for other types “If the datatype base is not numeric, boolean, a date/time type, or a duration type, the datatype format annotation provides a regular expression for the string values, with syntax and processing defined by [ECMASCRIPT]. If the supplied value is not a valid regular expression, implementations MUST issue a warning and proceed as if no format had been provided.” From DDI3.2 ManagedNumericRepresentation@format “A format for number expressed as a string.” From DDI3.2 ManagedDateTimeRepresentation_DateFieldFormat “Describes the format of the date field, in formats such as YYYY/MM or MM-DD-YY, etc. If this element is omitted, then the format is assumed to be the XML Schema format corresponding to the type attribute value.” | |
├▻format | ExternalControlledVocabularyEntry | ? |
│ | The length of the physical representation of the value. From https://www.w3.org/TR/tabular-metadata/ 5.11.2 length: “A numeric atomic property that contains a single integer that is the exact length of the value. The value of this property becomes the length annotation for the described datatype. See Length Constraints in [tabular-data-model] for details.” Corresponds to DDI2.5 var/location/width and DDI 3.2 PhysicalLocation/Width | |
├▭length | xsd:integer | ? |
│ | The smallest possible value for the length of the physical representation of the value. From https://www.w3.org/TR/tabular-metadata/ 5.11.2 minLength: “An atomic property that contains a single integer that is the minimum length of the value. The value of this property becomes the minimum length annotation for the described datatype. See Length Constraints in [tabular-data-model] for details.” | |
├▭minimumLength | xsd:integer | ? |
│ | The largest possible value of the length of the physical representation of the value. From https://www.w3.org/TR/tabular-metadata/ 5.11.2 maxLength: “A numeric atomic property that contains a single integer that is the maximum length of the value. The value of this property becomes the maximum length annotation for the described datatype. See Length Constraints in [tabular-data-model] for details.” | |
├▭maximumLength | xsd:integer | ? |
│ | The scale of the number expressed as an integer (for example a number expressed in 100's, 5 = 500 would have a scale of 100). From DDI 3.2 ManagedNumericRepresentation@scale: | |
├▭scale | xsd:integer | ? |
│ | The number of decimal positions expressed as an integer. Used when the decimal position is implied (no decimal separator is present) See DDI 3.2 ManagedNumericRepresentation@decimalPositions | |
├▭decimalPositions | xsd:integer | ? |
│ | If True a value is required for this variable. NOTE: this might be better at the InstanceVariable or higher in the variable cascade. From https://www.w3.org/TR/tabular-metadata/ Inherited 5.7 required: “A boolean atomic property taking a single value which indicates whether the cell value can be null. See Parsing Cells in [tabular-data-model] for more details. The default is false, which means cells can have null values. The value of this property becomes the required annotation for the described column.” | |
├▭isRequired | xsd:boolean | ? |
│ | Describes the physical representation of the InstanceVariable | |
├▻formatsDataPoint | DataPoint | * |
│ | Uses a PhysicalSegmentLocation to describe where in the physical record a segment representing the InstanceVarible is. This could be, for example, described as a start position and end position value for characters in a text record via the SegmentByText extension of PhysicalSegmentLocation. | |
└▻describesSegmentLocation | PhysicalSegmentLocation | ? |
The specification of a controlled vocabulary defines a set of values and their definitions together with the order relationships among those entries.
ControlledVocabulary | ⇩AnnotatedIdentifiable | |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to VocabularyEntry | |
│ └▻member | VocabularyEntry | |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | The RelationStructure defining hierarchy or specific realtionships between vocabulary entries in the vocabulary | |
├▻isStructuredBy | ⇩AnnotatedIdentifiable | * |
│ │ | Intentional definition of the order criteria (e.g. alphabetical, numerical, increasing, decreasing, etc.) | |
│ ├▻criteria | InternationalStructuredString | ? |
│ │ | A display label for the OrderRelation. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
│ ├▻displayLabel | LabelForDisplay | * |
│ │ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
│ ├▻usage | InternationalStructuredString | ? |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Relation between VocabularyEntries | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provide a semantic that provides a context for the relationship using and External Controlled Vocabulary | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of its totality using an enumeration list. | |
│ ├▻totality | TotalityType | ? |
│ │ | Restricts source to VocabularyEntry | |
│ ├▻source | VocabularyEntry | |
│ │ | Restricts target to VocabularyEntry and cardinality. | |
│ └▻target | VocabularyEntry | |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
A set of CustomValues to be attached to some object.
A set of OMB required information about a question.
The set of openEHR protocol information to be attached to a blood pressure Capture
CustomInstance | ⇩Identifiable | |
│ | see Collection | |
├▻name | ObjectName | * |
│ | see Collection | |
├▻purpose | InternationalStructuredString | ? |
│ | see Collection | |
├▻type | CollectionType | ? |
│ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to CustomValue | |
│ └▻member | ⇩Identifiable | |
│ │ | the value associated with a particular key expressed as a string. The ultimate value representation is defined by the corresponding CustomValue. | |
│ ├▻value | ValueString | ? |
│ │ | The unique String identifying the value | |
│ ├▭key | xsd:string | ? |
│ │ | The CustomItem which defines the key for this key,value pair, It also defines a ValueRepresentation | |
│ ├▻correspondsTo | CustomItem | |
│ │ | This optional relationship indicates an InstanceVariable compatible with the value associated with this key. Custom metadata might be reused as data and data might be used as metadata. This mechanism could enable these transformations. The related InstanceVariable could also carry information about units of measurement, missing values etc. | |
│ └▻comparesTo | InstanceVariable | ? |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | Is realted to a CustomStructure | |
├▻correspondsTo | ⇩AnnotatedIdentifiable | ? |
│ │ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
│ ├▻type | CollectionType | ? |
│ │ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
│ ├▻name | ObjectName | * |
│ │ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
│ ├▻purpose | InternationalStructuredString | ? |
│ │ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
│ ├▻contains | * | |
│ │ │ | Index value of member in an ordered array | |
│ │ ├▭index | xsd:integer | ? |
│ │ │ | Restricts member target class to CustomItem | |
│ │ └▻member | CustomItem | |
│ │ | If members are ordered set to true, if unordered set to false. | |
│ ├▭isOrdered | xsd:boolean | ? |
│ │ | Description of a complex structure for the Collection. A collection may be structured in more than one way for different uses. | |
│ ├▻isStructuredBy | ⇩AnnotatedIdentifiable | * |
│ │ │ | Intentional definition of the order criteria (e.g. alphabetical, numerical, increasing, decreasing, etc.) | |
│ │ ├▻criteria | InternationalStructuredString | ? |
│ │ │ | A display label for the RelationStructure. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
│ │ ├▻displayLabel | LabelForDisplay | * |
│ │ │ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
│ │ ├▻usage | InternationalStructuredString | ? |
│ │ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list. Use if all relations within this relation structure are of the same specification. . | |
│ │ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ │ | Provides semantic context for the relationship | |
│ │ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ │ ├▻totality | TotalityType | ? |
│ │ │ | Member relationships that comprise the relationship structure | |
│ │ └▻hasMemberRelation | * | |
│ │ │ | The type of relationship between the two CustomItems. The verb in the sentence describing the relationship between the source (subject) and the target (object). | |
│ │ ├▻hasRelationSpecification | RelationSpecification | |
│ │ │ | Provides semantic context for the relationship | |
│ │ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ │ ├▻totality | TotalityType | ? |
│ │ │ | Restricts source object to a CustomItem | |
│ │ ├▻source | CustomItem | |
│ │ │ | Restricts target object to a CustomItem | |
│ │ └▻target | CustomItem | * |
│ │ | The conceptual basis for the collection of members. | |
│ └▻definingConcept | Concept | * |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
A custom item description. This allows the definition of an item which is a member of a CustomStructure. It defines the minimum and maximum number of occurrences and representation of a CustomValue.
DegreeOfBurden for a question as required by the U.S. OMB.
BloodPressureCuffSize - the size of a blood pressure cuff specified for a particular protocol.
This definition will be referenced by a CustomValue when recording a key,value instance
CustomItem | ⇩AnnotatedIdentifiable | |
│ | The maximum number of occurrences of an associated CustomValue | |
├▭maxOccurs | xsd:integer | ? |
│ | The minimum number of occurrences of an associated CustomValue | |
├▭minOccurs | xsd:integer | ? |
│ | The key to be used by a key,value pair | |
├▭key | xsd:string | ? |
│ | The type of value for the key.value pair | |
├▻uses | ValueDomain | ? |
│ | A Concept associated with the key of a CustomValue | |
├▻hasConcept | Concept | ? |
│ | This optional relationship indicates a RepresentedVariable compatible with this key. Custom metadata might be reused as data and data might be used as metadata. This mechanism could enable these transformations. | |
└▻comparesTo | RepresentedVariable | ? |
One entry term and its definition in an ordered list comprising a controlled vocabulary.
aunt - The female sibling of a parent
VocabularyEntry | ⇩AnnotatedIdentifiable | |
│ | the term being defined | |
├▻entryTerm | InternationalStructuredString | ? |
│ | An explanation (definition) of the value | |
└▻definition | InternationalStructuredString | ? |
Generic description of a sampling algorithm expressed by a Sampling Design and implemented by a Sampling Process. May include common algebraic formula or statistical package instructions (use of specific selection models).
Random Sample; Stratified Random Sample
SamplingAlgorithm | ⇩AlgorithmOverview | |
│ | The algorithm expressed as algebraic or computer code. | |
└▻codifiedExpressionOfAlgorithm | CommandCode | ? |
The Sampling Procedure describes the population being sampled, the sampling frame and the sampling plan including steps and sub steps by referencing the universe, sample frames and sampling plans described in schemes. Target sample sizes for each stage can be noted as well as the process for determining sample size, the date of the sample and the person or organization responsible for drawing the sample.
Census of Population and Housing, 1980 Summary Tape File 4, chapter on Technical Information. Overview is the Introduction generally describing the sample; there is a sample design section which provides a more detailed overview of the design. Additional external documentation provides detailed processes for sample adjustments needed for small area estimations, sample frames etc.
This is a summary of the methodology of sampling providing both an overview of purpose and use of a particular sampling approach and optionally providing specific details regarding the algorithm, design, and process of selecting a sample.
SamplingProcedure | ⇩MethodologyOverview | |
│ | Sampling Design used to perform the Sampling Procedure | |
├▻hasDesign | ⇩DesignOverview | * |
│ │ | Is an expression of this Sampling Algorithm | |
│ ├▻expressesAlgorithm | SamplingAlgorithm | * |
│ │ | Specification of the goal for the Sampling Design. Constrained to SamplingGoal. | |
│ ├▻specifiesGoal | ⇩Goal | * |
│ │ │ | The goal for the overall size of the sample expressed as an integer. | |
│ │ ├▭overallTargetSampleSize | xsd:integer | ? |
│ │ │ | The goal for the overall size of the sample expressed as a decimal (i.e. 70% entered as .7). | |
│ │ ├▭overallTargetSamplePercent | xsd:double | ? |
│ │ │ | Repeat for primary and secondary target samples. Supports identification of size, percent, unit type, and universe | |
│ │ └▻targetSampleSize | * | |
│ │ │ | Default value is True. The information is for the primary sample unit or universe. Change to False if the information relates to a secondary or sub- sample universe. | |
│ │ ├▭isPrimary | xsd:boolean | |
│ │ │ | The target size of the sample expressed as an integer. | |
│ │ ├▭targetSize | xsd:integer | ? |
│ │ │ | The target size of the sample expressed as an integer (70% expressed as .7) | |
│ │ ├▭targetPercent | xsd:double | ? |
│ │ │ | Unit type of the sample | |
│ │ ├▻hasUnitType | UnitType | ? |
│ │ │ | The universe of the sample. Note that when the Design is implemented the Population should be a Population within this Universe. | |
│ │ └▻fromUniverse | Universe | ? |
│ │ | The design of the expressed algorithm is implemented by the Sampling Process. Constrains impliementedBy of the Design Pattern by limiting the target to a Sampling Process. | |
│ └▻implementedBy | SamplingProcess | * |
│ | Sampling Process used to perform the Sampling Procedure | |
├▻hasProcess | SamplingProcess | * |
│ | Sampling Algorithm that defines the methodology in a generic way | |
├▻isExpressedBy | SamplingAlgorithm | * |
│ | A Sampling Procedure that is a component part of this Sampling Procedure | |
└▻componentMethodology | SamplingProcedure | * |
Provides the details of the process used to apply the sampling design and obtain the sample. Sampling Process contains a Workflow Step which provides the constituents of a Workflow. It can be a composition (a set of Control Constructs) or atomic (an Act) and may be performed by a service. This allows the use of existing Workflow models to express various sampling process actions. Sampling Frames and Sample Population can be used as designated Inputs or Outputs using Parameters.
A Split which takes a sampling stage and divides the sample frame into different subsets. A different sampling technique is applied to each subset. Once a split occurs each subset can have stages underneath, and the number of states under each split subset may differ. A Stage is the application of a single sampling algorithm applied to a sampling frame. For instance, the US Current Population Survey samples geographic areas first before identifying household to contact within each of those areas. A Stratification of a stage into multiple subsets. Each stratified group will be sampled using the same sampling approach. For example stratifying a state by ZIP Code areas in each of 5 mean income quintiles and then doing a random sample of the households in a set of Zip Codes. Allows for oversampling of identified subpopulations.
SamplingProcess | ⇩AnnotatedIdentifiable | |
│ | Provides a high level overview or summary of the class. Can be used to inform end-users or as part of an executive summary. Supports the use of multiple languages and structured text. | |
├▻overview | InternationalStructuredString | ? |
│ | Description and link to external material discussing this Sampling Process | |
├▻isDiscussedIn | ExternalMaterial | * |
│ | The Process Sequence which initiate the process flow and describes the sequence of the process flow | |
├▻isSpecifiedBy | WorkflowStepSequence | ? |
│ | Results of the Sampling Process. Restriction to SamplePopulation, a type of Result | |
├▻hasResults | ⇩Result | * |
│ │ | The overall size of the sample | |
│ ├▭sizeOfSample | xsd:integer | ? |
│ │ | The name or number of the specific strata if the sample frame has been stratified prior to sampling within the specified stage | |
│ ├▭strataName | xsd:string | ? |
│ │ | The date the sample was selected from the sample frame | |
│ ├▻sampleDate | Date | ? |
│ │ | The Unit Type of the units within the sample. | |
│ ├▻sampleUnitType | UnitType | ? |
│ │ | The population represented by the sample | |
│ └▻populationSampled | Population | ? |
│ | The sampling algorithm implanted by this sampling process. Constraint of the relationship implementsAlgorithm in Process pattern class by limiting the target to a SamplingAlgorithm | |
└▻implementsAlgorithm | SamplingAlgorithm | * |
Study is the conceptual anchor for an individual collection activity resulting in a data set or data file. It can be both a part of a StudySeries as a wave etc. or an unrelated activity like a single survey project.
ICPSR study 35575 Americans and the Arts [1973 - 1992] (ICPSR 35575). https://www.icpsr.umich.edu/icpsrweb/ICPSR/studies/35575?dataFormat%5B0%5D=SAS&keyword%5B0%5D=public+opinion&geography%5B0%5D=United+States&searchSource=revise
The Study class brings together many properties and relationships describing a set of data – coverage, kind of data, methodology, citation information, access information and more.
s:StudyUnitType
Study | ⇩AnnotatedIdentifiable | |
│ | Describes, with a string or a term from a controlled vocabulary, the kind of data documented in the logical product(s) of a study unit. Examples include survey data, census/enumeration data, administrative data, measurement data, assessment data, demographic data, voting data, etc. | |
├▻kindOfData | ExternalControlledVocabularyEntry | * |
│ | A general descriptive overview of the Study | |
├▻overview | InternationalStructuredString | ? |
│ | Complete bibliographic reference containing all of the standard elements of a citation that can be used to cite the work. The "format" attribute is provided to enable specification of the particular citation style used, e.g., APA, MLA, Chicago, etc. | |
├▻bibliographicCitation | InternationalStructuredString | ? |
│ | A series in which this Study takes part. | |
├▻partOfSeries | StudySeries | * |
│ | Spatial, Temporal, and Topical coverage information for the Study | |
├▻hasCoverage | Coverage | * |
│ | Unit(s) of analysis for the study, e.g. persons, households. | |
├▻hasAnalysisUnit | UnitType | * |
│ | The set of specific Units studied. Examples: 1. Canadian adult persons residing in Canada on 13 November 1956 2. US computer companies at the end of 2012 3. Universities in Denmark 1 January 2011. | |
├▻hasPopulation | Population | * |
│ | The defined classes of Units related to the data, Examples: 1. Canadian adults (not limited to those residing in Canada) 2. Computer companies 3. Universities | |
├▻hasUniverse | Universe | * |
│ | The design for the Study | |
├▻hasDesign | DesignOverview | ? |
│ | Overview of the Process employed in the Study | |
├▻hasProcess | ⇩AnnotatedIdentifiable | * |
│ │ | Provides a high level overview or summary of the class. Can be used to inform end-users or as part of an executive summary. Supports the use of multiple languages and structured text. Edit | |
│ ├▻overview | InternationalStructuredString | ? |
│ │ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
│ ├▻name | ObjectName | * |
│ │ | The Process Control Step which describes the organization of the process flow. This could be realizes as a sequence, a temporal relationship, or conditional control step. It should provide a clear entry and exit point(s) for the process. | |
│ ├▻isSpecifiedBy | WorkflowControlStep | ? |
│ │ | An implementation and/or execution of an algorithm which is associated with the design of the process. | |
│ └▻implementsAlgorithm | AlgorithmOverview | * |
│ | The implemented instruments used in capturing the data. The ImplentedInstrument designates the mode of delivery, a relation to an external representation of the instrument, and reference to the conceptual instrument that contains more detailed information on the content of the instrument. | |
├▻hasInstrument | ⇩AnnotatedIdentifiable | * |
│ │ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
│ ├▻displayLabel | LabelForDisplay | * |
│ │ | Specification of the type of instrument according to the classification system of the documentor. | |
│ ├▻typeOfInstrument | ExternalControlledVocabularyEntry | ? |
│ │ | A reference to an external representation of the the data collection instrument, such as an image of a questionnaire or programming script. | |
│ ├▭uri | iri | * |
│ │ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
│ ├▻name | ObjectName | * |
│ │ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
│ ├▻usage | InternationalStructuredString | * |
│ │ | The ConceptualInstrument which informs the design of the ImplementedInstrument. | |
│ └▻usesConceptualInstrument | ⇩WorkflowProcess | ? |
│ │ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
│ ├▻displayLabel | LabelForDisplay | * |
│ │ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
│ ├▻name | ObjectName | * |
│ │ | A description of the purpose or use of the Member. May be expressed in multiple languages and supports the use of structured content. | |
│ ├▻description | InternationalStructuredString | ? |
│ │ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
│ ├▻usage | InternationalStructuredString | ? |
│ │ | Refers to the RepresentedMeasures and RepresentedQuestions used by the ConceptualInstrument. | |
│ └▻organizes | Capture | * |
│ | Information about data that are not currently available because of policies established by the principal investigators and/or data producers. | |
├▻hasEmbargo | ⇩AnnotatedIdentifiable | ? |
│ │ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
│ ├▻displayLabel | LabelForDisplay | * |
│ │ | Provides the date range of the embargo | |
│ ├▻embargoDates | DateRange | ? |
│ │ | Explanation of the reasons some decision was made or some object exists. Supports the use of multiple languages and structured text. | |
│ ├▻rationale | InternationalStructuredString | ? |
│ │ | Agent (Organiztion, Individual, etc.) that is responsible for the embargo | |
│ ├▻responsibleAgent | Agent | ? |
│ │ | Agent responsible for enforcing the embargo | |
│ └▻enforcementAgent | Agent | ? |
│ | Information relating to the availability of data from the study. | |
├▻accessInformation | Access | ? |
│ | Information about the individual, agency and/or grant(s) which funded the described entity. | |
├▻hasFundingInformation | FundingInformation | * |
│ | The authorizing agency and allows for the full text of the authorization (law, regulation, or other form of authorization). | |
├▻hasAuthorizationSource | AuthorizationSource | * |
│ | A statement of quality which may be related to an external standard or contain a simple statement of internal quality goals or expectations. | |
├▻hasQualityStatement | ⇩AnnotatedIdentifiable | ? |
│ │ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
│ ├▻name | ObjectName | * |
│ │ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
│ ├▻displayLabel | LabelForDisplay | * |
│ │ | Short natural language account of the information obtained from the combination of properties and relationships associated with an object. Supports the use of multiple languages and structured text. | |
│ ├▻overview | InternationalStructuredString | ? |
│ │ | Explanation of the reasons some decision was made or some object exists. Supports the use of multiple languages and structured text. | |
│ ├▻rationale | InternationalStructuredString | ? |
│ │ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
│ ├▻usage | InternationalStructuredString | ? |
│ │ | Identifies the external standard used and describes the level of compliance with the standard in terms specific aspects of the standard's content. | |
│ └▻usesStandard | ⇩AnnotatedIdentifiable | ? |
│ │ | Allows for a quality statement based on frameworks to be described using itemized properties. A reference to a concept, a coded value, or both can be used to specify the property from the standard framework identified in StandardUsed. Usage can provide further details or a general description of compliance with a standard. | |
│ ├▻compliance | ⇩AnnotatedIdentifiable | ? |
│ │ │ | Specification of a code which relates to an area of coverage of the standard. Supports the use of an external controlled vocabulary. | |
│ │ ├▻externalComplianceCode | ExternalControlledVocabularyEntry | ? |
│ │ │ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
│ │ ├▻usage | InternationalStructuredString | ? |
│ │ │ | A reference to a concept which relates to an area of coverage of the standard. | |
│ │ └▻definingConcept | Concept | * |
│ │ | Provide the citation and location of the published standard using the OtherMaterialType. | |
│ └▻standardUsed | ExternalMaterial | * |
│ | A description of the budget for the Study | |
├▻hasBudget | ⇩AnnotatedIdentifiable | * |
│ │ | Short natural language account of the information obtained from the combination of properties and relationships associated with an object. Supports the use of multiple languages and structured text. | |
│ ├▻overview | InternationalStructuredString | ? |
│ │ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
│ ├▻name | ObjectName | * |
│ │ | References to one or more external budget documents. | |
│ └▻budgetDocument | ExternalMaterial | * |
│ | A variable describing actual instances of data as recorded in the study. An example might be self reported gender, with categories of male encoded as "0" and female encoded as "1", with missing values recorded as "-9" for refused and "-8" as "not asked", recorded (physically) as an integer. | |
├▻hasInstanceVariable | InstanceVariable | * |
│ | Evaluation for the purpose of reviewing the study, data collection, data processing, or management processes. | |
├▻hasExPostEvaluation | ⇩AnnotatedIdentifiable | * |
│ │ | Brief identification of the type of evaluation. Supports the use of an external controlled vocabulary. | |
│ ├▻typeOfEvaluation | ExternalControlledVocabularyEntry | * |
│ │ | Describes the evaluation process. Supports multi-lingual content. Allows the optional use of structured content. | |
│ ├▻evaluationProcess | InternationalStructuredString | * |
│ │ | Describes the outcomes of the evaluation process. Supports multi-lingual content. Allows the optional use of structured content. | |
│ ├▻outcomes | InternationalStructuredString | * |
│ │ | Identifies the date the evaluation was completed. | |
│ ├▻completionDate | Date | ? |
│ │ | Evaluator used in this process. | |
│ └▻evaluator | Agent | * |
│ | The methodologies for sampling employed by the study. | |
├▻hasSamplingProcedure | SamplingProcedure | * |
│ | A relationship to a description of a simple overview, in which case the MethodologyOverView class should be the target. | |
├▻hasMethodology | MethodologyOverview | * |
│ | A relationship to a description of a simple overview, in which case the AlgorithmOverView class should be the target. | |
├▻hasAlgorithm | AlgorithmOverview | * |
│ | A Study may relate to multiple concepts. These may also be denoted by keywords in an Annotation. | |
├▻hasConcept | Concept | * |
│ | A Study may relate to a multiple collections of variables which may be defined by type, subject, use, source, etc. | |
├▻hasVariableCollection | ⇩AnnotatedIdentifiable | * |
│ │ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
│ ├▻type | CollectionType | ? |
│ │ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
│ ├▻name | ObjectName | * |
│ │ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
│ ├▻purpose | InternationalStructuredString | ? |
│ │ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
│ ├▻displayLabel | LabelForDisplay | * |
│ │ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
│ ├▻usage | InternationalStructuredString | ? |
│ │ | A semantic term defining the factor used for defining this group | |
│ ├▻groupingSemantic | ExternalControlledVocabularyEntry | ? |
│ │ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
│ ├▻contains | * | |
│ │ │ | Index value of member in an ordered array | |
│ │ ├▭index | xsd:integer | ? |
│ │ │ | Restricts member target class to ConceptualVariable, RepresentedVariable, and InstanceVariable | |
│ │ └▻member | ConceptualVariable | |
│ │ | If members are ordered set to true, if unordered set to false. | |
│ ├▭isOrdered | xsd:boolean | ? |
│ │ | This supplies information for linking disparate records in a dataset. RecordRelations describe corresponding InstanceVariables between record types. | |
│ ├▻isStructuredBy | ⇩Identifiable | * |
│ │ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list. Use if all relations within this relation structure are of the same specification. | |
│ │ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ │ | Provides semantic context for the relationship | |
│ │ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ │ ├▻totality | TotalityType | ? |
│ │ │ | Member relations that comprise the relation structure | |
│ │ └▻hasMemberRelation | * | |
│ │ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ │ ├▻hasRelationSpecification | RelationSpecification | |
│ │ │ | Provides semantic context for the relationship | |
│ │ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ │ ├▻totality | TotalityType | ? |
│ │ │ | First member in a relationship. | |
│ │ ├▻source | ConceptualVariable | * |
│ │ │ | Second member in a relationship. Note that this can be realized as a collection to support tuples. | |
│ │ └▻target | ConceptualVariable | * |
│ │ | The conceptual basis for the collection of members. | |
│ └▻definingConcept | Concept | * |
│ | Makes use of the Agent Listing to define relationships between agents. | |
└▻hasAgentListing | ⇩Identifiable | * |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of the Agent Listing. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value within an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target to Agent | |
│ └▻member | Agent | |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | Description of a complex structure for the Collection. A collection may be structured in more than one way for different uses. | |
├▻isStructuredBy | ⇩Identifiable | * |
│ │ | The effective start and end date of the relationship | |
│ ├▻effectiveDates | DateRange | ? |
│ │ | Define the level of privacy regarding this relationship. Supports the use of a controlled vocabulary. | |
│ ├▻privacy | ExternalControlledVocabularyEntry | ? |
│ │ | Explanation of the intent of creating the relation. Supports the use of multiple languages and structured text. | |
│ ├▻purpose | InternationalStructuredString | ? |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relation structure | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Agent relations that comprise the relation structure | |
│ └▻hasMemberRelation | * | |
│ │ | The effective dates of the relation. A structured DateRange with start and end Date (both with the structure of Date and supporting the use of ISO and non-ISO date structures); Use to relate a period with a start and end date. | |
│ ├▻effectiveDates | DateRange | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | The Parent agent in the hierarchical relationship | |
│ ├▻source | Agent | |
│ │ | The Child agent in the hierarchical relationship | |
│ └▻target | Agent | |
│ | Agent that maintains this Agency list | |
├▻maintenanceUnit | Agent | ? |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
StudyControl references a Study. StudyControl enables the representation of a research protocol at the Study level. [If the only purpose of the object is to carry a Study, it should be seriously considered for melting with another object. Modeling rules state that any object needs to have a reality of its own. Carrying another object is not a reality. If I misunderstood, please clarify the description instead]
StudyControl | ⇩Act | |
│ | Study that is the target of the StudyControl | |
└▻hasStudy | Study | * |
A collection of studies which can be structured as a simple sequence, or with a more complex structure.
An annual series of surveys.
A set of studies may be defined in many ways. A study may be repeated over time. One or more studies may attempt to replicate an earlier study. The StudySeries allows for the description of the relationships among a set of studies.
A simple ordered or unordered sequence of studies can be described via the "contains StudyIndicator" property. More complex relationships among studies may also be described using the optional "isStructuredBy StudyRelationsStructure".
StudySeries | ⇩AnnotatedIdentifiable | |
│ | The name of the series as a whole | |
├▻name | ObjectName | * |
│ | A general descriptive overview of the series. | |
├▻overview | InternationalStructuredString | ? |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to Study | |
│ └▻member | Study | ? |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | Description of a complex structure for the Collection. A collection may be structured in more than one way for different uses | |
├▻isStructuredBy | ⇩Identifiable | * |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Member relations that comprise the relation structure | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | First member in the relationship | |
│ ├▻source | Study | ? |
│ │ | Second member in a relationship. Note that this can be realized as a collection to support tuples. | |
│ └▻target | Study | * |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
CategoryRelationCode | ||
Nominal | ||
Ordinal | ||
Interval | ||
Ratio | ||
Continuous |
CollectionType | ||
Bag | ||
Set |
ComputationBaseList | ||
Total | ||
ValidOnly | ||
MissingOnly |
MappingRelation | ||
ExactMatch | ||
CloseMatch | ||
Disjoint |
PointFormat | ||
DecimalDegree | ||
DegreesMinutesSeconds | ||
DecimalMinutes | ||
Meters | ||
Feet |
RelationSpecification | ||
Unordered | ||
List | ||
ParentChild | ||
WholePart | ||
AcyclicPrecedence | ||
Equivalence | ||
GeneralSpecific |
SexSpecificationType | ||
Masculine | ||
Feminine | ||
GenderNeutral |
ShapeCoded | ||
Rectangle | ||
Circle | ||
Polygon | ||
LinearRing |
SpatialObjectPairs | ||
PointToPoint | ||
PointToLine | ||
PointToArea | ||
LineToLine | ||
LineToArea | ||
AreaToArea |
SpatialObjectType | ||
Point | ||
Polygon | ||
Line | ||
LinearRing | ||
Raster |
SpatialRelationSpecification | ||
Equals | ||
Disjoint | ||
Intersects | ||
Contains | ||
Touches |
StringStructureType | ||
XHTML | ||
RST | ||
Other |
TableDirectionValues | ||
Ltr | ||
Rtl | ||
Auto |
TemporalRelationSpecification | ||
TemporalMeets | ||
TemporalContains | ||
TemporalFinishes | ||
TemporalPrecedes | ||
TemporalStarts | ||
TemporalOverlaps | ||
TemporalEquals |
TextDirectionValues | ||
Ltr | ||
Rtl | ||
Auto | ||
Inherit |
TotalityType | ||
Total | ||
Partial | ||
Unknown |
TrimValues | ||
Start | ||
End | ||
Both | ||
Neither |
ValueRelationshipType | ||
Equal | ||
NotEqual | ||
GreaterThan | ||
GreaterThanOrEqualTo | ||
LessThan | ||
LessThanOrEqualTo |
WhiteSpaceRule | ||
Preserve | ||
Replace | ||
Collapse |
A Business Algorithm is used to express the generalized function of the Business Process. The underlying properties of the algorithm or method rather than the specifics of any particular implementation. In short a description of the method in its simplest and most general representation.
There are several well-established algorithms for performing data anonymization including "local suppression", "global attribute generalization" and "k-Anonymization with suppression" which is a specific combination of the two. An anonymizing business process might implement one of these algorithms.
BusinessAlgorithm | ⇩AlgorithmOverview |
A DataPipeline is a single traversal of the Generic Longitudinal Business Model (GLBPM) and/or the Generic Statistical Business process Model (GSBPM) in the course of a study where a study is either one off or a wave in a StudySeries.
In a study where the study is a wave in a StudySeries, we do a single traversal of the Generic Longitudinal Business Process Model. From one wave to the next the traversal may be different. Each traversal is described in a DataPipeline.
Extract Transform and Load (ETL) platforms support data pipelines to move data between systems. Using an ETL platform, data engineers create data pipelines to orchestrate the movement, transformation, validation, and loading of data, from source to final destination. The DataPipeline describes this "orchestration".
A prospective DataPipeline gives guidance to data engineers. It is a design pattern. A retrospective DataPipeline documents an ETL data pipeline after the fact.
Traversal, Data Lifecycle
DataPipeline | ⇩AnnotatedIdentifiable | |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Specifies BusinessProcess that participates in the DataPipeline | |
├▻contains | * | |
│ │ | Provides an index for the member within an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Member of the collection | |
│ └▻member | ⇩WorkflowProcess | |
│ │ | If a standard process model such as The Generic Statistical Business Process Model (GSBPN), the Generic Longitudinal Business Process Model (GLBPM), Open Archive Information System model (OAIS), etc. has been related to this business process, the model and step or sub-step is noted here using the Paired External Controlled Vocabulary Entry. Enter the name of the model in "term" and the step, sub-step, or specific portion of the model in "extent". | |
│ ├▻standardModelUsed | PairedExternalControlledVocabularyEntry | * |
│ │ | A condition for beginning the Business Process which may include the specification of the data set required for beginning the Business Process. | |
│ ├▻preCondition | BusinessProcessCondition | * |
│ │ | A condition for completing and exiting the Business Process which may include the specification of the data set resulting from the Business Process. | |
│ └▻postCondition | BusinessProcessCondition | * |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | A study has at most one DataPipeline. The same DataPipeline can be used in many studies. | |
├▻isInStudy | Study | ? |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
DDI4Version | ||
... | {"type":"NodeConstraint","nodeKind":"Literal","annotations":[{"type":"Annotation","predicate":"http://www.w3.org/2000/01/rdf-schema#definedBy","object":"http://lion.ddialliance.org/ddiobjects/ddi4version"},{"type":"Annotation","predicate":"http://www.w3.org/ns/shex-xmi#package","object":{"value":"http://ddi-alliance.org/ns/#Utility"}}]} |
Provides a consistent path to identifying information regarding the DDI Document and is automatically available for all Functional Views (/DocumentInformation/Annotation etc.). It covers annotation information, coverage (general, plus specific spatial, temporal, and topical coverage), access information from the producer (persistent access control), access information from the local distributor (Local Access Control), information on related series (i.e. a study done as a series of data capture events over time, qualitative material that is part of a larger set, one of a series of funded data capture activities, etc.), funding information, and other document level information used to identify and discover information about a DDI document regardless of its Functional View type. Use the Annotation at this level to provide the full annotation of the DDI Document. Note that related materials can be entered within the Annotation fields.
Annotation associated with a specific class is the annotation of the metadata class itself, such as the Study, InstanceVariable, Concept, etc. The annotation associated with Document Information is to refer to the Document itself. Note that not all DDI instances are intended to be persistent documents. For those that are DocumentInformation provides a consistent set of discovery level information on the content of the whole rather than specific parts of the instance.
DocumentInformation | ⇩AnnotatedIdentifiable | |
│ | Allows for the addition of a Purpose, Table of Contents, List of Variables, or other forms of information more specific than a general abstract. Provides both the content (using description) and a type identification using an External Controlled Vocabulary Entry. | |
├▻contentCoverage | * | |
│ │ | Uses a controlled vocabulary entry to classify the description provided. | |
│ ├▻typeOfContent | ExternalControlledVocabularyEntry | ? |
│ │ | A short natural language account of the characteristics of the object. | |
│ └▻descriptiveText | InternationalStructuredString | ? |
│ | Default value is False. Indicates that the metadata instance will not be changed without versioning, and is a stable target for referencing. | |
├▭isPublished | xsd:boolean | |
│ | A whitespace-delimited list of the DDI URN identifiers of the objects contained in an XML instance or RDF graph which could be considered the primary objects or entry points. In a Codebook View, for example, the top-level Codebook object, fo example. In some views, such as the Agents View, there my be more than one primary object (Individuals, Organizations, and Machines in this case). | |
├▭hasPrimaryContent | xsd:string | ? |
│ | Automatically brings in the version number for of DDI 4 | |
├▻ofType | DDI4Version | |
│ | Describes the coverage of the document as a whole. | |
├▻hasDocumentCoverage | Coverage | ? |
│ | Access control that will persist over time, generally imposed by the producer (i.e. embargo limits, confidentiality constraints). Provides information on access restrictions as well as the process to gain access. | |
├▻hasPersistentAccessControl | Access | * |
│ | Access control imposed by the local distributor. For example, distribution only to registered users of a system or members of an association. Provides information on access restrictions as well as the process to gain access. | |
├▻hasLocalAccessControl | Access | * |
│ | Describes funding source by description, grant number, and link to funding agent | |
├▻hasFundingSource | FundingInformation | * |
│ | Allows for listing information on any material external to the DDI metadata instance that is related to it. | |
└▻hasExternalMaterial | ExternalMaterial | * |
ExternalMaterial describes the location, structure, and relationship to the DDI metadata instance for any material held external to that instance. This includes citations to such material, an external reference to a URL (or other URI), and a statement about the relationship between the cited ExternalMaterial the contents of the DDI instance. It should be used as follows:as a target object from a relationship which clarifies its role within a class; or as the target of a relatedResource within an annotation.
ExternalMaterial is used to identify material and optionally specific sections of the material that have a relationship to a class. There is a generic relatedMaterial on AnnotatedIdentifiable. This should be used to attach any additional material that the user identifies as important to the class. The properties typeOfMaterial, descriptiveText, and relationshipDescription should be used to clarify the purpose and coverage of the related material.
Within the DDI model, ExternalMaterial is used as an extension base for specific external materials found such as an External Aid. It is used as a base for specifically related material (e.g. ExternalAid) by creating a relationship whose name clarifies the purpose of the related material.
r:OtherMaterialType
ExternalMaterial | ⇩Identifiable | |
│ | Designation of the type of material being described. Supports the use of a controlled vocabulary. | |
├▻typeOfMaterial | ExternalControlledVocabularyEntry | ? |
│ | A description of the referenced material. This field can map to a Dublin Core abstract. Note that Dublin Core does not support structure within the abstract element. Supports multiple languages and optional structured content. | |
├▻descriptiveText | InternationalStructuredString | ? |
│ | URI for the location of the material | |
├▭uri | iri | * |
│ | Describes the reason the external material is being related to the DDI metadata instance. | |
├▻relationshipDescription | InternationalStructuredString | * |
│ | Provides a standard Internet MIME type for use by processing applications. | |
├▻mimeType | ExternalControlledVocabularyEntry | ? |
│ | Can describe a segment within a larger object such as a text or video segment. | |
├▻usesSegment | * | |
│ │ | Describes the type and length of the audio segment. | |
│ ├▻usesAudioSegment | * | |
│ │ │ | The type of audio clip provided. Supports the use of a controlled vocabulary. | |
│ │ ├▻typeOfAudioClip | ExternalControlledVocabularyEntry | ? |
│ │ │ | The point to begin the audio clip. If no point is provided the assumption is that the start point is the beginning of the clip provided. | |
│ │ ├▭audioClipBegin | xsd:string | ? |
│ │ │ | The point to end the audio clip. If no point is provided the assumption is that the end point is the end of the clip provided. | |
│ │ └▭audioClipEnd | xsd:string | ? |
│ │ | Describes the type and length of the video segment. | |
│ ├▻usesVideoSegment | * | |
│ │ │ | The type of video clip provided. Supports the use of a controlled vocabulary. | |
│ │ ├▻typeOfVideoClip | ExternalControlledVocabularyEntry | ? |
│ │ │ | The point to begin the video clip. If no point is provided the assumption is that the start point is the beginning of the clip provided. | |
│ │ ├▭videoClipBegin | xsd:string | ? |
│ │ │ | The point to end the video clip. If no point is provided the assumption is that the end point is the end of the clip provided. | |
│ │ └▭videoClipEnd | xsd:string | ? |
│ │ | An X-Pointer expression identifying a node in the XML document. | |
│ ├▭xml | xsd:string | * |
│ │ | Defines the segment of textual content used by the parent object. Can identify a set of lines and or characters used to define the segment | |
│ ├▻useseTextualSegment | * | |
│ │ │ | Specification of the line and offset for the beginning and end of the segment. | |
│ │ ├▻lineParamenter | ? | |
│ │ │ │ | Number of lines from beginning of the document. | |
│ │ │ ├▭startLine | xsd:integer | ? |
│ │ │ │ | Number of characters from start of the line specified in StartLine. | |
│ │ │ ├▭startOffset | xsd:integer | ? |
│ │ │ │ | Number of lines from beginning of the document. | |
│ │ │ ├▭endLine | xsd:integer | ? |
│ │ │ │ | Number of characters from the start of the line specified in EndLine. | |
│ │ │ └▭endOffset | xsd:integer | ? |
│ │ │ | Specification of the character offset for the beginning and end of the segment. | |
│ │ └▻characterParameter | ? | |
│ │ │ | Number of characters from beginning of the document, indicating the inclusive start of the text range. | |
│ │ ├▭startCharOffset | xsd:integer | ? |
│ │ │ | Number of characters from the beginning of the document, indicating the inclusive end of the text segment. | |
│ │ ├▭endCharOffset | xsd:integer | ? |
│ │ │ | can be used to describe a text segment as start and length | |
│ │ └▭characterLength | xsd:integer | ? |
│ │ | Defines the shape and area of an image used as part of a location representation. The shape is defined as a Rectangle, Circle, or Polygon and Coordinates provides the information required to define it. | |
│ └▻usesImageArea | * | |
│ │ | A comma-delimited list of x,y coordinates, listed as a set of adjacent points for rectangles and polygons, and as a center-point and a radius for circles (x,y,r). | |
│ ├▭content | xsd:string | ? |
│ │ | A fixed set of valid responses includes Rectangle, Circle, and Polygon. | |
│ └▻shape | ShapeCoded | ? |
│ | Bibliographic citation for the external resource. | |
└▻citationOfExternalMaterial | Annotation | ? |
Provides information about the individual, agency and/or grant(s) which funded the described entity. Lists a reference to the agency or individual as described by a DDI Agent, the role of the funder, the grant number(s) and a description of the funding activity.
A "millionaire grant" (funding description) from John Beresford Tipton, Jr. (individual). Exploration of the effect of sudden wealth and basis for a television episode (funder role).
r:FundingInformationType
FundingInformation | ⇩Identifiable | |
│ | Role of the funding organization or individual. Supports the use of a controlled vocabulary. | |
├▻funderRole | ExternalControlledVocabularyEntry | ? |
│ | The identification code of the grant or other monetary award which provided funding for the described object. | |
├▭grantNumber | xsd:string | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured tex | |
├▻purpose | InternationalStructuredString | ? |
│ | The source of the funding expressed as an Organization or Individual. | |
└▻hasFunder | Agent | * |
An Act is an indivisible, atomic step, i.e. not composed of other steps. An Act can also be viewed as a terminal node in a hierarchy of Workflow Steps.
QuestionConstructType from DDI 3.x is an example of an Act. GenerationInstructionType from DDI 3..x is an example of an Act extended to include a CommandCode used to create a derivation or recode for an InstanceVariable or other similar use
Act is named after the act in the HL7 RIM. This act can take many forms including an observation, a procedure, a referral, a prescription, a consent and so forth.
Act | ⇩WorkflowStep |
Provides an extensible framework for specific computation or transformation objects.
In data processing, a ComputationAction might be a code statement in a code sequence.
In data capture, a ComputationAction might takes the form of a question, a measurement or instrument code.
d:ComputationItemType
ComputationAction | ⇩Act | |
│ | Describes the transformation activity | |
├▻activityDescription | InternationalStructuredString | ? |
│ | The command code performed as a part of the transformation or computation | |
├▻usesCommandCode | CommandCode | ? |
│ | Allows for the specification of a computation or transformation type supporting the use of an external controlled vocabulary | |
└▻typeOfComputation | ExternalControlledVocabularyEntry | ? |
Type of WorkflowControlStep in which the execution flow is determined by one or more conditions.
If-then-else and iterative structures.
ConditionalControlStep | ⇩WorkflowControlStep | |
│ | Condition to be evaluated to determine whether or not to execute the Workflow Sequence in contains. It can be an expression and/or programmatic code. The specialized sub-classes determine whether the Sequence is executed when the condition is true or false | |
├▻condition | CommandCode | ? |
│ | The Workflow Sequence is executed depending on the result of the condition evaluation. The specialized sub-classes determine whether the Sequence is executed when the condition is true or false. Specialization of contains in Control Construct. | |
└▻executes | WorkflowStepSequence | ? |
IfThenElse describes an if-then-else decision type of control construct. If the stated condition is met, then the associated Workflow Sequence in containsSubSeqence is triggered, otherwise the Workflow Sequence that is triggered is the one associated via elseContains.
An IfThenElse object describes the conditional logic in the flow of a questionnaire or other data collection instrument, where if a stated condition is met, one path is followed through the flow, and if the stated condition is met, another path is taken.
Contains a condition and two associations:
d:IfThenElseType
IfThenElse | ⇩ConditionalControlStep | |
│ | The condition to check if the IfThenElse condition is false. | |
├▻elseIf | * | |
│ │ | The condition to verify if the parent IfThenElse condition is false. | |
│ ├▻condition | CommandCode | ? |
│ │ | The WorkflowStepSequence to execute if the condition is true | |
│ └▻executes | WorkflowStepSequence | ? |
│ | Optional sequence of Process Steps that are triggered for execution when the condition is false. | |
└▻elseExecutes | WorkflowStepSequence | ? |
Iterative control structure to be repeated a specified number of times based on one or more conditions. Inside the loop, one or more Workflow Steps are evaluated and processed in the order they appear.
A loop is set to repeat a fixed number of times (initialValue). A stepValue is initially specified. At the end of the loop the current value is decremented by the stepValue. The current value might be the initialValue or it might be the current value after the initialValue has been decremented one or more times.
The Workflow Sequence contained in the Loop is executed until the condition is met, and then control is handed back to the containing control construct.
ForLoop
d:LoopType
Loop | ⇩ConditionalControlStep | |
│ | The command used to set the initial value for the process. Could be a simple value. | |
├▻initialValue | CommandCode | ? |
│ | The command used to set the incremental or step value for the process. Could be a simple value. | |
└▻stepValue | CommandCode | ? |
MetadataDrivenActions are Acts in which their logic is defined by validation and transformation rules expressed in some standard rule language.
Some data management systems present users with a menu of actions they can use in a sequence to perform a specific task. The system engages the user in a dialog driven by an action template. The dialog completes the template which the system then uses to perform the action. The user doesn't write any code.
Whereas ComputationActions are used in statistical packages like SPSS, Stata, SAS and R to perform data management and data transformations, MetadataDrivenActions are used by data pipelines, e.g. ETL (Extract Transform Load) platforms, along with ComputationActions.
In a data pipeline the user is presented with a menu of MetadataDrivenActions that are captured here in an external controlled vocabulary. Users enter into a dialog with the platform through which they customize the MetadataDrivenAction. The user writes no code. The dialog is saved.
In the course of this dialog the user might specify a data source, specify which variables to keep or drop, rename variables, specify join specifics, create a value map between two variables and so forth.
MetadataDrivenActions represent this dialog in some standard rule language, e.g. Structured Data Transformation Language (SDTL) , Validation and Transformation Language (VTL), etc.. In fact, MetaDataDrivenAction can use VTL with certain "extensions". Together they form quasi-VTL. quasi-VTL in turn conforms to a known schema. Using this schema users can render the quasi-VTL as XHTML and record it in the MetadataDrivenAction quasiVTL property. quasiVTL supports structured text.
Note that we would like NOT to create specific subtypes of MetadataDrivenAction -- one for each transformation. In fact there are a dozen or more such actions that will be captured in the MetadataDrivenAction types external controlled vocabulary. As an alternative, users can optionally write structured text based on a known schema. In this approach we are able to "evolve" SDTL as needed without changing our model. Instead, as our language "evolves", we one have to update its schema.
MetadataDrivenAction | ⇩Act | |
│ | Describes the transformation activity | |
├▻activityDescription | InternationalStructuredString | ? |
│ | Allows for the specification of a transformation type supporting the use of an external controlled vocabulary | |
├▻typeOfMetadataDrivenAction | ExternalControlledVocabularyEntry | ? |
│ | A definition of the action in XHTML that conforms to the quasi-VTL schema. Each action has its own definition that a user optionally completes. | |
└▻quasiVTL | InternationalStructuredString | ? |
An Input or Output to a Process Step defined by as a unique identifier. It may be a single value or an array.
A question might have dynamic text or, again, "fills". Depending on the gender of the subject, a question might say "he" or "she" and/or "him" or "her". A gender variable is passed into the question, and question code resolves the dynamic text. A computation action may be expecting a numeric array of values [result of looping an "Age in years" question through every member of a household]. isArray = "true"; valueRepresentation would link to a SubstantiveValueDomain defining a numeric value with a possible valid range; and because the parameter occurs in the context of a computation action it is necessary to specify an alias (e.g. AGE). The alias links the parameter to the code in the computation.
When used as an hasInputParameter it defines a value being used by Process Step as a direct input or as an alias value within an equation. When used as an hasOutputParameter it defines itself as the value of the variable, capture, or explicit value of the parent class or as a specific value in a computation output by assigning the related Alias and/or defining the item within an array. Providing a defaultValue ensures that when bound to another Parameter that some value will be passed or received. A Value Domain expressed as a SubstantiveValueDomain or a SentinalValueDomain may be designated to define the datatype and range( of the expected value.
Parameter | ||
│ | If the content of the parameter is being used in a generic set of code as an alias for the value of an object in a formula (for example source code for a statistical program) enter that name here. This provides a link from the identified parameter to the alias in the code. | |
├▭alias | xsd:double | ? |
│ | Provides a default value for the parameter if there is no value provided by the object it is bound to or the process that was intended to produce a value. | |
├▻defaultValue | ValueString | ? |
│ | If set to "true" indicates that the content of the parameter is a delimited array rather than a single object and should be processed as such.limitArrayIndex | |
├▭isArray | xsd:boolean | ? |
│ | When the Parameter represents an array of items, this attribute specifies the index identification of the items within the zero-based array which should be treated as that associated with the parameter. If not specified, the full array is treated as the parameter. | |
├▭limitArrayIndex | xsd:double | ? |
│ | This is the registered agency code with optional sub-agencies separated by dots. For example, diw.soep, ucl.qss, abs.essg. | |
├▭agency | xsd:string | |
│ | The ID of the object. This must conform to the allowed structure of the DDI Identifier and must be unique within the Agency. | |
├▭id | xsd:string | |
│ | The version number of the object. The version number is incremented whenever the non-administrative metadata contained by the object changes. | |
├▭version | xsd:string | |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of the Agent Listing. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | If the content of the parameter contains representational content, such as codes, provide the representation here. ValueDomain is the abstract with a number of subtype and may be replaced with any valid substitution for ValueDomain. Inclusion of the valueRepresentation is recommended if you will be sharing data with others as it provides information on the structure of what they can expect to receive when the parameter is processed. | |
└▻valueRepresentation | ValueDomain | ? |
Iterative control structure to be repeated until a specified condition is met. After each iteration the condition is tested. If the condition is not met, the associated Workflow Sequence in contains (inherited from Conditional Control Construct) is triggered. When the condition is met, control passes back to the containing Workflow Step.
A RepeatUntil loop is similar to a RepeatWhile loop, except that it tests the Boolean expression after the loop rather than before. Thus, a RepeatUntil loop always executes the loop once, whereas if the Boolean expression is initially False, a RepeatWhile loop does not execute the loop at all. For example, in a household there is at last one person and a loop might contain a block of person questions. After the first person the last question in the block might be "Anyone else in the household"? The RepeatUntil would continue iterating until there was no-one else in the household.
d:RepeatUntilType
RepeatUntil | ⇩ConditionalControlStep |
Iterative control structure to be repeated while a specified condition is met. Before each iteration the condition is tested. If the condition is met, the associated Workflow Sequence in contains (inherited from Conditional Control Construct) is triggered. When the condition is not met, control passes back to the containing Workflow Step.
A RepeatWhile loop is similar to a RepeatUntil loop, except that it tests the Boolean expression before the loop rather than after. Thus, a RepeatUntil loop always executes the loop once, whereas if the Boolean expression is initially False, a RepeatWhile loop does not execute the loop at all. For example, RepeatWhile may be used to pre-test a certain condition like if "the number of new people in a household is greater than 0" in which case a block of questions might be asked for each new person.
d:RepeatWhileType
RepeatWhile | ⇩ConditionalControlStep |
The components of a Split consists of a number of process steps to be executed concurrently with partial synchronization. Split completes as soon as all of its component process steps have been scheduled for execution.
Supports parallel processing that does not require completion to exit.
Split | ⇩TemporalRelationControlStep |
SplitJoin consists of process steps that are executed concurrently (execution with barrier synchronization). That is, SplitJoin completes when all of its components processes have completed.
A GANTT chart where a number of processes running parallel to each other are all prerequisites of a subsequent step.
Supports parallel processing that requires completion of all included process steps to exit.
SplitJoin | ⇩TemporalRelationControlStep |
Defines complex synchronous or asynchronous temporal ordering control. Defines temporal relationships using Allen's Intervals.
When creating a specific subtype identify the workflow steps included in a structure that is appropriate to the subtype. For example, Split contains a relationship "executeConcurrently".
TemporalRelationControlStep | ⇩WorkflowControlStep | |
│ | Specify the type of temporal relationhship between identified WorkflowSteps using Allen's Interval definitions. | |
└▻typeOfTemporalRelationship | TemporalRelationSpecification | ? |
A subtype of WorkflowStep which controls the ordering of Workflow Steps within a Process. Abstract base for specialized ordering conditions that have specific requirements to relay ordering information.
A WorkflowStepSequence is a subtype of WorkflowControlStep which defines a sequential order for included steps.
WorkflowControlStep | ⇩WorkflowStep | |
│ | The WorkflowSteps executed by the control mechanism | |
└▻executes | WorkflowStep | * |
A Workflow Process is a realization of Process which identifies the Workflow Step Sequence which contains the WorkflowSteps and their order. It may identify the algorithm that it implements.
Overall description of steps taken when ingesting a dataset into an archive; A Sampling Process; A step or sub-step of the Generic Longitudinal Business Process Model (GLBPM).
WorkflowProcess | ⇩AnnotatedIdentifiable | |
│ | Provides a high level overview or summary of the class. Can be used to inform end-users or as part of an executive summary. Supports the use of multiple languages and structured text. | |
├▻overview | InternationalStructuredString | ? |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Explanation of the ways in which the pattern is employed. Supports the use of multiple languages and structured text. | |
├▻usage | InternationalStructuredString | ? |
│ | The algorithms implemented by the process. May be expressed by AlgorithmOverview or any subclass | |
├▻implementsAlgorithm | AlgorithmOverview | * |
│ | Points to the WorkflowControlStep subtype which defines the starting point for initiating the set of process steps contained in the process. | |
└▻isSpecifiedBy | WorkflowControlStep | ? |
One of the constituents of a Workflow. It can be a composition or atomic and might be performed by a Service.
A ControlConstruct that orchestrates steps and substeps in a Workflow is a WorkflowStep. An Act is a WorkflowStep.
An atomic Workflow Step has no Control Constructs -- it's an Act. A composition consists of a tree of Control Constructs. In this tree Acts are associated with the leaf nodes.
Furthermore, a composition might be a glass box or a black box from the perspective of a service. If a service performs a WorkflowStep, it might invoke just the topmost ControlConstruct -- for example a WorkflowSequence. It may know nothing about the internal workings of the sequence. In this case the WorkflowStep is a black box.
Process Step
WorkflowStep | ⇩AnnotatedIdentifiable | |
│ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
├▻displayLabel | LabelForDisplay | * |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
├▻usage | InternationalStructuredString | * |
│ | Short natural language account of the information obtained from the combination of properties and relationships associated with an object. Supports the use of multiple languages and structured text. | |
├▻overview | InternationalStructuredString | ? |
│ | Mapping of specific information flow within the workflow | |
├▻hasInformationFlow | Binding | * |
│ | Identifies the Service Implementation which performs the Workflow Step. Specialization of isPerformedBy in Process Step for Service Implementations. | |
├▻isPerformedBy | ⇩AnnotatedIdentifiable | ? |
│ │ | Specifies how to communicate with the service. | |
│ ├▻serviceInterface | ExternalControlledVocabularyEntry | * |
│ │ | Specifies where the service can be accessed. | |
│ ├▻serviceLocation | ExternalControlledVocabularyEntry | ? |
│ │ | The estimated time period associated with the operation of the Service. This may be expressed as a time, date-time, or duration. | |
│ ├▻estimatedDuration | Date | ? |
│ │ | Actor that performs a role in the service, | |
│ └▻hasAgent | Agent | * |
│ | An identification for a Parameter related to the WorkflowStep and referred to by a Binding indicating the Input to the WorkflowStep | |
├▻hasInputParameter | Parameter | * |
│ | An identification for a Parameter related to the WorkflowStep and referred to by a Binding indicating the Output from the WorkflowStep | |
└▻hasOutputParameter | Parameter | * |
A WorkflowStepSequence controls the order of WorkflowSteps by defining a simple sequence.
WorkflowSteps that may be used in a WorkflowStepSequence may be of many subtypes, covering simple or computational acts, conditional steps such as an IfThenElse, temporally defined ordering controls such as Split and SplitJoin, or others designed for various specializations of the WorkflowProcess. .
WorkflowSteps in a WorkflowStepSequence exchange variables and values by way of output parameters, input parameters and their bindings.
A WorkflowStepSequence can be used to describe the flow of questions in a questionnaire.
A WorkflowStepSequence can be used to decompose a BusinessProcess like data integration or anonymization into a series of steps.
If more complex temporal or graph ordering is required use the subtype StructuredWorkflowSteps. The relationship "executes" in this instance of a WorkflowControlStep is an optional means of noting the set of WorkflowSteps managed by the sequence. Sequencing is done using orderedStep. This is currently an anomoly that should be resolved in future discussion application of transformation rules from UML model.
d:SequenceType
WorkflowStepSequence | ⇩WorkflowControlStep | |
│ | Provides the ability to "type" a sequence for classification or processing purposes. Supports the use of an external controlled vocabulary. | |
├▻typeOfWorkflowStepSequence | ExternalControlledVocabularyEntry | * |
│ | The Workflow Steps included in the Collection with an index for position within ordered array. | |
├▻orderedStep | * | |
│ │ | Index value of WorkflowStep in an ordered array | |
│ ├▭index | xsd:integer | |
│ │ | The subtype of a WorkflowStep occuring at the indexed position within the array. | |
│ └▻indexedWorkflowStep | WorkflowStep | |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
└▻purpose | InternationalStructuredString | ? |
Something an enterprise does, or needs to do, in order to achieve its objectives.
A Business Function delivers added value from a business point of view. It is delivered by bringing together people, processes and technology (resources), for a specific business purpose.
Business Functions answer in a generic sense "What business purpose does this Business Service or Process Step serve?" Through identifying the Business Function associated with each Business Service or Process Step it increases the documentation of the use of the associated Business Services and Process Steps, to enable future reuse.
A Business Function may be defined directly with descriptive text and/or through reference to an existing catalogue of Business Functions.
Business Function
BusinessFunction | ⇩AnnotatedIdentifiable | |
│ | Provides a high level overview or summary of the class. Can be used to inform end-users or as part of an executive summary. Supports the use of multiple languages and structured text. | |
└▻overview | InternationalStructuredString | ? |
Goals are the "things" a method aims to achieve. A goal may be a business function (GSIM) corresponding to a function in a catalog of functions such as GSBPM or GLBMN. However, goals may be specified more broadly. For example, conducting a clinical trial might be the goal of a method. Machine learning might be the goal of a method.
To further distinguish a "goal" from an "output", consider the construction of a statistic. A goal may be the construction of the statistic. The output is the statistic. The output is data. The statistic by itself -- the output -- is arguably meaningless even if we capture the process of its construction.
Business Function
Goal | ⇩BusinessFunction | |
│ | Identifies material discussing the goal. The material may be in DDI or other format. | |
└▻isDiscussedIn | ExternalMaterial | * |
Describes the results of a process for the purpose of linking these results to guidance for future usage in specified situations. Result is abstract and serves as a substitution base for the specified result of a specific instantiation of a methodology process.
The use of a weight resulting from a sampling process by an analyst within the context of a specific set of variables. The class containing the weight would use the extension base Result, adding any additional required properties and relationships to describe it.
Result | ⇩AnnotatedIdentifiable | |
│ | Provides a high level overview or summary of the class. Can be used to inform end-users or as part of an executive summary. Supports the use of multiple languages and structured text. | |
├▻overview | InternationalStructuredString | ? |
│ | Can bind data attached to parameters into, out of, and between processes. | |
├▻hasBinding | Binding | * |
│ | The result may have one or more specific usages which provides guidance for the use of the result with a specific unit type. | |
├▻hasAppliedUse | ⇩AnnotatedIdentifiable | * |
│ │ | Provides a high level overview or summary of the class. Can be used to inform end-users or as part of an executive summary. Supports the use of multiple languages and structured text. | |
│ ├▻overview | InternationalStructuredString | ? |
│ │ | The guide describing the appropriate usage of the result in the context of specified unit types and/or objects. | |
│ ├▻hasGuide | ⇩AnnotatedIdentifiable | * |
│ │ │ | Provides a high level overview or summary of the class. Can be used to inform end-users or as part of an executive summary. Supports the use of multiple languages and structured text. | |
│ │ ├▻overview | InternationalStructuredString | ? |
│ │ │ | Identifies material discussing the precondition. The material may be in DDI or other format. | |
│ │ └▻isDiscussedIn | ExternalMaterial | * |
│ │ | The unit type or types for which the guide is appropriate | |
│ ├▻appliesToUnitType | UnitType | * |
│ │ | Specifies the object for which the guide is appropriate | |
│ └▻isUsedBy | AnnotatedIdentifiable | * |
│ | Comparison of Result of the Process against the Goal to inform further activities. | |
├▻evaluateAgainstGoal | Goal | * |
│ | Used by Binding to link the output of another class to the input of this class | |
├▻hasInputParameter | Parameter | * |
│ | Used by Binding to link the output of this class to the input of another class | |
└▻hasOutputParameter | Parameter | * |
Describes access to the annotated object. This item includes a confidentiality statement, descriptions of the access permissions required, restrictions to access, citation requirements, depositor requirements, conditions for access, a disclaimer, any time limits for access restrictions, and contact information regarding access.
A proprietary InstanceQuestion might have specific access restrictions.
a:AccessType
Access | ⇩AnnotatedIdentifiable | |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text | |
├▻purpose | InternationalStructuredString | ? |
│ | A statement regarding the confidentiality of the related data or metadata. | |
├▻confidentialityStatement | InternationalStructuredString | ? |
│ | A link to a form used to provide access to the data or metadata including a statement of the purpose of the form. | |
├▻accessPermission | * | |
│ │ | The number or other means of identifying the form. | |
│ ├▭formNumber | xsd:string | ? |
│ │ | The URN or URL of the form. | |
│ ├▭uri | iri | ? |
│ │ | A statement regarding the use, coverage, and purpose of the form. | |
│ ├▻statement | InternationalString | ? |
│ │ | Set to "true" if the form is required. Set to "false" if the form is optional. | |
│ └▭isRequired | xsd:boolean | ? |
│ | A statement regarding restrictions to access. May be expressed in multiple languages and supports the use of structured content. | |
├▻restrictions | InternationalStructuredString | ? |
│ | A statement regarding the citation requirement. May be expressed in multiple languages and supports the use of structured content. | |
├▻citationRequirement | InternationalStructuredString | ? |
│ | A statement regarding depositor requirements. May be expressed in multiple languages and supports the use of structured content. | |
├▻depositRequirement | InternationalStructuredString | ? |
│ | A statement regarding conditions for access. May be expressed in multiple languages and supports the use of structured content. | |
├▻accessConditions | InternationalStructuredString | ? |
│ | A disclaimer regarding the liability of the data producers or providers. May be expressed in multiple languages and supports the use of structured content. | |
├▻disclaimer | InternationalStructuredString | ? |
│ | The agent to contact regarding access including the role of the agent. | |
├▻contactAgent | AgentAssociation | * |
│ | The date range or start date of the access description. | |
└▻validDates | DateRange | ? |
A type of Spatial coverage describing a rectangular area within which the actual range of location fits. A BoundingBox is described by 4 numbers - the maxima of the north, south, east, and west coordinates found in the area.
Burkino Faso: (N) 15.082773; (S) 9.395691; (E) 2.397927; (W) -5.520837
A BoundingBox is often described by two x,y coordinates where the x coordinates are used for the North and South Latitudes and y coordinates for the West and East Longitudes
r:BoundingBox
BoundingBox | ⇩AnnotatedIdentifiable | |
│ | The easternmost coordinate expressed as a decimal between the values of -180 and 180 degrees | |
├▭eastLongitude | xsd:double | |
│ | The westernmost coordinate expressed as a decimal between the values of -180 and 180 degrees | |
├▭westLongitude | xsd:double | |
│ | The northernmost coordinate expressed as a decimal between the values of -90 and 90 degrees. | |
├▭northLatitude | xsd:double | |
│ | The southermost latitude expressed as a decimal between the values of -90 and 90 degrees | |
└▭southLatitude | xsd:double |
Coverage information for an annotated object. Includes coverage information for temporal, topical, and spatial coverage.
A survey might have ask people about motels they stayed in (topical coverage) in the year 2015 (temporal coverage), while they were travelling in Kansas (spatial coverage). This is different than the temporal, and spatial attributes of the population studied – (international travelers to the US surveyed in 2017).
Coverage is a container for the more specific temporal, spatial, and topical coverages to which it refers.
r:CoverageType
Coverage | ⇩AnnotatedIdentifiable | |
│ | A generic description including temporal, topical, and spatial coverage that is the equivalent of dc:coverage (the refinement base of dcterms:spatial and dcterms:temporal. Use specific coverage content for detailed information. Short natural language account of the information obtained from the combination of properties and relationships associated with an object. Supports the use of multiple languages and structured text. | |
├▻overview | InternationalStructuredString | ? |
│ | The dates and time periods described by the contents of the annotated object. | |
├▻hasTemporalCoverage | ⇩AnnotatedIdentifiable | ? |
│ │ | A date referencing a specific aspect of temporal coverage. The date may be typed to reflect coverage date, collection date, referent date, etc. Subject and Keywords may be associated with the date to specify a specific set of topical information (i.e. Residence associated with a date 5 years prior to the collection date). | |
│ └▻coverageDate | ⇩AnnotationDate | * |
│ │ | If the date is for a subset of data only such as a referent date for residence 5 years ago, use Subject to specify the coverage of the data this date applies to. May be repeated to reflect multiple subjects. | |
│ ├▻subject | ExternalControlledVocabularyEntry | * |
│ │ | If the date is for a subset of data only such as a referent date for residence 5 years ago, use keyword to specify the coverage of the data this date applies to. May be repeated to reflect multiple keywords. | |
│ └▻keyword | ExternalControlledVocabularyEntry | * |
│ | The topics covered by the contents of the annotated object. These may be expressed by subject classification systems and structured or unstructured keywords. | |
├▻hasTopicalCoverage | ⇩AnnotatedIdentifiable | ? |
│ │ | A subject that describes the topical coverage of the content of the annotated object. Subjects are members of structured classification systems such as formal subject headings in libraries. Uses and InternationalCodeValue and may indicate the language of the code used. | |
│ ├▻subject | ExternalControlledVocabularyEntry | * |
│ │ | A keyword that describes the topical coverage of the content of the annotated object. Keywords may be structured (e.g. TheSoz thesauri) or unstructured and reflect the terminology found in the document and other related (broader or similar) terms. Uses and InternationalCodeValue and may indicate the language of the code used. | |
│ └▻keyword | ExternalControlledVocabularyEntry | * |
│ | Description of the spatial (geographic) coverage of the contents of the annotated object. | |
└▻hasSpatialCoverage | ⇩AnnotatedIdentifiable | ? |
│ | A textual description of the spatial coverage to support general searches. | |
├▻description | InternationalStructuredString | ? |
│ | Supports the use of a standardized code such as ISO 3166-1, the Getty Thesaurus of Geographic Names, FIPS-5, etc. | |
├▻spatialAreaCode | ExternalControlledVocabularyEntry | * |
│ | Indicates the most discrete spatial object type identified for a single case. Note that data can be collected at a geographic point (address) and reported as such in a protected file, and then aggregated to a polygon for a public file. | |
├▻spatialObject | SpatialObjectType | ? |
│ | The north and south latitudes and east and west longitudes that define the spatial coverage area. | |
├▻hasBoundingBox | BoundingBox | * |
│ | A classification which describes the geographic unit types and relationships used within this coverage. | |
├▻usesGeographicUnitTypeClassification | GeographicUnitTypeClassification | * |
│ | A classification which describes the geographic units (specific locations) and relationships used within this coverage. | |
├▻usesGeographicUnitClassification | GeographicUnitClassification | * |
│ | The geographic unit types used within this coverage. | |
├▻includesGeographicUnitType | UnitType | * |
│ | The geographic units used within this coverage. | |
├▻includesGeographicUnit | GeographicUnit | * |
│ | The unit type describing the highest or broadest geographic unit type that can be assembled within this coverage. In some cases with multiple hierarchies there may be multiple geographic unit types assembled. | |
├▻highestGeographicUnitTypeCovered | UnitType | * |
│ | The lowest geographic unit type identified within this coverage. Repeat if multiple geographic hierarchies are used and there is no single lowest level that can be used to compile geographic areas into higher levels. For example a file that has one hierarchy using State-County-CensusTract/BNA and also data identified for Place which cannot be constructed directly from Census Tracts as they may cross Place boundaries. | |
└▻lowestGeographicUnitTypeCovered | UnitType | * |
A response domain capturing a binary response, such as selected/unselected or checked/unchecked or true/false.
Exactly what is captured may be dependent upon the Implemented Instrument, however the response being captured is either there or not there (ON/OFF, True/False)
BooleanResponseDomain | ⇩ResponseDomain | |
│ | The category to which a boolean response is requested. | |
└▻forCategory | Category | ? |
A measurement that describes a means of capturing data. This class can be extended to account for different specific means. Use a specific instantiation of a Capture to describe a means of capturing a measurement.
A survey question, blood pressure reading; MRI images; thermometer; web service; experimental observation. Classes could include InstanceQuestion, InstanceMeasurement or other class extending Capture.
Provides an abstract base so that current and future forms of data capture can use this as an extension base and be freely mixed and matched within conceptual instruments as needed such as capturing a GPS point (using a RepresentedMeasurement) when administering a questionnaire (using RepresentedQuestions).
Capture | ⇩AnnotatedIdentifiable | |
│ | A name for the measurement. A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
├▻displayLabel | LabelForDisplay | * |
│ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
├▻usage | InternationalStructuredString | ? |
│ | A description of the purpose or use of the Measurement. May be expressed in multiple languages and supports the use of structured content. | |
├▻purpose | InternationalStructuredString | ? |
│ | The source of a capture structure defined briefly; typically using an external controlled vocabulary | |
├▻captureSource | ExternalControlledVocabularyEntry | ? |
│ | Identifies the unit being analyzed such as a Person, Housing Unit, Enterprise, etc. | |
├▻analysisUnit | ExternalControlledVocabularyEntry | * |
├▻hasResponseDomain | ResponseDomain | * |
│ | Capture has a Concept | |
├▻hasConcept | Concept | * |
│ | Capture has an Instruction | |
├▻hasInstruction | Instruction | * |
│ | Capture has an External Aid | |
└▻hasExternalAid | ExternalAid | * |
A response domain capturing a coded response (where both codes and their related category value are displayed) for a question. This response domain allows the single selection of one coded response.
d:CodeDomainType
CodeListResponseDomain | ⇩ResponseDomain | |
│ | The CodeList which includes the response options to list. | |
├▻usesCodeList | ⇩EnumerationDomain | ? |
│ │ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
│ ├▻contains | * | |
│ │ │ | Provides an index for the member within an ordered array | |
│ │ ├▭index | xsd:integer | ? |
│ │ │ | Indicates the level within which the CodeItem resides | |
│ │ ├▭isInLevel | xsd:integer | ? |
│ │ │ | The member containing the designation of the CodeItem | |
│ │ └▻member | Code | |
│ │ | A complex structure, hierarchical, for a CodeList. Restricted to single structure. | |
│ └▻isStructuredBy | ⇩Identifiable | ? |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection | |
│ ├▻totality | TotalityType | |
│ │ | CodeRelations making up the relation structure. | |
│ └▻hasMemberRelation | * | |
│ │ | Type of relation in terms of totality with respect to an associated collection | |
│ ├▻totality | TotalityType | ? |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | First member in a relationship. | |
│ ├▻source | Code | |
│ │ | Second member in a relationship. Note that this can be realized as a collection to support tuples. | |
│ └▻target | Code | * |
│ | Optionally allows specifying the attached secondary response domain used by a specific item within this CodeListResponseDomain. For example, attach a TextResponseDomain to the code for "Other" using the TextDomain label (Please specify) as a label for the TextDomain. The attached secondary response domain must also be added to the Represented Question or Measure. | |
├▻specifyOtherResponseDomain | ResponseDomain | ? |
│ | Optionally allows specifying the Code to which a secondary response domain is attached. For example, link to code which signifies "Other" within this CodeList. | |
└▻specifyOtherCorrespondingCode | Code | ? |
Any external material used in an instrument that aids or facilitates data capture, or that is presented to a respondent and about which measurements are made.
Image, link, external aid, stimulus, physical object.
r:OtherMaterialType
ExternalAid | ⇩ExternalMaterial | |
│ | ||
└▻stimulusType | ExternalControlledVocabularyEntry | ? |
An instance measurement instantiates a represented measurement, so that it can be used as an Act in the Process Steps that define a data capture process.
InstanceMeasurement | ⇩InstrumentComponent | |
│ | The measurement being instantiated in the data collection process | |
└▻instantiates | ⇩Capture | ? |
│ | The type of measurement performed | |
├▻measurementType | ExternalControlledVocabularyEntry | ? |
│ | An optional link to a represented variable which can be used by each instance variable created by a use of this measure. | |
└▻hasRepresentedVariable | RepresentedVariable | ? |
An instance question is an instantiation of a represented question,to be used as an Act in the process steps that define a survey questionnaire.
“How old are you?”
InstanceQuestion | ⇩InstrumentComponent | |
│ | The name of a question as used in an Instrument. Redefined to provide a more useful description. A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | The question being used. | |
└▻instantiates | ⇩Capture | ? |
│ | The text of the question which may be literal or dynamic (altered to personalize the question text) in terms of content. | |
├▻questionText | DynamicText | * |
│ | The purpose or intent of the question. | |
├▻questionIntent | InternationalStructuredString | ? |
│ | An estimation of the number of seconds required to respond to the question. Used for estimating overall questionnaire completion time. | |
├▭estimatedResponseTimeInSeconds | xsd:double | ? |
│ | An optional link to a represented variable which can be used by each instance variable created by a use of this question. | |
└▻hasRepresentedVariable | RepresentedVariable | * |
Provides the content and description of data capture instructions. Contains the "how to" information for administering an instrument.
Completion instructions in self-administered mail questionnaire, information for administering a blood pressure measurement, interviewer instructions for a CATI questionnaire, guidance for communicating between an interviewer and a respondent (note MIDUS cognitive assessment example).
d:InstructionType
Instruction | ⇩AnnotatedIdentifiable | |
│ | The content of the Instruction text provided using DynamicText. Note that when using Dynamic Text, the full InstructionText must be repeated for multi-language versions of the content. The InstructionText may also be repeated to provide a dynamic and plain text version of the instruction. This allows for accurate rendering of the instruction in a non-dynamic environment like print. | |
├▻instructionText | DynamicText | * |
│ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
├▻displayLabel | LabelForDisplay | * |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | An image or other external material associated with the Instruction, located at the provided URN or URL. | |
└▻associatedMaterial | ExternalMaterial | * |
An InstrumentComponent that specifies the performance of a specific computation within the context of an instrument flow.
quality control, edit check, checksums, compute filler text, compute values for use in administering the instrument
d:ComputationItemType
InstrumentCode | ⇩InstrumentComponent | |
│ | The purpose of the code (e.g., quality control, edit check, checksums, compute filler text, compute values for use in administering the instrument) | |
├▻purposeOfCode | ExternalControlledVocabularyEntry | ? |
│ | Describes the code used to execute the command using the options of inline textual description, inline code, and/or an external file. | |
└▻usesCommandCode | CommandCode | ? |
InstrumentComponent is an abstract object which extends an Act (a type of Process Step). The purpose of InstrumentComponent is to provide a common parent for Capture (e.g., Question, Measure), Statement, and Instructions.
InstrumentComponent acts as a substitution head (abstract) for semantically meaningful for objects that extend it and exist in an instrument.
InstrumentComponent | ⇩Act | |
│ | An instrument compoment can have zero to many instructions | |
├▻hasInstruction | Instruction | * |
│ | Any external object used to clarify, inform, or support the role of the instrument component | |
└▻hasExternalAid | ExternalAid | * |
A response domain capturing a numeric response (the intent is to analyze the response as a number) for a question.
Systolic blood pressure level, as an integer from 0 to 200
d:NumericDomainType
NumericResponseDomain | ⇩ResponseDomain | |
│ | Identification of the numeric type such as integer, decimal, etc. supports the use of an external controlled vocabulary. | |
├▻numericTypeCode | ExternalControlledVocabularyEntry | ? |
│ | An optional unit of measurement. Examples include units from the International System of Units (SI) such as meter, seconds, mole, kilograms. Other examples include miles, tons, pints. | |
├▻unit | ExternalControlledVocabularyEntry | ? |
│ | Defines the valid number range or number values for the representation. | |
└▻usesNumberRange | * | |
│ | A display label for the number range. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
├▻displayLabel | LabelForDisplay | * |
│ | High or top value on the range expressed as an xs:decimal within an isInclusive Boolean flag. | |
├▻highCode | NumberRangeValue | ? |
│ | High or top value on the range expressed as an xs:double within an isInclusive Boolean flag. | |
├▻highCodeDouble | DoubleNumberRangeValue | ? |
│ | High or top value on the range expressed as an xs:decimal within an isInclusive Boolean flag. | |
├▻lowCode | NumberRangeValue | ? |
│ | Low or bottom value on the range expressed as an xs:double within an isInclusive Boolean flag. | |
├▻lowCodeDouble | DoubleNumberRangeValue | ? |
│ | Regular expression defining the allowed syntax of the number. | |
├▭regExp | xsd:string | ? |
│ | Default value is False. The High or top code represents the value expressed and anything higher. | |
├▭isTopCoded | xsd:boolean | |
│ | Default value is False. The Low or bottom code represents the value expressed and anything lower. | |
└▭isBottomCoded | xsd:boolean |
A response domain capturing a ranking response which supports a "ranking" or "Ordering" of provided categories. Note: This item still must be modeled and is incomplete at this time.
RankingResponseDomain | ⇩ResponseDomain |
The possible list of values that are allowed by a Capture.
Yes/No, Male/Female, Age in years, Open-ended text, Temperature, BP reading
Identifies both the sentinel and substantive value domains used for capturing the response to a question
GSIM & DDI: ResponseDomain
ResponseDomain | ⇩AnnotatedIdentifiable | |
│ | A display label for the domain. May be expressed in multiple languages. | |
├▻displayLabel | LabelForDisplay | ? |
│ | Associates the ResponseDomain with the RepresentedVariable that the question will populate into an InstanceVariable when fielded. | |
├▻intendedRepresentation | RepresentedVariable | ? |
│ | A parameter which can be used to bind the output of this response domain to another parameter to direct the flow of the captured datum. | |
└▻hasOutputParameter | Parameter | * |
A response domain capturing a scaled response, such as a Likert scale. Note: This item still must be modeled and is incomplete at this time.
ScaleResponseDomain | ⇩ResponseDomain |
A Statement is a type of Instrument Component containing human readable text or referred material.
Introductory text; Explanations; Labels, Headers, Help screens, etc. "Thank you for agreeing to take this survey. We will start with a brief set of demographic questions." "The following set of questions are related to your household income. Please consider all members of the household and all sources of income when answering these questions."
It is not directly related to another specific Instrument Component such as an InstanceQueston or InstanceMeasurement. It may be placed anywhere in a WorkflowStepSequence.
DDI:StatementItem
d:StatementItemType
Statement | ⇩InstrumentComponent | |
│ | Structured human-readable text that allows for dynamic content. For example, the insertion of a name or gender specific pronoun. Repeat ONLY for capturing the same content in multiple languages. | |
├▻statementText | DynamicText | * |
│ | Describes the use of the statement within the instrument. For example, a section divider, welcome statement, or other text. | |
└▻purposeOfStatement | ExternalControlledVocabularyEntry | ? |
A response domain capturing a textual response including the length of the text and restriction of content using a regular expression.
Collecting the first name on an individual in an open ended text field
r:TextDomainType
TextResponseDomain | ⇩ResponseDomain | |
│ | The maximum number of characters allowed. | |
├▭maximumLength | xsd:integer | ? |
│ | The minimum number of characters allowed. | |
├▭minimumLength | xsd:integer | ? |
│ | A regular expression limiting the allowed characters or character order of the content. Use typeOfContent to specify the syntax of the regularExpression found in content. | |
└▻regularExpression | TypedString | ? |
Used to identify objects for purposes of internal and/or external referencing. Elements of this type are versioned. Provides identification and administrative metadata about the object. Adds optional annotation. Use this as the extension base for First Order Classes that contain intellectual content that needs to be discoverable in its own right.
AnnotatedIdentifiable | ⇩Identifiable | |
│ | Provides annotation information on the object to support citation and crediting of the creator(s) of the object. | |
├▻hasAnnotation | Annotation | ? |
│ | Used to reference external resources. Should include the citation to such material, an external reference to a URI, and a statement of the relationship of the material to the object it has been associated with. | |
└▻relatedMaterial | ExternalMaterial | * |
Used to identify objects for purposes of internal and/or external referencing. Elements of this type are versioned and provide administrative metadata properties. Use for First Order Classes whose content does not need to be discoverable in its own right but needs to be related to multiple classes.
Identifiable | ||
│ | This is the registered agency code with optional sub-agencies separated by dots. For example, diw.soep, ucl.qss, abs.essg. | |
├▭agency | xsd:string | |
│ | The ID of the object. This must conform to the allowed structure of the DDI Identifier and must be unique within the Agency. | |
├▭id | xsd:string | |
│ | The version number of the object. The version number is incremented whenever the non-administrative metadata contained by the object changes. | |
├▭version | xsd:string | |
│ | Contributor who has the ownership and responsibility for the current version. | |
├▭versionResponsibility | xsd:string | ? |
│ | The reason for making this version of the object. | |
├▻versionRationale | ? | |
│ │ | Textual description of the rationale/purpose for the version change to inform users as to the extent and implication of the version change. May be expressed in multiple languages. | |
│ ├▻rationaleDescription | InternationalString | ? |
│ │ | RationaleCode is primarily for internal processing flags within an organization or system. Supports the use of an external controlled vocabulary. | |
│ └▻rationaleCode | ExternalControlledVocabularyEntry | ? |
│ | The date and time the object was changed. Supports standard ISO date and datetime formats. | |
├▻versionDate | IsoDateType | ? |
│ | Default value is false. Usually the combination of agency and id (ignoring different versions) is unique. If isUniversallyUnique is set to true, it indicates that the id itself is universally unique (unique across systems and/or agencies) and therefore the agency part is not required to ensure uniqueness. | |
├▭isUniversallyUnique | xsd:boolean | |
│ | Default value is false. Usually the content of the current version is allowed to change, for example as the contributor is working on the object contents. However, when isPersistent is true, it indicates the there will be no more changes to the current version. | |
├▭isPersistent | xsd:boolean | |
│ | This is an identifier in a given local context that uniquely references an object, as opposed to the full ddi identifier which has an agency plus the id. For example, localId could be a variable name in a dataset. | |
├▻localId | * | |
│ │ | Value of the local ID. | |
│ ├▭localIdValue | xsd:string | |
│ │ | Type of identifier, specifying the context of the identifier. | |
│ ├▭localIdType | xsd:string | |
│ │ | Version of the Local ID. | |
│ └▭localIdVersion | xsd:string | ? |
│ | The object/version that this object version is based on. | |
└▻basedOnObject | ? | |
│ | Textual description of the rationale/purpose for the based on reference to inform users as to the extent and implication of the version change. May be expressed in multiple languages. | |
├▻basedOnRationaleDescription | InternationalString | ? |
│ | RationaleCode is primarily for internal processing flags within an organization or system. Supports the use of an external controlled vocabulary. | |
├▻basedOnRationaleCode | ExternalControlledVocabularyEntry | ? |
│ | The identification for the object upon which the current object is based. | |
└▻basedOn | Identifiable | + |
A DataPoint is a container for a Datum.
A cell in a spreadsheet table. Note that this could be empty. It exists independently of the value to be stored in it.
The DataPoint is structural and distinct from the value (the Datum) that it holds. [GSIM 1.1]
Data Point
DataPoint | ⇩AnnotatedIdentifiable | |
│ | The InstanceVariable delimits the values which can populate a DataPoint. | |
├▻isDescribedBy | InstanceVariable | |
│ | The Datum populating the DataPoint. | |
└▻hasDatum | ⇩Designation | ? |
│ | Specification of the type of Signification | |
├▻representation | ValueString | |
│ | A Datum is bounded by an InstanceVariable. The Datum is drawn from a set of values, either substantive or sentinel described by the value domain of the InstanceVariable | |
└▻isBoundedBy | InstanceVariable | ? |
A DataStore is either a SimpleCollection or a StructuredCollection of LogicalRecords, keeping in mind that a LogicalRecords is a definition, not a "datasets".
LogicalRecords organized in a StructuredCollection is called a LogicalRecordRelationStructure.
Instances of LogicalRecords instantiated as organizations of DataPoints hosting data are described in FormatDescription.
A DataStore is reusable across studies. Each Study has at most one DataStore.
The data lineage of an individual BusinessProcess or an entire DataPipeline are both examples of a LogicalRecordRelationStructures. In a data lineage we can observe how LogicalRecords are connected within a BusinessProcess or across BusinessProcesses.
Schema repository, data network
Data Set
DataStore | ⇩AnnotatedIdentifiable | |
│ | Default character set used in the Data Store. | |
├▭characterSet | xsd:string | ? |
│ | The type of DataStore. Could be delimited file, fixed record length file, relational database, etc. Points to an external definition which can be part of a controlled vocabulary maintained by the DDI Alliance. | |
├▻dataStoreType | ExternalControlledVocabularyEntry | ? |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | The number of records in the Data Store. | |
├▭recordCount | xsd:integer | ? |
│ | General information about missing data, e.g., that missing data have been standardized across the collection, missing data are present because of merging, etc.- corresponds to DDI2.5 dataMsng. | |
├▻aboutMissing | InternationalStructuredString | ? |
│ | Data in the form of Data Records contained in the Data Store. Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to LogicalRecord | |
│ └▻member | LogicalRecord | |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | Description of a complex structure for the Collection. A collection may be structured in more than one way for different uses. | |
├▻isStructuredBy | ⇩Identifiable | * |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Logical Record relations that comprise the relation structure | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | First member in the relationship. | |
│ ├▻source | LogicalRecord | ? |
│ │ | Second member in a relationship. Note that this can be realized as a collection to support tuples. | |
│ └▻target | LogicalRecord | * |
│ | A Study has at most one DataStore. Many studies can have the same set of record types. | |
├▻isInStudy | Study | * |
│ | The Record Relation that defines the relationship and linking requirements between LogicalRecords in the DataStore | |
├▻usesRecordRelation | ⇩AnnotatedIdentifiable | ? |
│ │ | A display label for the CollectionCorrespondence. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
│ ├▻displayLabel | LabelForDisplay | * |
│ │ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
│ ├▻purpose | InternationalStructuredString | ? |
│ │ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
│ ├▻usage | InternationalStructuredString | ? |
│ │ | Correspondences between Instance Variables of different Logical Record Layout. | |
│ ├▻correspondence | * | |
│ │ │ | Relationship between the source and target InstanceVariables or to the setValue if provided | |
│ │ ├▻valueRelationship | ValueRelationshipType | |
│ │ │ | A set value for the key source Instance Variables | |
│ │ ├▻setValue | ValueString | ? |
│ │ │ | Describes the relationship between the source and target members using both controlled vocabularies and descriptive text. In this context the correspondence refers to the two instance variables, not their value. The relationship would normally be exactMatch. | |
│ │ ├▻hasCorrespondenceType | CorrespondenceType | |
│ │ │ | The source Intance Variable for the relationship. | |
│ │ ├▻source | InstanceVariable | + |
│ │ │ | Target Instance Variables if a directional relation is used | |
│ │ └▻target | InstanceVariable | * |
│ │ | Map related record types, which are Collections of Instance Variables. Realization of structures in Symmetric Relation. | |
│ └▻maps | ⇩LogicalRecord | {2,-1} |
│ │ | Describe the order of InstanceVariables in a record for those cases where the variables have a more complicated logical order than a simple sequence. | |
│ ├▻isStructuredBy | ⇩AnnotatedIdentifiable | * |
│ │ │ | Intensional definition of the order criteria (e.g. alphabetical, numerical, increasing, decreasing, etc.) | |
│ │ ├▻criteria | InternationalStructuredString | ? |
│ │ │ | A display label for the OrderRelation. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
│ │ ├▻displayLabel | LabelForDisplay | * |
│ │ │ | A display label for the OrderRelation. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
│ │ ├▻usage | InternationalStructuredString | ? |
│ │ │ | Controlled vocabulary for the order relation semantics. It should contain, at least, the following: Self_Or_Descendant_Of, Part_Of, Less_Than_Or_Equal_To, Subtype_Of, Subclass_Of. | |
│ │ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ │ | Controlled Vocabulary to specify whether the relation is total, partial or unknown. | |
│ │ ├▻totality | TotalityType | |
│ │ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list. Use if all relations within this relation structure are of the same specification. | |
│ │ ├▻hasRelationSpecification | RelationSpecification | |
│ │ │ | Member relations of InstanceVariables that comprise the relation structure | |
│ │ └▻hasMemberRelation | * | |
│ │ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ │ ├▻totality | TotalityType | ? |
│ │ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ │ ├▻hasRelationSpecification | RelationSpecification | |
│ │ │ | Provides semantic context for the relationship | |
│ │ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ │ | First member in a relationship. | |
│ │ ├▻source | InstanceVariable | |
│ │ │ | Second member in a relationship. Note that this can be realized as a collection to support tuple | |
│ │ └▻target | InstanceVariable | * |
│ │ | A UnitDataRecord may have multiple ViewPoints, each of which assigns among roles identifier, measure, and attribute to the InstanceVariables associated with each Datapoint | |
│ └▻isViewedFrom | ⇩AnnotatedIdentifiable | * |
│ │ | The InstanceVaribles functioning as identifiers | |
│ ├▻hasIdentifierRole | ⇩ViewpointRole | * |
│ │ | The InstanceVaribles functioning as measures | |
│ ├▻hasMeasureRole | ⇩ViewpointRole | * |
│ │ | The InstanceVaribles functioning as attributes | |
│ └▻hasAttributeRole | ⇩ViewpointRole | * |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
A DataStoreLibrary is a collection or, again, a "library" of DataStores.
An individual DataStore is associated with a Study. A collection of DataStores is associated with a StudySeries.
The relationships among the DataStores in the DataStoreLibrary is described by the DataStoreRelationStructure. Relations may be more or less complicated depending on the StudySeries type. A StudySeries may be ad hoc. A StudySeries may form a time series. The variety of these collections has been described using the <a href=https://www.ddialliance.org/Specification/DDI-Lifecycle/3.1/XMLSchema/FieldLevelDocumentation/">"Group" in DDI 3.1.
Like any RelationStructure, the DataStoreRelationStructure is able to describe both part/whole relations and generalization/specialization relations. See the controlled vocabulary at RelationSpecification to review all the types of relations a RelationStructure is able to describe.
A StudySeries is a time series and a DataStoreRelationStructure is dedicated to tracking "supplements".
There is a study at T0. Perhaps it is never executed. It is the "core" study. At T1 there is a study that includes the core and Supplement A. At T2 there is a study that includes the core, Supplement A and Supplement B. At T3 there is a study that includes the core and a one off supplement that is never asked again. T4 though T6 repeats T1 through T3.
If we broke a study down into sub-studies where the core is a sub-study and each supplement is a sub-study, we could also use the DataStoreRelationStructure to track the generalization/specialization relationship or, again, "going deep" over time.
Sometimes across a StudySeries we add panels. If panels were also sub-studies, we could use the DataStoreRelationStructure to track both the core and supplements by panel over time.
Structured metadata archive
DataStoreLibrary | ⇩AnnotatedIdentifiable | |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | The DataStores in the Catalog. Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to DataStore | |
│ └▻member | DataStore | |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | Description of a complex structure for the Collection. A collection may be structured in more than one way for different uses. | |
├▻isStructuredBy | ⇩Identifiable | * |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Member relations that comprise the relation structure | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | First DataStore in the relation | |
│ ├▻source | DataStore | * |
│ │ | Second DataStore in a relationship. Note that this can be realized as a collection to support tuples. | |
│ └▻target | DataStore | * |
│ | Whereas a DataStore is associated with a Study, a DataSoreLibrary is associated with a StudySeries. Each StudySeries has at most one DataStoreLibrary | |
├▻isInStudySeries | StudySeries | ? |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
The LogicalRecord is a record definition. It is abstract.
The actual realization of record definitions are provided by the UnitDataRecord and the DataCube. UnitDataRecords support two types of record definitions. The first is based on the SimpleCollection it inherits from LogicalRecord. The second type is a StructuredCollection that specializes the LogicalRecord. As a SimpleCollection a UnitDataRecord can, for example, provide table definitions. As a StructuredCollection, UnitDataRecord can define structures comparable to a "struct" in C or a JSON nested object. A UnitDataRecord, then, inherits SimpleCollection from LogicalRecord but adds its own StructuredCollection into the mix. The DataCube brings into play its own StructuredCollection which is distinct from the UnitDataRecord StructuredCollection.The DataCube StructuredCollection is not currently in scope.
The various record definitions -- simple and structured -- when they are actually instantiated with data is described by the PhysicalLayout of a LogicalRecord in the FormatDescription package. The PhysicalLayout places data into DataPoints formed at the direction of a LogicalRecord and its instance variables. At this point a LogicalRecord turn into a "dataset" that hosts unit records, A record definition is not a record. So we conflate metadata and data when we refer to a LogicalRecord as an empty table.
SQL Data Definition Language (DDL) traffics in record definitions. SQL queries on "system tables" discover record definitions.
In GSIM a DataPoint is a member of a "DataSet" and a UnitDataRecord. Since a DataPoint contains "Datum", this can lead to the conflation of a DataSet and a record definition. In the presence of a DataPoint it is difficult to be clear that a record definition does not have any rows.
In DDI4 we defer the introduction of DataPoints until PhysicalLayouts are described. In this approach the instance variables that make up a LogicalRecord work downstream where they help to give each DataPoint in a PhysicalRecord its format.
Record Type, Data Structure
l:LogicalRecordType
Data Structure
LogicalRecord | ⇩AnnotatedIdentifiable | |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Specifies contents of Unit Record as Instance Variable values. | |
├▻contains | InstanceVariableIndicator | * |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
A ViewpointRole designates the function an InstanceVariable performs in the context of the Viewpoint. (IdentifierRole, AttributeRole, or MeasureRole of interest).
Each of three roles within a Viewpoint may be a collection. This happens when a role is mapped to multiple instance variables. In this event a role forms a SimpleCollection. There are SimpleCollections of instance variables in each role.
See the Viewpoint documentation for an in depth discussion of the uses of ViewpointRoles: http://lion.ddialliance.org/ddiobjects/viewpoint
ViewpointRole | ⇩AnnotatedIdentifiable | |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | InstanceVariableIndicator | * |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
An actor that performs a role in relation to a process or product.
Analyst performing edits on data, interviewer conducting an interview, a relational database management system managing data, organization publishing data on a regular basis, creator or contributor of a publication.
foaf:Agent is: An agent (eg. person, group, software or physical artifact) prov:Agent is An agent is something that bears some form of responsibility for an activity taking place, for the existence of an entity, or for another agent's activity.
Agent
Agent | ⇩AnnotatedIdentifiable | |
│ | An identifier within a specified system for specifying an agent | |
├▻hasAgentId | * | |
│ │ | The identifier for the agent. | |
│ ├▭agentIdValue | xsd:string | |
│ │ | The identifier system in use. | |
│ └▭agentIdType | xsd:string | |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | References an image using the standard Image description. In addition to the standard attributes provides an effective date (period), the type of image, and a privacy ranking. | |
└▻image | ⇩Image | * |
│ | The period for which this image is effective/valid. | |
├▻effectiveDates | DateRange | ? |
│ | Specify the level privacy for the image as public, restricted, or private. Supports the use of an external controlled vocabulary. | |
└▻privacy | ExternalControlledVocabularyEntry | ? |
A person who may have a relationship to another Agent and who may be specified as being associated with an act.
Analyst performing edits on data, interviewer conducting an interview, a creator.
A set of information describing an individual and means of unique identification and/or contact. Information may be repeated and provided effective date ranges to retain a history of the individual within a metadata record. Actions and relationships are specified by the use of the Individual as the target of a relationship (Creator) or within a collection of Agents in an AgentListing (employee of an Organization).
Individual | ⇩Agent | |
│ | The name of an individual broken out into its component parts of prefix, first/given name, middle name, last/family/surname, and suffix. | |
├▻hasIndividualName | * | |
│ │ | Title that precedes the name of the individual, such as Ms., or Dr. | |
│ ├▭prefix | xsd:string | ? |
│ │ | First (given) name of the individual | |
│ ├▭firstGiven | xsd:string | ? |
│ │ | Middle name or initial of the individual | |
│ ├▭middle | xsd:string | * |
│ │ | Last (family) name /surname of the individual | |
│ ├▭lastFamily | xsd:string | ? |
│ │ | Title that follows the name of the individual, such as Esq. | |
│ ├▭suffix | xsd:string | ? |
│ │ | This provides a means of providing a full name as a single object for display or print such as identification badges etc. For example a person with the name of William Grace for official use may prefer a display name of Bill Grace on a name tag or other informal publication. | |
│ ├▻fullName | InternationalString | ? |
│ │ | Clarifies when the name information is accurate. | |
│ ├▻effectiveDates | DateRange | ? |
│ │ | An abbreviation or acronym for the name. This may be expressed in multiple languages. It is assumed that if only a single language is provided that it may be used in any of the other languages within which the name itself is expressed. | |
│ ├▻abbreviation | InternationalString | ? |
│ │ | The type of individual name provided. the use of a controlled vocabulary is strongly recommended. At minimum his should include, e.g. PreviousFormalName, Nickname (or CommonName), Other. | |
│ ├▻typeOfIndividualName | ExternalControlledVocabularyEntry | ? |
│ │ | Sex allows for the specification of male, female or neutral. The purpose of providing this information is to assist others in the appropriate use of pronouns when addressing the individual. Note that many countries/languages may offer a neutral pronoun form. | |
│ ├▻sex | SexSpecificationType | ? |
│ │ | If more than one name for the object is provided, use the isPreferred attribute to indicate which is the preferred name content. All other names should be set to isPreferred="false". | |
│ ├▭isPreferred | xsd:boolean | ? |
│ │ | A name may be specific to a particular context, i.e. common usage, business, social, etc.. Identify the context related to the specified name. Supports the use of an external controlled vocabulary. | |
│ ├▻context | ExternalControlledVocabularyEntry | ? |
│ │ | The legal or formal name of the individual should have the isFormal attribute set to true. To avoid confusion only one individual name should have the isFormal attribute set to true. Use the TypeOfIndividualName to further differentiate the type and applied usage when multiple names are provided. | |
│ └▭isFormal | xsd:boolean | ? |
│ | The agency identifier of the individual according to the DDI Alliance agent registry. | |
├▭ddiId | xsd:string | * |
│ | Contact information for the individual including location specification, address, URL, phone numbers, and other means of communication access. Sets of information can be repeated and date-stamped. | |
└▻hasContactInformation | ContactInformation | ? |
Mechanism or computer program used to implement a process.
SAS program, photocopier
May be used as the target to describe how an action was performed. Relevent to data capture and data processing or wherever a role is performed by a Machine.
Machine | ⇩Agent | |
│ | The kind of machine used - software, web service, physical machine, from a controlled vocabulary | |
├▻typeOfMachine | ExternalControlledVocabularyEntry | ? |
│ | The name of the machine. A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | The locations where the machine can be access | |
├▻hasAccessLocation | ? | |
│ │ | A URI for access, normally expressed as a URL | |
│ ├▭uri | iri | * |
│ │ | The mime type. Supports the use of an controlled vocabulary. | |
│ ├▻mimeType | ExternalControlledVocabularyEntry | ? |
│ │ | The physical location of the machine | |
│ └▻physicalLocation | InternationalString | * |
│ | The function of the machine | |
├▻function | ExternalControlledVocabularyEntry | * |
│ | Specified the machine interface. Supports the use of a controlled vocabulary. | |
├▻machineInterface | ExternalControlledVocabularyEntry | * |
│ | Contact information for the owner/operator including location specification, address, URL, phone numbers, and other means of communication access. Sets of information can be repeated and date-stamped. | |
└▻ownerOperatorContact | ContactInformation | ? |
A framework of authority designated to act toward some purpose.
U.S. Census Bureau, University of Michigan/ISR, Norwegian Social Data Archive
related to org:Organization which is described as "Represents a collection of people organized together into a community or other..."
Organization | ⇩Agent | |
│ | Names by which the organization is known. | |
├▻hasOrganizationName | ⇩ObjectName | + |
│ │ | An abbreviation or acronym for the name. This may be expressed in multiple languages. It is assumed that if only a single language is provided that it may be used in any of the other languages within which the name itself is expressed. | |
│ ├▻abbreviation | InternationalString | ? |
│ │ | The type of organization name provided. the use of a controlled vocabulary is strongly recommended. At minimum this should include, e.g. PreviousFormalName, Nickname (or CommonName), Other. | |
│ ├▻typeOfOrganizationName | ExternalControlledVocabularyEntry | ? |
│ │ | The time period for which this name is accurate and in use. | |
│ ├▻effectiveDates | DateRange | ? |
│ │ | The legal or formal name of the organization should have the isFormal attribute set to true. To avoid confusion only one organization name should have the isFormal attribute set to true. Use the TypeOfOrganizationName to further differentiate the type and applied usage when multiple names are provided. | |
│ └▭isFormal | xsd:boolean | ? |
│ | The agency identifier of the organization as registered at the DDI Alliance register. | |
├▭ddiId | xsd:string | * |
│ | Contact information for the organization including location specification, address, URL, phone numbers, and other means of communication access. Sets of information can be repeated and date-stamped. | |
└▻hasContactInformation | ContactInformation | ? |
Identifies the authorizing agency and allows for the full text of the authorization (law, regulation, or other form of authorization).
May be used to list authorizations from oversight committees and other regulatory agencies.
Supports requirements for some statistical offices to identify the agency or law authorizing the collection or management of data or metadata.
Use for the Case Law, Case Law Description, and Case Law Date properties in ClassificationItem
r:AuthorizationSourceType
AuthorizationSource | ⇩AnnotatedIdentifiable | |
│ | Text of the authorization (law, mandate, approved business case). | |
├▻statementOfAuthorization | InternationalStructuredString | ? |
│ | Provide a legal citation to a law authorizing the study/data collection. For example, a legal citation for a law authorizing a country's census. | |
├▻legalMandate | InternationalString | ? |
│ | Identifies the date of Authorization. | |
├▻authorizationDate | Date | ? |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | References the authorizing agent generally described as an organization or individual | |
└▻authorizingAgent | Agent | * |
A Classification Family is a collection of Classification Series related from a particular point of view. The Classification Family is related by being based on a common Concept, as documented by the definingConcept relationship (e.g. economic activity).[GSIM1.1]
A family of industrial classifications each a separate series (i.e. U.S. Standard Industrial Classification (SIC) and North American Industrial Classification System (NAICS)
Different classification databases may use different types of Classification Families and have different names for the families, as no standard has been agreed upon. [GSIM1.1]
Classification Family
ClassificationFamily | ⇩AnnotatedIdentifiable | |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Allows for the identification of the member Classification Series and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to ClassificationSeries | |
│ └▻member | ClassificationSeries | |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | ClassificationIndexes associated to the ClassificationFamily. | |
├▻hasClassificationIndex | ClassificationIndex | * |
│ | Description of a complex structure for the Collection. A collection may be structured in more than one way for different uses. | |
├▻isStructuredBy | ⇩Identifiable | * |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Member relations that comprise the relation structure | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | First member in the relationship | |
│ ├▻source | ClassificationSeries | ? |
│ │ | Second member in the relationship | |
│ └▻target | ClassificationSeries | * |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
A Classification Index is an ordered list (alphabetical, in code order etc) of Classification Index Entries. A Classification Index can relate to one particular or to several Statistical Classifications. [GSIM Statistical Classification Model]
An alphabetical index of a topically ordered Statistical Classification
A Classification Index shows the relationship between text found in statistical data sources (responses to survey questionnaires, administrative records) and one or more Statistical Classifications. A Classification Index may be used to assign the codes for Classification Items to observations in statistical collections. A Statistical Classification is a subtype of a Structured Collection. [GSIM Statistical Classification Model] Note that a GSIM Node is the equivalent of a DDI Member and a GSIM Node Set is a DDI Collection.
Classification Index
ClassificationIndex | ⇩AnnotatedIdentifiable | |
│ | Date when the current version of the Classification Index was released. | |
├▻releaseDate | Date | ? |
│ | A Classification Index can exist in several languages. Indicates the languages available. If a Classification Index exists in several languages, the number of entries in each language may be different, as the number of terms describing the same phenomenon can change from one language to another. However, the same phenomena should be described in each language. Supports the indication of multiple languages within a single property. Supports use of codes defined by the RFC 1766. | |
├▭availableLanguage | xsd:language | * |
│ | Verbal summary description of corrections, which have occurred within the Classification Index. Corrections include changing the item code associated with an Classification Index Entry. | |
├▻corrections | InternationalString | * |
│ | Additional information which drives the coding process for all entries in a Classification Index. | |
├▻codingInstruction | CommandCode | * |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to ClassificationIndexEntry | |
│ └▻member | ClassificationIndexEntry | |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | A list of the publications in which the Classification Index has been published. | |
├▻hasPublication | ExternalMaterial | * |
│ | Description of a complex structure for the Collection. A collection may be structured in more than one way for different uses. | |
├▻isStructuredBy | ⇩AnnotatedIdentifiable | * |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Index Entry Relations that comprise the relationship structure | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Restricts soruce to ClassificationEntry. | |
│ ├▻source | ClassificationIndexEntry | |
│ │ | Restricts target to ClassificationEntry. | |
│ └▻target | ClassificationIndexEntry | |
│ | The unit or group of persons within the organization responsible for the Classification Index, i.e. for adding, changing or deleting Classification Index Entries. | |
├▻maintenanceUnit | Agent | ? |
│ | Person(s) who may be contacted for additional information about the Classification Index. | |
├▻contactPerson | Agent | * |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
A Classification Index Entry is a word or a short text (e.g. the name of a locality, an economic activity or an occupational title) describing a type of object/unit or object property to which a Classification Item applies, together with the code of the corresponding Classification Item. Each Classification Index Entry typically refers to one item of the Statistical Classification. Although a Classification Index Entry may be associated with a Classification Item at any Level of a Statistical Classification, Classification Index Entries are normally associated with items at the lowest Level.
Classification Index Entry
ClassificationIndexEntry | ⇩AnnotatedIdentifiable | |
│ | Text describing the type of object/unit or object property. | |
├▻entry | InternationalString | ? |
│ | Date from which the Classification Index Entry became valid (startDate). The date must be defined if the Classification Index Entry belongs to a floating Classification Index. Date at which the Classification Index Entry became invalid (endDate). The date must be defined if the Classification Index Entry belongs to a floating Classification Index and is no longer valid. | |
├▻validDates | DateRange | ? |
│ | Additional information which drives the coding process. Required when coding is dependent upon one or many other factors. | |
└▻codingInstruction | CommandCode | ? |
A Classification Item represents a Category at a certain Level within a Statistical Classification.
In the 2012 NAICS (North American Industry Classification System) one Classification Item has the Code 23 and the Category construction.
A Classification Item defines the content and the borders of the Category. A Unit can be classified to one and only one item at each Level of a Statistical Classification. As such a Classification Item is a placeholder for a position in a StatisitcalClassification. It contains a Designation, for which Code is a kind; a Category; and other things.
This differentiates it from Code which is a kind of Designation, in particular it is an alphanumeric string assigned to stand in place of a category. For example, the letter M might stand for the category Male in the CodeList called Gender.
Classification Item
ClassificationItem | ⇩Designation | |
│ | Indicates whether or not the item is currently valid. If updates are allowed in the Statistical Classification, an item may be restricted in its validity, i.e. it may become valid or invalid after the Statistical Classification has been released. | |
├▭isValid | xsd:boolean | ? |
│ | Indicates whether or not the item has been generated to make the level to which it belongs complete | |
├▭isGenerated | xsd:boolean | ? |
│ | A Classification Item may be associated with explanatory notes, which further describe and clarify the contents of the Category. Explanatory notes consist of: General note: Contains either additional information about the Category, or a general description of the Category, which is not structured according to the "includes", "includes also", "excludes" pattern. Includes: Specifies the contents of the Category. Includes also: A list of borderline cases, which belong to the described Category. Excludes: A list of borderline cases, which do not belong to the described Category. Excluded cases may contain a reference to the Classification Items to which the excluded cases belong. | |
├▻explanatoryNotes | InternationalStructuredString | * |
│ | The future events describe a change (or a number of changes) related to an invalid item. These changes may e.g. have turned the now invalid item into one or several successor items. This allows the possibility to follow successors of the item in the future. | |
├▻futureNotes | InternationalString | * |
│ | Describes the changes, which the item has been subject to during the life time of the actual Statistical Classification. | |
├▻changeLog | InternationalString | ? |
│ | Describes the changes, which the item has been subject to from the previous version to the actual Statistical Classification | |
├▻changeFromPreviousVersion | InternationalString | ? |
│ | Dates for which the classification is valid. Date from which the item became valid. The date must be defined if the item belongs to a floating Statistical classification. Date at which the item became invalid. The date must be defined if the item belongs to a floating Statistical classification and is no longer valid | |
├▻validDates | DateRange | ? |
│ | A Classification Item has a name as provided by the owner or maintenance unit. The name describes the content of the category. The name is unique within the Statistical Classification to which the item belongs, except for categories that are identical at more than one level in a hierarchical classification. Use the context attribute to identify Official Name or alternate names for the Classification Item. | |
├▻name | ObjectName | * |
│ | The value as expressed in the data file. | |
├▻representation | ValueString | |
│ | Case law rulings related to the Classification Item. | |
├▻caseLaw | AuthorizationSource | * |
│ | Classification Items to which the excluded cases belong (as described in explanatoryNotes). | |
├▻exclude | ClassificationItem | * |
│ | A definition for the code. Specialization of denotes for Categories. | |
└▻denotes | Category | ? |
A Classification Series is an ensemble of one or more Statistical Classifications, based on the same concept, as documented by the definingConcept relationship, and related to each other as versions or updates. Typically, these Statistical Classifications have the same name.
ISIC or ISCO SIC (with different published versions related to the publication year)
Classification Series
ClassificationSeries | ⇩AnnotatedIdentifiable | |
│ | ClassificationSeries can be designed in a specific context. Supports the use of and External Controlled Vocabulary. | |
├▻context | ExternalControlledVocabularyEntry | ? |
│ | A ClassificationSeries is designed to classify a specific type of object/unit according to a specific attribute. | |
├▻objectsOrUnitsClassified | ExternalControlledVocabularyEntry | ? |
│ | Areas of statistics in which the ClassificationSeries is implemented. | |
├▻subject | ExternalControlledVocabularyEntry | * |
│ | A ClassificationSeries can be associated with one or a number of keywords. | |
├▻keyword | ExternalControlledVocabularyEntry | * |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | MemberIndicator Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Index value of member in an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Restricts member target class to StatisticalClassification | |
│ └▻member | StatisticalClassification | |
│ | If members are ordered set to true, if unordered set to false. | |
├▭isOrdered | xsd:boolean | ? |
│ | Description of a complex structure for the Collection. A collection may be structured in more than one way for different uses. | |
├▻isStructuredBy | ⇩Identifiable | * |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | ? |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Member relations that comprise the relation structure | |
│ └▻hasMemberRelation | * | |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | First member of the relationship | |
│ ├▻source | StatisticalClassification | * |
│ │ | The second member of the relationship | |
│ └▻target | StatisticalClassification | * |
│ | The statistical office or other authority, which created and maintains the StatisticalClassification (s) related to the ClassificationSeries. A ClassificationSeries may have several owners. | |
├▻owner | Agent | * |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
A type of Designation that relates a representation expressed as a string with or without meaningful white space to a specific classification. For use in a Code List. The representation property (Value) is expressed as it would be found in a data file. Multiple representations may relate to the same Category but should be expressed as separate Codes.
The letter M might stand for the category Male in the CodeList called Gender.
A Code is a kind of Designation, in particular it is the assignment of an alphanumeric string to stand in place of a category.
It should not be confused with a ClassificationItem which is a placeholder for a position in a StatisticalClassification. It contains a Designation, for which Code is a kind; a Category; and other things. For example, in 2012 NAICS (North American Industry Classification System) one Classification Item has the Code 23 and the Category construction.
l:CodeType
Code
Code | ⇩Designation | |
│ | The value as expressed in the data file. | |
├▻representation | ValueString | |
│ | A definition for the code. Specialization of denotes for Categories. | |
└▻denotes | Category | ? |
A Correspondence Table expresses relationships between the members within or between StatisticalClassifications.
Correspondence between the U.S. Standard Industrial Classification (SIC) and North American Industrial Classification System (NAICS)
CorrespondenceTables are used with Statistical Classifications. For instance, it can relate two versions from the same Classification Series; Statistical Classifications from different Classification Series; a variant and the version on which it is based; or, different versions of a variant. In the first and last examples, the Correspondence Table facilitates comparability over time.
Correspondence Table
CorrespondenceTable | ⇩AnnotatedIdentifiable | |
│ | Effective period of validity of the CorrespondenceTable. The correspondence table expresses the relationships between the two NodeSets as they existed on the period specified in the table. | |
├▻effectiveDates | DateRange | ? |
│ | Set of mappings between nodes that participate in the correspondence. | |
├▻correspondence | Map | * |
│ | The Statistical Classification(s) from which the correspondence is made. | |
├▻maps | StatisticalClassification | + |
│ | Level from which the correspondence is made. Correspondences might be restricted to a certain Level in the NodeSet. In this case, target items are assigned only to source items on the given level. If no level is indicated, source items can be assigned to any level of the target NodeSet. | |
├▻sourceLevel | LevelStructure | ? |
│ | Level to which the correspondence is made. Correspondences might be restricted to a certain Level in the NodeSet. In this case, target items are assigned only to source items on the given level. If no level is indicated, target items can be assigned to any level of the source NodeSet. | |
├▻targetLevel | LevelStructure | ? |
│ | A list of the publications in which the Correspondence Table has been published. | |
├▻hasPublication | ExternalMaterial | * |
│ | The statistical office, other authority or section that created and maintains the Correspondence Table. A Correspondence Table may have several owners. | |
├▻owner | Agent | * |
│ | The unit or group of persons who are responsible for the Correspondence Table, i.e. for maintaining and updating it. | |
├▻maintenanceUnit | Agent | ? |
│ | The person(s) who may be contacted for additional information about the Correspondence Table. Can be an individual or organization. | |
└▻contactPerson | Agent | * |
A sign denoting a concept.
A linking of the term “Unemployment” to an particular underlying concept.
The representation of a concept by a sign (e.g., string, pictogram, bitmap) which denotes it. An example is the code M designating the marital status Married, which is a concept. In this context, M means Married.
Designation
Designation | ⇩Identifiable | |
│ | The concept denoted by the designation. | |
└▻denotes | Concept | ? |
An abstract base to allow all codifications (CodeList, StatisticalClassification, etc.) to be used as enumerated value representations.
EnumerationDomain | ⇩AnnotatedIdentifiable | |
│ | Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates | |
├▻type | CollectionType | ? |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided | |
├▻name | ObjectName | * |
│ | Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. | |
├▻purpose | InternationalStructuredString | ? |
│ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▭isOrdered | xsd:boolean | ? |
│ | CategorySet associated with the enumeration | |
├▻references | ⇩ConceptSystem | ? |
│ │ | MemberIndicator Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
│ ├▻contains | * | |
│ │ │ | Index value of member in an ordered array | |
│ │ ├▭index | xsd:integer | ? |
│ │ │ | Restricts member target class to Concept or subtype of Concept | |
│ │ └▻member | Category | |
│ │ | A structure containing specific relationships between members of the collection. | |
│ └▻isStructuredBy | ⇩Identifiable | * |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list. Use if all relations within this relation structure are of the same specification. | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | |
│ │ | Restricted to CategoryRelation. CategoryRelations making up the relation structure. | |
│ └▻hasMemberRelation | * | |
│ │ | Type of relation in terms of totality with respect to an associated collection. | |
│ ├▻totality | TotalityType | ? |
│ │ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
│ ├▻hasRelationSpecification | RelationSpecification | |
│ │ | Provides semantic context for the relationship | |
│ ├▻semantic | ExternalControlledVocabularyEntry | ? |
│ │ | First member in a relationship. | |
│ ├▻source | Category | |
│ │ | Second member in a relationship. Note that this can be realized as a collection to support tuples. | |
│ └▻target | Category | * |
│ | Has meaningful level to which members belong. | |
├▻usesLevelStructure | LevelStructure | ? |
│ | The conceptual basis for the collection of members. | |
└▻definingConcept | Concept | * |
The LevelStructure describes the nesting structure of a hierarchical collection. The levels within the structure begin at the root level '1' and continue as an ordered array through each level of nesting.
ISCO-08 (Major, Sub-Major, and Minor) or NAICS (2 digit sector codes, 3 digit subsector code list, 4 digit industry group code list, and 5 digit industry code list)
Levels are used to organize a hierarchy. Usually, a hierarchy often contains one root member at the top, though it could contain several. These are the first Level. All members directly related to those in the first Level compose the second Level. The third and subsequent Levels are defined similarly.
A Level often is associated with a Concept, which defines it. These correspond to kinds of aggregates. For example, in the US Standard Occupational Classification (2010), the Level below the top is called Major Occupation Groups, and the next Level is called Minor Occupational Groups. These ideas convey the structure. In particular, Health Care Practitioners (a Major Group) can be broken into Chiropractors, Dentists, Physicians, Vets, Therapists, etc. (Minor Groups) The Categories in the Nodes at the lower Level aggregate to the Category in Node above them.
"Classification schemes are frequently organized in nested levels of increasing detail. ISCO-08, for example, has four levels: at the top level are ten major groups, each of which contain sub-major groups, which in turn are subdivided in minor groups, which contain unit groups. Even when a classification is not structured in levels ("flat classification"), the usual convention, which is adopted here, is to consider that it contains one unique level." (http://rdf-vocabulary.ddialliance.org/xkos.html#) Individual classification items organized in a hierarchy may be associated with a specific level.
l:LevelType
Level
LevelStructure | ⇩AnnotatedIdentifiable | |
│ | A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. | |
├▻name | ObjectName | * |
│ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. Use in locations where you need to relay information on the usage of the instantiated class. | |
├▻usage | InternationalStructuredString | ? |
│ | The association of a level number in an ordered array with the description of that level | |
├▻containsLevel | * | |
│ │ | Provides an association between a level number and optional concept which defines it within an ordered array. Use is required. | |
│ ├▭levelNumber | xsd:integer | |
│ │ | A display label for the object. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
│ ├▻displayLabel | LabelForDisplay | * |
│ │ | A concept or concept sub-type which describes the level. | |
│ └▻definedBy | Concept | ? |
│ | The dates for which the level structure is valid. A structured DateRange with start and end Date (both with the structure of Date and supporting the use of ISO and non-ISO date structures); Use to relate a period with a start and end date. | |
└▻validDateRange | DateRange | ? |
The Value Domain for a sentinel conceptual domain. Sentinel values are defined in ISO 11404 as "element of a value space that is not completely consistent with a datatype's properties and characterizing operations...". A common example would be codes for missing values.
Missing categories expressed as Codes <-9, refused>; <-8, Don't Know> for a numeric variable with values greater than zero.
Sentinel values are used for processing, not to describe subject matter. Typical examples include missing values or invalid entry codes. Sentinel Value Domains are typically of the enumerated type, but they can be the described type, too.
This is not to say that sentinel values carry no information. Data on gender might be enumerated by "0, male" and "1, female". These are the substantive values (see Substantive Value Domain). However, there may be the need to include missing values along with that data, such as "m, missing" and "r, refused". These are sentinel values.
ISO/IEC 11404 - General purpose datatypes, defines sentinel values in terms of how that standard defines datatypes. But, the fact that the sentinels don't fit in terms of the calculations and statistics one would perform on the "clean" data is a distinguishing characteristic. In the example above, one would not include missing or refused data in calculating a ratio of females to the total population.
Sentinel values may be described rather than enumerated. For instance, there might be a range of values, each representing an out of range value, but there could be too many to enumerate. It is easier to describe the range.
In some software missing values are represented as values not in the datatype of the valid values. R has values of NA, NaN, Inf, and -Inf. SAS and Stata have values displayed as ".", ".A" through ".Z", and "._"
Other software might use values like 999 for missing that would otherwise be the same datatype as valid values but outside the parameters of the domain.
In the gender example above: For SPSS the sentinel values might be represented as: 998 = "refused" 999 = "not recorded"
For SAS or Stata the sentinel values might be represented as: .R = "refused" .N = "not recorded"
Sentinel values can also be used for other purposes beyond missing. For a numeric variable "A" might represent a value somewhere in a defined range to prevent disclosure of information about an individual. This might be considered a "semi-missing value". In SAS or Stata for example: .A = "greater than or equal to 100 and less than 1000 "
Enumerated Value Domain
SentinelValueDomain | ⇩ValueDomain | |
│ | The type of platform under which sentinel codes will be used. Statistical software platforms use different sets of codes to indicate missing values. The external controlled vocabulary should list platform tpes and a description of the allowed missing value types. A sample list would be: • BlankString - A Blank string indicates missing. Comparison is based on lexical order. • EmptyString - An empty string indicates missing. Use in comparisons returns missing. • Rstyle - Codes drawn from NA and the IEEE 754 values of NaN -Inf +Inf. Comparisons return NA. • SASNumeric - codes drawn from . ._ .A .B .C .D .E .F .G .H .I .J .K .L .M .N .O .P .Q .R .S .T .U .V .W .X .Y .Z Sentinel code treated as less than any substantive value • SPSSstyle - System missing (a dot) a set of individual values drawn from the same datatype as the SubstantiveValueDomain, and a range of values drawn from the same datatype as the SubstantiveValueDomain. Comparisons return system missing. Some functions substitute with valid values (e.g. SUM replaces missing values with 0) • StataNumeric - codes drawn from . ._ .A .B .C .D .E .F .G .H .I .J .K .L .M .N .O .P .Q .R .S .T .U .V .W .X .Y .Z Sentinel code treated as greater than any substantive value • Unrestricted - No restrictions on codes for sentinel values. Use in comparisons is indeterminate. | |
├▻platformType | ExternalControlledVocabularyEntry | ? |
│ | Corresponding conceptual definition given by a SentinelConceptualDomain. | |
├▻takesConceptsFrom | SentinelConceptualDomain | ? |
│ | A formal description of the set of valid values - for described value domains. | |
├▻describedValueDomain | ValueAndConceptDescription | ? |
│ | Any subtype of an Enumeration Domain enumerating the set of valid values. | |
└▻enumeratedValueDomain | EnumerationDomain | ? |
A Statistical Classification is a set of Categories represented by Classification Items which may be assigned to one or more variables registered in statistical surveys or administrative files, and used in the production and dissemination of statistics. The Categories at each Level of the classification structure must be mutually exclusive and jointly exhaustive of all objects/units in the population of interest. (Source: GSIM StatisticalClassification)
A Classification Item represents a Category at a certain Level within a Statistical Classification. The Categories are defined with reference to one or more characteristics of a particular universe of units of observation. A Statistical Classification may have a flat, linear structure or may be hierarchically structured, such that all Categories at lower Levels are sub-Categories of Categories at the next Level up. (Source: GSIM StatisticalClassification)
Statistical Classification
StatisticalClassification | ⇩EnumerationDomain | |
│ | Date the Statistical Classification was released | |
├▻releaseDate | Date | ? |
│ | The date the statistical classification enters production use and the date on which the Statistical Classification was superseded by a successor version or otherwise ceased to be valid. (Source: GSIM Statistical Classification) | |
├▻validDates | DateRange | ? |
│ | Indicates if the Statistical Classification is currently valid. | |
├▭isCurrent | xsd:boolean | ? |
│ | Indicates if the Statistical Classification is a floating classification. In a floating statistical classification, a validity period should be defined for all Classification Items which will allow the display of the item structure and content at different points of time. (Source: GSIM StatisticalClassification/Floating | |
├▭isFloating | xsd:boolean | ? |
│ | Describes the relationship between the variant and its base Statistical Classification, including regroupings, aggregations added and extensions. (Source: GSIM StatisticalClassification/Changes from base Statistical Classification) | |
├▻changeFromBase | InternationalStructuredString | ? |
│ | If the Statistical Classification is a variant, notes the specific purpose for which it was developed. (Source: GSIM StatisticalClassification/Purpose of variant) | |
├▻purposeOfVariant | InternationalStructuredString | ? |
│ | Copyright of the statistical classification. | |
├▻copyright | InternationalString | * |
│ | Summary description of changes which have occurred since the most recent classification version or classification update came into force. | |
├▻updateChanges | InternationalStructuredString | * |
│ | A list of languages in which the Statistical Classification is available. Supports the indication of multiple languages within a single property. Supports use of codes defined by the RFC 1766. | |
├▭availableLanguage | xsd:language | * |
│ | A structured display label providing a fully human readable display for the identification of the object. Supports the use of multiple languages and structured text. | |
├▻displayLabel | LabelForDisplay | * |
│ | Explanation of the reasons some decision was made or some object exists. Supports the use of multiple languages and structured text. | |
├▻rationale | InternationalStructuredString | ? |
│ | Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. | |
├▻usage | InternationalStructuredString | ? |
│ | Allows for the identification of the member and optionally provides an index for the member within an ordered array | |
├▻contains | * | |
│ │ | Provides an index for the member within an ordered array | |
│ ├▭index | xsd:integer | ? |
│ │ | Indicates the level within which the CodeItem resides | |
│ ├▭hasLevel | xsd:integer | ? |
│ │ | The member containing the designation of the Classification Item | |
│ └▻member | ClassificationItem | |
│ | Organization, agency, or group within an agency responsible for the maintenance and upkeep of the statistical classification. | |
├▻isMaintainedBy | Organization | * |
│ | Description and link to a publication, including print, PDF, HTML and other electronic formats, in which the Statistical Classification has been published. This is similar to dcat:Distribution. | |
├▻distributedAs | ExternalMaterial | * |
│ | Statistical Classification on which the current variant is based, and any subsequent versions of that Statistical Classification to which it is also applicable. | |
├▻variantOf | StatisticalClassification | ? |
│ | ClassificationIndex(es) related to the StatisticalClassification. | |
├▻isIndexedBy | ClassificationIndex | * |
│ | Statistical Classification superseded by the actual Statistical Classification (for those Statistical Classifications that are versions or updates). | |
├▻predecessor | StatisticalClassification | * |
│ | Statistical Classification that supersedes the actual Statistical Classification (for those Statistical Classifications that are versions or updates), | |
├▻successor | StatisticalClassification | * |
│ | A complex structure, hierarchical, for a ClassificationItem. Restricted to single structure. | |
└▻isStructuredBy | ⇩Identifiable | ? |
│ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list. Use if all relations within this relation structure are of the same specification. | |
├▻hasRelationSpecification | RelationSpecification | |
│ | Provides semantic context for the relationship | |
├▻semantic | ExternalControlledVocabularyEntry | ? |
│ | Type of relation in terms of totality with respect to an associated collection. | |
├▻totality | TotalityType | ? |
│ | A display label for the OrderRelation. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
├▻displayLabel | LabelForDisplay | * |
│ | Member relations that comprise the relation structure | |
└▻hasMemberRelation | * | |
│ | Type of relation in terms of totality with respect to an associated collection | |
├▻totality | TotalityType | ? |
│ | Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an ennumeration list | |
├▻hasRelationSpecification | RelationSpecification | |
│ | Provides semantic context for the relationship | |
├▻semantic | ExternalControlledVocabularyEntry | ? |
│ | First member in a relationship. | |
├▻source | ClassificationItem | |
│ | Second member in a relationship. Note that this can be realized as a collection to support tuples. | |
└▻target | ClassificationItem | * |
A formal description of a set of values.
Example 1)
The integers between 1 and 10 inclusive.
The values of x satisfying the logicalExpression property:
" (1 <=x <= 10) AND mod(x,10)=0"
Also described with minimumValueInclusive = 1 and maximumValueInclusive = 10 (and datatype of integer)
Example 2) The upper case letters A through C and X described with the regularExpression "/[A-CX]/"
Example 3) A date-time described with the Unicode Locale Data Markup Language pattern yyyy.MM.dd G 'at' HH:mm:ss zzz
The ValueAndConceptDescription may be used to describe either a value domain or a conceptual domain. For a value domain, the ValueAndConceptDescription contains the details for a “described” domain (as opposed to an enumerated domain). There are a number of properties which can be used for the description. The description could be just text such as: “an even number greater than zero”. Or a more formal logical expression like “x>0 and mod(x,2)=0”. A regular expression might be useful for describing a textual domain. It could also employ a format pattern from the Unicode Locale Data Markup Language (LDML) (http://www.unicode.org/reports/tr35/tr35.html. Some Conceptual Domains might be described with just a narrative. Others, though, might be described in much the same way as a value domain depending on the specificity of the concept.
In ISO 11404 a value domain may be described either through enumeration or description, or both. This class provides the facility for that description. It may be just a text description, but a description through a logical expression is machine actionable and might, for example, be rendered as an integrity constraint. If both text and a logical expression are provided the logical expression is to be taken as the canonical description. The logical expression should conform to the expression syntax of VTL. https://sdmx.org/?page_id=5096
ValueAndConceptDescription | ⇩Identifiable | |
│ | A formal description of the set of values. | |
├▻description | InternationalStructuredString | ? |
│ | A logical expression where the values of "x" making the expression true are the members of the set of valid values. Example: (all reals x such that x >0) describes the real numbers greater than 0 | |
├▻logicalExpression | ExternalControlledVocabularyEntry | ? |
│ | A regular expression where strings matching the expression belong to the set of valid values. Use typeOfContent to specify the syntax of the regularExpression found in content. | |
├▻regularExpression | TypedString | ? |
│ | A string denoting the minimum possible value. From https://www.w3.org/TR/tabular-metadata/ 5.11.2 minimum: “An atomic property that contains a single number or string that is the minimum valid value (inclusive); equivalent to minInclusive. The value of this property becomes the minimum annotation for the described datatype. See Value Constraints in [tabular-data-model] for details.” | |
├▭minimumValueInclusive | xsd:string | ? |
│ | A string denoting the maximum possible value. From https://www.w3.org/TR/tabular-metadata/ 5.11.2 maximum: “An atomic property that contains a single number or string that is the maximum valid value (inclusive); equivalent to maxInclusive. The value of this property becomes the maximum annotation for the described datatype. See Value Constraints in [tabular-data-model] for details.” | |
├▭maximumValueInclusive | xsd:string | ? |
│ | A string denoting the minimum possible value (excluding this value) From https://www.w3.org/TR/tabular-metadata/ 5.11.2 minExclusive: “An atomic property that contains a single number or string that is the minimum valid value (exclusive). The value of this property becomes the minimum exclusive annotation for the described datatype. See Value Constraints in [tabular-data-model] for details.” DDI3.2 handles this with a Boolean isInclusive attribute. | |
├▭minimumValueExclusive | xsd:string | ? |
│ | A string denotFrom https://www.w3.org/TR/tabular-metadata/ 5.11.2 maxExclusive: “An atomic property that contains a single number or string that is the maximum valid value (exclusive). The value of this property becomes the maximum exclusive annotation for the described datatype. See Value Constraints in [tabular-data-model] for details.” DDI3.2 handles this with a Boolean isInclusive attribute. ing the maximumpossible value (excluding this value) | |
├▭maximumValueExclusive | xsd:string | ? |
│ | Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous. Use where appropriate for the representation type. | |
├▻classificationLevel | CategoryRelationCode | ? |
│ | A pattern for a number as described in Unicode Locale Data Markup Language (LDML) (http://www.unicode.org/reports/tr35/tr35.html) Part 3: Numbers (http://www.unicode.org/reports/tr35/tr35-numbers.html#Number_Format_Patterns) and Part 4. Dates (http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns) . Examples would be #,##0.### to describe the pattern for a decimal number, or yyyy.MM.dd G 'at' HH:mm:ss zzz for a datetime pattern. | |
└▻formatPattern | ExternalControlledVocabularyEntry | ? |
The permitted range of values for a characteristic of a variable. [GSIM 1.1]
Age categories with a numeric code list; Age in years; Young, Middle-aged and Old
The values can be described by enumeration or by an expression. Value domains can be either substantive/sentinel, or described/enumeration
BUT NOT Grid/Numeric/Code/*_ResponseDomain [DDI-L/Questions] - this is "ResponseDomain"
r:RepresentationType
Value Domain
ValueDomain | ⇩AnnotatedIdentifiable | |
│ | A display label for the object. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. | |
├▻displayLabel | LabelForDisplay | * |
│ | The data types that are recommended for use with this domain | |
└▻recommendedDataType | ExternalControlledVocabularyEntry | * |
Definition
A basic structure for declaring the name of an Agent inline, reference to an Agent, and role specification. This object is used primarily within Annotation.
DDI 3.2 mapping
r:ContributorType