import medicinal delivery notification - fagg · web viewgeneral new web service that allows: - to...

Sanitel Med

FAGG

Import Medicinal Delivery Notification

Contents1. General............................................................................................................................................4

2. Import parameters..........................................................................................................................5

3. . .Layout9

Import Medicinal Delivery Notification 2/05/2016 1 of 20Version 16.01.01

4. Export parameters.........................................................................................................................12

5. User Code Values...........................................................................................................................12

5.1 MEIG..........................................................................................................................................12

5.2 ANTP..........................................................................................................................................13

5.3 ANCT..........................................................................................................................................13

5.4 MEDT.........................................................................................................................................15

5.5 TMUN........................................................................................................................................15

5.6 PHFM.........................................................................................................................................15

5.7 PKUN..........................................................................................................................................16

5.8 SRUN..........................................................................................................................................16

5.9 PTGY..........................................................................................................................................17

5.10 Notification Action.....................................................................................................................18


Document history

Version Date Author Remarks

0.1 10/09/2015 Jean-Marc De Schrijver

Initial Version

16.01.00 15/09/2015 Jean-Marc De Schrijver

Reviewed by G. Sluydts and S. Selvaraj

16.01.01 12/10/2015 Greetje Sluydts - PTGY user code details added

- NOCO_CMN specified as separate section in §2.

- NTHS_CMN added

- MEPR_PAK_QTY_UNT, MEPR_BAR_CDE deleted

- MEPR_PAK_QTY, NODD_ANM_CNT is DECIMAL

- XML_USER_NAME to specify on file-level

- NODD_AGE_UNT renamed NODD_AGE_TMUN_CDE

- NODD_FRT_DIG renamed NODD_FRT_DIG_PTGY_CDE

- NODD_ID renamed NODD_NOTF_ID

- NODD_PRD_BAT_STR_DTE renamed NODD_PRD_BAT_STA_DTE

- NODD_MED_FED_WIG renamed NODD_MED_FED_WGT

- NODD_SLF_DFN_PRD, MEPR_ACT_FAV, NODD_IMP, NODD_CAD renamed NODD_SLF_DFN_PRD_FLG, MEPR_ACT_FAV_FLG, NODD_IMP_FLG, NODD_CAD_FLG

- NODD_SLF_DFN_PRD_FLG, MEPR_ACT_FAV_FLG, NODD_CAD_FLG, NODD_IMP_FLG are Boolean

- Max 4 ingredients allowed

16.01.02 24/02/2016 Greetje Sluydts - SRUN values changed and added

- PHFM: value added


Version Date Author Remarks

16.01.03 04/04/2016 Sudhagar Selvaraj - Translations added

- Output xml – example added


1. GeneralNew web service that allows:

- to create a new Medicinal Document and one or more of its Medicinal Delivery Notifications

or

- to create or update one or more Medicinal Delivery Notifications for an existing Medicinal Document

The structure of the import XML contains :

A document part, containing the document data A Medicinal Notification part, containing the details about the Medicinal

Notifications for the Document at hand , that need to be added or changed

As there are 2 types of data, there will be operations performed on 2 levels.

1. Document level:

The Document Identifier is an attribute in the Documentation part of the XML.

In case the Document Identifier is not filled: A new Medicinal Document is to be created, based on all delivered data.

In case the Document Identifier is filled: No new Medicinal Document is to be created, only actions on notification-level are to be performed.

2. Medicinal Delivery Notification level

The Medicinal Delivery Notification Identifier is an attribute in every Notification part of the XML.

In case the Medicinal Delivery Notification is to be updated (including cancel), the Medicinal Delivery Notification Identifier is mandatory.


2. Import parameters

In the below table the following abbreviations are used :

MP – Medicinal Product from the FAGG list SDP – Self Defined Product MF – Medicated Feed

The import parameters for the Import Medicinal Delivery Notification web service are as below:

Field Description Allowed Values Mandatory/Optional

XML_USER_NAME Name of the XML user who do the import via external web services.

Optional

Section : DocumentInformation (Occurs 1)

MEDM_ID Document Identifier

Mandatory in case of update actions on notifications within an existing documentLeft blank in case of creation of the document

MEDM_DOC_NBR Document numberMandatory in case the MEDM_ID is not filled

