Bricks Switchboard version 2.0

The XML-based version of Bricks Switchboard (version 1.0) has been upgraded to version 2.0, which now uses a modern JSON-based format.

Please contact Tetra B.V. to begin the upgrade process and take advantage of the latest features in Bricks Switchboard.

E-consult¶

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.

Create new e-consult¶

Patient creates a new e-consult.

Request¶

<?xml version="1.0" encoding="utf-16"?>
<Tetra_EConsult_VraagEConsultAan_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>
  <Vraag Id="-1000">
    <OmschrijvingKlacht>Last van hoofdpijn</OmschrijvingKlacht>
    <Fotos />
  </Vraag>
  <PatientId>10000</PatientId>
</Tetra_EConsult_VraagEConsultAan_Verzoek>

In case you want to send photo’s with the e-consult you need to add the following data to the <Fotos /> node for each photo:

<OZB_Deeldocument Id="-1000">
  <MimeType>OZB_NietGevuld</MimeType>
  <BestandBase64>[base64-encoded-data-string]</BestandBase64>
  <BestandsNaam>[filename.ext]</BestandsNaam>
</OZB_Deeldocument>

De final request looks like this:

<?xml version="1.0" encoding="utf-16"?>
<Tetra_EConsult_VraagEConsultAan_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>
  <Vraag Id="-1000">
    <OmschrijvingKlacht>Last van hoofdpijn</OmschrijvingKlacht>
    <Fotos>
     <OZB_Deeldocument Id="-1000">
        <MimeType>OZB_NietGevuld</MimeType>
        <BestandBase64>[base64-encoded-data-string]</BestandBase64>
        <BestandsNaam>[filename.ext]</BestandsNaam>
     </OZB_Deeldocument>
    </Fotos>
  </Vraag>
  <PatientId>10000</PatientId>
</Tetra_EConsult_VraagEConsultAan_Verzoek>

Response¶

<?xml version="1.0" encoding="utf-16"?>
<Tetra_EConsult_VraagEConsultAan_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>Verzoek is toegevoegd.</StatusTekst>
</Tetra_EConsult_VraagEConsultAan_Antwoord>

Get a list of existing e-consults¶

Retrieve a list of all e-consults registered in Bricks Huisarts.

Request¶

<?xml version="1.0" encoding="utf-16"?>
<Tetra_EConsult_EerdereEConsulten_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>10000</PatientId>
</Tetra_EConsult_EerdereEConsulten_Verzoek>

Response¶

<?xml version="1.0" encoding="utf-16"?>
<Tetra_EConsult_EerdereEConsulten_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>Verzoek is toegevoegd.</StatusTekst>
  <ObjectOmschrijvingen>
    <OZB_Communicatie_ObjectOmschrijving Id="1562216">
      <KorteOmschrijving>02-04-2014 Nieuw e-consult</KorteOmschrijving>
    </OZB_Communicatie_ObjectOmschrijving>
    <OZB_Communicatie_ObjectOmschrijving Id="1562218">
      <KorteOmschrijving>02-04-2014 Nieuw e-consult</KorteOmschrijving>
    </OZB_Communicatie_ObjectOmschrijving>
  </ObjectOmschrijvingen>
</Tetra_EConsult_EerdereEConsulten_Antwoord>

Get e-consult detail¶

Retrieve the detailed information of a single e-consult. When a response is given by the doctor in Bricks Huisarts this will be shown in the node <Beantwoording />.

Request¶

<?xml version="1.0" encoding="utf-16"?>
<Tetra_EConsult_GetEconsult_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>1562218</ObjectId>
</Tetra_EConsult_GetEconsult_Verzoek>

Response¶

<?xml version="1.0" encoding="utf-16"?>
<Tetra_EConsult_GetEconsult_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>Gevonden.</StatusTekst>
  <Vraag Id="-1001">
    <OmschrijvingKlacht>Last van hoofdpijn</OmschrijvingKlacht>
    <Fotos />
  </Vraag>
  <EConsultAntwoord Id="-1001">
    <Beantwoording>Vroeg naar bed</Beantwoording>
    <Acties />
  </EConsultAntwoord>
</Tetra_EConsult_GetEconsult_Antwoord>

Send e-consult reaction¶

Send a reaction on the e-consult detail, as requested with “Get e-consult detail”.

Important

This method is only accessable from within Bricks Huisarts.

Request¶

<?xml version="1.0" encoding="utf-16"?>
<Tetra_EConsult_Beantwoord_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>
  <ContactId>1562218</ContactId>
  <EConsultAntwoord Id="-1000">
    <Beantwoording>Vroeg naar bed</Beantwoording>
    <Acties />
  </EConsultAntwoord>
</Tetra_EConsult_Beantwoord_Verzoek>

Response¶

<?xml version="1.0" encoding="utf-16"?>
<Tetra_EConsult_Beantwoord_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>Verzoek is toegevoegd.</StatusTekst>
</Tetra_EConsult_Beantwoord_Antwoord>