Versions Compared

Old Version 5

changes.mady.by.user Mathias Rõzko Tryggedsson

Saved on

compared with

New Version 6

changes.mady.by.user Mathias Rõzko Tryggedsson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Adding changelog

Model for case

A case can contain one or more parties, documents and actions. Depending on the degree of implementation in the origin system, there may be cases where, for example, actions are not included. The same applies to the time of implementation. Origin systems where there are cases from earlier than the implementation time, cases with similar deficiencies can be found.

Case Object

Properties

Type

Description

Description

String

Can contain a description of the case.

Documents

List<Document>

Case documents.

Events

List<Event>

The actions of the case.

ExternalMetadata

ExternalMetadata

See description of ExternalMetadata.

Id

Long

Identification for internal use in NemJournalisering.

IsCollected [1]

Bool

Indication of whether the case is marked as retrieved.

ExternalId

String

Any. ID from the data recipient’s system, sent when the case is marked as retrieved.

KLE

String

KLE number for the case.

Name

String

Name of the case.

Origin

Origin

Origin of the case. See description of Origin.

Parts

List<Part>

Parties involved.

PublicId

Guid

Unique identification of the case generated based on a combination of identification in the origin system and the origin system itself.


 

Document Object

Properties

Type

Description

Content

Byte[]

IMPORTANT:Will always be empty. To get the content of a document, the method “GetDocumentContent” must be called.

Description

String

Can contain a description of the case.

DocumentType

DocumentType

Indication of the type of document.

ExternalMetadata

ExternalMetadata

See description of ExternalMetadata.

File name

String

Document filename

FileSize

Int

File size in bytes

Id

Long

Identification for internal use in NemJournalisering.

IsCollected [1]

Bool

Indication of whether the document is marked as retrieved.

ExternalId

String

Any. ID from the data recipient’s system, sent when the document is marked as retrieved.

Name

String

The nickname of the document.

Origin

Origin

Origin of document. See description of Origin.

PartReference

List<DocumentPartReference>

List of parties that can be directly related to the document.

PublicId

Guid

Unique identification of the document generated from the combination of identification in the origin system and the origin system itself.


 

Event Object

Properties

Type

Description

DateTime

DateTime

Date of the action.

Description

String

Can contain a description of the action.

EventType

EventType

The type of action.

ExternalMetadata

ExternalMetadata

See description of ExternalMetadata.

Id

Long

Identification for internal use in NemJournalisering.

IsCollected [1]

Bool

Indication of whether the action is marked as retrieved.

ExternalId

String

Any. ID from the data recipient’s system, sent when the action is marked as retrieved.

Message

String

Can contain a message from the system that created the action.

Name

String

Name of the action.

Origin

Origin

Origin of the action. See description of Origin.

PartReference

List<EventPartReferences>

List of parties that can be directly related to the action.

PublicId

Guid

Unique identifier of the action generated based on the combination of identification in the origin system and the origin system itself.


 

Part Object

Properties

Type

Description

Description

String

Can contain a description of the party

ExternalMetadata

ExternalMetadata

See description of ExternalMetadata.

Id

Long

Identification for internal use in NemJournalisering.

Identifier

String

Identification of the party. Can contain both social security number, CVR number and identification of buildings. This is derived from PartType.

IsCollected [1]

Bool

Identification of whether the party is marked as retrieved.

ExternalId

String

Any. ID from the data recipient’s system, included when the party is marked as retrieved.

IsPrimary

Bool

Selection of primary party.

Name

String

Name of the party. Can contain personal names, company names, etc. This is derived from PartType.

Origin

Origin

The origin of the party. See description of Origin.

PartReferencetype

PartReferencetype

Indication of the party’s affiliation to the case.

PartType

PartType

Indication of type of party. It can be derived from this what it can be expected that Identifier and Name contain.

PublicId

Guid

Unique identification of the party generated on the basis of a combination of identification in the origin system and the origin system itself.


 

Origin Object

Origin contains data about which origin system Case, Document, Part or Event originates from. In addition, there is data for which user and in which department Case, Document, Part or Event was created, when it occurred, when it was last updated and in which entity (typically municipality) the creation took place. The origin system will always be an EGKI system.

Properties

Type

Description

Created

DateTime

Date when the Case, Document, Part or Event was created in the originating system.

EntityCode

Int

Contains entity code (typical municipality code)

