Patient¶

Search with a free query¶

Warning

Be careful with this API option, with the options it is possible that patient information is getting into the wrong hands! Only use the ‘free query’ for users that have access to all the data in the practice.

Request¶

Current Previous

{
  "Name": "{{name}}",
  "Key": "{{key}}",
  "Target": "{{target}}",
  "Method": "Zoek",
  "query": "Jan",
  "zoekType": "Alles"
}

Parameters

query: Query value
Possible zoekType values:
- Telefoon: Search by phonenumber.
- Email: Search by email address.
- Alles: Search by all possible fields.

<His_ZoekPatient_Vrij_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>
  <Query>090286</Query>
  <OokMeisjesnaam>false</OokMeisjesnaam>
  <OokStraat>false</OokStraat>
  <OokInactief>false</OokInactief>
</His_ZoekPatient_Vrij_Verzoek>

Response¶

Current Previous

{
    "zoekresultaten": [
        {
            "Naam": "Dhr. Jan Janssen",
            "GeboorteDatum": "0001-01-01T00:00:00",
            "PatientId": 160285,
            "Email": "mail@example.com",
            "Telefoonnummers": []
        },
        {
            "Naam": "Dhr. Jan de Groot",
            "GeboorteDatum": "1965-01-01T00:00:00",
            "PatientId": 157376,
            "Email": "",
            "Telefoonnummers": [
                "0612345698",
                "0331234567"
            ]
        }
    ],
    "ReturnValue": {
        "ResponseCode": 200,
        "ResponseText": "OK",
        "Melding": "OK",
        "Gelukt": true
    }
}

<His_ZoekPatient_Vrij_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>
  <ObjectOmschrijvingen>
    <OZB_Communicatie_ObjectOmschrijving Id="10263">
    <KorteOmschrijving>Dhr. AAAAA aaaa (27) 9-2-1986 OOS Geuldalweg11 Meerssen</KorteOmschrijving>
  </OZB_Communicatie_ObjectOmschrijving>
  </ObjectOmschrijvingen>
</His_ZoekPatient_Vrij_Antwoord>

Find by phone number¶

Search for patient by one or more phone numbers. All residential members will be returned.

Request¶

{
  "Name": "{{name}}",
  "Key": "{{key}}",
  "Target": "{{target}}",
  "Method": "ZoekTelefoonnummer",
  "nummers": ["0612345678", "0681000025"]
}

Parameters

nummers: De lijst met telefoonnummers waarvoor de patiënten moeten worden opgezocht.

Response¶

{
    "resultaten": [
        {
            "Nummer": "0612345678",
            "Patienten": [
                {
                    "Naam": "testP Den Boer 05-09-2018",
                    "GeboorteDatum": "0001-01-01T00:00:00",
                    "PatientId": 157793,
                    "Links": [
                        {
                            "URL": null,
                            "Caption": null,
                            "Text": null
                        }
                    ]
                }
            ]
        },
        {
            "Nummer": "0681000025",
            "Patienten": []
        }
    ],
    "ReturnValue": {
        "ResponseCode": 200,
        "ResponseText": "OK",
        "Melding": "OK",
        "Gelukt": true
    }
}

Get patient details¶

Request¶

Current Previous

The data is moved to the patient WieBenIk request.

<His_GetPatientAdministratief_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>157058</ObjectId>
</His_GetPatientAdministratief_Verzoek>

The response contains a lot of data. When getting the patients name and date of birth you’ll need:

Node	Result	Example / comment
<Geboortedatum/>	Date of Birth	1995-06-10T00:00:00
<Geslacht />	Male / Female	Male (NHG_Geslacht_Man) / Female (NHG_Geslacht_Vrouw)
<Voornaam />	Call name
<Voorletters/>	Initials
<TussenvoegselEigennaam/>	Family name prefix
<Eigennaam />	Family name

Create new patient¶

With this API call you register a patient in Bricks Huisarts. Keep in mind that deleting patients in Bricks Huisarts is not possible.

We advice you to place the registrations in some kind of ‘buffer’. Do not store registration directly in Bricks Huisarts using a API call. Using a buffer takes care of duplicate entries.

Another advantage of using a ‘buffer’ is that an employee of the practice can act as a filter that will prevent unauthorized registrations.

Info

It is not possible to create a login account for the patient using the API, accounts are created in Bricks Huisarts.

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¶

Info

When the request is processed a “you are registered in the practice” confirmation will be send to the patient by email.

Current Previous

