Agenda¶

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.

Finding a patient with a free query¶

Warning

Be careful with this API option, with the options it is possible that patient information is getting into the wrong hands! Only use the ‘free query’ for users that have access to all the data in the practice.

Request¶

<His_ZoekPatient_Vrij_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>
  <Query>090286</Query>
  <OokMeisjesnaam>false</OokMeisjesnaam>
  <OokStraat>false</OokStraat>
  <OokInactief>false</OokInactief>
</His_ZoekPatient_Vrij_Verzoek>

Response¶

<His_ZoekPatient_Vrij_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>
  <ObjectOmschrijvingen>
    <OZB_Communicatie_ObjectOmschrijving Id="10263">
    <KorteOmschrijving>Dhr. AAAAA aaaa (27) 9-2-1986 OOS Geuldalweg11 Meerssen</KorteOmschrijving>
  </OZB_Communicatie_ObjectOmschrijving>
  </ObjectOmschrijvingen>
</His_ZoekPatient_Vrij_Antwoord>

Get patient details¶

Request¶

<His_GetPatientAdministratief_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>
  <ObjectId>157058</ObjectId>
</His_GetPatientAdministratief_Verzoek>

Response¶

The response contains a lot of data. When getting the patients name and date of birth you’ll need:

Node	Result	Example / comment
<Geboortedatum/>	Date of birth	1995-06-10T00:00:00
<Geslacht />	Male / Female	Male (NHG_Geslacht_Man) / Female (NHG_Geslacht_Vrouw)
<Voornaam />	Call name
<Voorletters/>	Initials
<TussenvoegselEigennaam/>	Family name prefix
<Eigennaam />	Family name

Find appointments for this patient¶

Request¶

<Tetra_Agenda_GetPatientAfspraken_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>
</Tetra_Agenda_GetPatientAfspraken_Verzoek>

Node	Comment
<OntvangerEntiteit />	Optional
<PatientId />	Optional

Response¶

<Tetra_Agenda_GetPatientAfspraken_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>
  <Afspraken>
    <Tetra_Agenda_Afspraak Id="213769">
      <PatientId>10263</PatientId>
      <AgendaId>10048</AgendaId>
      <Start>2013-04-10T13:20:00</Start>
      <Eind>2013-04-10T13:30:00</Eind>
      <PortaalAfspraak>true</PortaalAfspraak>
      <GemaaktDoorPraktijk>false</GemaaktDoorPraktijk>
      <Opmerkingen>Appointment remark</Opmerkingen>
    </Tetra_Agenda_Afspraak>
  </Afspraken>
</Tetra_Agenda_GetPatientAfspraken_Antwoord>

Node	Comment
<PortaalAfspraak />	Appointment made using portal/Switchboard (true / false)
<GemaaktDoorPraktijk />	Appointment made by practice in HIS (true / false)
<Opmerkingen />	Appointment text

Create an appointment¶

Request (based on patient ID)¶

Create an appointment (default).

<Tetra_Agenda_MaakAfspraak_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>
  <PatientId>10263</PatientId>
  <Opmerkingen>Headache</Opmerkingen>
  <Start>2013-04-16T00:20:00</Start>
  <Eind>0001-01-01T00:00:00</Eind>
  <AgendaId>10048</AgendaId>
  <AnoniemePatientId>0</AnoniemePatientId>
</Tetra_Agenda_MaakAfspraak_Verzoek>

Request (based on patient match)¶

Create an appointment and let the API try to connect the appointment to a existing Bricks Huisarts patient.

<Tetra_Agenda_MaakAfspraak_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_Servertoken" Id="-1001">
    <Sessie>[session token]</Sessie>
  </Identificatie>
  <ZenderIP>172.26.4.11</ZenderIP>
  <OntvangerEntiteit>[practice code]</OntvangerEntiteit>
  <PatientId>0</PatientId>
  <PatientNAW Id="-1000">
    <Geslacht>NHG_Geslacht_Man</Geslacht>
    <Geboortedatum>1980-01-01T00:00:00</Geboortedatum>
    <Telefoonnummers />
    <Naam Id="-1000">
      <NaamGebruik>OZB_NietGevuld</NaamGebruik>
      <Eigennaam>johnson</Eigennaam>
    </Naam>
  </PatientNAW>
  <Opmerkingen>Sore throat</Opmerkingen>
  <Start>2015-11-26T09:00:00</Start>
  <Eind>2015-11-26T09:10:00</Eind>
  <AgendaId>10082</AgendaId>
