Exchange Endpoints
Where health information goes: the Direct HISP, the national-network gateway (TEFCA / Carequality / CommonWell / HIE), the immunization registry, AIMS, ELR and syndromic receivers, the image archive, VA HSRM. Sandbox to try it without sending anything.
Where to find it
- Module: EHR
- Group: Information & Population
- Section: Interoperability
- Screen: Exchange Endpoints
Address in the console: /ehr/exchange-endpoints
List · 8 columns · 16 fields on its form · 3 of them required · 1 action
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Code | Code | code |
| Name | Text | name |
| Kind | Status | kind |
| Transport | Status | transport |
| Address | Text | endpoint_url |
| Credentials | Yes or no | has_secret |
| Active | Yes or no | is_active |
| Last used | Date and time | last_used_at |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Code required | Text | ||
| Name required | Text | ||
| Kind required | Choice | direct_hisp, xca_gateway, iis, eicr, elr, syndromic, pacs, va_hsrm | |
| Transport | Choice | sandbox, https | |
| Address (https) | Text | ||
| Authentication | Choice | none, basic, bearer, mtls | |
| User name | Text | ||
| Client certificate (PEM) | Long text | ||
| CA certificate (PEM) | Long text | ||
| Our Direct address | Text | ||
| Our community OID | Text | ||
| Their community OID | Text | ||
| Registry facility id | Text | ||
| Image viewer URL | Text | e.g. https://viewer.example/viewer?StudyInstanceUIDs={StudyInstanceUID} | |
| Default | Yes or no | ||
| Active | Yes or no |
What you can do here
Set credentials
Asks for: Password or token Client private key (PEM)
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.