PharmaPortal Offerteaanvragen details API

Request

Requests zijn GET requests.

Response

Deze API retourneert de volgende HTTP status codes:

• 401 Bij foutieve authenticatie of HMAC
• 200 Bij een correct request

Voorbeeld van een response bij een succesvol & correct request:

{
	"result": "success",
	"data": {
		"id": "ronde-x-1",
		"status": "nieuw",
		"omschrijving": "Ronde X",
		"ingangsdatumContracten": "2019-02-01T00:00:00+01:00",
		"sluitingsdatumOfferte": "2018-10-13T00:00:00+02:00",
		"datumBesluitvorming": "2018-12-02T00:00:00+01:00",
		"piCodeCoordinator": 630001,
		"isLeveringDirectToegestaan": true,
		"isLeveringGroothandelToegestaan": true,
		"looptijdenMaanden": [12, 24, 36],
		"verbruikcijfersJaar": 2018,
		"isOnlineIndienenOfferteToegestaan": true,
		"onlineOfferteIndienenCode": "q712k4hh4l1",
		"offerteAanvraagOntvangenOp": "2018-04-10T17:18:31+02:00",
		"isStaffelToegestaan" => false,
		"mandaatPublicatieUrl" => "https://url-naar-mandaat-publicatie/mandaten.json", // Zie mandaten API documentatie
		"toeslagOffreren": false,
		"toeslagOmschrijving": "",
		"vragenLijst": [
			{
				"id": "07ad0b4b-2e89-40c7-a9c6-43ebefefaa5f",
				"vraag": "Testvraag 1",
				"perZindexNummer": false,
				"soortVraag": "tekst"
			},
			{
				"id": "3f52ca72-16a7-49a0-9a87-acdbde4e9712",
				"vraag": "Testvraag 2",
				"perZindexNummer": true,
				"soortVraag": "meerkeuze",
				"keuzes": [
					"ja",
					"nee"
				]
			},
			{
				"id": "29b7cb44-d116-4878-8ce7-a94a756cd1fb",
				"vraag": "Testvraag 3",
				"perZindexNummer": false,
				"soortVraag": "meerkeuze",
				"keuzes": [
					"optie 1",
					"optie 2",
					"optie 3",
				]
			},
			{
				"id": "29b7cb44-d116-4878-8ce7-a94a756cd1fe",
				"vraag": "Testvraag 4",
				"perZindexNummer": true,
				"soortVraag": "tekst"
			},
			{
				"id": "29b7cb44-d116-4878-8ce7-a94a756cd1fc",
				"vraag": "Testvraag 5",
				"perZindexNummer": false,
				"soortVraag": "numeriek"
			},
			{
				"id": "29b7cb44-d116-4878-8ce7-a94a756cd1fd",
				"vraag": "Testvraag 5",
				"perZindexNummer": true,
				"soortVraag": "datum" // Antwoord wordt verwacht als YYYY-MM-DD
			}
		],
		"deelnemers": [{
			"PiCode": 630000,
			"Naam": "UNIVERSITAIR MEDISCH CENTRUM X",
			"Adres": "Ergensweg 12",
			"Woonplaats": "Nergenshoven",
			"Postcode": "1234AB",
			"Postbus": "",
			"Agb": "06020101",
			"Gln": null,
			"Soort": 2,
			"Telefoonnummer": "050-3616161",
			"IsActief": true,
			"Slug": "universitair-medisch-centrum-x",
			"contactpersoon": {
				"InkooprondeId": 18,
				"PiCode": 630000,
				"LogoFilename": null,
				"Naam": "Dhr. X Inkoper",
				"Functie": "inkoper ",
				"Adres": "Ergensweg 12",
				"Postcode": "1234 AB",
				"Postbus": "944",
				"Plaats": "Nergenshoven",
				"Locatie": "Ruimte 123 ",
				"Telefoonnummer": "020-123457",
				"Email": "j.petersen@umcx.nl"
			}
		}, (...)
		}],
		"pakketten": [{
			"atc": "A02BC01",
			"pakkethouder": 630001,
			"deelnemers": ["630002", (...)]
		},(...)],
		"documenten": [{
			"uuid": "03acf4d3-0e50-41af-9414-9fb0e604b306",
			"titel": "Offertebrief",
			"contentType": "application/pdf"
		}, // / Te downloaden via https://www.pharma-portal.nl/api/offerte-aanvraag/[id van aanvraag]/documenten/[uuid]
		(...)],
		"verbruik": [{
			"prk": 1775,
			"aantalStuks": 6302
		}, (...) ],
		"verbruikVerpakkingsNiveau": [{
			"prk": 1775,
			"deelverpakkingOmschrijvingKode": 47,
			"aantalStuks": 6302
		}, (...)],
		"acceptaties": [{   # Bestaat alleen als status = besluitvorming afgerond
		    "zindexNummer": 16182383,
		    "piCode": 871001,
		    "route": "direct", # direct | groothandel
		    "looptijdMaanden": 12,
		    "ingangsDatum": "2019-02-01T00:00:00+01:00",
		    "eindDatum": "2020-01-31T00:00:00+01:00",
		    "looptijdMaanden": 12,
		    "vastOfPercentage": "vast", # vast | percentage,
		    "percentage": 5.00, # 0 bij vastOfPercentage = vast
		    "bedrag": 5.00, # 0 bij vastOfPercentage = percentage
			"terugkoppeling_aan_leverancier": "Een optionele reactie vanuit apotheken op de offerteregel", # Default leeg
		}, (...)]
	}
}

Aandachtspunten

Indien u uw integratie wilt testen neemt u tijdig contact met ons op via info@zagis.nl. Wij zetten dan testdata voor u klaar en voorzien u van API-Key.

De key acceptaties bestaat alleen als er vanuit ZAGIS besluitvorming is verstuurd naar PharmaPortal (Ziekenhuizen hebben een keuze gemaakt). Als de key wel bestaan maar een lege array [] is hebben de ZAGIS gebruikers geen keuze gemaakt voor een ingestuurde offerte.