</Tetra_Agenda_MaakAfspraak_Verzoek>

When <PatientID /> contains a zero this means that the appointment will be made for a patient that does not exists in the system. To make this work the system needs one active(!) patient with the with the following data:

Lastname	Afspraak
Category	Nooit factureren

It can take up to 24 hours before this patient is active on the API.

Response¶

<Tetra_Agenda_MaakAfspraak_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>
  <Transactiestatus>OZB_NietGevuld</Transactiestatus>
  <AgendaStatus>OZB_NietGevuld</AgendaStatus>
  <WisToken>12345AAAAAAAA123</WisToken>
  <AfspraakId>147002</AfspraakId>
</Tetra_Agenda_MaakAfspraak_Antwoord>

Delete appointment¶

Request (loggedin user)¶

<Tetra_Agenda_WisAfspraak_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>
  <ObjectId>213769</ObjectId>
</Tetra_Agenda_WisAfspraak_Verzoek>

Request (anonymous user)¶

Delete appointment when request is based on a token login.

<Tetra_Agenda_WisAfspraak_Verzoek xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Id="-1001">
  <Identificatie xsi:type="OZB_Communicatie_Identificatie_Servertoken" Id="-1001">
    <Token>[server token]</Token>
  </Identificatie>
<WisToken>12345AAAAAAAA123</WisToken>
</Tetra_Agenda_WisAfspraak_Verzoek>

Response¶

<Tetra_Agenda_WisAfspraak_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>
</Tetra_Agenda_WisAfspraak_Antwoord>

Response¶

<Tetra_Agenda_WisAfspraak_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>
</Tetra_Agenda_WisAfspraak_Antwoord>

Find appointment slots (obsolete, don’t use)¶

Warning

This method is obsolete, please use the logic as described in “Getting slots using parameters for blocktypes, agendas and period”.

The length of an appointment slot depends on the settings in Bricks Huisarts. Normal slots have a length of 10 minutes.

To find appointment slots the practice needs to add online agenda slots to their agenda in Bricks Huisarts. More information how to do this can be found in the Bricks Huisarts documentation.

Request¶

<Tetra_Agenda_GetSlots_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>
</Tetra_Agenda_GetSlots_Verzoek>

Response¶