MEDM_MEDT_CDE Document type See MEDTMandatory in case the MEDM_ID is not filled

MEDM_DOC_DTE Document dateMandatory in case the MEDM_ID is not filled

MEDM_PATY_CDE Veterinary CodeMandatory in case the MEDM_ID is not filled

MEDM_FCLT_CDE Facility CodeMandatory in case the MEDM_ID is not filled

MEDM_EXT_REF_NBR External reference number

Optional



Section Medicinal Delivery Notification (Occurs 1 to N)

NODD_NOTF_ID Notification Identifier

Mandatory in case of update actionsLeft blank in case of creation

NODD_NOTF_ACT Notification action See Notification Action Mandatory

NODD_ANTP_CDE Animal Type See ANTPMandatory in case NODD_SNUN_CDE is not filled

NODD_SNUN_CDE Sanitary Unit CodeMandatory in case NODD_ANTP_CDE is not filled

NODD_ANCT_CDE Animal Category See ANCT Mandatory

NODD_STB_ID_PEN Stable(s) – ID Pen(s) Optional

NODD_HSB_CONHusbandry conditions – Biosecurity measures

Optional

NODD_ANM_BAT_ID Animal Number / Animal batch ID Optional

NODD_ANM_CNT Number of animals Optional

NODD_ANM_WGT Mean weight per animal Optional

NODD_ANM_AGE Age Optional

NODD_AGE_TMUN_CDE Age unit See TMUN Optional

NODD_FRT_DIG_PTGY_CDE First diagnosis See PTGY Optional

NODD_DIG_CMT Diagnosis comments Optional

NODD_SLF_DFN_PRD_FLG Self-defined Flag 1 or 0 Mandatory in case of SDP

NODD_CAD_FLG Cascade flag 1 or 0 Optional

NODD_IMP_FLG Import flag 1 or 0 Optional



MEPF_ACT_FAV_FLG Favorite flag 1 or 0 Optional

NODD_TRT_STA_DTE Treatment Start date Optional

NODD_TRT_DUR Treatment Duration Optional

NODD_PRD_BAT_STA_DTE Production Batch Start date Optional

NODD_SLG_DTE Slaughter date Optional

NODD_ADM_QTYVeterinary delivered or administered quantity

Optional but : Mandatory in case document type is“Prescription” or “delivery and administration document”.Mandatory in case document type is “prescription medicated feed” and all of these attributes are not filled : “Medicated feed weight”, “Premix PPM” and “Kg Premix”

NODD_MED_FED_WGT Medicated Feed Weight

Optional but : Mandatory in case document type is “Prescription Medicated Feed” and all of these attributes are not filled : “Veterinary Delivered or Administered Quantity” and “Kg Premix”



NODD_PRX_PPM Premix Ppm

Optional but : Mandatory in case “Medicated Feed Weight” is filledEmpty in case “Medicated Feed Weight” is empty

NODD_PRX_KG Kg Premix

Optional but : Mandatory in case document type is “Prescription Medicated Feed” and all of these attributes are not filled : “Veterinary Delivered or Administered Quantity”, “Medicated Feed Weight” and “Premix Ppm”

NODD_VET_ADM_QTY Veterinary administered quantity Optional

NTHS_CMN Notification History Comment Optional

Section Notification Comment (Occurs 0 to N)NOCO_CMN Notification Comment OptionalSection Medicinal Product (Occurs 1)

MEPR_NAMMedicinal Product Name (SDP only)

Optional but Mandatory in case of SDP

MEPR_RGN_HLR Registration holder(SDP only) Optional

MEPR_REG_NBR Registration number(SDP only)


MEPR_PAK_SIZ_ID Packsize ID (MP only)

Mandatory in case of MPNot filled in case of SDP

MEPR_PHFM_CDE Pharmaceutical form(SDP only) See PHFM




MEPR_PAK_QTY Packsize quantity (SDP only)


MEPR_PKUN_CDE Packsize Unit (SDP only) See PKUN


MEPR_WDR_PRD_SDP Withdrawal period(SDP only) Optional

Section Ingredient (Occurs 0 to 4)

MEPI_CDE Ingredient Code

See MEIG (refer MEIG_CDE in the attached excel in section MEIG)

