NIEM is a large data model, with contributions from many different people at different points in time. In order to attempt to maintain a somewhat singular voice, provide consistency for common cases to users, and to enable some automated conformance testing on otherwise untestable semantics, certain elements and types are required to use standardized representation terms at the end of their names, and to use standard opening phrases at the beginning of their definitions.
Primary / Alternate Representation Terms |
Typical Uses | Typical Data Types | Definition Standard Opening Phrase |
---|---|---|---|
Amount | Money | nc:AmountType | A(n) (optional adjectives) amount ... |
BinaryObject | Binary, Base64 encoding, hexadecimal encoding | nc:BinaryType | A(n) ... |
- Graphic | Diagram, graph, mathematical curve, etc. | nc:ImageType | A(n) ... |
- Picture | Picture, photo, image | nc:ImageType | A(n) (optional adjectives) (image|picture|photograph) ... |
- Sound | Sound | nc:BinaryType | A(n) ... |
- Video | Video | nc:BinaryType | A(n) ... |
Code | Code Set | custom type | A(n) ... |
DateTime | Date and time | nc:DateType | A(n) (optional adjectives) date and time ... |
- Date | Date | nc:DateType | A(n) (optional adjectives) date ... |
- Time | Time | niem-xs:time | A(n) (optional adjectives) time ... |
- Duration | Length of time | niem-xs:duration | A(n) ... |
ID | Unique identifier | niem-xs:string | A(n) (optional adjectives) identifier ... |
- URI | URL | niem-xs:anyURI | A(n) ... |
Indicator | True or False; Yes or No | niem-xs:boolean | True if ...; false (otherwise|if) ... |
Measure | Measured value with unit | nc:MeasureType | A(n) ... |
Numeric | Number, no unit | nc:NumericType | A(n) ... |
- Value | Calculated number | nc:NumericType | A(n) ... |
- Rate | Ratio comparing two numbers | nc:NumericType | A(n) ... |
- Percent | Ratio representing parts per hundred | nc:PercentType | A(n) ... |
Quantity | Numeric count (non-monetary) | nc:QuantityType | A(n) (optional adjectives) (count|number) ... |
Text | Character string, free text | nc:TextType | A(n) ... |
- Name | Word or term used for identification | nc:TextType | A(n) (optional adjectives) name... |
- CategoryText | Kind or type of something | nc:TextType | A kind of ... |
- DescriptionText | Free text description | nc:TextType | A description of ... |
- List | Sequence of values for very large data sets | various space-delimited lists | A(n) ... |
Representation Terms | Typical Uses | Typical Data Types | Definition Standard Opening Phrase |
---|---|---|---|
Abstract | Substitution group head for code lists or alternative to xs:choice | none | A data concept ... |
Association | A relationship between elements | custom [Name]AssociationType | An (optional adjectives) (relationship|association) ... |
Augmentation | Additional information about an existing type | custom [Name]AugmentationType | Additional information about ... |
AugmentationPoint | A hook in a complex type to allow others to add additional information (augmentations) | none | An augmentation point ... |
Identification | An identifier plus related info (e.g., expiration date, category, status) | nc:IdentificationType | A(n) (optional adjectives) identification ... |
MetaData | Secondary data about information (e.g., source, last updated, info quality) | custom MetadataType | Metadata about ... |
[Other elements] | custom [Name]Type | A(n) ... |
Representation Terms | Typical Uses | Typical Base Types | Definition Standard Opening Phrase |
---|---|---|---|
AssociationType | A relationship between elements | nc:AssociationType | A data type for an association ... |
AugmentationType | Additional information about an existing type | structures:AugmentationType | A data type for additional information about ... |
MetadataType | Secondary data about information (e.g., source, last updated, info quality) | structures:MetadataType | A data type for metadata about ... |
CodeType | Complex type with simple content that wraps a simple code type (NIEM elements are required to have a complex data type) | custom [Name]CodeSimpleType | A data type ... |
CodeSimpleType | Simple type with a code set | xs:token | A data type ... |
SimpleType | Simple type with facets (value constraints) | XML Schema built-in type | A data type ... |
Type | Other types | structures:ObjectType | A data type ... |