API docs by Redocly

Zorg op Orde API (v0.9)

Download OpenAPI specification:Download

Zorg op Orde: api@zorgoporde.nl

This documentation is also available in OpenAPI 3.1.0 yaml format.

Copyright by Zorg op Orde, all rights reserved.

Patient

API for retrieving medical dossier data and concerns based on looking up a specific patient.

Detailed medical dossier

Get detailed medical dossier info for the stated patient.

WorkInProgress: The API may require you to provide the person on whose authority this request is being made, which will be logged and reviewed for the Principle of Least Privilege policy.

Known design parameters:

  • send along the date on which the result is based (GPIS snapshot date)
  • Sender must send a key (or list of keys) representing the context, such as 'DM', 'Obesitas', 'Dietetiek', etc. We combine the targeted data (the GP or zorggroep) with these keys to know precisely what we filter (we do not just return all medical dossier data).
  • uptime is important; these API calls are done live as patients show.
  • q - edit it a bit, can be for example 'dm' or even 'dm/dietetiek'. Send all relevant parts in one response.
  • required response categories: Journaal, Bepalingen, Medicatie, episodes.
Authorizations:
BearerAuth
query Parameters
agb
integer (agb) [ 1 .. 99999999 ]
Example: agb=1053293

The AGB code (dutch: Algemeen Gegevens Beheer - unique identifier for medical professionals and GP practices) of the GP practice. This value can be a claim in the JWT (preferred), or, if no agb claim exists in the authenticating JWT token, it must be a query parameter. The JWT token must be authorized for this entity.

bsn
integer <int32> [ 1 .. 999999999 ]
Example: bsn=123456789

The SSN (dutch: BSN) of a patient to look up. May only contain digits, cannot contain more than 9 digits, and cannot be 0. Either bsn or pu must be present. Note that bsn can also be sent via header (not recommended).

pu
string
Example: pu=

The Patient unique ID, as e.g. reported by /patient/base's patUnid response.

Either bsn or pu must be present. We do not recommend including both; if this is done, both filters are applied, and patient info is only returned if a patient exists matching both.

q
Array of strings non-empty
Example: q=q=medication,measurements

A comma-separated list of dossier aspects to query. If omitted, everything is returned. The keys match the keys in the JSON structure that is returned on a success, such as medication or measurements.

Current list of aspects:

  • personal (basic info such as birth dates and address)
  • careprograms (which actively managed chronic care programs the patient participates in)
  • episodes (chronic conditions and problems)
  • measurements (lab values, process management, answers to basic questions)
  • feats (declared acts such as 'standard consult')
  • correspondence (messages sent and received about this patient to other care professionals)
  • medications
  • contraindications
  • journals
purpose
required
string
Example: purpose=diet-dm2

A unique key identifying for what purpose this request is being made. Keys are agreed upon between ZorgOpOrde and the API user, and will result in the data returned filtered down to what is relevant / necessary for the stated purpose. For example, "diet-dm2" would be a key to represent that this patient is being enrolled in Diabetes Mellitus chronic care and a report on this patient's DM status is being prepared to send to a licensed dietitian. The data returned would be filtered to only include those aspects relevant for this task.

header Parameters
bsn
integer <int32> [ 1 .. 999999999 ]
Example: 123456789

An alternate location for the bsn parameter.

Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "personal": {
    },
  • "episodes": [
    ],
  • "measurements": [
    ],
  • "feats": [
    ],
  • "correspondence": [
    ],
  • "medications": [
    ],
  • "contraindications": [
    ],
  • "journals": [
    ]
}

Basic personal patient

Get basic personal patient info not directly related to their medical dossier

Authorizations:
BearerAuth
query Parameters
agb
integer (agb) [ 1 .. 99999999 ]
Example: agb=1053293

The AGB code (dutch: Algemeen Gegevens Beheer - unique identifier for medical professionals and GP practices) of the GP practice. This value can be a claim in the JWT (preferred), or, if no agb claim exists in the authenticating JWT token, it must be a query parameter. The JWT token must be authorized for this entity.

bsn
integer <int32> [ 1 .. 999999999 ]
Example: bsn=123456789

The SSN (dutch: BSN) of a patient to look up. May only contain digits, cannot contain more than 9 digits, and cannot be 0.

header Parameters
bsn
integer <int32> [ 1 .. 999999999 ]
Example: 123456789

An alternate location for the bsn parameter.

Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "bsn": 123456789,
  • "name": {
    },
  • "gender": "V",
  • "dob": "1970-01-13",
  • "category": "V",
  • "doctor": 1051234,
  • "address": {
    },
  • "contact": {
    },
  • "insurance": {
    },
  • "patid": 1234,
  • "patPubId": "P000123",
  • "patUnid": "1234",
  • "startDate": "1970-01-13",
  • "endDate": "1970-01-13",
  • "endReason": "",
  • "careprograms": {
    }
}

Contact list

Get a contact list for printing address labels, sending e-mail and/ or calling.

Authorizations:
BearerAuth
query Parameters
patUnids
Array of strings (pat-patUnid)
Example: patUnids=1234,5678

A comma separated list of patUnid values, as provided by other API endpoints. For each patUnid the contact details are in the response. If sending lots of patUnids, we suggest you call this API in a POST (which is also allowed, though the semantic intent of this method is GET: It only queries and makes no changes) to avoid HTTP limits on query length.

fields
any
Example: fields=displayName,addressLine,postcode,city

