poieti/developers
資料與欄位

DeliveryV1

Poieti 推送給院方端點的紀錄格式。

範例#

delivery-create.json
{
  "schema": "poieti.his.delivery/1",
  "deliveryId": "3d2c1b0a-9f8e-4d7c-8b6a-5f4e3d2c1b0a",
  "generation": 1,
  "kind": "create",
  "institutionId": "demo-hospital",
  "feature": {
    "id": "wound-record",
    "templateVersion": 1,
    "title": "傷口紀錄"
  },
  "mapping": {
    "id": "demo-hospital-wound",
    "version": 1
  },
  "target": {
    "form": "NUR_WOUND",
    "formVersion": "2026.1",
    "charset": "cp950"
  },
  "record": {
    "id": "8b7a6f5e-4d3c-4b2a-9f1e-0d9c8b7a6f5e",
    "version": 1,
    "observedAt": "2026-10-16T09:30:00+08:00",
    "confirmedAt": "2026-10-16T09:52:18+08:00",
    "author": {
      "poietiUserId": "user_2nM8cXh3kQ9rT5vW1yZ4aB7dE0f",
      "staffNumber": "N10234"
    },
    "lastEditedBy": {
      "poietiUserId": "user_2nM8cXh3kQ9rT5vW1yZ4aB7dE0f",
      "staffNumber": "N10234"
    },
    "confirmedBy": {
      "poietiUserId": "user_2nM8cXh3kQ9rT5vW1yZ4aB7dE0f",
      "staffNumber": "N10234"
    }
  },
  "supersedes": null,
  "patient": {
    "medicalRecordNumber": "DEMO-002",
    "encounterId": "A2026101502",
    "hisPatientId": null,
    "displayName": "測試陳小姐",
    "wardCode": "8B",
    "bed": "8B-07"
  },
  "fields": {
    "WOUND_SITE": "03",
    "WOUND_TYPE": "PI",
    "STAGE": "2",
    "LEN_CM": "2.5",
    "WID_CM": "1.0",
    "ONSET": "2026-10",
    "EXUDATE_Y": "Y",
    "DRESSING": "FOAM,HYDRO",
    "CARE_NOTE": "已清潔並更換敷料。"
  },
  "missingRequired": [],
  "notSent": [],
  "attachments": [
    {
      "id": "c4b3a291-8f7e-4d6c-9b5a-4e3d2c1b0a9f",
      "mimeType": "image/jpeg",
      "size": 183204,
      "sha256": "600ccca710bf414025cd83685356270c4840a84933242a68ed2e1699517abbb8"
    }
  ]
}

欄位#

