Lab result and specialist letter¶

Hint

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

Request¶

User session required

To get a list of all lab results:

Current Previous

{
  "Name": "{{name}}",
  "Key": "{{key}}",
  "Target": "{{target}}",
  "Session": "{{session}}",
  "Method": "PortalGetMedeur",
  "maximumDagenOud": 180,
  "directVrijgeven": false
}

Key	Comment
maximumDagenOud	Limit the lab results overview by the age of the results
directVrijgeven	`false` : Get lab only results that are reviewed by the doctor `true` : Get all labs results directly

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

Current Previous

Warning

When the WaardeDisplay contains the value -1 the value to display your be retrieved from WaardeTekst.

A result with type Tekst are MedVrij and other “free text” messages from, for example, the hospital. The types with the value Uitslagen are containing measurement results.

This is a results overview with a combination of Tekst and Uitslagen. After this example you will find specific examples of a lab result and a specialist letter in combination with information how to interpret the data.

{
  "berichten": [
    {
      "Type": "Tekst",
      "Datum": "2022-09-07T00:00:00",
      "IsBeoordeeldDoorArts": true,
      "OpmerkingenArts": "",
      "Uitslagen": null,
      "Tekst": "Plain text\r\nWith new lines\r\nThis is an example result."
    },
    {
      "Type": "Uitslagen",
      "Datum": "2006-06-23T00:00:00",
      "IsBeoordeeldDoorArts": true,
      "OpmerkingenArts": "ziet er goed uit",
      "Uitslagen": [
        {
          "Id": 737136,
          "Datum": "2020-07-01T08:45:00",
          "MetingTypeId": 16598,
          "Memo": "TRIG/B/",
          "Waarde": "2530",
          "WaardeDisplay": "2,53",
          "WaardeTekst": "2530",
          "MetingOmschrijving": "triglyceriden",
          "MetingEenheid": "mmol/L",
          "Opmerkingen": "",
          "Afwijkend": true,
          "MinVolgensLab1000": 0,
          "MaxVolgensLab1000": 1700
        },
        {
          "Id": 737132,
          "Datum": "2020-07-01T08:45:00",
          "MetingTypeId": 14564,
          "Memo": "CHOL/B/MT",
          "Waarde": "3800",
          "WaardeDisplay": "3,80",
          "WaardeTekst": "3800",
          "MetingOmschrijving": "cholesterol totaal",
          "MetingEenheid": "mmol/L",
          "Opmerkingen": "",
          "Afwijkend": false,
          "MinVolgensLab1000": 0,
          "MaxVolgensLab1000": 5000
        },
        {
          "Id": 737133,
          "Datum": "2020-07-01T08:45:00",
          "MetingTypeId": 15218,
          "Memo": "HDL/B/",
          "Waarde": "820",
          "WaardeDisplay": "0,82",
          "WaardeTekst": "820",
          "MetingOmschrijving": "HDL-cholesterol",
          "MetingEenheid": "mmol/L",
          "Opmerkingen": "",
          "Afwijkend": true,
          "MinVolgensLab1000": 1000,
          "MaxVolgensLab1000": 0
        }
      ],
      "Tekst": null
    }
  ],
  "ReturnValue": {
    "ResponseCode": 200,
    "ResponseText": "OK",
    "Melding": "OK",
    "Gelukt": true
  }
}

MedLabs are the lab results.

MedVrij are “free text” messages from, for example, the hospital.

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

Lab result example¶

Current Previous

Warning

When the WaardeDisplay contains the value -1 the value to display your be retrieved from WaardeTekst.

{
  "Type": "Uitslagen",
  "Datum": "2006-06-23T00:00:00",
  "IsBeoordeeldDoorArts": true,
  "OpmerkingenArts": "ziet er goed uit",
  "Uitslagen": [
      {
        "Id": 737132,
        "Datum": "2020-07-01T08:45:00",
        "MetingTypeId": 14564,
        "Memo": "CHOL/B/MT",
        "Waarde": "3800",
        "WaardeDisplay": "3,80",
        "WaardeTekst": "3800",
        "MetingOmschrijving": "cholesterol totaal",
        "MetingEenheid": "mmol/L",
        "Opmerkingen": "",
        "Afwijkend": false,
        "MinVolgensLab1000": 0,
        "MaxVolgensLab1000": 5000
      },
      {
        "Id": 737133,
        "Datum": "2020-07-01T08:45:00",
        "MetingTypeId": 15218,
        "Memo": "HDL/B/",
        "Waarde": "820",
        "WaardeDisplay": "0,82",
        "WaardeTekst": "820",
        "MetingOmschrijving": "HDL-cholesterol",
        "MetingEenheid": "mmol/L",
        "Opmerkingen": "",
        "Afwijkend": true,
        "MinVolgensLab1000": 1000,
        "MaxVolgensLab1000": 0
      }
  ],
  "Tekst": null
}

Response keys

IsBeoordeeldDoorArts: Contains true when the result is reviewed by the GP and can be shown to the patient.
OpmerkingenArts: Contains a reaction from the GP

Measurement keys

Memo: NHG memo code
Waarde: Measurement value multiplied by 1000
WaardeDisplay: Value to display
WaardeTekst: Text representation of the value, this can be a text value then the measurement will not contain numeric value
MetingOmschrijving: Measurement description / name
MetingEenheid: Measurement unit
Opmerkingen: Measurement remark. This value can be from the patient (home measurement) of from the lab
Afwijkend: Value is true when the value is not between normal boundaries
MinVolgensLab1000: Minimum measurement value multiplied by 1000
MaxVolgensLab1000: Maximum measurement value multiplied by 1000

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

Key	Remark
Afwijkend	`<His_Uitslag_Afwijkend_Wijkt_af`: Indicates a value that is not between normal boundaries
`<Waarde1000 />`, `<MinimumVolgensLab1000 />`, `<MaximumVolgensLab1000 />`	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)

Specialist letter example¶

Current Previous

{
  "Type": "Tekst",
  "Datum": "2022-09-07T00:00:00",
  "IsBeoordeeldDoorArts": true,
  "OpmerkingenArts": "",
  "Uitslagen": null,
  "Tekst": "Plain text\r\nWith new lines\r\nThis is an example result."
}

For the this type of messages the value of the Tekst-key needs to be shown together with the remarks by the doctor (OpmerkingenArts).

Response keys

IsBeoordeeldDoorArts: Contains true when the result is reviewed by the GP and can be shown to the patient.
OpmerkingenArts: Contains a reaction from the GP
Tekst: The result itself.

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

For the this type of messages the <Tekst /> needs to be shown together with the remarks by the doctor (<OpmerkingenArts />).