<?xml version="1.0" encoding="UTF-8"?>
<Tetra_Agenda_GetSlots_Antwoord xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Id="-1001">
  <CommunicatieStatus>OZB_Communicatie_Status_Verzoek_is_geslaagd</CommunicatieStatus>
  <Perioden>
    <Tetra_Agenda_Periode Id="-1003">
      <Start>2013-04-11T09:00:00</Start>
      <Eind>2013-04-11T09:50:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10006</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1012">
          <Start>2013-04-11T09:00:00</Start>
          <Eind>2013-04-11T09:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1013">
          <Start>2013-04-11T09:10:00</Start>
          <Eind>2013-04-11T09:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1014">
          <Start>2013-04-11T09:20:00</Start>
          <Eind>2013-04-11T09:30:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1015">
          <Start>2013-04-11T09:30:00</Start>
          <Eind>2013-04-11T09:40:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1016">
          <Start>2013-04-11T09:40:00</Start>
          <Eind>2013-04-11T09:50:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1001">
      <Start>2013-04-11T09:50:00</Start>
      <Eind>2013-04-11T10:20:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10044</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1006">
          <Start>2013-04-11T09:50:00</Start>
          <Eind>2013-04-11T10:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1007">
          <Start>2013-04-11T10:00:00</Start>
          <Eind>2013-04-11T10:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1008">
          <Start>2013-04-11T10:10:00</Start>
          <Eind>2013-04-11T10:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1005">
      <Start>2013-04-11T10:40:00</Start>
      <Eind>2013-04-11T11:10:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10044</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1022">
          <Start>2013-04-11T10:40:00</Start>
          <Eind>2013-04-11T10:50:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1023">
          <Start>2013-04-11T10:50:00</Start>
          <Eind>2013-04-11T11:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1024">
          <Start>2013-04-11T11:00:00</Start>
          <Eind>2013-04-11T11:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1000">
      <Start>2013-04-11T11:20:00</Start>
      <Eind>2013-04-11T12:20:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10006</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1000">
          <Start>2013-04-11T11:20:00</Start>
          <Eind>2013-04-11T11:30:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1001">
          <Start>2013-04-11T11:30:00</Start>
          <Eind>2013-04-11T11:40:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1002">
          <Start>2013-04-11T11:40:00</Start>
          <Eind>2013-04-11T11:50:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1003">
          <Start>2013-04-11T11:50:00</Start>
          <Eind>2013-04-11T12:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1004">
          <Start>2013-04-11T12:00:00</Start>
          <Eind>2013-04-11T12:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1005">
          <Start>2013-04-11T12:10:00</Start>
          <Eind>2013-04-11T12:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1004">
      <Start>2013-04-12T09:00:00</Start>
      <Eind>2013-04-12T09:50:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10006</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1017">
          <Start>2013-04-12T09:00:00</Start>
          <Eind>2013-04-12T09:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1018">
          <Start>2013-04-12T09:10:00</Start>
          <Eind>2013-04-12T09:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1019">
          <Start>2013-04-12T09:20:00</Start>
          <Eind>2013-04-12T09:30:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1020">
          <Start>2013-04-12T09:30:00</Start>
          <Eind>2013-04-12T09:40:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1021">
          <Start>2013-04-12T09:40:00</Start>
          <Eind>2013-04-12T09:50:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1002">
      <Start>2013-04-12T09:50:00</Start>
      <Eind>2013-04-12T10:20:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10044</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1009">
          <Start>2013-04-12T09:50:00</Start>
          <Eind>2013-04-12T10:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1010">
          <Start>2013-04-12T10:00:00</Start>
          <Eind>2013-04-12T10:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1011">
          <Start>2013-04-12T10:10:00</Start>
          <Eind>2013-04-12T10:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1006">
      <Start>2013-04-12T10:40:00</Start>
      <Eind>2013-04-12T11:10:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10044</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1025">
          <Start>2013-04-12T10:40:00</Start>
          <Eind>2013-04-12T10:50:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1026">
          <Start>2013-04-12T10:50:00</Start>
          <Eind>2013-04-12T11:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1027">
          <Start>2013-04-12T11:00:00</Start>
          <Eind>2013-04-12T11:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1007">
      <Start>2013-04-12T11:20:00</Start>
      <Eind>2013-04-12T11:30:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10044</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1028">
          <Start>2013-04-12T11:20:00</Start>
          <Eind>2013-04-12T11:30:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1011">
      <Start>2013-04-15T09:00:00</Start>
      <Eind>2013-04-15T09:50:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10006</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1041">
          <Start>2013-04-15T09:00:00</Start>
          <Eind>2013-04-15T09:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1042">
          <Start>2013-04-15T09:10:00</Start>
          <Eind>2013-04-15T09:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1043">
          <Start>2013-04-15T09:20:00</Start>
          <Eind>2013-04-15T09:30:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1044">
          <Start>2013-04-15T09:30:00</Start>
          <Eind>2013-04-15T09:40:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1045">
          <Start>2013-04-15T09:40:00</Start>
          <Eind>2013-04-15T09:50:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1009">
      <Start>2013-04-15T09:50:00</Start>
      <Eind>2013-04-15T10:20:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10044</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1035">
          <Start>2013-04-15T09:50:00</Start>
          <Eind>2013-04-15T10:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1036">
          <Start>2013-04-15T10:00:00</Start>
          <Eind>2013-04-15T10:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1037">
          <Start>2013-04-15T10:10:00</Start>
          <Eind>2013-04-15T10:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1012">
      <Start>2013-04-15T10:40:00</Start>
      <Eind>2013-04-15T11:10:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10044</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1046">
          <Start>2013-04-15T10:40:00</Start>
          <Eind>2013-04-15T10:50:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1047">
          <Start>2013-04-15T10:50:00</Start>
          <Eind>2013-04-15T11:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1048">
          <Start>2013-04-15T11:00:00</Start>
          <Eind>2013-04-15T11:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1008">
      <Start>2013-04-15T11:20:00</Start>
      <Eind>2013-04-15T12:20:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10006</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1029">
          <Start>2013-04-15T11:20:00</Start>
          <Eind>2013-04-15T11:30:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1030">
          <Start>2013-04-15T11:30:00</Start>
          <Eind>2013-04-15T11:40:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1031">
          <Start>2013-04-15T11:40:00</Start>
          <Eind>2013-04-15T11:50:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1032">
          <Start>2013-04-15T11:50:00</Start>
          <Eind>2013-04-15T12:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1033">
          <Start>2013-04-15T12:00:00</Start>
          <Eind>2013-04-15T12:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1034">
          <Start>2013-04-15T12:10:00</Start>
          <Eind>2013-04-15T12:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1010">
      <Start>2013-04-16T09:50:00</Start>
      <Eind>2013-04-16T10:20:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10044</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1038">
          <Start>2013-04-16T09:50:00</Start>
          <Eind>2013-04-16T10:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1039">
          <Start>2013-04-16T10:00:00</Start>
          <Eind>2013-04-16T10:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1040">
          <Start>2013-04-16T10:10:00</Start>
          <Eind>2013-04-16T10:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1013">
      <Start>2013-04-16T10:40:00</Start>
      <Eind>2013-04-16T11:10:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10044</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1049">
          <Start>2013-04-16T10:40:00</Start>
          <Eind>2013-04-16T10:50:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1050">
          <Start>2013-04-16T10:50:00</Start>
          <Eind>2013-04-16T11:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1051">
          <Start>2013-04-16T11:00:00</Start>
          <Eind>2013-04-16T11:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1014">
      <Start>2013-04-16T11:20:00</Start>
      <Eind>2013-04-16T12:20:00</Eind>
      <AgendaId>10048</AgendaId>
      <BloktypeId>10006</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1052">
          <Start>2013-04-16T11:20:00</Start>
          <Eind>2013-04-16T11:30:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1053">
          <Start>2013-04-16T11:30:00</Start>
          <Eind>2013-04-16T11:40:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1054">
          <Start>2013-04-16T11:40:00</Start>
          <Eind>2013-04-16T11:50:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1055">
          <Start>2013-04-16T11:50:00</Start>
          <Eind>2013-04-16T12:00:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1056">
          <Start>2013-04-16T12:00:00</Start>
          <Eind>2013-04-16T12:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1057">
          <Start>2013-04-16T12:10:00</Start>
          <Eind>2013-04-16T12:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
  </Perioden>
