ZorgMail Address Book SE Documentation

Maat: px

Weergave met pagina beginnen:

Download "ZorgMail Address Book SE Documentation"

Diana Bogaert
8 jaren geleden
Aantal bezoeken:

1 ZorgMail Address Book SE Documentation File ID: addressbook_zorgmail_a15_se 2014 ENOVATION B.V. Alle rechten voorbehouden. Niets uit deze uitgave mag worden openbaar gemaakt of verveelvoudigd, opgeslagen in een data verwerkend systeem of uitgezonden in enige vorm door middel van druk, fotokopie of welke andere wijzen dan ook zonder voorafgaande schriftelijke toestemming van de directie van ENOVATION B.V.

Niets uit deze uitgave mag worden openbaar gemaakt of verveelvoudigd, opgeslagen in een data

2 Table of contents 1 Introduction File formats File contents Column definitions Disclaimer... 6 ZorgMail Address Book SE Page 2 / 6

.. 4 4 Column definitions... 4 5 Disclaimer.

3 1 Introduction ZorgMail provides a Secure solution for healthcare in the Netherlands. Addresses for secure are published in the ZorgMail Address Book Secure . ZorgMail also provides the secure messaging service for healthcare in the Netherlands. Applications of all types of practitioners are integrated by electronic data interchange (EDI) using ZorgMail. Addresses for EDI are published in the ZorgMail Address Book EDI, a separate book, separately documented. The ZorgMail Address Book can be accessed through the ZorgMail API. The documentation is available at: The API provides three interfaces: a REST interface to integrate a search in your application for EDI, a FILE interface to synchronize the ZorgMail address in the local contacts of your application for EDI or SE, and a LDAP interface to integrate the Secure book in your mail client for SE. This document contains the documentation of the FILE interface for Secure (SE). Complete documentation for all interfaces can be found online. 2 File formats The FILE API supports two formats: json and csv. The files are UTF-8 encoded with CRLF line endings and have no defined sort order. The rows and columns are the same for both formats and described in the next two chapters. References to the standards: Encoding = UTF-8 ( Format = csv ( Format = json ( Format = zip ( ZorgMail Address Book SE Page 3 / 6

Addresses for EDI are published in the ZorgMail Address Book EDI, a separate book, separately documented. The ZorgMail Address Book can be accessed through the ZorgMail API.

4 3 File contents The standard file can be downloaded from: Basic authentication is required. Your synchronization tool can login with an application password (EDI password). This file contains all enabled mailboxes for Secure . Your tool can process this file to update your local address book. This process can be optimized by skipping all records with a lastmodified smaller than the transactionid of the file processed last. To remove ZorgMail addresses that are no longer enabled all stored addresses must be checked whether the address still exists or not (publication of deletions is not available for secure ). Replace json by csv in the URI s for format csv. 4 Column definitions The column definitions a13 and a14 are described in this chapter. The format codes are defined as: A..12 means a string with maximum length 12. A3 means a string with length 3. N..9 means a string of digits (0-9) with maximum length 9, leading zeros are allowed. N08 means a string of digits (0-9) with length 8, leading zeros are allowed. N9 means a string of digits (0-9) with length 9, leading zeros are not allowed. Mandatory columns have minimum length 1. The type codes are defined as: M means Mandatory O means Optional U means Unique PK means Primary key, which is always mandatory and unique ZorgMail Address Book SE Page 4 / 6

Your tool can process this file to update your local address book. This process can be optimized by skipping all records with a lastmodified smaller than the transactionid of the file processed last.

5 addressbook_zorgmail_a15_se column definitions: # Column Type Format Description 1 version M A3 This column definition is version A15. Same value for all records in a file. 2 transactionid M A..128 Id of transaction that produced this csv file. Starts with YYYY-MM-DD. Same value for all records in a file. 3 id O N09 ZorgMail Mailbox id, also known as Customer number ( Klantnummer ). 4 displayname M A..64 Display name is a summary of the mailbox profile, the identity of the addressee. 5 mailaddress PK A..128 ZorgMail Secure address. 6 deleted M A1 Y/N. For Y delete this address from your local contacts. 7 created M A..40 Mailbox creation date(time). Starts with YYYY-MM-DD. 8 lastmodified M A..40 Mailbox last modification (or touch) date(time). Starts with YYYY-MM-DD. 9 role M A..64 Role of person or practice. 10 zvagbcode OU N08 AGB-practitioner code: practitioner type N02 + practitioner number N06. Leading zero s added to fixed length. 11 gender M A1 F/M/U. Gender: Female / Male / Unknown. 12 surname M A..128 Surname. Not empty: for non-human equal to the department or organization. 13 initials O A..10 Initials with punctuation. 14 prefix O A..10 Surname prefix. 15 department O A..128 Department in organization. 16 organizationid O A..128 Organization ID. Meaningless, can change in time. 17 pragbcode O N08 AGB-practice code: practice type N02 + practice number N06. Leading zero s added to fixed length. 18 organizationtype O A..64 Organization type. 19 organization M A..128 Organization name. 20 street M A..80 Street. 21 housenumber M A..12 House number and additions. 22 postalcode M A..12 Postal code. 23 locality M A..80 Locality or City. 24 country M A..40 Country name. 25 telephonenumber O A..15 Telephone number of organization. ZorgMail Address Book SE Page 5 / 6

6 5 Disclaimer Disclaimer in Dutch: Het doel van het ZorgMail Adresboek is het beschikbaar maken van ZorgMail-adressen ten behoeve van elektronische post via ZorgMail. Elektronische post kan zowel EDI als secure zijn. Voor adressering wordt het mailadres, het postbusnummer of de AGB-code gebruikt. Alle overige velden zijn ter identificatie, voor de herkenbaarheid tijdens het zoeken naar een adres. De straat en woonplaats worden in verband met de herkenbaarheid zo veel mogelijk gevuld met een bezoek- of praktijkadres. ENOVATION ontvangt de gegevens op verschillende manieren: aanmeldformulieren, telefoon, bestanden, etc.. Aanpassingen op het ZorgMail Adresboek zijn reactief: (adres)wijzigingen die aan ENOVATION worden gemeld worden verwerkt. ENOVATION is op geen enkele wijze aansprakelijk voor directe- of indirecte schade die ontstaat door onjuiste gegevens in het ZorgMail Adresboek. Het ZorgMail Adresboek mag uitsluitend gebruikt worden voor elektronische post via ZorgMail. De gebruiker heeft niet het recht om deze gegevens om welke reden dan ook aan derden ter beschikking te stellen. Alle schade die ENOVATION loopt door het ter beschikking stellen van het ZorgMail Adresboek aan derden kan ENOVATION op de gebruiker verhalen of indien en zodra de gebruiker het ZorgMail Adresboek aan derden om welke reden dan ook ter beschikking heeft gesteld, verbeurt de gebruiker een niet voor matiging vatbare boete van ongeacht het recht van ENOVATION om alle door haar geleden schade op de gebruiker te verhalen. ZorgMail Address Book SE Page 6 / 6

Alle overige velden zijn ter identificatie, voor de herkenbaarheid tijdens het zoeken naar een adres.

Vergelijkbare documenten

2019 SUNEXCHANGE USER GUIDE LAST UPDATED

2019 SUNEXCHANGE USER GUIDE LAST UPDATED 0 - -19 1 WELCOME TO SUNEX DISTRIBUTOR PORTAL This user manual will cover all the screens and functions of our site. MAIN SCREEN: Welcome message. 2 LOGIN SCREEN: