Nippin database | docs.healthdata.be

Last updated: 2024-04-25 15:39

The different statuses of a Nippin_message in the database

Status	Description
TO_SEND	HD4DP v2 ready to be sent to MyCareNet or SFTP folder
ARCHIVED	Messages are set to ARCHIVED, only if the NippinCleanup table has 0 records. These messages will not be processed and won't receive any attention afterwards.
INVALID	XML payload is invalid, a ticket can be created at our service portal, including the payload of the invalid message.
BUFFERED	not used
ERROR	HD4DP v2 was not able to send the message to MyCareNet or SFTP folder
SENT	HD4DP v2 was able to send the message to MyCareNet or SFTP folder

Nippin_message information table

Column name	Data type	Description
id	bigserial	Primary Key
message_id	varchar(255)	Identifier for the message
identification_value	text	Identification value of the organization that is sending the message
name	text	Name of the organization that is sending the message
payload	text	Payload of the message
payload_after_validation	text	Payload after (xsd-)validation
response	text	Response to the message (received from myCarenet)
valid	boolean	Whether the message is valid or not
interface_type	varchar(25)	Type of interface used for the message (e.g. FILE_SYSTEM or REST)
status	varchar(25)	Current status of the message (possible states : INVALID (validation against xsd-scheme failed), TO_SEND (ready for sending to myCarenet), SENT (sent to myCarenet), ERROR (something went wrong during sending, e.g. unable to reach myCarenet))
created_on	timestamp	Timestamp of when the message was created
input_reference	varchar(255)	Reference for the input message (this is a unique identifier that can be used for debugging/tracing with myCarenet)
issuer	text	Issuer of the message
postresponse_tack_applies_to	text	Applies-to value for the TACK post-response (received from myCarenet)
postresponse_tack_id	text	ID of the TACK post-response (received from myCarenet)
postresponse_tack_reference	text	Reference for the TACK post-response (received from myCarenet)
postresponse_tack_resultMajor	text	Result major for the TACK post-response (received from myCarenet)
postresponse_tack_resultMinor	text	Result minor for the TACK post-response (received from myCarenet)
postresponse_tack_resultMessage	text	Result message for the TACK post-response (received from myCarenet)
previous_registrationcode	varchar(255)	Previous registration code for the message (obsolete)
current_registrationcode	varchar(255)	Current registration code for the message (value will be identical to previous_registrationcode)
version_tag	varchar(255)	Current application-version

Granted privileges

Database	User	Privileges
nippin	dpuser	CONNECT/nippin_message:SELECT/nippin_cleanup:SELECT

Queries

Count records grouped by the type and status:

nippin=# select interface_type, status, count(id) from nippin_message group by interface_type,status;
 interface_type | status  | count
----------------+---------+-------
 FILE_SYSTEM    | SENT    |   117
 FILE_SYSTEM    | INVALID |   352
 FILE_SYSTEM    | TO_SEND |  9238
(3 rows)

Get all error and invalid information:

select id, message_id, project_id, dcd_id, payload_after_validation from nippin_message where status in ('INVALID', 'ERROR');

Get previous and current registration code:

select id, message_id, project_id, dcd_id, previous_registrationcode, current_registrationcode from nippin_message;

Get nippin cleanup information:

select * from nippin_cleanup;

MyCareNet integration-specific queries

Only for hospitals that are using the Nippin integration in HD4DP v2.

Count records with status SENT and group them based on the reference ID received from MyCareNet:

 select postresponse_tack_result_major, postresponse_tack_reference, count(*)  from nippin_message where status = 'SENT' group by status, postresponse_tack_result_major, postresponse_tack_reference;
  postresponse_tack_result_major   |     postresponse_tack_reference      | count
-----------------------------------+--------------------------------------+-------
 urn:nip:tack:result:major:success | ***** |   2
 urn:nip:tack:result:major:success | ***** |   88