Cerner connector
Connectors continue to be released outside the IDM release. For the latest documentation, refer to the ICF documentation. |
Cerner is a healthcare-related service which provides an integrated healthcare IT solution for large healthcare providers. The Cerner connector lets you manage and synchronize accounts between Cerner and IDM managed user objects. A Cerner system account is required for this connector to work.
Before you start
Before you configure the connector, log in to your Cerner system account and note the following:
- Bearer token
-
The bearer token associated with your system account.
- Tenant
-
Your Cerner tenant ID.
- Region
-
The Cerner Cloud region where the tenant resides.
Install the Cerner connector
Download the connector .jar file from the ForgeRock BackStage download site.
-
If you are running the connector locally, place it in the
/path/to/openidm/connectors
directory, for example:mv ~/Downloads/cerner-connector-1.5.20.15.jar /path/to/openidm/connectors/
-
If you are using a remote connector server (RCS), place it in the
/path/to/openicf/connectors
directory on the RCS.
Configure the Cerner connector
Create a connector configuration using the admin UI:
-
Select Configure > Connectors and click New Connector.
-
Enter a Connector Name.
-
Select Cerner Connector - 1.5.20.15 as the Connector Type.
-
Provide the Base Connector Details.
-
Click Save.
When your connector is configured correctly, the connector displays as Active in the admin UI.
Alternatively, test that the configuration is correct by running the following command:
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Accept-API-Version: resource=1.0" \ --request POST \ "http://localhost:8080/openidm/system/Cerner?_action=test" { "name": "Cerner", "enabled": true, "config": "config/provisioner.openicf/Cerner", "connectorRef": { "bundleVersion": "[1.5.0.0,1.6.0.0)", "bundleName": "org.forgerock.openicf.connectors.cerner-connector", "connectorName": "org.forgerock.openicf.connectors.cerner.CernerConnector" }, "displayName": "Cerner Connector", "objectTypes": [ "__ORGANIZATION__", "__ACCOUNT__", "__ORGANIZATIONGROUP__", "__ALL__", "__PERSONNELGROUP__" ], "ok": true }
If the command returns "ok": true
, your connector was configured correctly and can authenticate to the Cerner system.
Use the Cerner connector
Connector resource | Cerner resource type |
---|---|
|
Personnel |
|
Organization |
|
Personnel Group |
|
Organization Group |
__ACCOUNT__
attributes
Attribute | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
The user’s name, in a |
||||||||||||
|
Must be in |
||||||||||||
|
Accepted values are |
||||||||||||
|
The user’s first name. Required. |
||||||||||||
|
The user’s last name. Required. |
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
|
Accepted values are: |
||||||||||||
|
|||||||||||||
|
|||||||||||||
|
|
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
|
For a list of valid language tags, refer to the Internet Assigned Numbers Authority (IANA) language subtag registry. |
__ORGANIZATION__
attributes
Attribute | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
The name of the organization. This corresponds to |
||||||||||||
|
The name of the organization. Required. |
||||||||||||
|
Alias types related to the organization. |
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
|
For a list of valid language tags, refer to the Internet Assigned Numbers Authority (IANA) language subtag registry. |
||||||||||||
|
The postal codes indicating the area of coverage provided by the organization. |
||||||||||||
|
|
__PERSONNELGROUP__
attributes
Attribute | Notes | ||||||
---|---|---|---|---|---|---|---|
|
A comma-separated name for the personnel group. |
||||||
|
The mnemonic determines the function of the personnel group. |
||||||
|
The type of the personnel group mnemonic. Usually either |
||||||
|
The name of the personnel group. |
||||||
|
|
||||||
|
The type of alias. Requires |
||||||
|
The source of the alias value. Requires |
||||||
|
The unique identifier of alias. Requires |
__ORGANIZATIONGROUP__
attributes
Attribute | Notes | ||||||
---|---|---|---|---|---|---|---|
|
A comma-separated name for the organization group. |
||||||
|
A list of organization IDs that are members of the organization group. |
||||||
|
The name of the organization group. |
||||||
|
|
||||||
|
The type of alias. Requires |
||||||
|
The source of the alias value. Requires |
||||||
|
The unique identifier of alias. Requires |
You can use the Cerner connector to perform the following actions on a Cerner account:
Create a Cerner user
The following example creates a user with the minimum required attributes:
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request POST \ --data '{ "given": "Barbara", "family": "Jensen", "aliasType": "USER", "__NAME__": "Jensen, Barbara" }' \ "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__?_action=create" { "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "updatedAt": "2022-04-29T22:54:08Z", "given": "Barbara", "name": { "given": "Barbara", "family": "Jensen", "formatted": "Barbara Jensen" }, "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "languages": [], "formattedName": "Barbara Jensen", "aliases": { "type": "USER", "value": "Jensen", "system": "Barbara" }, "aliasValue": "Jensen", "__NAME__": "Jensen,Barbara", "createdAt": "2022-04-29T22:54:08Z", "aliasType": "USER", "family": "Jensen", "isManual": true, "aliasSystem": "Barbara" }
When you create a new user, you must specify at least |
Update a Cerner user
You can modify an existing user with a PUT request, including all attributes of the account in the request:
For example, to add the user’s middle name:
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match:*" \ --request PUT \ --data '{ "given": "Barbara", "family": "Jensen", "aliasType": "USER", "__NAME__": "Jensen, Barbara", "name": { "middle": "Simone" } }' \ "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" { "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "updatedAt": "2022-04-29T23:03:57Z", "given": "Barbara", "name": { "given": "Barbara", "middle": "Simone", "family": "Jensen", "formatted": "Barbara Simone Jensen" }, "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "languages": [], "formattedName": "Barbara Simone Jensen", "aliases": { "type": "USER", "value": "Jensen", "system": "Barbara" }, "aliasValue": "Jensen", "__NAME__": "Jensen,Barbara", "createdAt": "2022-04-29T22:54:08Z", "aliasType": "USER", "family": "Jensen", "isManual": true, "aliasSystem": "Barbara" }
Query Cerner users
The following example queries all Cerner users:
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request GET \ "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__?_queryId=query-all-ids" { "result": [ { "_id": "7d9538c8-1c2a-4894-a403-129b35308f39" }, { "_id": "8f1c2671-9ebb-4105-9537-a3a0fc24afce" }, { "_id": "ac944860-705f-4487-99bf-6959c5e6157c" }, { "_id": "d308e459-51fa-469a-a07e-72f96906a4b4" }, { "_id": "ff9d6902-20be-4c6e-821a-5a0f3ccaebc8" }, { "_id": "bf2b9346-715e-4f59-9dc5-2bc89b8216cd" }, { "_id": "055def33-a845-4100-bcd1-2b59a3526ec5" }, { "_id": "167609b8-dfd0-4302-9022-4a3e8809b166" }, [ ... ] { "_id": "9f4ea23d-bacc-46ee-b8c9-75916a5f5128" }, { "_id": "a4d6be21-a5ce-4a56-91af-94c627701d4f" } ], "resultCount": 1020, "pagedResultsCookie": null, "totalPagedResultsPolicy": "NONE", "totalPagedResults": -1, "remainingPagedResults": -1 }
Querying all ids can take a significant amount of time to return when the data set is large. Consider using paginated results instead, for example: curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request GET \ "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__?_queryFilter=true&_fields=_id&_pageSize=2&_pagedResultsOffset=50" { "result": [ { "_id": "878c87d4-8322-4908-a858-555a1cb45e36" }, { "_id": "9ecaa98b-58df-4dd1-bc99-34341411b151" } ], "resultCount": 2, "pagedResultsCookie": null, "totalPagedResultsPolicy": "NONE", "totalPagedResults": -1, "remainingPagedResults": -1 } |
The following command queries a specific user by their ID:
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request GET \ "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" { "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "updatedAt": "2022-04-29T23:03:57Z", "given": "Barbara", "name": { "given": "Barbara", "middle": "Simone", "family": "Jensen", "formatted": "Barbara Simone Jensen" }, "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "languages": [], "formattedName": "Barbara Simone Jensen", "aliases": { "type": "USER", "value": "Jensen", "system": "Barbara" }, "aliasValue": "Jensen", "__NAME__": "Jensen,Barbara", "createdAt": "2022-04-29T22:54:08Z", "aliasType": "USER", "family": "Jensen", "isManual": true, "aliasSystem": "Barbara" }
Delete a Cerner user account
You can use the Cerner connector to delete an account from the Cerner repository.
The following example deletes a Cerner account:
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request DELETE \ "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" { "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "updatedAt": "2022-04-29T23:03:57Z", "given": "Barbara", "name": { "given": "Barbara", "middle": "Simone", "family": "Jensen", "formatted": "Barbara Simone Jensen" }, "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "languages": [], "formattedName": "Barbara Simone Jensen", "aliases": { "type": "USER", "value": "Jensen", "system": "Barbara" }, "aliasValue": "Jensen", "__NAME__": "Jensen,Barbara", "createdAt": "2022-04-29T22:54:08Z", "aliasType": "USER", "family": "Jensen", "isManual": true, "aliasSystem": "Barbara" }
All supported resources can be queried. You can update user accounts, organizations, organization groups, and personnel groups, but only user accounts can be created or deleted. Available additional operations include:
Assign personnel groups to a user
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match:*" \ --request PUT \ --data '{ "given": "Barbara", "family": "Jensen", "aliasType": "USER", "__NAME__": "Jensen, Barbara", "name": { "middle": "Simone" }, "personnelGroupId": [ "8636d4c3-de7c-4f8a-828b-b709d6bfd636" ] }' \ "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" { "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "formattedName": "Barbara Simone Jensen", "__NAME__": "Jensen,Barbara", "aliasValue": "Jensen", "family": "Jensen", "updatedAt": "2022-10-25T23:50:31Z", "aliasType": "USER", "given": "Barbara", "organizationId": [], "aliasSystem": "Barbara", "name": { "given": "Barbara", "middle": "Simone", "family": "Jensen", "formatted": "Barbara Simone Jensen" }, "languages": [], "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "isManual": true, "personnelGroupId": [ "8636d4c3-de7c-4f8a-828b-b709d6bfd636" ], "aliases": { "type": "USER", "value": "Jensen", "system": "Barbara" }, "createdAt": "2022-04-29T22:54:08Z" }
Remove a user from a personnel group
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match:*" \ --request PUT \ --data '{ "given": "Barbara", "family": "Jensen", "aliasType": "USER", "__NAME__": "Jensen, Barbara", "name": { "middle": "Simone" }, "personnelGroupId": [] }' \ "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" { "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "formattedName": "Barbara Simone Jensen", "__NAME__": "Jensen,Barbara", "aliasValue": "Jensen", "family": "Jensen", "updatedAt": "2022-10-26T00:03:40Z", "aliasType": "USER", "given": "Barbara", "organizationId": [], "aliasSystem": "Barbara", "name": { "given": "Barbara", "middle": "Simone", "family": "Jensen", "formatted": "Barbara Simone Jensen" }, "languages": [], "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "isManual": true, "personnelGroupId": [], "aliases": { "type": "USER", "value": "Jensen", "system": "Barbara" }, "createdAt": "2022-04-29T22:54:08Z" }
Assign an organization member
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match:*" \ --request PUT \ --data '{ "given": "Barbara", "family": "Jensen", "aliasType": "USER", "__NAME__": "Jensen, Barbara", "name": { "middle": "Simone" }, "organizationId": [ "c66f037b-50f5-4703-b51f-838f42a49e84" ] }' \ "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" { "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "formattedName": "Barbara Simone Jensen", "__NAME__": "Jensen,Barbara", "aliasValue": "Jensen", "family": "Jensen", "updatedAt": "2022-10-26T00:03:40Z", "aliasType": "USER", "given": "Barbara", "organizationId": [ "c66f037b-50f5-4703-b51f-838f42a49e84" ], "aliasSystem": "Barbara", "name": { "given": "Barbara", "middle": "Simone", "family": "Jensen", "formatted": "Barbara Simone Jensen" }, "languages": [], "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "isManual": true, "personnelGroupId": [], "aliases": { "type": "USER", "value": "Jensen", "system": "Barbara" }, "createdAt": "2022-04-29T22:54:08Z" }
Remove an organization member
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match:*" \ --request PUT \ --data '{ "given": "Barbara", "family": "Jensen", "aliasType": "USER", "__NAME__": "Jensen, Barbara", "name": { "middle": "Simone" }, "organizationId": [] }' \ "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" { "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "formattedName": "Barbara Simone Jensen", "__NAME__": "Jensen,Barbara", "aliasValue": "Jensen", "family": "Jensen", "updatedAt": "2022-10-26T00:03:40Z", "aliasType": "USER", "given": "Barbara", "organizationId": [], "aliasSystem": "Barbara", "name": { "given": "Barbara", "middle": "Simone", "family": "Jensen", "formatted": "Barbara Simone Jensen" }, "languages": [], "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", "isManual": true, "personnelGroupId": [], "aliases": { "type": "USER", "value": "Jensen", "system": "Barbara" }, "createdAt": "2022-04-29T22:54:08Z" }
Assign an organization to an organization group
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match:*" \ --request PUT \ --data '{ "organizationId": [ "f90a6224-1880-4935-a838-e19d3079a23c", "19b5157e-6fbe-4716-860b-28d6df90f331", "c66f037b-50f5-4703-b51f-838f42a49e84" ] }' \ "http://localhost:8080/openidm/system/Cerner/__ORGANIZATIONGROUP__/67203020-aae7-4f44-865f-c8591d618ffc" { "_id": "67203020-aae7-4f44-865f-c8591d618ffc", "organizationId": [ "c66f037b-50f5-4703-b51f-838f42a49e84", "f90a6224-1880-4935-a838-e19d3079a23c", "19b5157e-6fbe-4716-860b-28d6df90f331" ], "updatedAt": "2022-05-06T12:56:02Z", "aliases": { "type": "SOGI", "value": "0001ORGVALUE", "system": "0001System" }, "id": "67203020-aae7-4f44-865f-c8591d618ffc", "aliasType": "SOGI", "aliasValue": "0001ORGVALUE", "aliasSystem": "0001System", "name": "ABC SK ORG GROUP", "createdAt": "2022-05-06T12:56:02Z", "__NAME__": "0001ORGVALUE,0001System" }
Remove an organization from an organization group
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match:*" \ --request PUT \ --data '{ "organizationId": [ "f90a6224-1880-4935-a838-e19d3079a23c", "19b5157e-6fbe-4716-860b-28d6df90f331" ] }' \ "http://localhost:8080/openidm/system/Cerner/__ORGANIZATIONGROUP__/67203020-aae7-4f44-865f-c8591d618ffc" { "_id": "67203020-aae7-4f44-865f-c8591d618ffc", "organizationId": [ "f90a6224-1880-4935-a838-e19d3079a23c", "19b5157e-6fbe-4716-860b-28d6df90f331" ], "updatedAt": "2022-05-06T12:56:02Z", "aliases": { "type": "SOGI", "value": "0001ORGVALUE", "system": "0001System" }, "id": "67203020-aae7-4f44-865f-c8591d618ffc", "aliasType": "SOGI", "aliasValue": "0001ORGVALUE", "aliasSystem": "0001System", "name": "ABC SK ORG GROUP", "createdAt": "2022-05-06T12:56:02Z", "__NAME__": "0001ORGVALUE,0001System" }
OpenICF Interfaces Implemented by the Cerner Connector
The Cerner Connector implements the following OpenICF interfaces. For additional details, see ICF interfaces:
- Create
-
Creates an object and its
uid
. - Delete
-
Deletes an object, referenced by its
uid
. - Schema
-
Describes the object types, operations, and options that the connector supports.
- Script on Connector
-
Enables an application to run a script in the context of the connector.
Any script that runs on the connector has the following characteristics:
-
The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access.
-
The script has access to a
connector
variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. -
The script has access to any script arguments passed in by the application.
-
- Search
-
Searches the target resource for all objects that match the specified object class and filter.
- Test
-
Tests the connector configuration.
Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid.
This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out).
You can invoke the test operation before a connector configuration has been validated.
- Update
-
Updates (modifies or replaces) objects on a target resource.
Cerner Connector Configuration
The Cerner Connector has the following configurable properties:
Configuration properties
Property | Type | Default | Encrypted(1) | Required(2) |
---|---|---|---|---|
|
|
|
Yes |
Yes |
Provide the bearer token to authorize Cerner |
||||
|
|
|
|
No |
Provide the tenant to authorize Cerner |
||||
|
|
|
|
No |
Provide the region to authorize Cerner |
||||
|
|
|
|
No |
Provide the maximum connections |
||||
|
|
|
|
No |
Provide the maximum connection timeout in seconds |
||||
|
|
|
|
Yes |
Provide the Proxy Host |
||||
|
|
|
|
Yes |
Provide the Proxy Port |
||||
|
|
|
|
Yes |
Provide the Proxy Username |
||||
|
|
|
Yes |
Yes |
Provide the Proxy Password |
(1) Whether the property value is considered confidential, and is therefore encrypted in IDM.
(2) A list of operations in this column indicates that the property is required for those operations.