Skip to main content

Patient Information

The patient search API follows the FHIR standard for searching for patients. However, it only allows the retrieval of one patient at a time, and is therefore practically patient-bound.

The two types of requests available are:

  • GET <TENANT_BASE_URL>/fhir/R4/Patient?identifier=http://fhir.nl/fhir/NamingSystem/bsn|<IDENTIFIER>
    Finds a patient by BSN. Primarily used for initial onboarding of the patient, to look up the patient ID.
  • GET <TENANT_BASE_URL>/fhir/R4/Patient/<PATIENT_ID>
    Retrieves a single patient by ID. Useful for retrieving patient information after the initial onboarding.

Linking a new identifier to a patient​

To associate a system's identifier to a patient, you can use the $add-identifier operation. This operation does, in one call, a search for the patient by BSN system and value, and if found, adds the identifier to the patient and returns the updated patient.

Note: Only one identifier with the same system can be added to a patient. If you try to add a second identifier with the same system, the operation will return a warning.

  • POST <TENANT_BASE_URL>/fhir/R4/Patient/$add-identifier
{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "bsn",
            "valueString": "12345678901"
        }
        {
            "name": "identifier",
            "valueIdentifier": {
                "system": "http://some-system.nl/fhir/NamingSystem/id",
                "value": "123456789"
            }
        }
    ]
}

Removing an identifier from a patient​

To remove an identifier from a patient, you can use the $remove-identifier operation.

  • POST <TENANT_BASE_URL>/fhir/R4/Patient/<PATIENT_ID>/$remove-identifier
{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "identifier",
            "valueIdentifier": {
                "system": "http://some-system.nl/fhir/NamingSystem/id",
                "value": "123456789"
            }
        }
    ]
}