Comma separated list of data fields that shold be returned in the response. Available options are: bsn - adds CSV column/JSON key 'bsn'. patPubId - adds CSV column/JSON key 'patPubId'. patUnid - adds CSV column/JSON key 'patUnid'. gender - adds CSV column/JSON key 'gender', with values 'O', 'M', or 'F'. displayName - adds CSV column/JSON key 'displayName' with the full name of the patient as one would write it on an envelope. fullName - adds CSV columns 'initials', 'firstNames', 'infixOwn', 'ownLastName', 'infixPartner', 'partnerLastName', and JSON key 'name' with as value an object with those keys. addressLine - adds CSV column/JSON key 'addressLine'. postcode - adds CSV column/JSON key 'postcode'. city - adds CSV column/JSON key 'city'. tel - adds CSV column/JSON key 'tel'. email - adds CSV column/JSON key 'email'. dob - adds CSV column/JSON key 'dob'.

See the descriptions in the JSON output section of this documentation for the formatting of these outputs.

header Parameters
Accept
string
Enum: "text/csv" "application/json"

This API is capable of emitting both CSV (RFC 4180) and JSON. If a CSV response is needed, ensure mimetype text/csv is mentioned in the Accept header at a higher quality than application/csv. If no Accept header is provided, the API responds with JSON.

Responses

Response samples

Content type
[
  • {
    }
]

Funduscopy, care group

Get per-patient funduscopy status for one care group.

Returns patients that have an indication for requiring funduscopy across all practices of a care group, taking into account the medical dossier of each patient as well as the care group's policies.

For each patient, information about their funduscopy status as well as basic personal information is provided.

This endpoint may take quite a while to respond (may take more than 5 minutes) which can cause issues with timeouts; configure your endpoint call function appropriately and ensure intermediate proxies don't time out either.

Due to the potentially large amount of data, this endpoint rejects requests that don't support compression. A header of at least Accept-Encoding: gzip is therefore required.

Authorizations:
BearerAuth
query Parameters
agb
integer (agb) [ 1 .. 99999999 ]
Example: agb=1053293

The AGB code (dutch: Algemeen Gegevens Beheer - unique identifier for medical professionals and GP practices) of the entity that represents multiple GP practices. This value can be a claim in the JWT (preferred), or, if no agb claim exists in the authenticating JWT token, it must be a query parameter. The JWT token must be authorized for this entity.

purpose
required
string
Enum: "fundus-broker" "gp" "reporting"

A key describing the purpose of requesting funduscopy status of many patients.

Affects what data is supplied (for example, whether personally identifying information is provided), and whether certain filters are applied.

  • fundus-broker – An entity that takes care of arranging appointments between patients and funduscopy professionals.
  • gp – Medical personnel reviewing their funduscopy-relevant patient population.
  • reporting – Reporting on the status of the funduscopy-relevant patient population as a whole.

The reporting purpose limits PII, the fundus-broker purpose applies filtering as per the preferences of the care group's policies.

director
string
Enum: "gp" "specialist" "unknown" ""

If present, filter the returned population on the registered director for funduscopy.

  • gp – Returns only those patients whose most recent registration of responsible-for-funduscopy is 'The GP'.
  • specialist – Returns only those patients whose most recent registration of responsible-for-funduscopy is 'The specialist'.
  • unknown – Returns only those patients whose most recent registration of responsible-for-funduscopy is not present, registered as 'Unknown', or has an invalid registration.

If not present, no filtering is applied.

ifNewerThan
string <date>
Example: ifNewerThan=1970-01-13

Useful to check if new data is available relative to an earlier request: Provide the same date as provided in a previous response's refDate value. If no new data is available since then, a 206 - No Content HTTP response is returned. Date without time part in ISO8601 format.

pretty
boolean
Default: false

If true the emitted JSON is pretty-printed. Use only for debugging purposes.

group
string

The 'key' for the care group you want to retrieve data for. Providing this parameter is pointless unless the AGB code supplied via the agb parameter is responsible for more than one care group which is rare. A list of valid groups can be obtained via the list-groups endpoint.

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "dict": {
    },
  • "agb": 1053293,
  • "regionName": "string",
  • "refDate": "1970-01-13",
  • "practices": [
    ]
}

Funduscopy, practice

Get per-patient funduscopy status for one GP practice.

Returns patients that have an indication for requiring funduscopy, taking into account the medical dossier of each patient as well as the relevant care group's policies.

For each patient, information about their funduscopy status as well as basic personal information is provided.

Authorizations:
BearerAuth
query Parameters
agb
integer (agb) [ 1 .. 99999999 ]
Example: agb=1053293

The AGB code (dutch: Algemeen Gegevens Beheer - unique identifier for medical professionals and GP practices) of the GP practice. This value can be a claim in the JWT (preferred), or, if no agb claim exists in the authenticating JWT token, it must be a query parameter. The JWT token must be authorized for this entity.

purpose
required
string
Enum: "fundus-broker" "gp" "reporting"

A key describing the purpose of requesting funduscopy status of many patients.

Affects what data is supplied (for example, whether personally identifying information is provided), and whether certain filters are applied.

  • fundus-broker – An entity that takes care of arranging appointments between patients and funduscopy professionals.
  • gp – Medical personnel reviewing their funduscopy-relevant patient population.
  • reporting – Reporting on the status of the funduscopy-relevant patient population as a whole.

The reporting purpose limits PII, the fundus-broker purpose applies filtering as per the preferences of the care group's policies.

director
string
Enum: "gp" "specialist" "unknown" ""

If present, filter the returned population on the registered director for funduscopy.

  • gp – Returns only those patients whose most recent registration of responsible-for-funduscopy is 'The GP'.
  • specialist – Returns only those patients whose most recent registration of responsible-for-funduscopy is 'The specialist'.
  • unknown – Returns only those patients whose most recent registration of responsible-for-funduscopy is not present, registered as 'Unknown', or has an invalid registration.

