v1/AIWS_CU_Medical

The basic medical records of a seaman.

Fields Definition

Name	Format	Mandatory	Version	Example	APM XREF	Description

Name	Format	Mandatory	Version	Example	APM XREF	Description
Interface	string	Y	v1	companyname_import	Identified in APM > Setup > General Codes > Miscellaneous > Interfaces	Adonis generated interface name
ExternalPIN	string	Y	v1	AAA-9999999	Automatically mapped with the Adonis PIN.	This is the UID/PIN of the seaman inside your company/organization.
ExternalDocID	string	Y	v1	AAA-9999999	Automatically mapped with the Adonis DOCID	This is the UID of the record
ExternalDocType	string	Y	v1	COVID VACCINE	Identified in APM > Setup > General Codes > Medical > Medical Codes	Code to identify the type of medical certificate
ExternalDocCode	string	Y	V1	SCAN	Identified in APM > Setup > General Codes > Enclosed Document > Enclosed Document Codes	Code to identify the enclosed document type in APM
DateFrom	YYYY-MM-DD		v1	2022-08-16		Date it was issued
ExpiryDate	YYYY-MM-DD		v1			Expiration date
IssuedBy	string		v1	KOLKATA MEDICAL CENTER		Clinic, Hospital, Office who issued the certificate
Issuecountry	string		v1	IN		Country where the medical certificate was issued. ISO 3166-1 Set A-2 (2 letter country code)
DocumentScanBase64	Base64		v1	"data:text/plain;base64,UkVDUlVJVEVSU0VSVklDRVMgQVVESVQgQ09ERVMgU0hPVUxEIEJFIFNUQVJUIFdJVEggMToNCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09DQoNCkpPQlNFRUtFUlNFUlZJQ0VTIEFVRElUIENPREVTIFNIT1VMRCBCRSBTVEFSVCBXSVRIIDUwMToNCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0NCg0KDQpFTVBMT1lFUlNFUlZJQ0VTIENPREVTIFNIT1VMRCBTVEFSVCBXSVRIIDEwMDE6DQo9PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09DQoNCglGb3Jnb3RfcGFzc3dvcmRfcmVxdWVzdCA9IDEwMDEsDQogICAgICAgIFVwZGF0ZV9wYXNzd29yZCwNCiAgICAgICAgTG9nZ2VkX2luLA0KICAgICAgICBMb2dnZWRfb3V0DQoJVXNlcl9hZGRlZCwNCiAgICAgICAgVXNlcl91cGRhdGVkLA0KICAgICAgICBVc2VyX3JlbW92ZWQsDQogICAgICAgIFVzZXJfYWN0aXZhdGVkLA0KICAgICAgICBVc2VyX2RlYWN0aXZhdGVkLA0KICAgICAgICBTZXR0aW5nc191cGRhdGVkLA0KCVNlbmROb3RpZmljYXRpb25zX2luc2VydGVkLA0KCUVtcGxveWVyX2FkZGVkLA0KICAgICAgICBFbXBsb3llcl91cGRhdGVkLA0KICAgICAgICBFbXBsb3llcl9yZW1vdmVkLA0KICAgICAgICBFbXBsb3llcl9hY3RpdmF0ZWQsDQogICAgICAgIEVtcGxveWVyX2RlYWN0aXZhdGVkLA0KCVByZWZlcmVuY2VzX0FkZGVkLA0KICAgICAgICBQcmVmZXJlbmNlc191cGRhdGVkLA0KICAgICAgICBQcmVmZXJlbmNlc19yZW1vdmVkLA0KCVR3b0ZBTG9naW5fQWRkZWQsDQoJVGlueVVSTF9VcGRhdGVkLA0KICAgICAgICBUaW55VVJMX0FkZGVkDQoJU2lnbmF0dXJlX1VwZGF0ZWQsDQoJU2lnbmF0dXJlX1JlbW92ZWQNCg0KDQpUQVNLTUFOQUdFUlNFUlZJQ0VTIEFVRElUIENPREVTIFNIT1VMRCBCRSBTVEFSVEVEIA0KV0lUSCAxNTAxOg0KPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0NCg0KCVRhc2tSZXF1ZXN0X0FkZGVkID0gMTUwMQ0KCVRhc2tSZXF1ZXN0X1VwZGF0ZWQNCglUYXNrUmVxdWVzdF9VcGRhdGVk",		Scanned copy of the document. File types allowed: Pdf, Doc, DocX, Xls, XlsX, Png, Jpg
DocumentFileName	string		v1	SARSCovidVaccination.pdf		Filename of the scanned document
Comments	string		v1			any comments

Example Value in JSON

{
  "request": {
    "Interface": "SHIPADMIN",
    "ExternalPin": "SA-898",
    "ExternalDocID": "M-COV33G",
    "ExternalDocType": "COVVAC",
    "ExternalDocCode": "SCAN",
    "DateFrom": "2020-01-25",
    "ExpiryDate": "2025-01-25",
    "IssuedBy": "LA HOSPITAL",
    "IssueCountry": "UA",
    "DocumentScanBase64": "",
    "DocumentFileName": "",
    "Comments": ""
  }
}

Adonis HR Plug-ins User Documentation

v1/AIWS_CU_Medical

Fields Definition

Example Value in JSON

Related content