Security and TLS
How this Health IT Module enforces TLS 1.2 or above, how to verify it independently, and the security obligations that fall to your application.
This page documents how the Health IT Module enforces transport security, as required by the §170.315(g)(10) Certification Companion Guide.
TLS enforcement
TLS 1.2 is the minimum version accepted. TLS 1.0 and TLS 1.1 are disabled at the platform level, so a client offering only those versions is refused during the TLS handshake, before any HTTP request is parsed and before any application code runs. There is no application setting that can weaken this, and no negotiation path down to an earlier version.
| Protocol version | Status |
|---|---|
| TLS 1.0 | Refused at handshake |
| TLS 1.1 | Refused at handshake |
| TLS 1.2 | Accepted |
Enforcement applies uniformly to every public endpoint:
| Host | Role |
|---|---|
fhir.maximus.care | FHIR resource server |
apiauth.maximus.care | Authorization server |
documents.maximus.care | This documentation |
In addition, the application layer redirects any plaintext HTTP request to HTTPS, so there is no unencrypted path to the API even for a client that attempts one.
Verifying it yourself
You do not have to take this on trust. Attempt a handshake at a specific protocol version and observe that anything below TLS 1.2 is refused.
# OpenSSL - each of these should FAIL
openssl s_client -connect fhir.maximus.care:443 -tls1
openssl s_client -connect fhir.maximus.care:443 -tls1_1
# and this should SUCCEED
openssl s_client -connect fhir.maximus.care:443 -tls1_2
# nmap - enumerate everything the server will negotiate
nmap --script ssl-enum-ciphers -p 443 fhir.maximus.care
Client requirements
| Requirement | Detail |
|---|---|
| TLS 1.2 or above | Older platforms may default to TLS 1.0. Enable TLS 1.2 explicitly if your runtime does not. |
| Certificate validation | Required. Validate the chain and the hostname. Never disable verification, not even in testing — use a staging endpoint instead. |
| No certificate pinning | Not recommended. Certificates are rotated routinely and pinning will break your application without warning. |
| Modern cipher suites | Negotiated automatically. Clients restricted to legacy ciphers may fail to connect. |
.NET Framework 4.5 and 4.6 do not negotiate TLS 1.2 by default. Set
ServicePointManager.SecurityProtocol to include
SecurityProtocolType.Tls12, or target a current runtime.
Token handling
| Rule | Why |
|---|---|
Send tokens only in the Authorization header | Query strings are written to server logs, proxy logs and browser history. |
| Never log tokens | A logged token is a usable credential for as long as it lives. |
| Store tokens in platform secure storage | See refresh tokens for per-platform guidance. |
| Revoke on sign-out | Signing out of your application should revoke the token, not merely forget it. |
| Request the narrowest scope | A token that can read less is worth less if it leaks. |
Access control
Authorization is enforced on the server for every request. Three independent checks apply:
- Scope. The token must carry a scope covering the resource type and operation.
- Patient context. A token carrying a patient launch context is bound to that
patient. Requesting a different patient returns
403, regardless of the scope held. - Tenancy. Access is confined to the practice the token was issued for.
These checks run server-side on every call. Your application should still show users only what they are entitled to see, but it does not carry the enforcement burden.
Auditing
API access is logged. Each request records the authenticated client, the user where one is present, the patient context, the resource accessed and the outcome, including authorization failures. Logs are retained in line with Maximus EHR's HIPAA retention obligations.
Reporting a vulnerability
If you believe you have found a security vulnerability in the Maximus FHIR API, report it to the technical contact given during registration. Please do not disclose it publicly before it has been investigated, and do not access, modify or retain any patient data you encounter while testing.