POST api/v1/cuhk/checkin

Request Information

URI Parameters

None.

Body Parameters

ExamCheckin
NameDescriptionTypeAdditional information
PatInfo

PatInfo

None.

RequestInfo

Collection of RequestItemCheckin

None.

Request Formats

application/json, text/json

Sample:
{
  "patInfo": {
    "$id": "2",
    "surname": "sample string 1",
    "givenName": "sample string 2",
    "otherName": "sample string 3",
    "nameChinese": "sample string 4",
    "dob": "2025-06-21T19:46:46.2742893+08:00",
    "sex": "sample string 6",
    "address": "sample string 7",
    "patId": "sample string 8",
    "cumcNo": "sample string 9",
    "documentType": "sample string 10",
    "documentNumber": "sample string 11",
    "preferredTel": "sample string 12",
    "allergyHistory": "sample string 13",
    "visitNo": "sample string 14",
    "visitType": "sample string 15",
    "dept": "sample string 16",
    "bedNo": "sample string 17",
    "medicalHistory": "sample string 18",
    "createTime": "sample string 19",
    "adr": "sample string 20",
    "diagnosis": "sample string 21",
    "alert": "sample string 22",
    "episodeNo": "sample string 23",
    "clinicalInformation": "sample string 24",
    "roomType": "sample string 25"
  },
  "requestInfo": [
    {
      "$id": "3",
      "accNo": "sample string 1",
      "examAppId": "sample string 2",
      "requestItemUID": "sample string 3",
      "episodeNo": "sample string 4",
      "procedureCode": "sample string 5",
      "visitNo": "sample string 6",
      "requestNo": "sample string 7",
      "itemStatus": "sample string 8",
      "rPatientId": "sample string 9",
      "refDoctor": "sample string 10",
      "refDoctorId": "sample string 11",
      "refLocation": "sample string 12"
    },
    {
      "$ref": "3"
    }
  ]
}

text/html

Sample:
{"$id":"1","patInfo":{"$id":"2","surname":"sample string 1","givenName":"sample string 2","otherName":"sample string 3","nameChinese":"sample string 4","dob":"2025-06-21T19:46:46.2742893+08:00","sex":"sample string 6","address":"sample string 7","patId":"sample string 8","cumcNo":"sample string 9","documentType":"sample string 10","documentNumber":"sample string 11","preferredTel":"sample string 12","allergyHistory":"sample string 13","visitNo":"sample string 14","visitType":"sample string 15","dept":"sample string 16","bedNo":"sample string 17","medicalHistory":"sample string 18","createTime":"sample string 19","adr":"sample string 20","diagnosis":"sample string 21","alert":"sample string 22","episodeNo":"sample string 23","clinicalInformation":"sample string 24","roomType":"sample string 25"},"requestInfo":[{"$id":"3","accNo":"sample string 1","examAppId":"sample string 2","requestItemUID":"sample string 3","episodeNo":"sample string 4","procedureCode":"sample string 5","visitNo":"sample string 6","requestNo":"sample string 7","itemStatus":"sample string 8","rPatientId":"sample string 9","refDoctor":"sample string 10","refDoctorId":"sample string 11","refLocation":"sample string 12"},{"$ref":"3"}]}

application/xml, text/xml

Sample:
<ExamCheckin xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PatInfo>
    <Surname>sample string 1</Surname>
    <GivenName>sample string 2</GivenName>
    <OtherName>sample string 3</OtherName>
    <NameChinese>sample string 4</NameChinese>
    <DOB>2025-06-21T19:46:46.2742893+08:00</DOB>
    <Sex>sample string 6</Sex>
    <Address>sample string 7</Address>
    <PatId>sample string 8</PatId>
    <CumcNo>sample string 9</CumcNo>
    <DocumentType>sample string 10</DocumentType>
    <DocumentNumber>sample string 11</DocumentNumber>
    <PreferredTel>sample string 12</PreferredTel>
    <AllergyHistory>sample string 13</AllergyHistory>
    <VisitNo>sample string 14</VisitNo>
    <VisitType>sample string 15</VisitType>
    <Dept>sample string 16</Dept>
    <BedNo>sample string 17</BedNo>
    <MedicalHistory>sample string 18</MedicalHistory>
    <CreateTime>sample string 19</CreateTime>
    <Adr>sample string 20</Adr>
    <Diagnosis>sample string 21</Diagnosis>
    <Alert>sample string 22</Alert>
    <EpisodeNo>sample string 23</EpisodeNo>
    <ClinicalInformation>sample string 24</ClinicalInformation>
    <RoomType>sample string 25</RoomType>
  </PatInfo>
  <RequestInfo>
    <RequestItem>
      <AccNo>sample string 1</AccNo>
      <ExamAppId>sample string 2</ExamAppId>
      <RequestItemUID>sample string 3</RequestItemUID>
      <EpisodeNo>sample string 4</EpisodeNo>
      <ProcedureCode>sample string 5</ProcedureCode>
      <VisitNo>sample string 6</VisitNo>
      <RequestNo>sample string 7</RequestNo>
      <ItemStatus>sample string 8</ItemStatus>
      <RPatientId>sample string 9</RPatientId>
      <RefDoctor>sample string 10</RefDoctor>
      <RefDoctorId>sample string 11</RefDoctorId>
      <RefLocation>sample string 12</RefLocation>
    </RequestItem>
    <RequestItem>
      <AccNo>sample string 1</AccNo>
      <ExamAppId>sample string 2</ExamAppId>
      <RequestItemUID>sample string 3</RequestItemUID>
      <EpisodeNo>sample string 4</EpisodeNo>
      <ProcedureCode>sample string 5</ProcedureCode>
      <VisitNo>sample string 6</VisitNo>
      <RequestNo>sample string 7</RequestNo>
      <ItemStatus>sample string 8</ItemStatus>
      <RPatientId>sample string 9</RPatientId>
      <RefDoctor>sample string 10</RefDoctor>
      <RefDoctorId>sample string 11</RefDoctorId>
      <RefLocation>sample string 12</RefLocation>
    </RequestItem>
  </RequestInfo>
</ExamCheckin>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.