If not present, no filtering is applied.

ifNewerThan
string <date>
Example: ifNewerThan=1970-01-13

Useful to check if new data is available relative to an earlier request: Provide the same date as provided in a previous response's refDate value. If no new data is available since then, a 206 - No Content HTTP response is returned. Date without time part in ISO8601 format.

pretty
boolean
Default: false

If true the emitted JSON is pretty-printed. Use only for debugging purposes.

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "dict": {
    },
  • "practice": {
    }
}

Population statistics

Statistics of a patient population.

Population group-by

Groups the patient population by any combination of age, preferred doctor, etc. and calculates the count of each category.

Authorizations:
BearerAuth
query Parameters
refDate
string <date> (date)
Example: refDate=1970-01-13

If present, the date used as context (any measurements available done afterwards aren't taken into account, any expiry calculations use this date as reference, and so forth). Defaults to today.

groupByItems
required
Array of strings non-empty
Items Enum: "age" "preferredDoctor" "insurer" "gender"

Several items can be added to the group by using a comma separated list, e.g. groupByItems=gender,age. If an item is twice or more repeated the first occurrence is used.

insurer
Array of numbers <int32> (insurer-Uzovi) [ items <int32 > [ 0 .. 9999 ] ]
Example: insurer=211

Supply zero, one or more Uzovis to limit the responses to certain insurer. Use 0 to select all patients without insurer registered. Supply the Uzovi code as an integer in a comma separated list, e.g. insurer=101,211,3344.

passerBy
boolean

true to include passer-by patients. This also includes Medicom's noni patients. (Noni = niet op naam ingeschreven.) By default passer-by patients are excluded from the response.

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "cohorts": [
    ]
}

Group-by items

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • "age",
  • "preferredDoctor",
  • "insurer",
  • "gender",
  • "deprivedNeighborhood"
]

Deprived neighborhood

A simple report with a count of all patients living in a deprived neighborhood or regular one based on the well-known postcode table.

Authorizations:
BearerAuth
query Parameters
refDate
string <date> (date)
Example: refDate=1970-01-13

