Prescription¶

Before your start¶

To access this API (method) you need to be logged in to the Bricks Switchboard. Each request needs to contain:

<Identificatie xsi:type="OZB_Communicatie_Identificatie_GebruikerSessie" Id="-1001">
  <Sessie>[current session id]</Sessie>
</Identificatie>

When you have a server token to access the API method this identification looks like this:

<Identificatie xsi:type="OZB_Communicatie_Identificatie_Servertoken" Id="-1001">
  <Token>[token id]</Token>
</Identificatie>

Practice code needed

To successfully store data in Bricks Huisarts using the API you need to add a <OntvangerEntiteit /> to the request.

<His_Example>
  <Identificatie />
  <OntvangerEntiteit>[practice code]</OntvangerEntiteit>
  ...
</His_Exmaple>

The practice code be found in the setup documentation. In case you know the practice AGB-code this can also be used to send the request to the corresponding practice.

Get list of all medication¶

Request¶

<His_GetMedicatieProfiel_Verzoek xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Id="-1000">
  <Identificatie xsi:type="OZB_Communicatie_Identificatie_GebruikerSessie" Id="-1001">
    <Sessie>[session token]</Sessie>
  </Identificatie>
  <OntvangerEntiteit>[practice code]</OntvangerEntiteit>
</His_GetMedicatieProfiel_Verzoek>

Response¶

Overview of medication that can be renewed:

<?xml version="1.0" encoding="utf-16"?>
<His_GetMedicatieProfiel_Antwoord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Id="-1001">
  <CommunicatieStatus>OZB_Communicatie_Status_Verzoek_is_geslaagd</CommunicatieStatus>
  <StatusTekst>OK.</StatusTekst>
  <Profiel Id="-1001">
    <Regels>
      <His_MedicatieProfiel_Regel Id="310704">
        <Voorschrift Id="310704">
          <Product Id="-1001">
            <MedicatieOmschrijving>JODIUM/NATRIUMJODIDE OPL CUTAAN 10/12,5MG/G</MedicatieOmschrijving>
            <Voorschrijfniveau>ZIndex_Voorschrijfniveau_VoorschrijfProduct</Voorschrijfniveau>
            <ATC>D08AG03</ATC>
            <ATCOmschrijving>JODIUM</ATCOmschrijving>
            <GPK>108758</GPK>
            <GPKOmschrijving>JODIUM/NATRIUMJODIDE OPL CUTAAN 10/12,5MG/G</GPKOmschrijving>
            <PRK>13579</PRK>
            <PRKOmschrijving>JODIUM/NATRIUMJODIDE OPL CUTAAN 10/12,5MG/G</PRKOmschrijving>
            <PRKAlsHPK>261858</PRKAlsHPK>
            <PRKAlsHPKOmschrijving>JODIUM 1% ALC OPL FNA</PRKAlsHPKOmschrijving>
          </Product>
          <Dosering Id="-1001">
            <Aantal1000>100000</Aantal1000>
            <Code>10D10GR</Code>
            <DoseringOmschrijving>10 maal per dag 10 gram</DoseringOmschrijving>
            <VoorschriftType>His_VoorschriftType_Onbekend</VoorschriftType>
            <AantalHerhalingen>0</AantalHerhalingen>
            <StartDatum>2010-10-10T00:00:00</StartDatum>
            <VerwachteEinddatum>2010-10-10T00:00:00</VerwachteEinddatum>
            <BasiseenheidProduct>OZB_NietGevuld</BasiseenheidProduct>
            <EenheidGebruiksadvies>OZB_NietGevuld</EenheidGebruiksadvies>
          </Dosering>
          <RedenVoorschrijven>OZB_NietGevuld</RedenVoorschrijven>
          <Opmerking />
          <BlijvendBewaken>false</BlijvendBewaken>
          <SpecialistMedicatie>OZB_NietGevuld</SpecialistMedicatie>
          <RegelMutatie>OZB_NietGevuld</RegelMutatie>
          <RegelNummer />
        </Voorschrift>
        <RegelType>Chronisch</RegelType>
      </His_MedicatieProfiel_Regel>
    </Regels>
  </Profiel>
</His_GetMedicatieProfiel_Antwoord>

Renew medication¶

First get a list of medication that can be renewed (see above). After that you can copy the full “Voorschrift” from the response to renew the medication.

In case the HPK and PRK both have the value -1 it isn’t possible to renew the prescripion. Most of the times this is due to the fact that the medication isn’t available anymore according to the Z-index.

The request for a prescription renewal looks like this:

Request¶