Mandatory in case of SDP

MEPI_STN_QTY Strength of ingredient quantity Mandatory in case of

SDP

MEPI_SRUN_CDE Strength of ingredient unit See SRUN Mandatory in case of

SDP

3. Layout

Request:

POST /FAMHP.SanitelMed.WebServices/SanitelMedServices.asmx HTTP/1.1Host: localhostContent-Type: text/xml; charset=utf-8Content-Length: lengthSOAPAction: "http://SanitelMed.EAI/SanitelMedRepository/SanitelMedServices/ImportMedicinalDeliveryNotification"

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ImportMedicinalDeliveryNotification xmlns="http://SanitelMed.EAI/SanitelMedRepository/SanitelMedServices/MedicinalDeliveryNotification/Request"> <MedicinalDeliveryNotificationImport User="string" SecurityToken="string" OnBehalfRole="string" OnBehalfEntity="string" UserLanguage="string" XML_USER_NAME="string"


xmlns="http://SanitelMed.EAI/SanitelMedRepository/SanitelMedServices/MedicinalDeliveryNotificationImportSchema"> <DocumentInformation> <MEDM_ID>long</MEDM_ID> <MEDM_DOC_NBR>string</MEDM_DOC_NBR> <MEDM_MEDT_CDE>string</MEDM_MEDT_CDE> <MEDM_DOC_DTE>dateTime</MEDM_DOC_DTE> <MEDM_PATY_CDE>string</MEDM_PATY_CDE> <MEDM_FCLT_CDE>string</MEDM_FCLT_CDE> <MEDM_EXT_REF_NBR>string</MEDM_EXT_REF_NBR> </DocumentInformation> <MedicinalDeliveryNotification> <NODD_NOTF_ID>long</NODD_NOTF_ID> <NODD_NOTF_ACT>string</NODD_NOTF_ACT> <NODD_ANTP_CDE>string</NODD_ANTP_CDE> <NODD_SNUN_CDE>string</NODD_SNUN_CDE> <NODD_ANCT_CDE>string</NODD_ANCT_CDE> <NODD_ANM_CNT>decimal</NODD_ANM_CNT> <NODD_ANM_AGE>decimal</NODD_ANM_AGE> <NODD_AGE_TMUN_CDE>string</NODD_AGE_TMUN_CDE> <NODD_ANM_WGT>decimal</NODD_ANM_WGT> <NODD_STB_ID_PEN>string</NODD_STB_ID_PEN> <NODD_HSB_CON>string</NODD_HSB_CON> <NODD_ANM_BAT_ID>string</NODD_ANM_BAT_ID> <NODD_FRT_DIG_PTGY_CDE>string</NODD_FRT_DIG_PTGY_CDE> <NODD_DIG_CMT>string</NODD_DIG_CMT> <NODD_SLF_DFN_PRD_FLG>boolean</NODD_SLF_DFN_PRD_FLG> <NODD_CAD_FLG>boolean</NODD_CAD_FLG> <NODD_IMP_FLG>boolean</NODD_IMP_FLG> <MEPF_ACT_FAV_FLG>boolean</MEPF_ACT_FAV_FLG> <NODD_TRT_STA_DTE>dateTime</NODD_TRT_STA_DTE> <NODD_TRT_DUR>int</NODD_TRT_DUR> <NODD_PRD_BAT_STA_DTE>dateTime</NODD_PRD_BAT_STA_DTE> <NODD_SLG_DTE>dateTime</NODD_SLG_DTE> <NODD_ADM_QTY>decimal</NODD_ADM_QTY> <NODD_MED_FED_WGT>decimal</NODD_MED_FED_WGT> <NODD_PRX_PPM>decimal</NODD_PRX_PPM> <NODD_PRX_KG>decimal</NODD_PRX_KG> <NODD_VET_ADM_QTY>decimal</NODD_VET_ADM_QTY> <NTHS_CMN>string</NTHS_CMN> <MedicinalProduct> <MEPR_NAM>string</MEPR_NAM> <MEPR_RGN_HLR>string</MEPR_RGN_HLR> <MEPR_REG_NBR>string</MEPR_REG_NBR> <MEPR_PAK_SIZ_ID>string</MEPR_PAK_SIZ_ID> <MEPR_PHFM_CDE>string</MEPR_PHFM_CDE> <MEPR_PAK_QTY> decimal</MEPR_PAK_QTY> <MEPR_PKUN_CDE>string</MEPR_PKUN_CDE> <MEPR_WDR_PRD_SDP>string</MEPR_WDR_PRD_SDP> <Ingredient> <MEPI_CDE>string</MEPI_CDE> <MEPI_STN_QTY>decimal</MEPI_STN_QTY> <MEPI_SRUN_CDE>string</MEPI_SRUN_CDE> </Ingredient>


