Claimregels per claim¶

GET Haal de lijst met regels per claim op uit PharmaPortal.

Voor gebruikers van PharmaPortal is het mogelijk om via een API vanuit een eigen systeem de lijst met regels per claim op te vragen uit PharmaPortal. Dit is een REST-API met één endpoint en één actie.

Toegang

Alleen beschikbaar voor licentiehouders van PharmaPortal.

Endpoint¶

TestProductie

GET https://demo.pharma-portal.nl/api/claims/regels/{claimID}

GET https://www.pharma-portal.nl/api/claims/regels/{claimID}

Parameter	In	Type	Verplicht	Omschrijving
`claimID`	pad	string	ja	Claim-ID; op te halen via de claim-lijst-API.

Authenticatie¶

Deze API maakt gebruik van IP-whitelisting en een API-key. Stuur de header mee:

Header	Toelichting
`x-portal-key`	De aan uw organisatie uitgereikte API-key.

Request¶

Requests zijn GET-requests.

curl https://demo.pharma-portal.nl/api/claims/regels/8711722006004-1-brocacef-3 \
  -H "x-portal-key: <uw-api-key>"

Response¶

Code	Betekenis
`200`	Correct request.
`401`	Foutieve authenticatie of HMAC.

Voorbeeld van een succesvolle response:

{
  "claim": "8711722006004-1-brocacef-3",
  "numRegels": 53,
  "regels": [
    {
      "Regelnummer": 1, # Regelnummer uit de claim
      "RegelType": 'D', # Regeltype conform FIX specificatie
      "DatumVan": '2019-02-01', # Begindatum claimperiode
      "DatumTot": '2019-02-28', # Einddatum claimperiode
      "IdfKlant": "8154", # IDF van klant
      "GlnKlant": "", # GLN van klant
      "NaamKlant": "St.A. van Leeuwenhoek afdeling", # naam klant volgens groothandel
      "KlantId": 631205, # PI Code van gekoppelde klant
      "Gtin": "5055565719534", # GTIN van product
      "ZindexNummer": 16233123, # ZI# van product
      "ArtnrLeverancier": "", # Artikelnummer leverancier van product
      "EtiketNaam": "Temozolomide@ harde caps 180mg  acc", # Omschrijving van product
      "Eenheid1": "5", # Verpakkingshoeveelheid
      "Eenheid2": "ST", # Verpakkingseenheid
      "ContractPrijsCenten": 1010, # Contractprijs in centen  # Zie FIX specificatie
      "Kortingspercentage1Basispunten": 0, # Zie FIX specificatie
      "Kortingspercentage2Basispunten": 0, # Zie FIX specificatie
      "InkoopPrijsCenten": 1501, # GIP Prijs Zie FIX specificatie
      "ClaimpercentageBasispunten": 0, # Claim %, Zie FIX specificatie
      "ClaimbedragCenten": 75,  # Claimbedrag in centen, Zie FIX specificatie
      "AantalVerpakkingenGeleverd": 10, # Aantal verpakkingen geleverd
      "Claim1BedragCenten": 5000, # Zie FIX specificatie
      "Claim2BedragCenten": 751, # Zie FIX specificatie
      "ClaimTotaalBedragCenten": 5751, # Zie FIX specificatie
      "ClaimPeriode": {
        "date": "2019-02-01 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe\/Amsterdam"
      }, # Ingangsdatum van claimperiode, uit claimbestand
      "ClaimGrondslag": "G",  # Grondslag [G]IP, [T]ransactie of [A]IP, Zie FIX specificatie
      "IsContractprijsCorrect": true, # Is contract correct volgens PharmaPortal
      "IsInkoopprijsCorrect": false, # Is GIP correct volgens PharmaPortal
      "IsGeaccordeerd": false, # Is regel akkoord
      "AkkoordSoort": 0, # 0 = Niet akkoord, 1 = Automatisch akkoord, 2 = Akkoord na interventie medewerker
      "AipBedragCenten": 51400 # AIP op moment van verstrekken
    },(...)
]
}

Velden¶

Veld	Type	Omschrijving
`claim`	string	Claim-ID zoals opgevraagd.
`numRegels`	integer	Aantal claimregels.
`regels`	object[]	De claimregels (zie hieronder).

Velden per regel:

Veld	Type	Omschrijving
`Regelnummer`	integer	Regelnummer uit de claim.
`RegelType`	string	Regeltype conform FIX-specificatie.
`DatumVan`	string	Begindatum claimperiode.
`DatumTot`	string	Einddatum claimperiode.
`IdfKlant`	string	IDF van klant.
`GlnKlant`	string	GLN van klant.
`NaamKlant`	string	Naam klant volgens groothandel.
`KlantId`	integer	PI-Code van gekoppelde klant.
`Gtin`	string	GTIN van product.
`ZindexNummer`	integer	ZI-nummer van product.
`ArtnrLeverancier`	string	Artikelnummer leverancier van product.
`EtiketNaam`	string	Omschrijving van product.
`Eenheid1`	string	Verpakkingshoeveelheid.
`Eenheid2`	string	Verpakkingseenheid.
`ContractPrijsCenten`	integer	Contractprijs in centen (zie FIX-specificatie).
`Kortingspercentage1Basispunten`	integer	Zie FIX-specificatie.
`Kortingspercentage2Basispunten`	integer	Zie FIX-specificatie.
`InkoopPrijsCenten`	integer	GIP-prijs (zie FIX-specificatie).
`ClaimpercentageBasispunten`	integer	Claimpercentage (zie FIX-specificatie).
`ClaimbedragCenten`	integer	Claimbedrag in centen (zie FIX-specificatie).
`AantalVerpakkingenGeleverd`	integer	Aantal verpakkingen geleverd.
`Claim1BedragCenten`	integer	Zie FIX-specificatie.
`Claim2BedragCenten`	integer	Zie FIX-specificatie.
`ClaimTotaalBedragCenten`	integer	Zie FIX-specificatie.
`ClaimPeriode`	object	Ingangsdatum van claimperiode, uit claimbestand.
`ClaimGrondslag`	string	Grondslag: [G]IP, [T]ransactie of [A]IP (zie FIX-specificatie).
`IsContractprijsCorrect`	boolean	Is contract correct volgens PharmaPortal.
`IsInkoopprijsCorrect`	boolean	Is GIP correct volgens PharmaPortal.
`IsGeaccordeerd`	boolean	Is regel akkoord.
`AkkoordSoort`	integer	0 = niet akkoord, 1 = automatisch akkoord, 2 = akkoord na interventie medewerker.
`AipBedragCenten`	integer	AIP op moment van verstrekken.

Aandachtspunten

Wilt u uw integratie testen? Neem tijdig contact op via info@zagis.nl. Wij zetten dan testdata voor u klaar en voorzien u van een API-key.