</Tetra_Agenda_GetSlots_Antwoord>

Getting slots using parameters for blocktypes, agendas and period¶

To get free slots in the agenda with specifying the period, you have to specify the exact agendas and blocktypes as well.

To get blocktypes (also: “colors” in Bricks Huisarts):

Request

<?xml version="1.0" encoding="utf-16"?>
<Tetra_Agenda_GetBlokTypes_Verzoek xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Id="-1002">
  <Identificatie xsi:type="OZB_Communicatie_Identificatie_Servertoken" Id="-1001">
   <Sessie>[session token]</Sessie>
  </Identificatie>
  <OntvangerEntiteit>[practice code]</OntvangerEntiteit>
  <ZenderIP>127.0.0.1</ZenderIP>
</Tetra_Agenda_GetBlokTypes_Verzoek>

Reponse

You need to cache the response of this request!

This data is not changing on a regular basis.

<?xml version="1.0" encoding="utf-16"?>
<Tetra_Agenda_GetBlokTypes_Antwoord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Id="-1000">
  <CommunicatieStatus>OZB_Communicatie_Status_Verzoek_is_geslaagd</CommunicatieStatus>
  <ObjectOmschrijvingen>
    <OZB_Communicatie_ObjectOmschrijving Id="10001">
      <KorteOmschrijving>Koffie</KorteOmschrijving>
    </OZB_Communicatie_ObjectOmschrijving>
    <OZB_Communicatie_ObjectOmschrijving Id="10003">
      <KorteOmschrijving>Telelefonisch SpreekUur</KorteOmschrijving>
    </OZB_Communicatie_ObjectOmschrijving>
    <OZB_Communicatie_ObjectOmschrijving Id="10049">
      <KorteOmschrijving>Visite  </KorteOmschrijving>
    </OZB_Communicatie_ObjectOmschrijving>
    <OZB_Communicatie_ObjectOmschrijving Id="10052">
      <KorteOmschrijving>consult</KorteOmschrijving>
    </OZB_Communicatie_ObjectOmschrijving>
    <OZB_Communicatie_ObjectOmschrijving Id="10059">
      <KorteOmschrijving>Spoedplekjes</KorteOmschrijving>
    </OZB_Communicatie_ObjectOmschrijving>
    ...
  </ObjectOmschrijvingen>