GroupOwnerId

Long

ID of department (in EGKI user management) that has created Case, Document, Part or Event.

OwnerId

Long

ID of user (in EGKI user management) who has created Case, Document, Part or Event.

LastUpdated

DateTime

Date when Case, Document, Part or Event was last updated in the originating system.

OriginSystemType

OriginSystemType

Indication of which EGKI system Case, Document, Part or Event originates from.

SystemId

String

Unique identification of Case, Document, Part or Event in the originating system.


ExternalMetadata Object

Certain systems from EGKI allow cases to be created by an external system. If the external system originates from a supplier that is also a data recipient, an integration can be made where it is possible to send relevant data from the external system. A good example of this could be a unique identification of the case in the external system. This data can be exposed in ExternalMetadata, so that the data recipient can pair cases from NemJournalisering with cases in the external system. It is also possible to send more complex data if XElementId or ExternalKeyValuePairs are used.

ExternalMetadata is not only found on the Case object, but also on other objects in EasyJournalisation. This has been done to future-proof integrations that may be relevant in the future. For example, that an external system can add documents or actions to a case that already exists in an EGKI system, and then be able to pair these in its own system when they are extracted from NemJournalisering.

ExternalMetadata is not initialised in various constructors on objects that have the property. If ExternalMetadata is not used, this will always be null.

Note that agreements on the use and format of the ExternalMetadata concept must be agreed with the individual suppliers on an ad hoc basis and documented in the agreement between the data recipient and EGKI.

Properties

Type

Description

GuidId

Guid

An external system’s unique identification of Case, Document, Part or Event, in Guid format.

NumericId

Long

An external system’s unique identification of Case, Document, Part or Event, in numerical form.

StringId

String

An external system’s unique identification of Case, Document, Party or Event, in strict form.

XElementId

XElement

An XML structure that can contain relevant metadata from an external system.

ExternalKeyValuePair

List<ExternalKeyValuePair>

A list that can contain a collection of keys and values from an external system.

ExternalMetadataowner

ExternalMetadataowner

Indication of where ExternalMetadata originates from.

Example

The supplier of “System A” has made an agreement with EGKI to be able to create cases in an EGKI system. System A has a unique identification of its own cases in Guid format. In the EGKI system, a case is created with 2 documents, which must be paired with the case in System A. Depending on a date in System A, System A must be able to decide whether the pairing should take place or not. The actual pairing is a complicated process in System An and System An only wants to perform the pairing if this is relevant.

In connection with the conclusion of the integration agreement, it has been agreed to call the EGKI system with the following data:

Code Block
< Command Name = "CreateCase " >
 <Parameters >
  <CPR>1111901113</CPR>
  <CaseIdentifier>45236542</CaseIdentifier>
 < Deadline > 25-09-2014 13:48:16</ Deadline >
 </Parameters >
</ Command >

The EGKI system will forward this data to NemJournalisering. When the case is extracted from System A, ExternalMetadata in the Case object may look like the following examples, depending on what has been agreed:

Code Block
titleExternalMetadata Example 1
collapsetrue
< Case >
 < ... >
 < ExternalMetadata externalMetadataOwner="System A" >
   <NumericId>45236542</NumericId>
 <GuidId ></ GuidId >
 < StringId ></ StringId >
 <XElementId >
 < ExternalSystem ></ExternalSystem >
 </XElementId >
 <ExternalKeyValuePairs >
 < ExternalKeyValuePair key = "Deadline " > 25-09-2014 13:48:16</ ExternalKeyValuePair >
 </ExternalKeyValuePairs >
 </ExternalMetadata >
 < ... >
</ Case >
Code Block
titleExternalMetadata Example 2
collapsetrue
< Case >
 < ... >
 < ExternalMetadata externalMetadataOwner="System A" >
 <NumericId ></ NumericId >
 <GuidId ></ GuidId >
 < StringId ></ StringId >
 <XElementId >
 < ExternalSystem ></ExternalSystem >
 </XElementId >
 <ExternalKeyValuePairs >
 < ExternalKeyValuePair key = "CaseIdentifier " >45236542 </ExternalKeyValuePair >
 < ExternalKeyValuePair key = "Deadline " > 25-09-2014 13:48:16</ ExternalKeyValuePair >
 </ExternalKeyValuePairs >
 </ExternalMetadata >
 < ... >
