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.
Lab results and specialist letters¶
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.
Request¶
To get a list of all lab results:
<?xml version="1.0" encoding="utf-8"?>
<Tetra_Portal_GetMedeur_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>6a887933-24e2-441f-9ab7-fed864b2fd17</Sessie>
</Identificatie>
<OntvangerEntiteit>[practice code]</OntvangerEntiteit>
<PatientId>14858</PatientId>
<MaximumDagen>180</MaximumDagen>
</Tetra_Portal_GetMedeur_Verzoek>
Node |
Comment |
|---|---|
<PatientId /> |
The ID of the patient for retrieving the lab results (optional) |
<MaximumDagen /> |
Limit the result list by the number of days. |
Response¶
<?xml version="1.0" encoding="utf-16"?>
<Tetra_Portal_GetMedeur_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>
<StatusTekst>OK.</StatusTekst>
<MedLabs>
<Tetra_Portal_MedLab Id="-1000">
<Datum>2012-10-23T12:53:00</Datum>
<Uitslagen>
<His_Uitslag xsi:type="His_Uitslag_Numeriek" Id="348389">
<DatumBepaling>2012-10-23T12:53:00</DatumBepaling>
<Bepaling>NHG_Bepaling_Bezinking_BSE_</Bepaling>
<MetingOmschrijving>Bezinking (BSE)</MetingOmschrijving>
<MetingMemo>BSE/B/1U</MetingMemo>
<Afwijkend>His_Uitslag_Afwijkend_Wijkt_niet_af</Afwijkend>
<Opmerking />
<Waarde1000>5000</Waarde1000>
<MinimumVolgensLab1000>-1</MinimumVolgensLab1000>
<MaximumVolgensLab1000>-1</MaximumVolgensLab1000>
</His_Uitslag>
<His_Uitslag xsi:type="His_Uitslag_Numeriek" Id="348267">
<DatumBepaling>2006-06-23T00:00:00</DatumBepaling>
<Bepaling>NHG_Bepaling_Cholesterol_HDL_cholesterol_ratio</Bepaling>
<MetingOmschrijving>Cholesterol/HDL-cholesterol ratio</MetingOmschrijving>
<MetingMemo>CHHD/B/MI</MetingMemo>
<Afwijkend>His_Uitslag_Afwijkend_Wijkt_niet_af</Afwijkend>
<Opmerking />
<Waarde1000>3300</Waarde1000>
<MinimumVolgensLab1000>0</MinimumVolgensLab1000>
<MaximumVolgensLab1000>4500</MaximumVolgensLab1000>
</His_Uitslag>
</Uitslagen>
<IsBeoordeeldDoorArts>false</IsBeoordeeldDoorArts>
<OpmerkingenArts>|</OpmerkingenArts>
</Tetra_Portal_MedLab>
</MedLabs>
<MedVrij>
<Tetra_Portal_MedVrij Id="-1000">
<Datum>2014-10-15T10:34:00</Datum>
<Tekst>This is the text of message 1</Tekst>
<IsBeoordeeldDoorArts>true</IsBeoordeeldDoorArts>
<OpmerkingenArts>dasdasd</OpmerkingenArts>
</Tetra_Portal_MedVrij>
<Tetra_Portal_MedVrij Id="-1000">
<Datum>2014-10-15T10:34:00</Datum>
<Tekst>This is the text of message 2</Tekst>
<IsBeoordeeldDoorArts>true</IsBeoordeeldDoorArts>
<OpmerkingenArts>dasdasd</OpmerkingenArts>
</Tetra_Portal_MedVrij>
</MedVrij>
</Tetra_Portal_GetMedeur_Antwoord>
Example¶
<His_Uitslag xsi:type="His_Uitslag_Numeriek" Id="348401">
<DatumBepaling>2012-10-23T12:53:00</DatumBepaling>
<Bepaling>NHG_Bepaling_C_reactive_proteine_CRP_</Bepaling>
<MetingOmschrijving>C-reactive proteïne (CRP)</MetingOmschrijving>
<MetingMemo>CRP/B/</MetingMemo>
<Afwijkend>His_Uitslag_Afwijkend_Wijkt_af</Afwijkend>
<Opmerking />
<Waarde1000>15000</Waarde1000>
<MinimumVolgensLab1000>0</MinimumVolgensLab1000>
<MaximumVolgensLab1000>5000</MaximumVolgensLab1000>
</His_Uitslag>
Remarks¶
<MedLabs /> messages¶
His_Uitslag_Afwijkend_Wijkt_af |
Indicates a value that is not between normal boundaries |
Numeric values |
Each value is multiplied by 1000 to prevent cultural problems, please divide before showing |
<MetingOmschrijving /> |
Is the description, for example: C-reactive proteïne (CRP) |
<MedVrij /> messages¶
For the MedVrij messages, just the <Tekst /> needs to be shown together with the remarks by the doctor (<OpmerkingenArts />).