If present, the date used as context (any measurements available done afterwards aren't taken into account, any expiry calculations use this date as reference, and so forth). Defaults to today.

Responses

Response samples

Content type
application/json
{
  • "deprived": 42,
  • "regular": 256,
  • "unknown": 0
}

Deprived neighborhood, patients

The list of patients belonging to one of the categories, see neighborhood below.

Authorizations:
BearerAuth
path Parameters
neighborhood
string
Enum: "deprived" "regular" "unknown"
Example: deprived

The neighborhood is derived from the postcode. If the postcode is not valid, e.g. not in the regular language defined by [0-9]{4}\s*[a-zA-Z][a-zA-Z], then the neighborhood is 'unknown', otherwise the neighborhood is 'deprived' or 'regular'. The difference between the latter is based on national tables. NB: Asking for all patients in the regular group may result in access denied errors; these lists are generally large and not usually a worthwhile list to provide to medical professionals.

query Parameters
refDate
string <date> (date)
Example: refDate=1970-01-13

If present, the date used as context (any measurements available done afterwards aren't taken into account, any expiry calculations use this date as reference, and so forth). Defaults to today.

pii
boolean
Default: false
Example: pii=true

If false, limits the response to only patient ids.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employee turnover

Summaries the performance of employees expressed in feat count and turnover amounts. Only contract and national tariffs are used. Tariffs imported from any GPIS are ignored. Contract tariffs as registered by Zorg op Orde or, if not present, national tariffs as published by the government are used. Only to most recent years of national tariffs are available.

Authorizations:
BearerAuth
query Parameters
periodStart
string <date> (date)
Example: periodStart=1970-01-13

Start of the period (including) to summarize.

periodEnd
string <date> (date)
Example: periodEnd=1970-01-13

End of the period (excluding) to summarize.

gpCodes
Array of strings (Practitioner)
Example: gpCodes=AA,BZP,RZ,ECH

Restricts to the GP's which were medical responsible for the feat. Uses the GP at the time of the feat, or if not available, the GP responsible for the patient at the time of the GPIS-import. The GP at the time of the feat is the most accurate.

The responsible GP is not written in the response, due the structure of the agreggation.

employees
string (employee-alias)
Example: employees=MH,RZ,AXW

Restricts the selection of feats to one or more employees: an employee executed the feat.

excludeNilDeclarations
boolean

Declarations for which no tariff can determined, or which tariff equals zero, are omitted.

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "dict": {
    },
  • "employees": [
    ]
}

Frequent users

Gives insight and enumerates the patients who make most use of the practice. Use is defined as time needed from the doctor(s). Certain feat codes need more or less a constant time. These are used to get an approximation.

Visits report

Patient population projected on the number of visits.

Authorizations:
BearerAuth
query Parameters
periodStart
string <date> (date)
Example: periodStart=1970-01-13

Start of the period (including) to analyze.

periodEnd
string <date> (date)
Example: periodEnd=1970-01-13

End of the period (excluding) to analyze.

gpAgbs
Array of integers
Example: gpAgbs=01015678,01018765,01014321

If present, restrict report to patients registered to any of the GP AGBs listed here. The restriction is applied to the GP responsible for the patient now, not on the GP reponsislbe at the time of the feat.

gpMemocodes
Array of strings (Practitioner)
Example: gpMemocodes=AA

If present, restrict report to patients registered to any of the GPs listed here; list the memocode as used in the GP Information System. The restriction is applied to the GP responsible for the patient now, not on the GP reponsislbe at the time of the feat.

featCodes
integer (FeatCode)

The feats which are identified as time consuming or otherwise taking effort of the practice, defaults to: 12011,12411,12001,12401,12010,12410.

patients
Array of integers <int64> (pat-patId) [ items <int64 > ]
Example: patients=1234

If present, restrict output to only patients in this list.

Responses

Response samples

Content type
application/json
{
  • "frequencies": [
    ]
}

Frequent users

Lists the top n (1-50) frequent users (patients).

Authorizations:
BearerAuth
query Parameters
periodStart
string <date> (date)
Example: periodStart=1970-01-13

Start of the period (including) to analyze.

periodEnd
string <date> (date)
Example: periodEnd=1970-01-13

End of the period (excluding) to analyze.

gpAgbs
Array of integers

If present, restrict report to patients registered to any of the GP AGBs listed here. The restriction is applied to the GP responsible for the patient now, not on the GP responsible at the time of the feat.

gpMemocodes
Array of strings (Practitioner)
Example: gpMemocodes=01015678,01018765,01014321

If present, restrict report to patients registered to any of the GPs listed here; list the memocode as used in the GP Information System. The restriction is applied to the GP responsible for the patient now, not on the GP responsible at the time of the feat.

featCodes
integer (FeatCode)

The feats which are identified as time consuming or otherwise taking effort of the practice, defaults to: 12011,12411,12001,12401,12010,12410.

patients
Array of integers <int64> (pat-patId) [ items <int64 > ]
Example: patients=1234

If present, restrict output to only patients in this list.

pii
boolean
Example: pii=true

Allow personal identifying information in the response. Defaults to false if omitted. If false, only category, doctor, patid, patUnid and feats are in the response. In other words: they are always in the response, but can be extended with other pii properties, see non-required properties below.

limit
integer [ 1 .. 50 ]

Limits the output to the top 1 to 50 of the frequent users (patients). Defaults to 20 if omitted or not in the specified range.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Feats

Get the feats of a specific patient. Intended for use after the frequent user report. Is intended for statistical analysis purposes, does not replace the medical dossier.

Authorizations:
BearerAuth
query Parameters
periodStart
string <date> (date)
Example: periodStart=1970-01-13

Start of the period (including) to analyze.

periodEnd
string <date> (date)
Example: periodEnd=1970-01-13

End of the period (excluding) to analyze.

gpAgbs
Array of integers
Example: gpAgbs=01015678,01018765,01014321

If present, restrict report to patients registered to any of the GP AGBs listed here. The restriction is applied to the GP responsible for the patient now, not on the GP responsible at the time of the feat.

gpMemocodes
Array of strings (Practitioner)
Example: gpMemocodes=AA

If present, restrict report to patients registered to any of the GPs listed here; list the memocode as used in the GP Information System. The restriction is applied to the GP responsible for the patient now, not on the GP responsible at the time of the feat.

featCodes
integer (FeatCode)

The feats which are identified as time consuming or otherwise taking effort of the practice, defaults to: 12011,12411,12001,12401,12010,12410.

patId
integer <int64> (pat-patId)
Example: patId=1234

DEPRECATED this value will be removed in some future version and you should no longer rely on it. Some GPIS use non-numeric public IDs. Use value patPubId instead which is like this one, except a string instead of a number.

Patient's "public" ID, as used and shown on the GPIS patient page. Not necessarily unique, and not necessarily present; 0 indicates no patid is known or this GPIS does not use (numeric) public IDs.

The primary purpose of this field is to show it to medical professionals working at this practice who can use it to search for this dossier and is a way to communicate without sharing privacy-sensitive details.

The number is guaranteed to be positive, and have at most 14 digits. We suggest using a 64-bit numeric type to store the number; transferring this number via IEEE-double math (common, in JSON) is safe, as the number will not exceed the range within which all whole integers are perfectly representable (~`2^52`).

Responses

Response samples

Content type
application/json
{
  • "dict": {
    },
  • "feats": [
    ]
}

Quality of Care

API related to Quality of Care (QoC) features

A care program (dutch: ketenzorg or zorgprogramma) describes a specific disease (such as Diabetes or Astma) or a more abstract concern such as elderly care or general concern about cardiovascular health. The same care program can show up multiple times, as there are different care programs and standards for the same disease or concern. For example, there could be the InEen report 'take' on how one should provide Diabetes care, and there could be some regional group's slightly different take on it; these would show up as different care programs.

Any given customer has a 'fave' status for any given care program; some care programs are enabled by default and some are disabled by default. However, a customer can explicitly select a program they wouldn't ordinarily see ('favourite' it), or explicitly deselect a program they get by default ('unfavourite' it). Most care programs will be neither favourited nor unfavourited: They should be shown based on their defaultShow property.

To allow favouriting/unfavouriting, the front end has 2 separate views for selecting care programs: The usual view, which shows only:

  • Care programs that customer has explicitly favourited.
  • Care programs that are shown by default to this customer which they did not explicitly unfavourite.

As well as a 'config' view where they see all care programs that could possibly be relevant for that customer, where the customer can preview the report (essentially, run the report as normal), favourite something they don't get by default, or unfavourite something they get by default.

Care programs

Enumerate all care programs (ketens) in which the customer participates.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Indicator sets

List all available indicator sets. Includes all sets that the user is allowed to enable or preview, i.e. even ones that shouldn't be shown by default.

This endpoint is also reachable using URL /qoc/careprogram, but that endpoint is deprecated.

Authorizations:
BearerAuth
query Parameters
carePrograms
Array of strings (CareProgram-enum)
Example: carePrograms=COPD

A comma separated list of care program types, for example DM,COPD. The response is limited to the specified care programs.

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "indicatorsets": [
    ]
}

