Patient

This is based on the FHIR Patient resource.

Key Information

Integrating patient data into the Bingli API requires correctly structuring your request according to the FHIR standard. This ensures smooth interoperability between Bingli and your healthcare system.

Essential Parameters

Tenant Reference (Tenant_ID)

• Description: A unique identifier provided by Bingli for each tenant.
• Usage: Used in API requests to link the data to a specific tenant.

Patient Identifier

• Description: Unique identifiers assigned to a patient, such as hospital numbers or government-issued IDs.
• Usage: Ensures that the patient record correctly maps to the tenant’s system.

Patient Language

• Description: The language code representing the patient's preferred language.
• Usage: Required to personalize interactions with the patient.
• Examples: nl-be (Dutch in Belgium), en-us (English in the U.S.), fr-fr (French in France).

---

API Environments

Bingli provides multiple environments for different use cases:

• Production EU: https://fhir-gateway.api.bingli.eu/tenant-api/patient
• Acceptance EU: https://fhir-gateway.api.acc.bingli.be/tenant-api/patient
• Production US: https://fhir-gateway.api.bingli.us/tenant-api/patient

---

Creating a Patient

POST - Create Patient

Endpoint

https://fhir-gateway.api.bingli.eu/tenant-api/patient

Description

This endpoint is used to create a patient record within the Bingli system. If the patient does not already exist, Bingli will generate a new record and link it to your tenant's system.

---

Request Details

Headers

Key	Value
Content-Type	application/fhir+json
Authorization	Bearer JWTTOKEN

Body (Raw JSON)

{
    "resourceType": "Patient",
    "id": "<YOUR-PATIENT-ID>",
    "communication": [{
        "language": {
            "coding": [{
                "system": "http://hl7.org/fhir/ValueSet/languages",
                "code": "<PATIENT-LANGUAGE>"
            }]
        }
    }],
    "identifier": [
        {
            "system": "http://rrn.fgov.be/be-rrn",
            "value": "<PATIENT-RRN>"
        },
        {
            "system": "https://fhir.tenant.com/ns/hospital-patient-number",
            "value": "<PATIENT-HOSPITAL-NR>"
        }
    ],
    "name": [
        {
            "family": "<PATIENT-FAMILY-NAME>",
            "given": [
                "<PATIENT-GIVEN-NAME>"
            ]
        }
    ],
    "telecom": [
        {
            "system": "email",
            "value": "<PATIENT-EMAIL>"
        },
        {
            "system": "sms",
            "value": "<PATIENT-SMS>"
        }
    ],
    "gender": "<PATIENT-GENDER>",
    "birthDate": "<PATIENT-BIRTHDAY>"
}

cURL Request

To create a patient using cURL, use the following command:

curl --location 'https://fhir-gateway.api.bingli.eu/tenant-api/patient' \
--header 'Content-Type: application/fhir+json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "resourceType": "Patient",
    "id": "<YOUR-PATIENT-ID>",
    "communication": [{
        "language": {
            "coding": [{
                "system": "http://hl7.org/fhir/ValueSet/languages",
                "code": "<PATIENT-LANGUAGE>"
            }]
        }
    }],
    "identifier": [
        {
            "system": "http://rrn.fgov.be/be-rrn",
            "value": "<PATIENT-RRN>"
        },
        {
            "system": "https://fhir.tenant.com/ns/hospital-patient-number",
            "value": "<PATIENT-HOSPITAL-NR>"
        }
    ],
    "name": [
        {
            "family": "<PATIENT-FAMILY-NAME>",
            "given": [
                "<PATIENT-GIVEN-NAME>"
            ]
        }
    ],
    "telecom": [
        {
            "system": "email",
            "value": "<PATIENT-EMAIL>"
        },
        {
            "system": "sms",
            "value": "<PATIENT-SMS>"
        }
    ],
    "gender": "<PATIENT-GENDER>",
    "birthDate": "<PATIENT-BIRTHDAY>"
}'

Parameters Explanation

• id: Unique identifier for the patient in your system.
• communication.language.coding.code: The preferred language of the patient.
• identifier.system: System that identifies the patient.
• identifier.value: Unique patient number.
• name.family: Patient's last name.
• name.given: Patient's first name(s).
• telecom.system: Communication method (email or SMS).
• telecom.value: Contact details.
• gender: Patient's gender (male or female).
• birthDate: Patient's date of birth (YYYY-MM-DD).