<?xml version="1.0" encoding="utf-16"?>
<His_ReceptAanvraag_Verzoek xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Id="-1000">
  <Identificatie xsi:type="OZB_Communicatie_Identificatie_GebruikerSessie" Id="-1001">
    <Sessie>[session token]</Sessie>
  </Identificatie>
  <OntvangerEntiteit>[practice code]</OntvangerEntiteit>
  <Recept Id="-1000">
    <Datum>0001-01-01T00:00:00</Datum>
    <PatientAdministratief Id="-1000">
      <Geslacht>OZB_NietGevuld</Geslacht>
      <Geboortedatum>0001-01-01T00:00:00</Geboortedatum>
      <Praktijk Id="-1000">
        <Adres Id="-1000">
          <Landcode>OZB_NietGevuld</Landcode>
        </Adres>
        <Telefoonnummers />
      </Praktijk>
      <Telefoonnummers />
      <Naam Id="-1000">
        <NaamGebruik>OZB_NietGevuld</NaamGebruik>
      </Naam>
      <Woonadres Id="-1001">
        <Landcode>OZB_NietGevuld</Landcode>
      </Woonadres>
      <RedenInschrijving>OZB_NietGevuld</RedenInschrijving>
      <RedenUitschrijving>OZB_NietGevuld</RedenUitschrijving>
      <Inschrijfdatum>0001-01-01T00:00:00</Inschrijfdatum>
      <Uitschrijfdatum>0001-01-01T00:00:00</Uitschrijfdatum>
      <StandaardBezorgen>false</StandaardBezorgen>
      <Zorgverleners />
      <HoofdbehandelaarId>0</HoofdbehandelaarId>
      <Woonverbandnummer>0</Woonverbandnummer>
      <IsOverleden>false</IsOverleden>
      <Overlijdensdatum>0001-01-01T00:00:00</Overlijdensdatum>
      <IsIngeschreven>false</IsIngeschreven>
      <SoortPatient>OZB_NietGevuld</SoortPatient>
      <Categorieen />
      <Metagegevens />
      <OokBekendAls />
      <Memos />
    </PatientAdministratief>
    <Recepttype>OZB_NietGevuld</Recepttype>
    <Apotheek Id="-1000">
      <Adres Id="-1002">
        <Landcode>OZB_NietGevuld</Landcode>
      </Adres>
      <Telefoonnummers />
    </Apotheek>
    <AutorisatieNodig>false</AutorisatieNodig>
    <Voorschrijver Id="-1000" />
    <Voorschriften>
      <ZIndex_Voorschrift Id="698964">
        <Product Id="-1057">
          <MedicatieOmschrijving>OXAZEPAM TABLET 50MG</MedicatieOmschrijving>
          <Voorschrijfniveau>ZIndex_Voorschrijfniveau_VoorschrijfProduct</Voorschrijfniveau>
          <ATC>N05BA04</ATC>
          <ATCOmschrijving>OXAZEPAM</ATCOmschrijving>
          <GPK>20257</GPK>
          <GPKOmschrijving>OXAZEPAM TABLET 50MG</GPKOmschrijving>
          <PRK>7285</PRK>
          <PRKOmschrijving>OXAZEPAM TABLET 50MG</PRKOmschrijving>
          <PRKAlsHPK>1517295</PRKAlsHPK>
          <PRKAlsHPKOmschrijving>OXAZEPAM ACCORD 50MG TABLET</PRKAlsHPKOmschrijving>
        </Product>
        <Dosering Id="-1057">
          <Aantal1000>10000</Aantal1000>
          <Code>1d1t</Code>
          <DoseringOmschrijving>1 maal per dag 1 tablet</DoseringOmschrijving>
          <VoorschriftType>His_VoorschriftType_Chronisch</VoorschriftType>
          <AantalHerhalingen>0</AantalHerhalingen>
          <StartDatum>2014-04-02T14:30:16</StartDatum>
          <VerwachteEinddatum>2014-04-12T14:30:16</VerwachteEinddatum>
          <BasiseenheidProduct>ZIndex_BasiseenheidProduct_Stuk</BasiseenheidProduct>
          <EenheidGebruiksadvies>OZB_NietGevuld</EenheidGebruiksadvies>
        </Dosering>
        <RedenVoorschrijven>NHG_ICPC_Angststoornis_angsttoestand</RedenVoorschrijven>
        <Opmerking />
        <BlijvendBewaken>false</BlijvendBewaken>
        <SpecialistMedicatie>OZB_NietGevuld</SpecialistMedicatie>
        <RegelMutatie>OZB_NietGevuld</RegelMutatie>
        <RegelNummer />
      </ZIndex_Voorschrift>
    </Voorschriften>
    <Afhandeling>OZB_NietGevuld</Afhandeling>
    <Commentaar>Extra comments</Commentaar>
  </Recept>
</His_ReceptAanvraag_Verzoek>

Response¶

<?xml version="1.0" encoding="utf-16"?>
<His_ReceptAanvraag_Antwoord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Id="-1005">
  <CommunicatieStatus>OZB_Communicatie_Status_Verzoek_is_geslaagd</CommunicatieStatus>
  <UitgebreideStatus />
  <NieuwReceptNummer>499406</NieuwReceptNummer>
</His_ReceptAanvraag_Antwoord>

Last update: 29-01-2024