Indicator set

Provides indicators for a care program. An indicator set holds all indicators for a combination of a care program, reference date and a customer. Care groups and practices see different output. The authorisation for the care group to access care program data is taken in account.

Authorizations:
BearerAuth
path Parameters
setKey
required
string
Example: ZEL-dm

The key as listed in the /qoc/careprogram response.

query Parameters
refDate
string <date> (date)
Example: refDate=1970-01-13

The date in 2023-04-01 format; defaults to the sensible date for the indicator set you query, which is generally the first day of either this quarter, or the next quarter.

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "gpis": {
    },
  • "key": "ZOO-dm",
  • "name": "Diabetes Mellitus type 2 – per InEen 2023 accreditatie",
  • "careprogram": "COPD",
  • "refDate": "1970-01-13",
  • "calculating": 1,
  • "bars": [
    ],
  • "chapters": [
    ],
  • "cache": true
}

Indicator, patient detail

Show per-patient details for a specific indicator.

Authorizations:
BearerAuth
path Parameters
setKey
required
string
Example: ZEL-dm

The key as listed in the CareProgram schema.

indicatorKey
string
Example: ZOO-dm2-hb-3

The key as listed in the indicatorset.

query Parameters
refDate
string <date> (date)
Example: refDate=1970-01-13

The date in 2023-04-01 format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to 2023-07-01.

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "dict": {
    },
  • "gpis": {
    },
  • "key": "ZEL-dm2-bp-result",
  • "title": "Prevalentie Diabetes",
  • "type": "basic",
  • "refDate": "1970-01-13",
  • "htmlDescription": "Patiënten met ≥ 1 voorschrift(en) long acting beta-2 agonists (LABA) of long acting muscarine antagonists (LAMA) in de afgelopen 12 maanden",
  • "htmlDescriptionDetail": "LAMA (<code>R03BB</code> (04, 05, 06 of 07)) of LABA (<code>R03AC</code> (12, 13, 18 of 19))",
  • "focus": false,
  • "blocks": [
    ]
}

Indicator, practice details

Show per-practice details for each practice in a group for a specific indicator.

Authorizations:
BearerAuth
path Parameters
setKey
required
string
Example: ZEL-dm

The key as listed in the CareProgram schema.

indicatorKey
required
string
Example: ZOO-dm2-hb-3

The key as listed in the indicator set.

query Parameters
refDate
string <date> (date)
Example: refDate=1970-01-13

The date in 2023-04-01 format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to 2023-07-01.

group
string

The 'key' for the care group you want to retrieve data for. Providing this parameter is pointless unless the AGB code supplied via the agb parameter is responsible for more than one care group which is rare. A list of valid groups can be obtained via the list-groups endpoint.

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "group": "hwf",
  • "key": "ZEL-dm2-bp-result",
  • "title": "Prevalentie Diabetes",
  • "type": "basic",
  • "refDate": "1970-01-13",
  • "htmlDescription": "Patiënten met ≥ 1 voorschrift(en) long acting beta-2 agonists (LABA) of long acting muscarine antagonists (LAMA) in de afgelopen 12 maanden",
  • "htmlDescriptionDetail": "LAMA (<code>R03BB</code> (04, 05, 06 of 07)) of LABA (<code>R03AC</code> (12, 13, 18 of 19))",
  • "focus": false,
  • "xMin": 0.05,
  • "xMax": 0.105,
  • "markers": [
    ],
  • "unitDesc": "mmHg",
  • "legend": "[\n {\n \"title\": \"≥140\",\n \"category\": \"serious\",\n \"value\": 11\n },\n {\n \"title\": \"120-140\",\n \"category\": \"concern\",\n \"value\" 50\n },\n {\n \"title\": \"≤120\",\n \"category\": \"good\",\n \"value\": 60\n }\n]",
  • "skipped": [
    ],
  • "participants": [
    ],
  • "cache": true
}

Call-up status

Load call-up status for patients in a care program.

Returns each patient in a care program along with the progress on required or suggested measurements indicated for this care program. Also includes any custom callup policies as part of the response, and the callup plan for this quarter.

Every quarter, each patient is assigned a callup plan for just that quarter (it resets for every quarter). A callup plan is either 'call them up' or 'do not call them up'. Most patients start off in an 'open' state where no decision on whether to call them up has been made yet.

Callup policies are different: They aren't per quarter; instead they represent medical decisions that impact their chronic care. For example, 'this patient is not available for checkups until next year', or 'this patient is an amputee; do not consider a missing analysis of the feet as relevant'. They can have an explicitly chosen end date.

Call up plans have a default. Usually it is 'open' (no decision yet made on whether to call them up this quarter or not), but explicitly set policies as well as implicit policies chosen by the care group can affect this. For example, if a policy is set that the patient is not available for a few quarters, the plan defaults to 'do not call up' instead.

To enable making clear to the user via the UI exactly what choices have been made, the API services differentiates between what the default behaviour of a plan is; this is called the byPolicy plan - versus what the user explicitly chose.

In other words, a patient that defaults to 'do not call up' can be differentiated from a patient where an explicit choice was made to set their callup plan for the quarter to 'do not call up'. A patient that has defaulted to 'do not call up' can have that value change when the policies change; a patient that was explicitly set to 'do not call up' will not change the plan even if underlying policies change.

Policies are set vie the /qoc/callupPolicy endpoint.

Authorizations:
BearerAuth
path Parameters
setKey
required
string
Example: ZEL-dm

The key as listed in the CareProgram schema.

