Global Settings
The following global settings are related to running an API Server.
| Global Setting Name | Description |
|---|---|
| API Producer Host | Host or IP address of the CareRight API server. If the web and api server are on the same machine, use localhost. This is only required if any Data Producers are configured. |
| API Professional Contact Identifier | Field from the professional contact record to insert or match professional contacts in API messages. Defaults to Medicare Provider Number. |
| API Provider Identifier | Field from the provider record to insert or match providers in API messages. Defaults to Medicare Provider Number. |
| Enable API Patient Data Consumer Mode | If true, enables the patient data consumer, allowing messages from an external system to create and update patient records. If enabled, users cannot edit patient fields which are updated by the API, unless they have the role "Can modify patient information while Patient API is active". |
Data Producers
Data producers define external MLLP servers which can receive HL7 messages triggered by events in CareRight.
An API Server must be configured; then navigate to: Administration > Workflow > Data Producers
You can create multiple producers of the same type; this means the event will generate identical outgoing HL7 messages sent to different MLLP receivers.
| Field | Description | Example |
|---|---|---|
| Producer | Name of the type of producer; they are documented at API Server | Patient Demographics |
| Enabled | If ticked, producer is active and matching events will trigger a message | |
| Destination Host | The hostname or IP address of the external MLLP server which should receive these messages. | 10.0.0.1 |
| Destination Port | The TCP port number of the external MLLP server which should receive these messages | 2575 |
Update of Patient Info via API (v6.66 Enhancement)
Functionality
CareRight can now connect & transmit A08 messages to a single HL7 MLLP server when there is a change in a patient record.
Message are sent when a change occurs. If there is no active connection to the server at the time the change occurs, then the message is not stored for later transmission. To send the change, the patient record needs to be edited again in CareRight to trigger the message.
The API Server will record the ACK and NAK messages from the server, but these will not be monitored in the CareRight UI or be acted upon. If the server is unable to process messages, then ICON will be notified by the server software and will subsequently contact Clintel Systems regarding the failed transmissions for investigation.
What is in the Message?
The A08 message contains both the Patient's MRN and CRN (if supplied). The identifier used when populating HL7 messages is configured in the API Provider Identifier field in Administration → Global Settings:
If a provider does not have a value recorded for the selected type, then no number will be sent.
Messaging Configuration
CareRight will push messages to a host and port defined in CareRight’s administration config and will expect acknowledgements as responses to the originating message using the HL7 MLLP specification.
- To define the host and port, navigate to Administration → Workflow → Data Producers and select Edit for the Patient Demographics field.
- In the Destination Host and Destination Port fields, complete the required values as needed.
- When done, select Update Data producer.
