...
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 of the |
Description of the | 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 of the |
Content | Byte[] | IMPORTANT:Will always be empty. To get the content of a document, the method “GetDocumentContent” must be called. |
Description of the | 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 of the |
DateTime | DateTime | Date of the action. |
Description of the | 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. |
Party Object
Properties | Type | Description of the |
Description of the | 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 of the |
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.
...
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 of the |
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.
...
DocumentPartReference Object
Properties | Type | Description of the |
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 of the |
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 of the |
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 of the |
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 of the |
Unknown [2] | 0 | Unknown document type. |
Request | 100 | The document is of type: |
|
|
|
Authorization | 200 | The document is of type: |
|
· Authorisations
· Authorisations
Typically, this will be a copy of documents with the result Request, if the response is positive. | ||
Rejection | 300 | The document is of type: |
|
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: |
|
|
Information | 610 | The document is of type: |
| ||
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 of the |
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. |
EGOnAids | 1000 | The system of origin is EG On Aids. |
Health Certificate | 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 of the | ||
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 Case EDH. | ||
Visma | 418 | External system is of type Visma. | ||
NFBG | 424 | NetForvatning Funeral Assistance. | ||
NFV | 426 | NetForvatning Wedding. | ||
TraenIO | 428 | Train IO Manager. | ||
NFOA | 430 | NetAdministration Public Events. | ||
NFFO | 431 | NetForvaltning Association. | ||
NBOIBIntegration | 432 | NetBlanket/OIB integration. | ||
MCProcess | 434 | Mediconnect process. | ||
DataScanning | 436 | DataScanning. | ||
SchultzFacit | 438 | Schultz concludes. | ||
EGOnKN | 440 | EG-On Board of Appeal. | ||
NetCompanyGetOrganized | 442 | NetCompany GetOrganized | ||
EGOnAids | 444 | EG On Aids. | ||
EGOnHealthtime | 445 | EG On Health Allowance. | ||
ATP | 446 | ATP. | ||
EGSensum | 447 | EG Sensum. | ||
KMDMomentum | 448 | KMD Momentum. | ||
SBSIP | 449 | SBSIP. | ||
KMDNova | 450 | KMD Nova | ||
KMDNexus | 451 | KMD Nexus | ||
SystematicColumn | 455 | Systematic Column | ||
SystematicCura | 456 | SystematicCura | ||
ScalePoint NextWay | 465 | Next Way Scale Point | ||
CBrainF2 | 470 | Family Court House | ||
Health Certificate | 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 | ||
YEARS | 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 of the |
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 of the | ||
Unknown [2] | 0 | Unknown type of ExternalMetadataOwner. | ||
WorkBase | 100 | Medialogic Workbase | ||
KMDOpera | 200 | KMD Opera. | ||
AMSJobNet | 250 | AMS/JobNet. | ||
NFOA | 252 | NetAdministration Public Events. | ||
NFFO | 254 | NetForvaltning Association. | ||
EGOnAids | 256 | EG On Aids. | ||
EGOnHealthtime | 257 | EG On Health Allowance. | ||
X3 | 259 | X3 | ||
NetBlanket | 260 | NetBlanket. | ||
Acadre | 270 | Acadre. | ||
SchultzFacit | 280 | Schultz concludes. | ||
KMDMomentum | 290 | KMD Momentum. | ||
NetCompanyGetOrganized | 300 | NetCompanyGetOrganized | ||
SystematicColumn | 310 | Systematic Column | ||
Sense | 320 | EG Digital Welfare, Sensum | ||
ScalePoint NextWay | 340 | Next Way Scale Point | ||
CBrainF2 | 350 | Family Court House | ||
SystematicCura | 456 | SystematicCura | ||
Health Certificate | 1100 | Health certificate | ||
KubeData | 1110 | Kube Data A/S | ||
BioMetric | 1120 | BioMetric Solution A/S | ||
ScandiSystem | 1130 | Scandi System A/S | ||
YEARS | 1160 | ATP/AES |
[1] Will always be zero in objects found in case lists. Only on GetCaseById this value will be set.
...