E-consult¶

Hint

For each request on this page you need to add identication data. More information about this can be found in Identification / access chapter.

Create new e-consult¶

Patient creates a new e-consult.

Request¶

Current Previous

{
  "Name": "{{name}}",
  "Key": "{{key}}",
  "Target": "{{target}}",
  "Session": "{{session}}",
  "Method": "NieuwEConsult",
  "omschrijvingKlacht": "Hoofdpijn sinds gisteren",
  "fotos": null
}

<?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 add photos or documents to the e-consult you need to add the following to the request:

Current Previous

Add an array to the “fotos” key that contains, for each document:

{
  "FileName": "example.jpg",
  "ContentType": "image/jpeg",
  "File": "base64-encoded-data-string"
}

Within the <Fotos /> node add the following for each photo:

<OZB_Deeldocument Id="-1000">
  <MimeType>OZB_NietGevuld</MimeType>
  <BestandBase64>base64-encoded-data-string/BestandBase64>
  <BestandsNaam>example.jpg</BestandsNaam>
</OZB_Deeldocument>

The final request looks like this:

Current Previous

{
  "Name": "{{name}}",
  "Key": "{{key}}",
  "Target": "{{target}}",
  "Session": "{{session}}",
  "Method": "NieuwEConsult",
  "omschrijvingKlacht": "Hoofdpijn sinds gisteren",
  "fotos": [
    {
      "FileName": "example.jpg",
      "ContentType": "image/jpeg",
      "File": "base64-encoded-data-string"
    }
  ]
}

<?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>example.jpg</BestandsNaam>
      </OZB_Deeldocument>
    </Fotos>
  </Vraag>
  <PatientId>10000</PatientId>
</Tetra_EConsult_VraagEConsultAan_Verzoek>

Response¶

Current Previous

{
  "ReturnValue": {
    "ResponseCode": 200,
    "ResponseText": "OK",
    "Melding": "Verzoek is toegevoegd.",
    "Gelukt": true
  }
}

<?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 e-consults¶

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

Request¶

Current Previous

{
  "Name": "{{name}}",
  "Key": "{{key}}",
  "Target": "{{target}}",
  "Session": "{{session}}",
  "Method": "GetEConsults"
}

<?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¶

Current Previous

{
  "consulten": [
      {
          "Id": 1365735,
          "KorteOmschrijving": "24-11-2021 12:49 E-consult"
      },
      {
          "Id": 1441845,
          "KorteOmschrijving": "02-03-2023 12:02 E-consult"
      },
      {
          "Id": 1442492,
          "KorteOmschrijving": "30-03-2023 15:22 Nieuw e-consult"
      }
  ],
  "ReturnValue": {
      "ResponseCode": 200,
      "ResponseText": "OK",
      "Melding": "OK",
      "Gelukt": true
  }
}

<?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¶

Current Previous

{
  "Name": "{{name}}",
  "Key": "{{key}}",
  "Target": "{{target}}",
  "Session": "{{session}}",
  "Method": "GetEconsult",
  "contactId": 1441845
}

Repace the value of the contactId with the ID of the e-consult that you want to view. This ID is coming from “Get a list of e-consults”.

<?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¶

Current Previous

{
  "consult": {
    "ContactId": 0,
    "KorteOmschrijving": null,
    "OmschrijvingKlacht": "Patient question",
    "Fotos": null,
    "Beantwoording": "Reaction from doc\nWith kind regards\n\nYour doctor"
    "AntwoordBijlagen": null
  },
  "ReturnValue": {
    "ResponseCode": 200,
    "ResponseText": "OK",
    "Melding": "OK",
    "Gelukt": true
  }
}

In case Fotos and/or AntwoordBijlagen contain documents it will contain array for each document with the following values:

FileName: Name of the document
ContentType: Type of document / mime type
File: Document (base64 encoded)
DateTime: DateTime of the document

<?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>

Last update: 13-01-2025 14:43