JSON

Document (XML)

An abstract document that contains derived (conclusionary) text -- for example, a transcription or researcher analysis.

Namespace:http://gedcomx.org/v1/
URI:http://gedcomx.org/v1/Document
Extends:Conclusion

Attributes

Name Type Description
textType string The text type of the document. FTU
extracted boolean Whether this document has been identified as "extracted", meaning it captures information extracted from a single source. FTU
type documentType The type of the document. FTU
Attributes inherited from Conclusion
confidence confidenceLevel The level of confidence the contributor has about the data.
sortKey string A sort key in relation to other facts for display purposes.
lang string The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ FTR
Attributes inherited from ExtensibleData
id string A local, context-specific id for the data.

Elements

Name Type Occurs Description
text string 0..1 The document text. FTU
Elements inherited from Conclusion
attribution Attribution 0..1 Attribution metadata for a conclusion.
source SourceReference 0..* The source references for a conclusion.
analysis ResourceReference 0..1 A reference to the analysis document explaining the analysis that went into this conclusion. FTU
note Note 0..* Notes about a person.
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"?>
<Document xmlns="http://gedcomx.org/v1/" id="..." confidence="..." sortKey="..." xml:lang="..." textType="..." extracted="..." 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...-->
  <attribution id="...">
    <contributor resourceId="..." resource="..." />
    <modified>...</modified>
    <changeMessage>...</changeMessage>
  </attribution>
  <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="..." />
  <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...-->
  <text>...</text>
</Document>