</ Case >
Code Block
titleExternalMetadata Example 3
collapsetrue
< Case >
 < ... >
 < ExternalMetadata externalMetadataOwner="System A" >
 <NumericId ></ NumericId >
 <GuidId ></ GuidId >
 < StringId ></ StringId >
 <XElementId >
 < ExternalSystem >
 <SystemA >
      <CaseIdentifier>45236542</SystemACaseId>
 < Deadline > 25-09-2014 13:48:16</ Deadline >
 </SystemA >
 </ExternalSystem >
 </XElementId >
 < ExternalKeyValuePairs/>
 </ExternalMetadata >
 < ... >
</ Case >

DocumentPartReference Object

Properties

Type

Description

Id

Long

ID for internal use in EasyJournalization.

Identifier

String

Identification of the party. Can contain both social security number, CVR number and identification of buildings. This is derived from PartType.

Name

String

Name of the party. Can contain personal names, company names, etc. This is derived from PartType.

PartReferencetype

PartReferencetype

Indication of the party’s affiliation to the document.

PartType


Indication of type of party. It can be derived from this what it can be expected that Identifier and Name contain.

EventPartReference Object

Properties

Type

Description

Id

Long

ID for internal use in EasyJournalization.

Identifier

String

Identification of the party. Can contain both social security number, CVR number and identification of buildings. This is derived from PartType.

Name

String

Name of the party. Can contain personal names, company names, etc. This is derived from PartType.

PartReferencetype

PartReferencetype

Indication of the party’s affiliation to the action.

PartType


Indication of type of party. It can be derived from this what it can be expected that Identifier and Name contain.

Enumerations

PartType

Outcome

Value

Description

Unknown [2]

0

Unknown party type.

Person

100

The party is of the type person.

Company

200

The party is of the type company.

Building

30000

The party is of the property/building type.

PartReferencetype

Outcome

Value

Description

Unknown [2]

0

Unknown type of part reference.

Sender

100

The party’s reference to the object is of the sender type.

Receiver

200

The party’s reference to the object is of the recipient type.

Involved parties

300

The party’s reference to the object is of the stakeholder type.

DocumentType

Outcome

Value

Description

Unknown [2]

0

Unknown document type.

Request

100

The document is of type:

  • Application
  • Request
  • Motion

Authorization

200

The document is of type:

  • License
  • Authorization
  • Approval       

Typically, this will be a copy of documents with the result Request, if the response is positive.

Rejection

300

The document is of type:

  • Rejection
  • Dismissal

Typically, this will be a copy/response to documents with the result Request, if the response is negative.

Attestation

400

The document is of the type attestation/certificate.

Typically, this will be a copy/response to documents with the result Request, if a certificate is necessary for the case.

Documentation

500

The document is of the documentation type.

Statements

600

The document is of type:

  • Declaration
  • Statements

Information

610

The document is of type:

  • Orienteering

Appendix

700

The document is of the attachment type.

OIOXml

800

The document is of type OIO Xml.

Validity

900

Documentation for signature (e.g. with NemID)

SignText

910

Text signed with NemID

ESDHDocument

1000

Document already uploaded in ESDH system

The outcome area NotImplementedDocumentType01 to NotImplementedDocumentType10 is reserved for future use and can be renamed at any time. However, values for these outcome spaces will not be changed.

OriginSystemType

Outcome

Value

Description

Unknown [2]

0

Unknown origin system.

NFS

100

The system of origin is NetForvaltning Sundhed.

MC

200

The system of origin is Mediconnect.

MCProces

202

The origin system is Mediconnect Process.

NFV

300

The system of origin is NetForvaltning Vielse.

NFB

400

The system of origin is NetForvaltning Børn og Unge.

OIBADM

500

The system of origin is OIB Borger

NFBG

600

The system of origin is NetForvaltning Begravelseshjælp.

NetBlanket

700

The system of origin is NetBlanket.

NFE

800

The system of origin is NetForvaltning Ejendomshandel.

X3

900

The system of origin is X3.

EGOnHjaelpemidler

1000

The system of origin is EG On Hjælpemidler.

HealthCertificate

1100

The system of origin is Health Certificate.

KubeData

1110

The system of origin is Kube Data A/S.

BioMetric

1120

The system of origin is BioMetric Solution A/S.

ScandiSystem

1130

The system of origin is Scandi System A/S.

UnitTest

32767

