Page History

...

Send

Retrieve

SampleRequestRequest (comments reffer to changes to the current API definition)

SampleRequestRetrieve

Expand

title	Request

Payload
recipient	integer maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 1234 4 digit ION of recipient
correlationGuid*	string($uuid) Sender generated GUID used to correlate response acknowledgement
patient block*	{patient block}
donor*

{donor type

Wiki Markup
{donor id}

description:	Supply one node from the following
adult	{...}
adcu	{...}
cbu	{...}

referenceCode*

string($uuid)

requestDate*

string($date-time)

Request date REQ_DATE Req 8

prod1*

{...}

prod2

{...}

prod3

{...}

prod4

{...}

receptionDate1*

string($date-time)

Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd]

receptionDate2

string($date-time)
nullable: true

Latest date of sample reception REC_DATE2 Opt 8 yyyy-MM-dd [or yyyyMMdd]

acceptableReceptionDaysOfWeek

string
nullable: true

Weekdays acceptable for reception ACC_DAYS Opt 7

institutionToSendSampleTo*

address block

institutionPaying*

address block

urgent

boolean

Urgent request URGENT Opt 1

acknowledgementId

string
maxLength: 17
nullable: true
example: 1234567890abcdefg

Acknowledgement ID ACK_ID Opt 17

remark

string
nullable: true

Remark REMARK Opt 120

Expand

title	Response

deliveredAtUtc	string($date-time) Server-supplied timestamp showing time of Message delivery to recipient's inbox queue
referenceMessageId	string($uuid)
responseType	stringEnum: Array [ 3 ]
remark	[...]

Request

No parameters specified

Response

recipient	integer maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 1234 4 digit ION of recipient
correlationGuid*	string($uuid) Sender generated GUID used to correlate response acknowledgement
Payload
patient*	{...}
donor*	{...}
referenceCode*	string($uuid)
requestDate*	string($date-time) Request date REQ_DATE Req 8
requestDateEmdis	string nullable: true readOnly: true EMDIS format of Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd]
prod1*	{...}
prod2	{...}
prod3	{...}
prod4	{...}
receptionDate1*	string($date-time) Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd]
receptionDate1Emdis	string nullable: true readOnly: true EMDIS format of Earliest date of sample reception REC_DATE1 Req 8
receptionDate2	string($date-time) nullable: true Latest date of sample reception REC_DATE2 Opt 8 yyyy-MM-dd [or yyyyMMdd]
receptionDate2Emdis	string nullable: true readOnly: true EMDIS format of Latest date of sample reception REC_DATE2 Opt 8
acceptableReceptionDaysOfWeek	string nullable: true Weekdays acceptable for reception ACC_DAYS Opt 7
institutionToSendSampleTo*	string maxLength: 14 Institution the sample has to be sent to INST_SMP_SENT Req 10
institutionPaying*	string maxLength: 10 Institution paying INST_PAY Req 10
urgent	boolean Urgent request URGENT Opt 1
acknowledgementId	string maxLength: 17 nullable: true example: 1234567890abcdefg Acknowledgement ID ACK_ID Opt 17
remark	string nullable: true Remark REMARK Opt 120

...

Send

Retrieve

ResultReminderRequest

ResultReminderRetrieve

Expand

title	Request...

Field	Details
sender*	string maxLength: 4 minLength: 4 example: 5678 4 digit ION of sender
sentAtUtc*	string($date-time) Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest.
deliveredAtUtc*	string($date-time) Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue.
payload*	{...}
recipient*	string maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 1234 4 digit ION of recipient
correlationGuid*	string($uuid) Sender generated GUID used to correlate response acknowledgement
messageType	string Message types supported by WmdaConnect Enum: Array [ 21 ]

Expand

title	Response...

Field	Details
wmdaResponse	{...}

Meta Block (6.1.1)
Payload Result Reminder

...

Page tree

Versions Compared

Old Version 107

New Version 108

Key