query Parameters
refDate
string <date> (date)
Example: refDate=1970-01-13

The date in 2023-04-01 format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to 2023-07-01.

birthMonth
integer [ 1 .. 12 ]

Restricts the patient list to those born in the specified month and those with no birthdate (rare case). The list of gp's is limited to those who are responsible to the patients in the restricted list. The initial calculation of the call-up list is not affected by the parameter.

If the parameter is omitted or specified outside its boundaries, then all patients are returned.

addr
boolean

Request inclusion of address information

bsn
boolean

Request inclusion of BSN information (dutch social security number)

email
boolean

Request inclusion of email addresses

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc

Responses

Response samples

Content type
application/json
{
  • "gpis": {
    },
  • "key": "ZOO-dm",
  • "name": "Diabetes Mellitus type 2 – per InEen 2023 accreditatie",
  • "careprogram": "COPD",
  • "refDate": "1970-01-13",
  • "calculating": 1,
  • "doctors": [
    ],
  • "indicators": [
    ],
  • "patients": [
    ]
}

Call-up status

Set call-up status for patients in a care program.

Authorizations:
BearerAuth
header Parameters
BSN
Array of integers <int32> (pat-BSN) [ items <int32 > [ 0 .. 999999999 ] ]
Deprecated
Example: 612345671,123456782,123456789

If the bsns key in de request body form is omitted, it can be replaced by this HTTP header. Supply a comma separated list of BSN's. The further processing is the same as the bsns key in the request body, including the limit on the size of the list.

Request Body schema: application/x-www-form-urlencoded

The request is designed to set the status of several patients, specified by patId (mensId) or BSN, at once. The endpoint is idempotent for the combination of careprogram, callUpStatus and BSN or patId. That means that the call-up status for a patient in a certain care program is just set once, until a new status is set. As a consequence only the employee who set first a certain status is stored, until somebody else (or the same employee) overwrites the status.

>= 4 items
careprogram
required
string (CareProgram-enum)

The kind of chronic care you want to set the call up status for.

callUpStatus
required
string
Enum: "byPolicy" "callUp" "dontCallUp" "scheduled"
employee
required
string (employee-alias)

Alias for the doctor, sometimes called memocode. Should be an unique identifier for a doctor in a GPIS.

quarter
string <date> (date)

Callup plans are specific to a single quarter and are returned only when asking for callup lists with this quarter as the refDate. Defaults to 'next quarter' (i.e. on April 5th, would default to July 1st).

bsns
Array of integers <int32> (pat-BSN) [ items <int32 > <= 1000 items [ 0 .. 999999999 ] ]

BSNs consisting only of zeros or only of nines or the empty BSN are ignored, i.e. BSNs matching regex ^0*|9*$ are ignored. BSNs are NOT checked to be valid ('elfproef'). BSNs may be zero-padded but don't have to be. One of bsns or patIds must be provided (but not both).

patIds
Array of integers <int64> (pat-patId) [ items <int64 > <= 1000 items ]

patient GPIS ids. One of bsns or patIds must be provided (but not both).

Responses

Response samples

Content type
application/json
{
  • "bsns": [
    ],
  • "patIds": [
    ]
}

Call-up policy

Gets all call-up policies of a patient for all indicators in which the patient participates, or for a specific indicator. Parameters are optional and simply filter the response; in other words, without parameters all policies are returned.

Authorizations:
BearerAuth
query Parameters
policyType
string (CallupPolicyType-enum-short)
Enum: "PatientIndicator" "PatientOnly" "IndicatorUser"
Example: policyType=PatientIndicator
patUnid
string (pat-patUnid)
Example: patUnid=1234

Show only policies for patients that match this unid. Not allowed if asking for UserIndicator.

bsn
integer <int32> (pat-BSN) [ 0 .. 999999999 ]
Example: bsn=123456789

Show only policies for patients that match this bsn. Not allowed if asking for UserIndicator.

indicatorKey
string
Example: indicatorKey=ZOO-dm2-hb-1

The version suffix of the indicator is ignored. Only for type UserIndicator and PatientIndicator.

refDate
string <date> (date)
Example: refDate=1970-01-13

Return only policies that haven't expired at this date. Defaults to 'next quarter').

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Call-up policy

Set a call-up policy. Policies last until a specific expiry (or forever). See the descriptions of policy types to get an idea of what policies do and what they represent.

Authorizations:
BearerAuth
Request Body schema: application/json
policyType
required
string (CallupPolicyType-enum-full)
Enum: "PatientIndicator" "PatientOnly" "IndicatorUser"

Call-up policies type. Various types are supported:

PatientIndicator
A policy that applies to a specific patient for a specific indicator. For example, a policy might capture the notion "This patient is an amputee and therefore, the frequency of doing foot inspections for chronic diabetes care should be 'never', forever". Or "This patient is going to receive an eye operation next year, therefore funduscopy is not useful, and the specialist team managing their eye care is responsible for it until after the operation and its recovery. Frequency set to 'never', until 2026-08-01". Such policies always refer to a specific patient and a specific indicator, may or may not have an expiry date, and always have a custom frequency.

The effect of this policy is to modify the 'callup state' for that patient/indicator combination. For example, the amputee would receive a - state for 'foot inspection' (indicating: Foot inspection is not relevant for this patient) instead of a 0 (indicating: Foot inspection must be done this quarter). Naturally, any policy that expires before the refDate of a callup list you're asking for doesn't apply.

