schemas.genericode-1.0.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-genericode Show documentation
Show all versions of ph-genericode Show documentation
Library to read and write OASIS GeneriCode and CVA documents
Details of an agency which produces code lists or related artifacts.
Short name (without whitespace) for the agency.
Human-readable name for the agency.
Identifier for the agency.
User annotation information.
Human-readable information.
Machine-readable information.
Container for any XML content which is in a different namespace to the Schema's target namespace.
Container for any human-readable XML content which is in a different namespace to the Schema's target namespace.
Language for the human-readable XML content.
Top-level (root) element for a genericode code list definition.
A code list definition defines the details of a particular (version of a) code list.
Document type for genericode code list definitions.
A code list must have at least one key, unless it is a metadata-only definition without a 'SimpleCodeList' element.
General information (metadata) for the code list.
A choice between a column set definition and a column set reference.
The only choice is a simple (explicit) code list definition.
Not used if the code list definition contains code list metadata only.
Base URL which applies to relative location URIs.
xml:base does not apply to canonical URIs.
Reference to a code list, possibly defined in an external document.
The code list reference must be valid.
An application may use the CanonicalVersionUri to select a local copy of the code list.
If there is no CanonicalVersionUri, the CanonicalUri may be used to select a local copy of the code list.
Otherwise the LocationUri value(s) may be tried in order, until a valid code list document is retrieved.
An application must signal an error to the user if it is not able to retrieve a code list document to match the code list reference.
User annotation for the referenced code list.
Canonical URI which uniquely identifies all versions (collectively) of the referenced code list.
Must be an absolute URI, must not be relative. Must not be used as a de facto location URI.
Canonical URI which uniquely identifies a specific version of the referenced code list.
Must be an absolute URI, must not be relative. Must not be used as a de facto location URI.
Suggested retrieval location for this code list, in genericode format.
If the CanonicalVersionUri has been defined, the LocationUri must reference a genericode CodeList document.
If the CanonicalVersionUri is undefined, the LocationUri must reference a genericode CodeList Metadata document.
An application must signal an error to the user if a LocationUri does not reference the appropriate type of genericode document.
An application must signal an error to the user if a document retrieved using a LocationUri is not in genericode format.
Base URL which applies to relative location URIs.
xml:base does not apply to canonical URIs.
Top-level element for the definition of a code list set.
Document type for the definition of a set of code lists.
General document information for the code list set.
Contents of the code list set. If the code list set does not have any contents, it is a CodeListSet Metadata definition.
Base URL which applies to relative location URIs.
xml:base does not apply to canonical URIs.
A choice between a code list reference, an inline code list set, or a code list set reference.
Reference to a code list set, possibly defined in an external document.
The code list set reference must be valid.
An application may use the CanonicalVersionUri to select a local copy of the code list set.
If there is no CanonicalVersionUri, the CanonicalUri may be used to select a local copy of the code list set.
Otherwise the LocationUri value(s) may be tried in order, until a valid code list set document is retrieved.
An application must signal an error to the user if it is not able to retrieve a code list set document to match the code list set reference.
User annotation for the referenced code list set.
Canonical URI which uniquely identifies all versions (collectively) of the referenced code list set.
Must be an absolute URI, must not be relative. Must not be used as a de facto location URI.
Canonical URI which uniquely identifies a specific version of the referenced code list set.
Must be an absolute URI, must not be relative. Must not be used as a de facto location URI.
Suggested retrieval location for this code list set, in genericode format.
If the CanonicalVersionUri has been defined, the LocationUri must reference a genericode CodeListSet document.
If the CanonicalVersionUri is undefined, the LocationUri must reference a genericode CodeListSet Metadata document.
An application must signal an error to the user if a LocationUri does not reference the appropriate type of genericode document.
An application must signal an error to the user if a document retrieved using a LocationUri is not in genericode format.
Base URL which applies to relative location URIs.
xml:base does not apply to canonical URIs.
Definition of a column.
Each column of a code list defines a piece of metadata that can be specified for each item in the code list.
User information about the column.
Name(s) of the column.
URIs used to identify the column and/or the version of the column.
Data type of the column.
ID which identifies the column within the document.
Whether the column is required or optional.
A choice between a column definition and a column reference.
Definition of a column.
Reference to a column defined in an external column set or code list.
Reference to a column defined in an external column set or code list.
The column reference must be valid.
An application may use the CanonicalVersionUri to select a local copy of the code list or column set which contains the column definition.
Otherwise the LocationUri value(s) may be tried in order, until a valid code list or column set document (containing the necessary column definition) is retrieved.
An application must signal an error to the user if it is not able to retrieve a code list or column set document which contains the necessary column definition.
User annotation for the referenced column.
Identification of the external column set or code list document which contains the column set definition.
Restrictions to the data type of the referenced column.
ID which identifies the column within this document.
ID which identifies which identifies the column within the external column set or code list.
Whether the column is required or optional.
If specified, this overrides the usage specified in the external column set or code list document.
Base URL which applies to relative location URIs.
xml:base does not apply to canonical URIs.
Attribute set for referring to a column definition.
Reference to a column ID in the document.
Top-level element for the definition of a column set.
Definition of a column set (columns and keys for a code list).
Column set definitions.
Identification of the default datatype library for the column set.
Base URL which applies to relative location URIs.
xml:base does not apply to canonical URIs.
A choice between a column set definition and a column set reference.
Definition of a column set (columns and keys for the code list).
Reference to a column set defined in an external column set or code list document.
Specific details of a column set.
A choice between a column definition and a column reference.
A choice between a key definition and a key reference.
Document type for the definition of a column set, which is a set of code list columns and/or keys.
General document information for the column set.
Details of the column set.
Identification of the default datatype library for the column set.
Base URL which applies to relative location URIs.
xml:base does not apply to canonical URIs.
Reference to a column set defined in an external column set or code list document.
The column set reference must be valid.
An application may use the CanonicalVersionUri to select a local copy of the column set or code list.
Otherwise the LocationUri value(s) may be tried in order, until a valid column set or code list document is retrieved.
An application must signal an error to the user if it is not able to retrieve a column set or code list document to match the column set reference.
User annotation for the referenced column set.
Identification of the external column set or code list document which contains the column set definition.
Base URL which applies to relative location URIs.
xml:base does not apply to canonical URIs.
Data type definition.
User annotation for the datatype.
Facet parameter which refines the datatype.
Unique ID for the datatype within its datatype library.
The datatype ID must not include a namespace prefix.
For the W3C XML Schema datatypes, possible datatype IDs are 'string', 'token', 'boolean', 'decimal', etc. If the data is complex (i.e. XML), this value is set to the root element name for the XML value, or '*' if the root element name is not restricted.
URI which uniquely identifies the datatype library.
If this URI not explicitly provided, the datatype library for the enclosing column set is used. If the data is complex (i.e. XML), this value is set to the namespace URI for the XML, or '*' if the namespace URI is not restricted.
Language from which the data is taken or derived.
Restrictions to a data type.
The 'gc:lang' attribute may be specified only if no language is already set for the data type that is being restricted.
Facet parameter which refines the datatype.
Language from which the data is taken or derived.
Facet information for refining a datatype.
Short name (token) for the datatype facet.
Long name for the datatype facet.
Identification of the default datatype library for a column set.
URI which uniquely identifies the default datatype library for the column set. If not provided, defaults to the URI for W3C XML Schema datatypes.
General document information (metadata).
User annotation information.
Identification and location information (metadata).
Attribute set used to identify a definition within an external document.
Unique ID within the external document.
The external reference must not be prefixed with a '#' symbol.
An identifier value. Typically not a long or short name.
Attribute set used to identify a definition within the document.
Unique ID within the document.
Identification and location information (metadata).
Various names.
Version identifier.
Canonical URI which uniquely identifies all versions (collectively).
Must be an absolute URI, must not be relative. Must not be used as a de facto location URI.
Identification and location URIs for the version.
Agency that is responsible for publication and/or maintenance of the information.
Identification and location URIs.
Canonical URI which serves as a unique identifier for this version.
Must be an absolute URI, must not be relative. Must not be used as a de facto location URI.
Suggested retrieval location for this version, in genericode format.
An application must signal an error to the user if a document retrieved using a LocationUri is not in genericode format.
URIs used as unique identifiers.
Canonical URI which uniquely identifies all versions collectively.
Must be an absolute URI, must not be relative. Must not be used as a de facto location URI.
Canonical URI which uniquely identifies this version.
Must be an absolute URI, must not be relative. Must not be used as a de facto location URI.
Definition of a key.
A key is a set of one or more columns whose values together provide a unique identification of each item in a code list.
Only required columns can be used for keys.
User annotation for the key.
Name(s) of the key.
URIs used to identify the key and/or the version of the key.
Reference to the document ID of a column in the key.
ID which identifies the key within the document.
A choice between a key definition and a key reference.
Definition of a key.
Reference to a key defined in an external column set or code list.
Reference to a column which forms part of a key.
User annotation for the column.
Reference to the ID of the column within the document.
Reference to a key defined in an external column set or code list.
The key reference must be valid.
An application may use the CanonicalVersionUri to select a local copy of the code list or column set which contains the key definition.
Otherwise the LocationUri value(s) may be tried in order, until a valid code list or column set document (containing the necessary key definition) is retrieved.
An application must signal an error to the user if it is not able to retrieve a code list or column set document which contains the necessary key definition.
User annotation for the referenced key.
Identification of the external column set or code list which contains the key definition.
ID which identifies the key within this document.
ID which identifies which identifies the key within the external column set or code list.
Base URL which applies to relative location URIs.
xml:base does not apply to canonical URIs.
Attributes which describe the language of a piece of text.
Language code which accepts the same values as 'xml:lang'.
Unlike 'xml:lang', the scope of the language definition is not restricted to the XML content within the element where the 'lang' attribute appears.
A human-readable name.
Information used to identify a particular long name where multiple long names exist.
URI for a resource, with support for specifying the MIME type.
MIME type of the resource which can be retrieved from the URI.
Various names.
Short name (without whitespace).
Human-readable name.
Attribute set which defines the usage (optional attribute).
Whether the usage is required or optional.
A choice which currently only allows a simple (explicit) code list definition.
Details of a simple code list definition.
Attribute set which defines the usage (required attribute).
Whether the usage is required or optional.
Row which represents an individual item in a code list.
User annotation for the row.
Column value for the row.
A value must be provided for each required column.
A value does not need to be provided for a column if the column is optional. If a value does not have an explicit column reference, the column is taken to be the column following the column of the preceding value in the row, or the first column if the value is the first value of the row.
A short name without whitespace that is suitable for use in generating names for software artifacts.
Must not contain whitespace characters.
The language from which the short name is taken or derived.
Simple (explicit) code list definition.
Applications must not have any dependency on the ordering of the rows.
User annotation for the code list.
Row which represents an individual item in the code list.
Details of a simple code list definition.
Simple (explicit) code list definition.
Simple textual value.
Indicates whether the usage is required or optional.
An individual code list metadata value.
User annotation for the value.
A choice between a simple textual value and a complex (structured) XML value. If the value is undefined, then neither choice is used.
Reference to the column with which this value is associated.
A choice between a simple textual value and a complex (structured) XML value.
Simple textual value.
The value must be valid with respect to the datatype and restrictions of the matching column.
Complex (structured) XML value.
The names of all direct child elements of the 'ComplexValue' element must match the datatype ID for the matching column, unless that ID is set to '*'. The namespace URIs of all direct child elements of the 'ComplexValue' element must match the datatype library URI for the matching column, unless that URI is set to '*'.
Information which identifies one of a set of alternate values.
A string which identifies one of a set of alternate values.
The language from which the value is taken or derived.
Identification and location URIs for a version.
Canonical URI which uniquely identifies this version.
Must be an absolute URI, must not be relative. Must not be used as a de facto location URI.
Suggested retrieval location for this version, in genericode format.
An application must signal an error to the user if a document retrieved using a LocationUri is not in genericode format.
Suggested retrieval location for this version, in a non-genericode format.
Such alternative formats are intended only as additional renditions of the code list information, not as a replacements nor as alternatives for use in application processing.