General properties

The documentStructure is basically made up of the document entity, a commonTechnical entity for technical metadata and a commonFunctional entity for functional metadata. The structure is used for exchanging a wide range of document related data: for example pdf files, emails, attachments or (claim related) photographs.

Mandatory components

The table below contains the mandatory entities and attributes of the documentStructure. Please note: these are only the mandatory components; in this case only the presence of a document entity and the functional metadata of the commonFunctional entity. In many functions and messages, the message will also include technical metadata in a commonTechnical entity.

The content of the document itself can have any format and is stored in the content attribute, as long as a character-based notation is used. Commonly used options are:

  • Structured data in JSON, XML, EDIFACT, CSV or other format (either escaped plain text notation or base64 encoded)
  • Binary files like PDF, Word, Excel etc. (base64 encoded)

When the content is encoded, the attributes contentEncoding and contentType are required. In practice, the (non-mandatory) fileName attribute will often also occur here.

See AFD 2.0 Online for the complete and up-to-date data catalog with all entities, entityTypes and attributes, associated with the claimStructure. More documentation on the use of SIVI AFS is available in chapter Where to find elements of SIVI AFS. A general description of AFD structures is provided in Introduction to AFD structures, while information on details of AFD structures is available in chapter Where to find details about AFD structures.

Name Occur. Type Description
documentStructure 1..1 entity Structure of document related data, based on AFD attributes.
commonFunctional 1..1 entity Entity for general information with regard to structure, handling and processing.
entityType 1..1 string Set to ‘default’.
document 1..1 entity The main entity of the document structure.
entityType 1..1 string Set to ‘default’.
contentEncoding 0*..1 string Encoding of the content attribute (*mandatory if ‘content’ is encoded).
contentType 0*..1 string MIME type of the original file (*mandatory if ‘content’ is encoded).

JSON example

Below is an example of a documentStructure. Note that at the top level within JSON, the documentStructure entity is not explicitly mentioned. In XML, the structure is always explicitly defined (as documentStructure) at the highest level.

	"commonFunctional": [ {
		"entityType": "default",
		"dataCatalogVersion": "38D"
	"document": [ {
		"entityType": "default",
		"contentEncoding": "base64",
		"fileName": "voorbeeld.pdf",
		"contentType": "text/plain",
		"content": "QmVhbnR3b29yZCBvbmRlcnN0YWFuZGUgdnJhZ2VuIGVuIG5lZW0gaGV0IGluZ2V2dWxkZSBmb3JtdWxpZXIgcy52LnAuIG1lZSBuYWFyIGRlIHNlc3NpZS4="


Thanks for your feedback.

Post your comment on this topic.

Post Comment