JSON

SourceDescription (XML)

Represents a description of a source.

Namespace:http://gedcomx.org/v1/
URI:http://gedcomx.org/v1/SourceDescription
Extends:HypermediaEnabledData

Attributes

Name Type Description
about anyURI The URI (if applicable) of the actual source.
lang string The language of this genealogical data set. See http://www.w3.org/International/articles/language-tags/. Note that some language-enabled elements MAY override the language.
mediaType string Hint about the media (MIME) type of the resource being described.
sortKey string A sort key to be used in determining the position of this source relative to other sources in the same collection. FTU
resourceType resourceType The type of the resource being described.
Attributes inherited from ExtensibleData
id string A local, context-specific id for the data.

Elements

Name Type Occurs Description
citation SourceCitation 0..* The bibliographic citations for this source.
mediator ResourceReference 0..1 A reference to the entity that mediates access to the described source.
source SourceReference 0..* References to any sources to which this source is related (usually applicable to sources that are derived from or contained in another source).
analysis ResourceReference 0..1 A reference to the analysis document explaining the analysis that went into this description of the source.
componentOf SourceReference 0..1 A reference to the source that contains this source.
title TextValue 0..* A list of titles for this source.
titleLabel TextValue 0..1 A label for the title of this description. FTU
note Note 0..* Notes about a source.
attribution Attribution 0..1 The attribution metadata for this source description.
description TextValue 0..* Human-readable descriptions of the source. FTU
identifier Identifier 0..* The list of identifiers for the source.
created dateTime 0..1 The date the source was created. FTU
modified dateTime 0..1 The date the source was last modified. FTU
coverage Coverage 0..* Declarations of the coverage of the source. FTU
rights string 0..* The rights for this source.
field Field 0..* The fields that are applicable to the resource being described. FTU
repository ResourceReference 0..1 Reference to an agent describing the repository in which the source is found. FTU
descriptor ResourceReference 0..1 Reference to a descriptor of fields and type of data that can be expected to be extracted from the source. FTU
replacedBy string 0..1 The URI that this resource has been replaced by.
replaces string 0..* The list of resources that this resource replaces.
status string 0..* The list of status types for the source.
Elements inherited from HypermediaEnabledData
link Link 0..* The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Example

<?xml version="1.0" encoding="UTF-8"?>
<SourceDescription xmlns="http://gedcomx.org/v1/" id="..." about="..." xml:lang="..." mediaType="..." sortKey="..." resourceType="...">
  <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="..." />
  <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="...">
    <!--...-->
  </link>
  <!--...more "link" elements...-->
  <citation id="..." xml:lang="...">
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="..." />
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="...">
      <!--...-->
    </link>
    <!--...more "link" elements...-->
    <citationTemplate resourceId="..." resource="..." />
    <field name="...">...</field>
    <field name="...">...</field>
    <!--...more "field" elements...-->
    <value>...</value>
  </citation>
  <citation xml:lang="...">
    <!--...-->
  </citation>
  <!--...more "citation" elements...-->
  <mediator resourceId="..." resource="..." />
  <source id="..." description="...">
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="..." />
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="...">
      <!--...-->
    </link>
    <!--...more "link" elements...-->
    <attribution id="..." />
    <qualifier>...</qualifier>
    <qualifier>...</qualifier>
    <!--...more "qualifier" elements...-->
  </source>
  <source description="...">
    <!--...-->
  </source>
  <!--...more "source" elements...-->
  <analysis resourceId="..." resource="..." />
  <componentOf id="..." description="...">
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="..." />
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="...">
      <!--...-->
    </link>
    <!--...more "link" elements...-->
    <attribution id="..." />
    <qualifier>...</qualifier>
    <qualifier>...</qualifier>
    <!--...more "qualifier" elements...-->
  </componentOf>
  <title xml:lang="...">...</title>
  <title xml:lang="...">...</title>
  <!--...more "title" elements...-->
  <titleLabel xml:lang="...">...</titleLabel>
  <note id="..." xml:lang="...">
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="..." />
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="...">
      <!--...-->
    </link>
    <!--...more "link" elements...-->
    <subject>...</subject>
    <text>...</text>
    <attribution id="..." />
  </note>
  <note xml:lang="...">
    <!--...-->
  </note>
  <!--...more "note" elements...-->
  <attribution id="...">
    <contributor resourceId="..." resource="..." />
    <modified>...</modified>
    <changeMessage>...</changeMessage>
  </attribution>
  <description xml:lang="...">...</description>
  <description xml:lang="...">...</description>
  <!--...more "description" elements...-->
  <identifier type="...">...</identifier>
  <identifier type="...">...</identifier>
  <!--...more "identifier" elements...-->
  <created>...</created>
  <modified>...</modified>
  <coverage id="...">
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="..." />
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="...">
      <!--...-->
    </link>
    <!--...more "link" elements...-->
    <recordType>...</recordType>
    <spatial id="..." description="..." />
    <temporal id="..." />
  </coverage>
  <coverage>
    <!--...-->
  </coverage>
  <!--...more "coverage" elements...-->
  <rights>...</rights>
  <rights>...</rights>
  <!--...more "rights" elements...-->
  <field id="..." type="...">
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="..." />
    <link template="..." allow="..." count="..." accept="..." type="..." hreflang="..." title="..." results="..." rel="..." offset="..." href="...">
      <!--...-->
    </link>
    <!--...more "link" elements...-->
    <value id="..." confidence="..." sortKey="..." xml:lang="..." resource="..." datatype="..." type="..." labelId="..." />
    <value resource="..." datatype="..." type="..." labelId="...">
      <!--...-->
    </value>
    <!--...more "value" elements...-->
  </field>
  <field type="...">
    <!--...-->
  </field>
  <!--...more "field" elements...-->
  <repository resourceId="..." resource="..." />
  <descriptor resourceId="..." resource="..." />
  <replacedBy>...</replacedBy>
  <replaces>...</replaces>
  <replaces>...</replaces>
  <!--...more "replaces" elements...-->
  <status>...</status>
  <status>...</status>
  <!--...more "status" elements...-->
</SourceDescription>