</Tetra_Agenda_GetBlokTypes_Antwoord>

No we have the ids of colors. For example: 10052 is for “consult”.

Then we need to specify the agendas needed:

Request

<?xml version="1.0" encoding="utf-16"?>
<Tetra_Agenda_GetAgendas_Verzoek xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Id="-1002">
   <Identificatie xsi:type="OZB_Communicatie_Identificatie_Servertoken" Id="-1001">
       <Token>[token id]</Token>
   </Identificatie>
   <OntvangerEntiteit>[practice code]</OntvangerEntiteit>
</Tetra_Agenda_GetAgendas_Verzoek>

Reponse

You need to cache the response of this request!

This data is not changing on a regular basis.

<?xml version="1.0" encoding="utf-16"?>
<Tetra_Agenda_GetAgendas_Antwoord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Id="-1000">
  <CommunicatieStatus>OZB_Communicatie_Status_Verzoek_is_geslaagd</CommunicatieStatus>
  <ObjectOmschrijvingen>
    <OZB_Communicatie_ObjectOmschrijving Id="10013">
      <KorteOmschrijving>Harry v.d. Ploeg</KorteOmschrijving>
    </OZB_Communicatie_ObjectOmschrijving>
    <OZB_Communicatie_ObjectOmschrijving Id="10055">
      <KorteOmschrijving>Sjaak Haak</KorteOmschrijving>
    </OZB_Communicatie_ObjectOmschrijving>
    ...
  </ObjectOmschrijvingen>
</Tetra_Agenda_GetAgendas_Antwoord>

Again id’s, we’ll choose the first two: 10013 and 10055. The last step is to ask for the actual slots by selecting a period:

Request

<?xml version="1.0" encoding="utf-16"?>
<Tetra_Agenda_GetSlotsParameters_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_Servertoken" Id="-1001">
   <Sessie>[session token]</Sessie>
  </Identificatie>
  <OntvangerEntiteit>[practice code]</OntvangerEntiteit>
  <Start>2014-07-29T00:00:00+02:00</Start>
  <Eind>2014-08-01T00:00:00+02:00</Eind>
  <Bloktypen>
    <Tetra_Agenda_BlokType Id="10052">
      <Kleur>0</Kleur>
      <AfspraakDuurMinuten>0</AfspraakDuurMinuten>
    </Tetra_Agenda_BlokType>
    <Tetra_Agenda_BlokType Id="10064">
      <Kleur>0</Kleur>
      <AfspraakDuurMinuten>0</AfspraakDuurMinuten>
    </Tetra_Agenda_BlokType>
  </Bloktypen>
  <Agendas>
    <Tetra_Agenda Id="10013" />
    <Tetra_Agenda Id="10055" />
  </Agendas>
</Tetra_Agenda_GetSlotsParameters_Verzoek>

Response

<?xml version="1.0" encoding="utf-16"?>
<Tetra_Agenda_GetSlotsParameters_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>
  <Perioden>
    <Tetra_Agenda_Periode Id="-1005">
      <Start>2014-07-29T08:00:00</Start>
      <Eind>2014-07-29T10:00:00</Eind>
      <AgendaId>10013</AgendaId>
      <BloktypeId>10052</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1123">
          <Start>2014-07-29T08:00:00</Start>
          <Eind>2014-07-29T08:10:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1124">
          <Start>2014-07-29T08:10:00</Start>
          <Eind>2014-07-29T08:20:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        <Tetra_Agenda_Slot Id="-1125">
          <Start>2014-07-29T08:20:00</Start>
          <Eind>2014-07-29T08:30:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
        ...
      </Slots>
    </Tetra_Agenda_Periode>
    <Tetra_Agenda_Periode Id="-1001">
      <Start>2014-07-29T11:30:00</Start>
      <Eind>2014-07-29T17:00:00</Eind>
      <AgendaId>10013</AgendaId>
      <BloktypeId>10052</BloktypeId>
      <Slots>
        <Tetra_Agenda_Slot Id="-1012">
          <Start>2014-07-29T11:30:00</Start>
          <Eind>2014-07-29T11:40:00</Eind>
          <IsVrij>true</IsVrij>
        </Tetra_Agenda_Slot>
      </Slots>
    </Tetra_Agenda_Periode>
     ...
  </Perioden>
</Tetra_Agenda_GetSlotsParameters_Antwoord>

Last update: 29-01-2024