<Ingredient> <MEPI_CDE>string</MEPI_CDE> <MEPI_STN_QTY>decimal</MEPI_STN_QTY> <MEPI_SRUN_CDE>string</MEPI_SRUN_CDE> </Ingredient> </MedicinalProduct> <NotificationComment> <NOCO_CMN>string</NOCO_CMN> </NotificationComment> </MedicinalDeliveryNotification> <MedicinalDeliveryNotification> <NODD_NOTF_ID>long</NODD_NOTF_ID> <NODD_NOTF_ACT>string</NODD_NOTF_ACT> <NODD_ANTP_CDE>string</NODD_ANTP_CDE> <NODD_SNUN_CDE>string</NODD_SNUN_CDE> <NODD_ANCT_CDE>string</NODD_ANCT_CDE> <NODD_ANM_CNT>decimal</NODD_ANM_CNT> <NODD_ANM_AGE>decimal</NODD_ANM_AGE> <NODD_AGE_TMUN_CDE>string</NODD_AGE_TMUN_CDE> <NODD_ANM_WGT>decimal</NODD_ANM_WGT> <NODD_STB_ID_PEN>string</NODD_STB_ID_PEN> <NODD_HSB_CON>string</NODD_HSB_CON> <NODD_ANM_BAT_ID>string</NODD_ANM_BAT_ID> <NODD_FRT_DIG_PTGY_CDE>string</NODD_FRT_DIG_PTGY_CDE> <NODD_DIG_CMT>string</NODD_DIG_CMT> <NODD_SLF_DFN_PRD_FLG>boolean</NODD_SLF_DFN_PRD_FLG> <NODD_CAD_FLG>boolean</NODD_CAD_FLG> <NODD_IMP_FLG>boolean</NODD_IMP_FLG> <MEPF_ACT_FAV_FLG>boolean</MEPF_ACT_FAV_FLG> <NODD_TRT_STA_DTE>dateTime</NODD_TRT_STA_DTE> <NODD_TRT_DUR>int</NODD_TRT_DUR> <NODD_PRD_BAT_STA_DTE>dateTime</NODD_PRD_BAT_STA_DTE> <NODD_SLG_DTE>dateTime</NODD_SLG_DTE> <NODD_ADM_QTY>decimal</NODD_ADM_QTY> <NODD_MED_FED_WGT>decimal</NODD_MED_FED_WGT> <NODD_PRX_PPM>decimal</NODD_PRX_PPM> <NODD_PRX_KG>decimal</NODD_PRX_KG> <NODD_VET_ADM_QTY>decimal</NODD_VET_ADM_QTY> <NTHS_CMN>string</NTHS_CMN> <MedicinalProduct> <MEPR_NAM>string</MEPR_NAM> <MEPR_RGN_HLR>string</MEPR_RGN_HLR> <MEPR_REG_NBR>string</MEPR_REG_NBR> <MEPR_PAK_SIZ_ID>string</MEPR_PAK_SIZ_ID> <MEPR_PHFM_CDE>string</MEPR_PHFM_CDE> <MEPR_PAK_QTY>decimal</MEPR_PAK_QTY> <MEPR_PKUN_CDE>string</MEPR_PKUN_CDE> <MEPR_WDR_PRD_SDP>string</MEPR_WDR_PRD_SDP> <Ingredient> <MEPI_CDE>string</MEPI_CDE> <MEPI_STN_QTY>decimal</MEPI_STN_QTY> <MEPI_SRUN_CDE>string</MEPI_SRUN_CDE> </Ingredient> <Ingredient>


