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.
Journal (add data)¶
Before you start¶
To access this API method you need to be logged in to the Bricks Switchboard. Each request needs to contain:
Server token needed
To send the request to the API a server token is needed.
<His_Example>
<Identificatie xsi:type="OZB_Communicatie_Identificatie_Servertoken" Id="-1001">
<Token>[server token]</Token>
</Identificatie>
...
</His_Exmaple>
The practice code be found in the setup documentation.
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.
Request¶
You can add data to the patient journal with the following request:
<?xml version='1.0' encoding='UTF-8'?>
<His_VoegJournaalToe_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">
<Token>[server token]</Token>
</Identificatie>
<OntvangerEntiteit>[practice code]</OntvangerEntiteit>
<PatientId>0</PatientId>
<ContactId>[contact ID]</ContactId>
<Journaal Id="-1000">
<Contacten>
<His_Contact Id="-1000">
<Contacttype>OZB_NietGevuld</Contacttype>
<Datum>0001-01-01T00:00:00</Datum>
<ZorgverlenerId>0</ZorgverlenerId>
<Deelcontacten>
<HIS_Deelcontact Id="-1000">
<EpisodeId>0</EpisodeId>
<Deelcontactregels>
<His_Deelcontactregel xsi:type="His_CorrespondentieUit" Id="-1000">
<DatumTijd>0001-01-01T00:00:00</DatumTijd>
<IsAttentie>false</IsAttentie>
<IsVoorgeschiedenis>false</IsVoorgeschiedenis>
<SOEP>OZB_NietGevuld</SOEP>
<RegelNummer>0</RegelNummer>
<Samenvatting>[summary of document]</Samenvatting>
<Specialisme>OZB_NietGevuld</Specialisme>
<Document Id="-1000">
<Deeldocumenten>
<OZB_Deeldocument Id="-1000">
<MimeType>OZB_NietGevuld</MimeType>
<BestandBase64>[base64 encoded file content]</BestandBase64>
<BestandsNaam>[filename.extension]</BestandsNaam>
</OZB_Deeldocument>
</Deeldocumenten>
</Document>
</His_Deelcontactregel>
</Deelcontactregels>
</HIS_Deelcontact>
</Deelcontacten>
</His_Contact>
</Contacten>
<Allergieen></Allergieen>
<Contraindicaties></Contraindicaties>
<Episodes></Episodes>
<WikiPaginas></WikiPaginas>
</Journaal>
</His_VoegJournaalToe_Verzoek>
Add document to the patient journal¶
The following data needs to be added to the XML to add a document to the journal of a patient:
Node |
Comment |
|---|---|
<ContactId /> |
The contact where the document will be visible. The ContactId is received by initial request to external protal. |
<Samenvatting /> |
Summary of the document. |
<BestandBase64 /> |
Base64 encoded string of document content. |
<BestandsNaam /> |
Filename with the correct document extension. |
Response¶
<?xml version="1.0" encoding="utf-16"?>
<His_VoegJournaalToe_Antwoord xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Id="-1002">
<CommunicatieStatus>OZB_Communicatie_Status_Verzoek_is_geslaagd</CommunicatieStatus>
<StatusTekst />
<Transactiestatus>OZB_NietGevuld</Transactiestatus>
</His_VoegJournaalToe_Antwoord>