Poieti HIS Web Service
錯誤碼
HIS Web Service 的錯誤碼、院方端點回覆的代碼與待送原因。
HIS Web Service 錯誤碼#
錯誤回應為 {error, code, requestId};行為只依 code。
| 錯誤碼 | HTTP | 意思 | 下一步 |
|---|---|---|---|
HIS_UNAUTHORIZED | 401 | 金鑰缺漏、格式錯誤、未知、已撤銷或過期,或用了另一個環境的金鑰。 | 停止並通知資訊人員;不要密集重試。 |
HIS_IP_NOT_ALLOWED | 403 | 來源 IP 不在憑證允許的網段。 | 停止並通知資訊人員,向 Poieti 確認院方對外 IP。 |
HIS_SCOPE_DENIED | 403 | 憑證沒有此路由的範圍,或名單病房不在憑證允許的病房內。 | 改用正確範圍的憑證。 |
HIS_CENSUS_DISABLED | 409 | 機構未開啟病房名單。 | 停止上傳,請 Poieti 開啟。 |
HIS_RATE_LIMITED | 429 | 同一憑證每分鐘超過 120 次請求,或同一位址每分鐘超過 20 次被拒的授權。 | 依 Retry-After 秒數等待。 |
HIS_REQUEST_INVALID | 422 | 查詢參數不正確。 | 修正查詢參數(例如 limit 1–200)。 |
HIS_BODY_TOO_LARGE | 413 | 內容超過上限(名單 2 MB)。 | 縮小內容;名單每次一個病房、最多 500 人。 |
DELIVERY_NOT_FOUND | 404 | 機構內沒有這個 deliveryId(格式錯誤也視為未知)。 | 記錄後繼續。 |
HIS_ATTACHMENT_NOT_FOUND | 404 | 紀錄不在 leased/written、內容已清除,或不含此附件。 | 不要寫入;回可重試的有代碼 4xx,例如 ATTACHMENT_UNAVAILABLE。 |
WARD_NOT_FOUND | 404 | 沒有病房使用此 HIS 病房代碼。 | 請 Poieti 設定病房代碼。 |
CENSUS_STALE | 409 | asOf 早於上次套用,或相同 asOf 但內容不同。 | 捨棄舊名單;下次以新的 asOf 上傳。 |
HIS_CENSUS_INVALID | 422 | 名單格式、asOf 時區或時間範圍錯誤,或病歷號/住院號重複。 | 修正 HIS 查詢與時間格式。 |
CENSUS_CONTEXT_DISABLED | 422 | 非推送模式卻送了過敏、警示或生命徵象。 | 只送身分與住院資料。 |
HIS_INTERNAL_ERROR | 500 | Poieti 端非預期錯誤。 | 稍後重試;聯絡 Poieti 時提供 requestId。 |
路徑不在契約內(包含 HIS 主機上 /his/v1/* 與 /health 以外的路徑)回 404 HIS_NOT_FOUND;路徑中格式錯誤的 ID 視為未知。
院方回覆的代碼#
端點以有代碼的 4xx 拒收時,code 由院方自訂,格式 ^[A-Z][A-Z0-9_]{1,63}$。以下代碼有特別意義;失敗時護理師看到的文字後面會接上 message(有提供時)。
| 代碼 | 護理師看到 | 處理方式 |
|---|---|---|
PATIENT_MISMATCH、PATIENT_NOT_FOUND、ENCOUNTER_NOT_FOUND | 院方找不到或不符此病人/住院號 | 身分被拒:護理師修正病人或住院號後重新送出(新的 deliveryId 與代次) |
ENCOUNTER_CLOSED、DUPLICATE_RECORD、REQUIRED_FIELD_MISSING、VALUE_TOO_LONG、VALUE_UNENCODABLE、其他 | 院方系統未接收,資訊人員處理中 | 資訊人員處理原因後,在主控台重試(相同 deliveryId) |
ATTACHMENT_MISMATCH、HIS_LOCKED 等可重試代碼 | 等待院方系統接收 | retryable: true 且還有次數時依退避自動重試 |
Poieti 自己的代碼:HIS_UNREACHABLE(網路錯誤、逾時、5xx 等重試用完)、HIS_REJECTED(沒有代碼的 4xx)、LEASE_EXPIRED(嘗試次數因逾期用完,例如 202 之後保留期滿)。這些失敗的紀錄可能已在 HIS 中(回應遺失或無法判讀),因此同一份紀錄的較新版本會暫停,直到資訊人員在主控台重試這一版或作廢它;LEASE_EXPIRED 的這一版在 7 天內查詢狀態得到已寫入時也會解除。判斷依代碼的來源,不看拼法:端點以 JSON code 回覆的 4xx 一律是院方的拒絕,即使代碼與上述 Poieti 代碼同名(例如 422 {"code": "HIS_REJECTED"}),該版直接失敗,較新版本照常以 create 送出。
待送原因#
狀態為 blocked 的送出從未交給院方,blockReasons 說明原因;全部排除後才會進入 pending。「{欄位}」為紀錄範本中的欄位名稱。
| 原因 | 護理師看到 | 排除方式 |
|---|---|---|
CLIENT_UNVERIFIED | 待確認送出 | 護理師以新版 App 確認送出 |
IDENTITY_UNVERIFIED | 病人已變更,請確認後送出 | 護理師確認送出 |
PATIENT_REQUIRED | 尚未連結病人 | 護理師連結病人後送出 |
ENCOUNTER_REQUIRED | 缺少住院號 | 護理師補上住院號後送出 |
CHART_NUMBER_INVALID | 病歷號/住院號格式不符院方規則 | 護理師修正病人資料後送出 |
ENCOUNTER_INVALID | 病歷號/住院號格式不符院方規則 | 護理師修正病人資料後送出 |
STAFF_NUMBER_REQUIRED | 員工編號尚未設定,紀錄已保留 | Poieti 設定員工編號後自動放行 |
MAPPING_UNAVAILABLE | 院方欄位設定待更新,紀錄已保留 | Poieti 發布欄位對照後重新產生 |
VALUE_UNMAPPABLE | 院方欄位設定待更新,紀錄已保留 | 更新欄位對照,或護理師修改後重新確認 |
VALUE_TOO_LONG | 「{欄位}」需修改後重新確認 | 護理師縮短內容後重新確認(或 Poieti 放寬欄位對照) |
VALUE_UNENCODABLE | 院方欄位設定待更新,紀錄已保留 | 更新欄位對照字集,或修改內容 |
PARTIAL_DATE_UNSUPPORTED | 「{欄位}」需修改後重新確認 | 護理師補完整日期後重新確認 |
VALUE_OUT_OF_RANGE | 「{欄位}」需修改後重新確認 | 護理師改成院方系統接受範圍內的數值後重新確認 |