---

Fetching a Patient

GET - GET Patient

Endpoint

https://fhir-gateway.api.bingli.eu/tenant-api/patient/<YOUR-PATIENT-ID>

Description

This endpoint fetches an existing patient within the Bingli system.

---

Request Details

Headers

Key	Value
Authorization	Bearer JWTTOKEN

cURL Request

To fetch a patient using cURL, use the following command:

curl --location 'https://fhir-gateway.api.bingli.eu/tenant-api/patient/<YOUR-PATIENT-ID>' \
--header 'Authorization: Bearer <TOKEN>'

Parameters Explanation

• id: Unique identifier for the patient in your system.

---

Updating a Patient

PUT - Update Patient

Endpoint

https://fhir-gateway.api.bingli.eu/tenant-api/patient/<YOUR-PATIENT-ID>

Description

This endpoint is used to update a patient record within the Bingli system.

---

Request Details

Headers

Key	Value
Content-Type	application/fhir+json
Authorization	Bearer JWTTOKEN

Body (Raw JSON)

{
    "resourceType": "Patient",
    "id": "<YOUR-PATIENT-ID>",
    "communication": [{
        "language": {
            "coding": [{
                "system": "http://hl7.org/fhir/ValueSet/languages",
                "code": "<PATIENT-LANGUAGE>"
            }]
        }
    }],
    "identifier": [
        {
            "system": "http://rrn.fgov.be/be-rrn",
            "value": "<PATIENT-RRN>"
        },
        {
            "system": "https://fhir.tenant.com/ns/hospital-patient-number",
            "value": "<PATIENT-HOSPITAL-NR>"
        }
    ],
    "name": [
        {
            "family": "<PATIENT-FAMILY-NAME>",
            "given": [
                "<PATIENT-GIVEN-NAME>"
            ]
        }
    ],
    "telecom": [
        {
            "system": "email",
            "value": "<PATIENT-EMAIL>"
        },
        {
            "system": "sms",
            "value": "<PATIENT-SMS>"
        }
    ],
    "gender": "<PATIENT-GENDER>",
    "birthDate": "<PATIENT-BIRTHDAY>"
}

cURL Request

To update a patient using cURL, use the following command:

curl --location --request PUT 'https://fhir-gateway.api.bingli.eu/tenant-api/patient/<YOUR-PATIENT-ID>' \
--header 'Content-Type: application/fhir+json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "resourceType": "Patient",
    "id": "<YOUR-PATIENT-ID>",
    "communication": [{
        "language": {
            "coding": [{
                "system": "http://hl7.org/fhir/ValueSet/languages",
                "code": "<PATIENT-LANGUAGE>"
            }]
        }
    }],
    "identifier": [
        {
            "system": "http://rrn.fgov.be/be-rrn",
            "value": "<PATIENT-RRN>"
        },
        {
            "system": "https://fhir.tenant.com/ns/hospital-patient-number",
            "value": "<PATIENT-HOSPITAL-NR>"
        }
    ],
    "name": [
        {
            "family": "<PATIENT-FAMILY-NAME>",
            "given": [
                "<PATIENT-GIVEN-NAME>"
            ]
        }
    ],
    "telecom": [
        {
            "system": "email",
            "value": "<PATIENT-EMAIL>"
        },
        {
            "system": "sms",
            "value": "<PATIENT-SMS>"
        }
    ],
    "gender": "<PATIENT-GENDER>",
    "birthDate": "<PATIENT-BIRTHDAY>"
}'

Parameters Explanation

• id: Unique identifier for the patient in your system.
• communication.language.coding.code: The preferred language of the patient.
• identifier.system: System that identifies the patient.
• identifier.value: Unique patient number.
• name.family: Patient's last name.
• name.given: Patient's first name(s).
• telecom.system: Communication method (email or SMS).
• telecom.value: Contact details.
• gender: Patient's gender (male or female).
• birthDate: Patient's date of birth (YYYY-MM-DD).

---

Conclusion

Successfully creating a patient in the Bingli system enables smooth integration between your healthcare system and Bingli’s API. For further details, refer to the Bingli API Documentation or contact support@mybingli.com.