PatientSnoozed
A policy that applies to a specific patient for a certain care program type (e.g. `COPD`), and indicates that providing chronic care at the GP level is not possible for a limited time. For longer 'snoozing' the advice is generally to set the GPIS based registration of chronic care participation (i.e. the value 'COKZ' (COPD chronic care participation) to 'No'), but when the situation is temporary and a medical operator knows when the situation ends, this policy can be used instead, which has the advantage of restoring the patient to chronic care reporting automatically when the policy is expires. `expiry` is mandatory for this type of policy.

The effect of this policy is to default the patient's call up plan (the chosenStatus is byPolicy) to doNotCallup until the policy expires.

UserIndicator
WARNING: Not current available (not implemented yet).

This policy applies to a specific indicator, for all patients. Can be used to represent "our ECG machine is broken until 2025-10-01" for example, or "providing flu injections is done by a different team than DM chronic care therefore this indicator does not apply to me".

The effect of this policy is to mark it as 'not relevant' for all patients. It is not possible to configure an alternate frequency; that would be a modification of the protocol itself which can be implemented by contacting Zorg op Orde to discuss a customised protocol.

patUnid
string (pat-patUnid)

Patient's unique and persistent ID in GPIS. Usually identical to patPubId but certain GPISes may use UUID, or has globally unique keys (e.g. very large numbers). Can be blank, but only if supplying GPIS does not send them.

bsn
integer <int32> (pat-BSN) [ 0 .. 999999999 ]

Patient SSN (dutch: BSN). If not known or patient has no BSN, this value will be 0.

It is customary that BSNs are 9 digits; this API returns a number, i.e., no leading zeroes. API callers may want to transform this value into a string by explicitly left-padding 0 characters to the front to make the bsn value 9 digits.

indicatorKey
string

The key of the indicator as listed in the indicator set. The version of the indicator is ignored (if the string ends in a dash and a number, those are stripped). Only relevant for IndicatorUser and UserIndicator.

reason
string

An optional human written reason for why the policy is being applied.

expires
string <date> (date)

If provided, this policy does not apply on and after this date. Mandatory for certain types of policy.

frequency
string (CallupPolicyFrequency)
Enum: "quarter" "sixMonths" "year" "twoYear" "threeYear" "fiveYear" "never"

The stated patient should have the stated indicator checked with this frequency instead of the standard frequency as per the care protocol for this care program. The callup state is modified accordingly, except for the special value of never which means te callup state is reported as - ('not relevant for this patient').

employee
required
string (employee-string)

A string that identifies the employee who is setting this policy.

Responses

Request samples

Content type
application/json
{
  • "policyType": "PatientIndicator",
  • "patUnid": "1234",
  • "bsn": 123456789,
  • "indicatorKey": "ZOO-dm2-hb-3",
  • "reason": "Zit op een boorplatform.",
  • "expires": "1970-01-13",
  • "frequency": "never",
  • "employee": "Mien Dobbelsteen"
}

Call-up policy

Unset a call-up policy.

Authorizations:
BearerAuth
query Parameters
policyType
string (CallupPolicyType-enum-short)
Enum: "PatientIndicator" "PatientOnly" "IndicatorUser"
Example: policyType=PatientIndicator
patUnid
string (pat-patUnid)
Example: patUnid=123456

Patient's unique and persistent ID in GPIS. Usually identical to patPubId but certain GPISes may use UUID, or has globally unique keys (e.g. very large numbers). Can be blank, but only if supplying GPIS does not send them.

bsn
integer <int32> (pat-BSN) [ 0 .. 999999999 ]
Example: bsn=123456789

Patient SSN (dutch: BSN). If not known or patient has no BSN, this value will be 0.

It is customary that BSNs are 9 digits; this API returns a number, i.e., no leading zeroes. API callers may want to transform this value into a string by explicitly left-padding 0 characters to the front to make the bsn value 9 digits.

indicatorKey
string
Example: indicatorKey=ZOO-dm2-hb-1

The version suffix of the indicator is ignored (if any). Only relevant for IndicatorUser and UserIndicator.

reason
string

Some random string describing the reason. May be omitted.

employee
string (employee-string)
Example: employee=Mien Dobbelsteen

Employee who withdraws the policy for the patient and indicator combination.

Indicator, care groups

Show all care groups available for indicator reports. A group is a group of GP practices that do (part) of chronic care together.

Authorizations:
BearerAuth
query Parameters
refDate
string <date> (date)
Example: refDate=1970-01-13

The date in 2023-04-01 format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to 2023-07-01.

Responses

Response samples

Content type
application/json
{
  • "refDate": "1970-01-13",
  • "groups": [
    ]
}

Data quality

Show each participating GP practice as well as the status of their data for a given indicator report and a given group.

Authorizations:
BearerAuth
query Parameters
setKey
string
Example: setKey=ZEL-dm

The key as listed in the CareProgram schema. If omitted, information about participating in a specific care program will not be provided.

group
string
Example: group=hwf

The key as listed in the list-groups endpoint. Defaults to the only allowed group if the authentication party only has one; otherwise required.

refDate
string <date> (date)
Example: refDate=1970-01-13

The date in 2023-04-01 format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to 2023-07-01.

Responses

Response samples

Content type
application/json
{
  • "group": "hwf",
  • "calculatedAt": "19700131T235901",
  • "refDate": "1970-01-13",
  • "key": "ZOO-dm",
  • "title": "Diabetes Mellitus type 2",
  • "participants": [
    ]
}

Customer management

Practices and care programs

Gets all practices of a care group and their participation in a care program.

Enumerates all practices for which the current customer (user) is responsible in the care group. The customer identified with the JWT must be the group manager. The care group must be responsible for the underlying practices. Some care groups are organized in a way that they are not allowed to process data of the member practices. For these care groups no practices are shown.

