FHIR API HIEBus™ FHIR API
Interface Guide

Mapping Settings

The following table describes the endpoint configuration settings available in the Mapping tab.

Option Description Required?
Site URI This URI is used when identifying the originating system in FHIR code and identifier mapping. See Code Mapping and Identifier Mapping. Yes
Use Assigning Authority Whether to use the assigning authority when mapping FHIR identifiers (with a system URI) to CareEvolution identifiers that have both a type and an assigning authority. See Identifier Mapping. Yes
Organizational Caregiver Type Term Subset Scope and Name Caregivers that have types belonging to this term subset (identified by scope and name) are mapped to the FHIR ‘Organization’ resource. If not specified, no caregivers will be mapped to ‘Organization’. No
Medication Statement Term Subset Scope and Name Pharmacy orders that have priorities belonging to this term subset (identified by scope and name) are mapped to the FHIR ‘Medication Statement’ resource. If not specified, no pharmacy orders will be mapped to ‘Medication Statement’. No
Immunization Service Code Term Subset Scope and Name Claim services that have a service code belonging to this term subset (identified by scope and name) are mapped to the FHIR ‘Immunization’ resource. If not specified, no claim services will be mapped to ‘Immunization’. No
Patient Record Authority Code, Name and Unencrypted This record authority will be assigned to patients created from posting data to the FHIR endpoint. Yes
Caregiver Record Authority Code, Name and Unencrypted This record authority will be assigned to caregivers created from posting data to the FHIR endpoint. Yes
Patient Institution Code and Name Patients created from posting data to the FHIR endpoint will be associated to this institution. If not specified, new patients will not have an institution associated. No
Patient Access Policy Name This access policy will be assigned to patients created from posting data to the FHIR endpoint. Yes
Encounter Access Policy Name This access policy will be assigned to encounters created from posting data to the FHIR endpoint. Yes
Timezone Name Specify the name of the timezone used to convert FHIR date-times without a timezone to internal date-times (that must always have a timezone). If not specified, FHIR date-times without a timezone are assumed to be in the local timezone of the server. No
Default Term Namespace Code and Name This term namespace (identified by code and name) will be used when maping FHIR codes that are not associated with a specific system. Yes
Invalid Search Parameters Handling This setting controls how the system handles a search containing search parameters that are not implemented. See Invalid Search Parameter Handling below for details. Yes
Maximum Size of Uploaded Photo Attachments Patients and caregivers posted to the server with photos larger than this value will be rejected. Yes
Forbid Standard Term Namespaces This setting will prevent the prefixing of standard namespaces when mapping FHIR codeable concepts to terms. The system will respond with an error instead. See Term Mapping. Yes

Invalid Search Parameter Handling Options

You can control how the system responds when it receives a query containing invalid search parameters. The system can either ignore invalid search parameters or respond with an error. You can further fine-tune whether different types of invalid search parameters trigger an error response. There are two types of invalid search parameters:

  • Unknown parameters are not part of the version of the FHIR standard implemented by the system, and thus are completely unrecognized.
  • Unsupported parameters are part of the FHIR standard but not currently implemented by the system.

The Invalid Search Parameters Handling setting has three options:

  • Ignore unknown: Unknown parameters are ignored, but Unsupported parameters will trigger an error response.
  • Ignore unknown and not supported: Both Unknown and Unsupported parameters are ignored.
  • Strict: Both Unknown and Unsupported parameters will trigger an error response.