The system of origin is EGKI internal unit test.

This is used exclusively for unit testing of the object model, so that other data is not disturbed.

ExternalSystemType

Outcome

Value

Description

FileSystem

50

External system is of type NemJournalisering.Client (Save to Desktop).

Acadre41

100

External system is of type Acadre 4.1.

Acadre42

200

External system is of type Acadre 4.2.

eDoc

300

External system is of type eDoc.

WorkBase

400

External system is of type MediaLogic WorkBase.

KMDIOManager

408

External system is of type KMD IO Manager.

KMDOpera

410

External system is of type KMD Opera.

ProFile

412

External system is Convergens ProFile type.

SBSys

414

External system is of type Ditmer SBSys.

KMDSagEDH

416

External system is of type KMD Sag EDH.

Visma

418

External system is of type Visma.

NFBG

424

NetForvatning Begravelseshjælp.

NFV

426

NetForvatning Vielse.

TraenIO

428

Train IO Manager.

NFOA

430

NetForvaltning Offentlige Arrangementer.

NFFO

431

NetForvaltning Offentlige Forening.

NBOIBIntegration

432

NetBlanket/OIB integration.

MCProcess

434

Mediconnect process.

DataScanning

436

DataScanning.

SchultzFacit

438

Schultz concludes.

EGOnKN

440

EG On Klagenævn.

NetCompanyGetOrganized

442

NetCompany GetOrganized

EGOnHjaelpemidler

444

EG On Hjælpemidler.

EGOnHelbredstillaeg

445

EG On Helbredstillæg.

ATP

446

ATP.

EGSensum

447

EG Sensum.

KMDMomentum

448

KMD Momentum.

SBSIP

449

SBSIP.

KMDNova

450

KMD Nova

KMDNexus

451

KMD Nexus

SystematicColumna

455

Systematic Column

SystematicCura

456

SystematicCura

ScalePoint NextWay

465

Next Way Scale Point

CBrainF2

470

Familieretshuset

HealthCertificate

1100

Health certificate

KubeData

1110

Kube Data A/S

BioMetric

1120

BioMetric Solution A/S

ScandiSystem

1130

Scandi System A/S

Deloitte

1140

External system at Deloitte

KMDWorkzone

1150

KMD WorkZone

ANS

1160

ATP/AES

EGKI

32767

External system is of EGKI internal unit test.

This is used exclusively for unit testing of the object model, so that other data is not disturbed.

The NotImplementedSystem01 to NotImplementedSystem10 outcome area is reserved for future use and can be renamed at any time. However, values for these outcome spaces will not be changed.

EventType

Outcome

Value

Description

Unknown[2]

0

Unknown type of action.

CaseCreated

50

The type of action is case created.

CaseUpdated

100

The action type is case updated.

PartAdded

150

The action type is party added.

PartUpdated

200

Action type is party updated.

DocumentAdded

250

The action type is document added.

DocumentUpdated

300

The action type is document updated.

CaseDeleted

32766

The action type is case deleted.

CaseClosed

32767

The action type is case closed.

ExternalMetadataowner

Outcome

Value

Description

Unknown [2]

0

Unknown type of ExternalMetadataOwner.

WorkBase

100

Medialogic Workbase

KMDOpera

200

KMD Opera.

AMSJobNet

250

AMS/JobNet.

NFOA

252

NetForvaltning Offentlige Arrangementer.

NFFO

254

NetForvaltning Forening.

EGOnHjaelpemidler

256

EG On Hjælpemidler.

EGOnHelbredstillaeg

257

EG On Helbredstillæg.

X3

259

X3

NetBlanket

260

NetBlanket.

Acadre

270

Acadre.

SchultzFacit

280

Schultz concludes.

KMDMomentum

290

KMD Momentum.

NetCompanyGetOrganized

300

NetCompanyGetOrganized

SystematicColumna

310

Systematic Column

Sensum

320

EG Digital Welfare, Sensum

ScalePoint NextWay

340

Next Way Scale Point

CBrainF2

350

Familieretshuset

SystematicCura

456

SystematicCura

HealthCertificate

1100

Health certificate

KubeData

1110

Kube Data A/S

BioMetric

1120

BioMetric Solution A/S

ScandiSystem

1130

Scandi System A/S

ANS

1160

ATP/AES

[1] Will always be zero in objects found in case lists. Only on GetCaseById this value will be set.