Only care programs to which the practice was added by the authorised care group are shown. That means if a practice moves to another care group, then the registered care programs are gone.

If the JWT identifies a single practice, then API runs in bare mode. The response in this mode has the same structure, but the list of care programs of the care group is always empty and the list of practices holds exactly one practice.

Authorizations:
BearerAuth
query Parameters
refDate
string <date> (date)
Example: refDate=1970-01-13

If omitted, today is taken.

agbs
Array of integers (agb) [ items [ 1 .. 99999999 ] ]
Example: agbs=12345678,23456789

If the requesting entity is a care group, all GP practices in the group will be returned; this parameter can be used to filter the list, so that only those GP practices with one of the AGBs listed here are returned. If the requesting entity is a single GP practice, this parameter is ignored.

Responses

Response samples

Content type
application/json
{
  • "caregroup": {
    },
  • "practices": [
    ]
}

Add a practice to a care program.

Allows a care group manager to configure which care programs are actively participated in by a GP practice.

The caller must authorize itself as a care group (manager).

The care group must be allowed to take responsibility for the practices it holds. If not, the request is ignored and an empty Json-object is sent back to the caller, indicating that processing was not successful.

The practice must be one of the care group practices. If not, the request is ignored and an empty Json-object is sent back to the caller.

In all other cases a Json-object containing the same data as in the request with a timestamp added is sent back in the response.

The operation is idempotent for the combination of: careprogram, agb, periodStart and periodEnd. If these are the same in any subsequent call the request is processed as being fully accepted, showing the request data in the response, but the employee and timestamp aren't updated in the database. The timestamp and employee of the original submit to this API is included in the response instead of the provided values.

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
careprogram
required
string (CareProgram-enum)

The kind of care program that the practice participates in.

agb
required
integer (agb) [ 1 .. 99999999 ]

The AGB of the practice (not the doctor).

periodStart
required
string <date> (date)

If periodEnd is supplied, then the periodStart must meet the condition that periodStart < periodEnd. The period starts on periodStart and ends on the day before periodEnd, so the start date is inclusive and end date exclusive.

periodEnd
string <date> (date)

See periodStart.

employee
required
string

The employee that is adding the practice. Any string is accepted, but it is recommended to use a employee code derived from this API.

Responses

Response samples

Content type
application/json
{
  • "employee": "string",
  • "timestamp": "19700131T235901",
  • "careprogram": "COPD",
  • "agb": 1053293,
  • "periodStart": "1970-01-13",
  • "periodEnd": "1970-01-13"
}

Update only the period end

Updates only the period end date of the participation of a practice in a care program. This is equivalent to submitting a new participation to this API, but, the periodStart parameter is not needed. Requires that this practice already participates in the provided care program (and that participation will have its end date updated).

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
careprogram
required
string (CareProgram-enum)

The kind of care program that the practice participates in.

agb
required
integer (agb) [ 1 .. 99999999 ]

The AGB of the practice (not the doctor).

employee
required
string

The employee that is adding the practice. Any string is accepted, but it is recommended to use a employee code derived from this API.

periodEnd
string <date> (date)

The end of the period of the participation. Allowed to be not set or empty, when no end date is known. If set, periodEnd must be at least a day after the periodStart which is stored for the combination of careprogram and agb.

Responses

Response samples

Content type
application/json
{
  • "employee": "string",
  • "timestamp": "19700131T235901",
  • "careprogram": "COPD",
  • "agb": 1053293,
  • "periodStart": "1970-01-13",
  • "periodEnd": "1970-01-13"
}

Basic info

Authorizations:
BearerAuth
query Parameters
agb
integer (agb) [ 1 .. 99999999 ]
Example: agb=1053293

AGB of the practice for which basic info is requested. If the requesting entity is a single GP practice, this parameter can be omitted.

Responses

Response samples

Content type
application/json
{
  • "practice": {
    }
}

Basic info

Only certain properties of a practice can be updated. After updating the same response is outputted as when using GET.

Authorizations:
BearerAuth
query Parameters
agb
integer (agb) [ 1 .. 99999999 ]
Example: agb=1053293

AGB of the practice for which basic info is requested. If the requesting entity is a single GP practice, this parameter can be omitted.

Request Body schema: application/x-www-form-urlencoded

When authorized as a practice the address and contact data can be changed. Currently, if authorized as a care group, no properties can be changed.

Properties can be omitted if you do not want to change them. address1 and postcode cannot be set to empty.

address1
string

The first line of the practice postal address (street name and house number, generally).

postcode
string (postcode)

Any valid Dutch postcode, with or without whitespacing and in lower- or uppercase.

city
string (city)

The city or town.

tel
string

A Dutch phone number of 10 digits. Additional dashes and spacing are removed before validating.

email
string <email>

Responses

Response samples

Content type
application/json
{
  • "practice": {
    }
}

GPIS exports

List and download exported parts of GPIS dossiers.

List available exports

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "exportSources": [
    ]
}

Download an available export

Authorizations:
BearerAuth
path Parameters
agb
required
integer (agb) [ 1 .. 99999999 ]
Example: 1053293

The AGB code of the practice for the export file you want to download.

filename
required
string

The name of the file as provided by the /exports/available endpoint.

Responses

Download one CSV table from an available export

Authorizations:
BearerAuth
path Parameters
agb
required
integer (agb) [ 1 .. 99999999 ]
Example: 1053293

The AGB code of the practice for the export file you want to download.

filename
required
string

The name of the file as provided by the /exports/available endpoint.

tablename
required
string

The name of one of the tables in the export as provided by the /exports/available endpoint's tables list.

Responses