欄位型別必填說明
schema"poieti.his.delivery/1"是固定為 poieti.his.delivery/1;只有不相容的變更才會改版。
deliveryIdstring (uuid)是冪等鍵。院方只依此值去重。
generationinteger是代次。護理師因身分被拒後重新送出、或資訊人員在資料遺失後重新送出時加一,並使用新的 deliveryId。
kind"create" | "correction"是create 新增;correction 整筆取代 supersedes.hisRecordId。首次送出時決定,之後不變。
institutionIdstring是Poieti 機構代碼。
featureobject是紀錄功能(例如 nursing-admission)、範本版本與標題。
feature.idstring是
feature.templateVersioninteger是
feature.titlestring是
mappingobject是產生 fields 的欄位對照與版本。
mapping.idstring是
mapping.versioninteger是
targetobject是院方表單、版本,以及所有字串已確認可編碼的字集(utf-8 或 cp950)。
target.formstring是
target.formVersionstring是
target.charset"utf-8" | "cp950"是Every string was checked to be encodable in this charset.
recordobject是Poieti 紀錄 ID、版本、臨床時間 observedAt、確認時間,以及撰寫、最後編輯、確認者的員工編號。
record.idstring (uuid)是
record.versioninteger是
record.observedAtstring (RFC 3339)Clinical event time from the mapping's observedAt fields; omitted when unknown.
record.confirmedAtstring (RFC 3339)是RFC 3339 date-time with an explicit offset. Metadata times from Poieti are UTC (Z, millisecond precision); record times in DeliveryV1 use the mapping timezone (default Asia/Taipei, +08:00). Times sent to Poieti must carry an offset.
record.authorobject是staffNumber is the hospital employee number set by Poieti staff; null when the institution does not require it and none is set, and for the family-intake system account, which can be the author and last editor of a record staged from the family's entries. confirmedBy is always a person.
record.author.poietiUserIdstring是
record.author.staffNumberstring | null是
record.lastEditedByobject是staffNumber is the hospital employee number set by Poieti staff; null when the institution does not require it and none is set, and for the family-intake system account, which can be the author and last editor of a record staged from the family's entries. confirmedBy is always a person.
record.lastEditedBy.poietiUserIdstring是
record.lastEditedBy.staffNumberstring | null是
record.confirmedByobject是staffNumber is the hospital employee number set by Poieti staff; null when the institution does not require it and none is set, and for the family-intake system account, which can be the author and last editor of a record staged from the family's entries. confirmedBy is always a person.
record.confirmedBy.poietiUserIdstring是
record.confirmedBy.staffNumberstring | null是
supersedesobject | null是更正時:被取代的 deliveryId、紀錄版本與院方紀錄編號;新增時為 null。
supersedes.deliveryIdstring (uuid)是
supersedes.recordVersioninteger是
supersedes.hisRecordIdstring是The hospital's identifier for the written HIS record, stored verbatim.
patientobject是身分快照。新增以 medicalRecordNumber + encounterId 對應;姓名、病房、床號只供核對。
patient.medicalRecordNumberstring是病歷號.
patient.encounterIdstring | null是
patient.hisPatientIdstring | null是
patient.displayNamestring是Verification only.
patient.wardCodestring | null是
patient.bedstring | null是
fieldsobject是院方欄位代碼 → 值(依審核過的欄位對照產生)。
missingRequiredobject[]是適用但沒有值的必填欄位(含院方欄位代碼)。僅供參考,Poieti 仍會送出。
missingRequired[].fieldstring是Poieti field id.
missingRequired[].targetstring | null是
notSentstring[]是有值但欄位對照排除、沒有送出的 Poieti 欄位 ID。
attachmentsobject[]是附件 ID、類型、大小與 SHA-256;請求不含附件內容,院方端點以 deliveries 範圍的機器金鑰下載。
attachments[].idstring (uuid)是
attachments[].mimeTypestring是
attachments[].sizeinteger是
attachments[].sha256stringLower-case hex SHA-256 of the bytes, when known.

規則#

主題規則
冪等deliveryId 是唯一的去重鍵。同一 deliveryId 的內容每次相同;主控台重試、以及護理師送出從未交給院方的待送紀錄,都沿用 deliveryId。身分被拒後的重新送出與資料遺失後的重新送出會產生新的代次與 deliveryId。
新增與更正create 以病歷號 + 住院號對應;correction 整筆取代 supersedes.hisRecordId 指名的院方紀錄,身分沿用原紀錄(原住院可能已結帳),不會把紀錄移到另一次住院。
值院方欄位對照中,每個值都是字串,沒有值就省略(不送 null、不填預設值);poieti-canonical 保留原始 JSON 型別。字串已確認可用 target.charset 編碼且未截斷。
重複資料列整組取代院方已存的資料列。
時間RFC 3339 含時區。紀錄時間使用欄位對照的時區(預設 Asia/Taipei,+08:00);Poieti 的中繼資料時間為 UTC、毫秒。
員工編號staffNumber 為 Poieti 設定的院內員工編號;機構不要求且未設定時為 null。由家屬登記自動產生的紀錄,author 與未經修改時的 lastEditedBy 是系統帳號 family-intake,其 staffNumber 為 null;confirmedBy 一定是人員。
未知欄位Poieti 只送文件中的欄位,但讀取方應忽略不認得的欄位。schema 只在不相容的變更時改版。
Poieti · HIS 介接contracts/his v1.0.0

搜尋文件

OpenAPI 契約 3.1