[2] This outcome cannot occur when cases are retrieved from NemJournalisering.

Change log

Info
titleList order
Most recent entry is added to the top of the list.
DateChanges

13th February 2023 

  • Enumeration ExternalDataOwner expanded with the outcome SystematicCura

25th January 2023 

  • Enumeration ExternalDataOwner expanded with the outcome ANS  
  • ExternalSystemType enumeration expanded with the outcome ANS

24th January 2022 

  • Enumeration ExternalDataOwner expanded with the outcome CBrainF2
  • ExternalSystemType enumeration expanded with the outcome CBrainF2 

20th September 2021 

  • The ExternalSystemType enumeration has been expanded with the outcome SystematicCura 

1st July 2021 

  • The ExternalSystemType enumeration has been expanded with the outcome KMDWorkzone 

5th March 2021 

  • The ExternalDataOwner enumeration has been expanded with the outcome ScalePointNextWay 
  • The ExternalSystemType enumeration has been expanded with the outcome ScalePointNextWay 

17th April 2020 

  • The ExternalDataOwner enumeration expanded with the outcome Sensum 

19th March 2020 

  • Enumerations have been expanded with new outcomes 

12th December 2017 

  • The ExternalSystemType enumeration has been expanded with: 
  • KMDNova 
  • KMDNexus 

28th January 2016 

  • The ExternalSystemType enumeration has been expanded with the result ATP. 

7th October 2015 

  • The ExternalSystemType enumeration has been expanded with the outcomes: 
  • NetBlanket 
  • EGOnAids 
  • NetCompantGetOrganized 
  • The OriginSystemType enumeration has been expanded with the outcome X3. 

12th February 2015 

  • The ExternalMetadataOwner enumeration has been expanded with new outcomes. 
  • The ExternalSystemType enumeration has been expanded with new outcomes. 

15th August 2013 

  • The ExternalSystemType enumeration has been expanded with the outcome KMDIOManager. 

20th March 2013 

  • The ExternalSystemType enumeration has been expanded with the outcomes: 
  • TraenIO 
  • NFOA 
  • The ExternalMetadataOwner enumeration has been expanded with the outcome NFOA. 

8th October 2012 

  • The correction for IsCollected of 12th March 2012 was initially omitted for call ExternalSystemType set to KMDOpera and ProFile. This omission has now been removed.  
  • The ExternalMetaDataOwner enumeration has been expanded with the outcome AMSJobNet. 
  • The ExternalSystemType enumeration has been expanded with theoutcomes: 
  • AMSJobNet 
  • NFV 
  • NFBG 
  • The OriginSystemType enumeration has been expanded with the outcomes: 
  • NetBlanket 
  • NFE 

12th March 2012 

  • The ExternalSystemType enumeration has been expanded with the outcomes: 
  • NFBE (NetAdministration Funeral Assistance) 
  • Visma 
  • FileSystem 
  • EmailDKAL 
  • EmailFESD 
  • The property IsCollected will always be null in objects found in case lists. Only on GetCaseById this value will be set. 

2nd December 2011 

  • BaseIsCollected is extended with the ExternalId property. The following objects inherit from BaseIsCollected: 
  • Case 
  • Document 
  • Event 
  • Part 
  • The property KLE now removes all spaces when the set accessor is accessed. 
  • The ExternalSystemType enumeration has been expanded with the outcomes: 
  • KMDSagEDH 
  • ProFile 
  • SBSys 
  • Output from PropertyException has been improved so that you can now see which property is not set correctly. 
  • The enumeration DocumentType has been expanded with the outcome Information. 
  • Document.DocumentType can no longer have the outcome Unknown when the object is to be transported. 

14th November 2011 

  • It is now marked in footnotes where the outcome Unknown cannot occur when cases are retrieved from NemJournalisering. 
  • The enumeration ExternalMetadataOwner has been added in NemJournalisering.Core.Entities. 
  • ExternalMetadata has been added the property ExternalMetadataOwner. 
  • ExternalMetadata is no longer initialised in various constructors. ExternalMetadata can be transported as null. 

27th October 2011 

  • Major version was incorrectly set to 1.0. This has now been corrected to 2.0. 
  • DocumentType incorporated. 
  • Explanation of all enumerations added. 
  • The naming of the property <T>.Origin.System was inconsistent and renamed to <T>.Origin.OriginSystemType. 

Table of Contents