<MEPI_CDE>string</MEPI_CDE> <MEPI_STN_QTY>decimal</MEPI_STN_QTY> <MEPI_SRUN_CDE>string</MEPI_SRUN_CDE> </Ingredient> </MedicinalProduct> <NotificationComment> <NOCO_CMN>string</NOCO_CMN> </NotificationComment> </MedicinalDeliveryNotification> </MedicinalDeliveryNotificationImport> </ImportMedicinalDeliveryNotification> </soap:Body></soap:Envelope>

4. Export parameters

For the success response, the following parameters are displayed.

4.1Structure

4.2Example

If there is validation error in the response the following parameters are displayed:


1. User Code Values

1.1MEIG


1.2ANTP

CODE

DESCRIPTION_EN

DESCRIPTION_NL

DESCRIPTION_FR

DESCRIPTION_DE

BOV Bovine Rund Bovin RindPIG Pigs Varken Porcin SchweinPLTR Poultry Pluimvee Volaille Geflügel

1.3ANCT

CODEDESCRIPTION_EN DESCRIPTION_NL

DESCRIPTION_FR

DESCRIPTION_DE

BOVAB

Bovine adult BEEF

Rund volwassen Vlees

Bovin adulte viande

Ausgewachsene Fleischrinder

BOVAD

Bovine adult DAIRY

Rund volwassen melk

Bovin adulte lait

Ausgewachsene Milchrinder

BOVYS

Bovine young stock (between 8 and 24 months old)

Rund jongvee (tussen 8 en 24 maand)

Jeunes Bovins (entre 8 et 24 mois)

Rinderjungvieh (zwischen 8 und 24 Monaten)

BROIR Broiler Vleeskip Poulet de chair Masthähnchen

CAF8M

Calf (less than 8 months old)

Kalf (jonger dan 8 maand)

veau (moins de 8 mois)

Kalb (weniger als 8 Monate alt)

GILT Gilt Gelt cochette Jungsau

LAYIH Laying hen LegkipPoule pondeuse Legehenne

PIGLU Piglet unweaned Big niet gespeendPorcelet non sevré

Nicht abgesetzte Ferkel

PIGLW Piglet weaned big gespeend Porcelet sevré

Abgesetzte Ferkel

PIGB Pigs for Breeding Fokvarkens Porcs d'élevage Zuchtschweine

PIGFPigs for Fattening Vleesvarkens Porcs d'engrais Mastschweine

VECLF Vealcalf VleeskalfVeaux de boucherie Schlachtkalb

CODEDESCRIPTION_EN DESCRIPTION_NL

DESCRIPTION_FR

DESCRIPTION_DE


DELAD

Delivery and Administration Document

Toedienings - en verschaffingsdocument

Document d'administration et de fourniture

Dokument der Abgabe und Verschreibung

PRESN Prescription Voorschrift Precription Verschreibung

PREMF

Prescription Medicated Feed

Voorschrift gemedicineerd voeder

Prescription des aliments médicamenteux

Verschreibung der Arzneifuttermittel


1.4MEDT

CODE

DESCRIPTION_EN DESCRIPTION_NL

DESCRIPTION_FR

DESCRIPTION_DE

DELAD

Delivery and Administration Document

Toedienings - en verschaffingsdocument

Document d'administration et de fourniture

Dokument der Abgabe und Verschreibung

PRESN Prescription Voorschrift Precription Verschreibung

PREMF

Prescription Medicated Feed

Voorschrift gemedicineerd voeder

Prescription des aliments médicamenteux

Verschreibung der Arzneifuttermittel

1.5TMUN

CODE DESCRIPTION_EN DESCRIPTION_NL DESCRIPTION_FR DESCRIPTION_DEDAY Day Dag Jour TagMONT Month Maand Mois MonatWEEK Week Week Semaine WocheYEAR Year Jaar Année Jahr

1.6PHFM

CODE DESCRIPTION_EN DESCRIPTION_NL DESCRIPTION_FR DESCRIPTION_DEBOLUS Bolus Bolus Bolus BolusINJ Injection Injectie Injection InjektionINTRA Intramammary Intramammair Intramammaire Intramammär

INRDCIntramammary dry cow treatment

Droogzet therapie Tarissement

Intramammär Trockenstellen

INTRPIntrauterine preparations

Intra uterien preparaat

préparation intra utérine

Formulierung zur intrauterinen Anwendung

