Skip to main content

Organization

This is based on the FHIR Organization resource.

Key Information​

Integrating organization data into the Bingli API requires 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.

Organization Identifier​

  • Description: Unique identifiers assigned to an organization, ensuring consistent identification across systems.
  • Usage: Required to establish the organization within Bingli's system.

API Environments​

Bingli provides multiple environments for different use cases:

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

Creating an Organization​

POST - Create Organization​

Endpoint​

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

Description​

This endpoint facilitates the creation of a new organization within Bingli, enabling structured data exchange between systems. It ensures that the organization details are properly linked and stored in the Bingli database.

Request Details​

Headers​

KeyValue
Content-Typeapplication/fhir+json
AuthorizationBearer JWTTOKEN

Body (Raw JSON)​

{
    "resourceType": "Organization",
    "id": "<YOUR-ID-FOR-BINGLI>",
    "identifier": [
        {
            "system": "http://fhirgateway.bingli.com/identifier/TenantId",
            "value": "<TENANT-ID-FROM-BINGLI>"
        }
    ],
    "name": "<YOUR-NAME-FOR-BINGLI-INTEGRATION>"
}

cURL Request​

To create an organization using cURL, use the following command:

curl --location 'https://fhir-gateway.api.bingli.eu/tenant-api/organization' \
--header 'Content-Type: application/fhir+json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "resourceType": "Organization",
    "id": "<YOUR-ID-FOR-BINGLI>",
    "identifier": [
        {
            "system": "http://fhirgateway.bingli.com/identifier/TenantId",
            "value": "<TENANT-ID-FROM-BINGLI>"
        }
    ],
    "name": "<YOUR-NAME-FOR-BINGLI-INTEGRATION>"
}'

Parameters Explanation​

  • id: Unique identifier for the organization within your system.
  • identifier.system: System that identifies the organization.
  • identifier.value: The tenant ID received from Bingli.
  • name: The name of the organization being integrated with Bingli.

Fetching an Organization​

GET - Fetch Organization​

Endpoint​

https://fhir-gateway.api.bingli.eu/tenant-api/organization/<YOUR-ID-FOR-BINGLI>

Description​

This endpoint retrieves the details of a given organization previously created within Bingli.

Request Details​

Headers​

KeyValue
AuthorizationBearer JWTTOKEN

cURL Request​

To fetch an organization using cURL, use the following command:

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

Parameters Explanation​

  • id: Unique identifier for the organization within your system.

Updating an Organization​

PUT - Update Organization​

Endpoint​

https://fhir-gateway.api.bingli.eu/tenant-api/organization/<YOUR-ID-FOR-BINGLI>

Description​

This endpoint updates the details of a given organization that already exists within Bingli.

Request Details​

Headers​

KeyValue
Content-Typeapplication/fhir+json
AuthorizationBearer JWTTOKEN

Body (Raw JSON)​

{
    "resourceType": "Organization",
    "id": "<YOUR-ID-FOR-BINGLI>",
    "identifier": [
        {
            "system": "http://fhirgateway.bingli.com/identifier/TenantId",
            "value": "<TENANT-ID-FROM-BINGLI>"
        }
    ],
    "name": "<YOUR-NAME-FOR-BINGLI-INTEGRATION>"
}

cURL Request​

To update an organization using cURL, use the following command:

curl --location --request PUT 'https://fhir-gateway.api.bingli.eu/tenant-api/organization/<YOUR-ID-FOR-BINGLI>' \
--header 'Content-Type: application/fhir+json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "resourceType": "Organization",
    "id": "<YOUR-ID-FOR-BINGLI>",
    "identifier": [
        {
            "system": "http://fhirgateway.bingli.com/identifier/TenantId",
            "value": "<TENANT-ID-FROM-BINGLI>"
        }
    ],
    "name": "<YOUR-NAME-FOR-BINGLI-INTEGRATION>"
}'

Parameters Explanation​

  • id: Unique identifier for the organization within your system.
  • identifier.system: System that identifies the organization.
  • identifier.value: The tenant ID received from Bingli.
  • name: The name of the organization being integrated with Bingli.

Conclusion​

Successfully creating an organization 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.