0.1.0 - ci-build
CAREWareFHIRDataDictionary - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
The CAREWare FHIR interface exchanges health information between CAREWare and external electronic health record (EHR) systems. Implementations SHALL protect the confidentiality, integrity, and availability of this information throughout the exchange.
Security requirements may vary by EHR vendor and organizational policy. Implementers SHALL follow the security requirements of the EHR system, CAREWare, and their organization.
CAREWare SHALL authenticate with the EHR before accessing protected FHIR resources.
The authentication mechanism depends on the EHR implementation. CAREWare supports OAuth 2.0-based authentication and may use credentials such as client identifiers, private keys, certificates, or other credentials required by the EHR.
Implementers SHALL protect authentication credentials from unauthorized access.
Authentication credentials SHALL NOT be transmitted or stored in locations accessible to unauthorized users.
Access to FHIR resources SHALL be limited to the resources and operations required for the intended CAREWare workflows.
Implementers SHOULD follow the principle of least privilege when configuring OAuth scopes, application permissions, and other access controls.
The EHR is responsible for authorizing CAREWare to access the requested FHIR resources.
Successful authentication does not imply authorization to access all FHIR resources or data.
FHIR API communication between CAREWare and the EHR SHALL use HTTPS.
Implementations SHALL use TLS to protect FHIR data, authentication credentials, and access tokens while in transit.
Implementers SHALL NOT transmit protected FHIR data over unencrypted HTTP connections.
Private keys, certificates, client secrets, access tokens, and other authentication credentials SHALL be protected from unauthorized disclosure.
Private keys SHALL NOT be shared with the EHR or other unauthorized parties.
Implementers SHOULD establish procedures for credential expiration, renewal, rotation, and revocation.
Compromised credentials or private keys SHALL be revoked or replaced as soon as practical.
Administrative access to the CAREWare FHIR configuration SHOULD be restricted to authorized personnel.
Organizations SHOULD limit access to FHIR connection settings, credentials, mappings, and other security-sensitive configuration based on job responsibilities.
EHR-side access controls remain the responsibility of the implementing organization and EHR system.
FHIR resources exchanged with CAREWare may contain protected health information (PHI).
Implementers SHALL handle FHIR data in accordance with applicable organizational security and privacy policies and applicable legal or regulatory requirements.
Implementations SHOULD request and process only the FHIR data necessary for the intended CAREWare workflows.
Implementations SHOULD maintain sufficient logging to support troubleshooting, security monitoring, and auditing of the CAREWare FHIR integration.
Logs SHOULD avoid exposing authentication credentials, private keys, access tokens, or other sensitive authentication information.
When logs contain PHI or other sensitive information, access to those logs SHALL be appropriately restricted.
EHR vendors may impose additional security requirements for application registration, authentication, authorization, certificates, scopes, or production access.
Implementers SHALL follow the applicable EHR vendor requirements when configuring CAREWare access to the EHR's FHIR API.
Vendor-specific setup procedures are documented separately from the general security requirements defined in this section.