{
  "Name": "{{name}}",
  "Key": "{{key}}",
  "Target": "{{target}}",
  "Method": "NieuwePatient",
  "bsn": "012345678",
  "geslacht": "M",
  "voornaam": "Hanneke",
  "voorletters": "H.B.",
  "tussenvoegsel": "de",
  "achternaam": "Vries",
  "meisjesnaam": "Pietersen",
  "tussenvoegselMeisjesnaam": "",
  "geboorteDatum": "2000-02-15T00:00:00",
  "straat": "Begijnekade",
  "huisnummer": 13,
  "huisnummerToevoeging": "a",
  "postcode": "3512 VV",
  "woonplaats": "Utrecht",
  "geboorteplaats": "",
  "geboorteland": "NL",
  "telefoonnummer": "030-2760413",
  "huidigeHuisarts": "Dr Jansen",
  "beroep": "Fietsenmaker",
  "email": "hanneke@primarijwiel.nl",
  "agbArts": "",
  "inschrijfdatum": "2023-05-11T12:30:00",
  "agbApotheek": ""
}

Parameters

geslacht: Gender of the patient
- M: Male
- V: Female
- O: Unknown
- N: Not specified
geboorteland: Country of birth in 2 character ISO code format (ISO 3166-1 alpha-2 codes).
agbArts: AGB-code of the patient his doctor in Bricks Huisarts.
agbApotheek: AGB-code of the patient pharmacy. When set and available in Bricks Huisarts the prescriptions will be send to this pharmacy.

Warning

In case there is no data for Inschrijfdatum, Uitschrijfdatum and/or Overlijdensdatum sending an empty node is not allowed. In those cases please enter the following data: 0001-01-01T00:00:00

<?xml version="1.0" encoding="utf-16"?>
<His_NieuwePatient_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>
  <Administratief Id="-1000">
    <Geslacht>NHG_Geslacht_Man</Geslacht>
    <Geboortedatum>2003-02-01T00:00:00</Geboortedatum>
    <Praktijk Id="-1000">
      <Adres Id="-1000">
        <Landcode>OZB_NietGevuld</Landcode>
      </Adres>
      <Telefoonnummers />
    </Praktijk>
    <AGBArts>01021077</AGBArts>
    <Telefoonnummers>
      <OZB_Telefoonnummer Id="-1001">
        <Nummer>Telephone</Nummer>
        <TypeTelefoonNummer>OZB_NietGevuld</TypeTelefoonNummer>
      </OZB_Telefoonnummer>
    </Telefoonnummers>
    <Email>email@email.com</Email>
    <BSN>000000000</BSN>
    <Naam Id="-1000">
      <NaamGebruik>NHG_Naamgebruik_Naam_echtgenoot_gevolgd_door_eigen_naam</NaamGebruik>
      <Voornaam>First</Voornaam>
      <Voorletters>I.N.I.T</Voorletters>
      <TussenvoegselEigennaam>Adject</TussenvoegselEigennaam>
      <Eigennaam>Last name</Eigennaam>
      <TussenvoegselPartnernaam></TussenvoegselPartnernaam>
      <Partnernaam></Partnernaam>
    </Naam>
    <Geboorteplaats>Utrecht</Geboorteplaats>
    <Woonadres Id="-1001">
      <Straatnaam>Street</Straatnaam>
      <Huisnummer>10</Huisnummer>
      <Postcode>1234 PC</Postcode>
      <Plaatsnaam>City</Plaatsnaam>
      <Landcode>NHG_Land_Nederland</Landcode>
      <Land>Nederland</Land>
    </Woonadres>
    <RedenInschrijving>OZB_NietGevuld</RedenInschrijving>
    <RedenUitschrijving>OZB_NietGevuld</RedenUitschrijving>
    <Inschrijfdatum>0001-01-01T00:00:00</Inschrijfdatum>
    <Uitschrijfdatum>0001-01-01T00:00:00</Uitschrijfdatum>
    <StandaardBezorgen>false</StandaardBezorgen>
    <Zorgverleners />
    <HoofdbehandelaarId>0</HoofdbehandelaarId>
    <Woonverbandnummer>0</Woonverbandnummer>
    <IsOverleden>false</IsOverleden>
    <Overlijdensdatum>0001-01-01T00:00:00</Overlijdensdatum>
    <IsIngeschreven>false</IsIngeschreven>
    <SoortPatient>OZB_NietGevuld</SoortPatient>
    <Categorieen />
    <Metagegevens />
    <OokBekendAls />
    <Memos />
  </Administratief>
</His_NieuwePatient_Verzoek>

Response¶

Current Previous

{
   "patientId": 160325,
   "ReturnValue": {
       "ResponseCode": 200,
       "ResponseText": "OK",
       "Melding": "Patient toegevoegd met id 160325",
       "Gelukt": true
   }
}

<?xml version="1.0" encoding="utf-16"?>
<His_NieuwePatient_Antwoord xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Id="-1000">
    <CommunicatieStatus>OZB_Communicatie_Status_Verzoek_is_geslaagd</CommunicatieStatus>
    <StatusTekst>Patient is toegevoegd.</StatusTekst>
    <ObjectId>157645</ObjectId>
</His_NieuwePatient_Antwoord>

<ObjectId /> is het patiëntnummer van de zojuist aangemaakte patiënt.

Last update: 13-01-2025 14:43