XML

Document (JSON)

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

Properties

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
text string The document text. FTU
Properties 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
attribution Attribution Attribution metadata for a conclusion.
sources array of SourceReference The source references for a conclusion.
analysis ResourceReference A reference to the analysis document explaining the analysis that went into this conclusion. FTU
notes array of Note Notes about a person.
Properties inherited from HypermediaEnabledData
links array of Link The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.
Properties inherited from ExtensibleData
id string A local, context-specific id for the data.

Example

{
  "textType" : "...",
  "extracted" : false,
  "type" : "...",
  "text" : "...",
  "confidence" : "...",
  "sortKey" : "...",
  "lang" : "...",
  "attribution" : {
    "contributor" : {
    },
    "modified" : "...",
    "changeMessage" : "...",
    "creator" : {
    },
    "created" : "...",
    "id" : "..."
  },
  "sources" : [ {
    "description" : "...",
    "attribution" : {
    },
    "qualifiers" : [ {
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "analysis" : {
    "resourceId" : "...",
    "resource" : ...
  },
  "notes" : [ {
    "lang" : "...",
    "subject" : "...",
    "text" : "...",
    "attribution" : {
    },
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "links" : {
    "type1" : [ {
      "template" : "...",
      "allow" : "...",
      "count" : ...,
      "accept" : "...",
      "type" : "...",
      "hreflang" : "...",
      "title" : "...",
      "results" : ...,
      "rel" : "...",
      "offset" : ...,
      "href" : ...
    }, ... ],
    "type2" : [ {
      "template" : "...",
      "allow" : "...",
      "count" : ...,
      "accept" : "...",
      "type" : "...",
      "hreflang" : "...",
      "title" : "...",
      "results" : ...,
      "rel" : "...",
      "offset" : ...,
      "href" : ...
    }, ... ],
    "..." : ...
  },
  "id" : "..."
}