NODEF Not Defined

ORLPS Oral pasta Orale pasta Pâte oralePasta zum Einnehmen


ORLPR Oral powder Oraal poeder Poudre oralePulver zum Einnehmen

ORLS Oral solution Orale oplossing Solution oraleLösung zum Einnehmen

PRMIX Premix Premix Prémix Vormischung

TABL Tablets, capsules Tablet, capsuleComprimé , capsule Tabletten, Kapsel

1.7PKUN

CODE DESCRIPTION_EN DESCRIPTION_NL DESCRIPTION_FR DESCRIPTION_DEG G G G gKG KG KG KG kgL L L L lMG MG mg mg mgML ML ml ml mlPIECP PIECE STUK Pièce Stück

1.8SRUN

CODE DESCRIPTION_EN DESCRIPTION_NL DESCRIPTION_FR DESCRIPTION_DEG/KGK G/KG G/KG G/KG g/kgG/L G/L G/L G/L g/lG/PIE G/PIECE G/PIECE G/PIECE g/StückIU IU IU/G IU/G IU/G IU/G iu/gIU/KK IU/KG IU/KG IU/KG iu/kgIU/ML IU/ML IU/ML IU/ML iu/mlIUPCE IU/PIECE IU/PIECE IU/PIECE iu/StückMG MG MG/G MG/G MG/MG MG/MG MG/ML MG/ML MG/PP MG/PIECE MG/PIECE MG/PIECE mg/StückNODEF Not Defined µG/ML µG/ML


1.9PTGY

CODE DESCRIPTION_EN DESCRIPTION_NL DESCRIPTION_FRDESCRIPTION_DE

ATRHS Atrophic rhinitis Atrofische rhinitisRhinite atrophique

Atrophische Rhinitis

BAENT Bacterial enteritis Bacteriële enteritisEntérite bactérielle

Bakterielle Enteritis

COLIS Colibacillosis Colibacillosis Colibacillosis KolibazilloseCORY Coryza Coryza Coryza Schnupfen

SPIJNDigestive disorders Spijsverteringsstoornissen Troubles digistifs

Verdauungsstörungen

DROE Dry therapy Droogzettherapie Tarissement TrockenstellenDYSE Dysenteria Dysenterie Dysentérie Dysenterie

EXSESExudative epidermitis Exsudatieve epidermitis

Epidermite exudative

Exsudative Epidermitis

OOGPM Eye disorders oogproblemen

Troubles oculaires

Augenkrankheiten

ALGSAGeneral disorders / others

algemene stoornissen/andere

troubles généraux / autres

Allgemeine Störungen/Sonstige

INTAC

Intestinal adenomatosis complex (PIA)

Intestinaal adenomatose complex (PIA)

Adénomatose intestinale porcine (Iléite)

Intestinaler Adenomatose-Komplex (PIA)

LOCANLocomotor disorders

locomotorische aandoeningen

Troubles locomotrices

Erkrankungen des Bewegungsapparates

MAST Mastitis mastitis Mammite Mastitis

MYCMS Mycoplasmosis MycoplasmoseInfections à Mycoplasme Mycoplasmose

NEENT Necrotic enteritis Necrotiserende enteritisEntérite nécrotique

Nekrotische Enteritis

ZENTUNervous system disorders zenuwstoornissen for

Störungen des Nervensystems

ORTI ORT infection ORT infectie Infection ORT ORT-Infektion

PERBGPeri-operative treatment

Peri-operatieve behandeling

Traitement péri-opérative

Perioperative Behandlung


PLEUEPleuropneumoniae (APP) Pleuropneumonie (APP)

Pleuropneumonie (APP)

Pleuropneumoniae (APP)

ADSENRespiratory problems

Ademhalingsaandoeningen

Troubles respiratoires

Atmungsprobleme

HUIDN Skin disorders huidaandoeningenTroubles de la peau

Hauterkrankungen

UROANUrogenital disorders urogenitale aandoeningen

Maladies urogénitales

Urogenitale Erkrankungen

1.10 Notification Action

CODE DESCRIPTION

SENT Set to Entered

SVE Save

APT Accept

REF Refuse

CAN Cancel


import medicinal delivery notification - fagg · web viewgeneral new web service that allows: - to...

Documents