Temple Health · API Governance Rules
Temple Health API Rules
Spectral linting rules defining API design standards and conventions for Temple Health.
8 Rules
error 5
warn 3
Rule Categories
temple
Rules
error
temple-health-fhir-r4-base-url
Server URL must be the canonical Temple Health FHIR R4 endpoint.
$.servers[*].url
error
temple-health-fhir-r4-fhir-version-tag
API version must report FHIR R4 (4.0.1).
$.info.version
warn
temple-health-fhir-r4-fhir-media-type
All FHIR responses must use the application/fhir+json media type.
$.paths[*][*].responses[*].content
warn
temple-health-fhir-r4-summary-title-case
Operation summaries must use Title Case.
$.paths[*][*].summary
error
temple-health-fhir-r4-smart-on-fhir-security
API must declare SMART on FHIR / OAuth 2.0 security.
$.components.securitySchemes
error
temple-health-fhir-r4-smart-authorization-url
Authorization URL must be Temple Health's OAuth 2.0 authorize endpoint.
$.components.securitySchemes.smartOnFhir.flows.authorizationCode.authorizationUrl
error
temple-health-fhir-r4-smart-token-url
Token URL must be Temple Health's OAuth 2.0 token endpoint.
$.components.securitySchemes.smartOnFhir.flows.authorizationCode.tokenUrl
warn
temple-health-fhir-r4-uscdi-resources
API should document core USCDI FHIR resources (Patient, Observation, Condition, Encounter, MedicationRequest, AllergyIntolerance, DocumentReference).
$.paths