...

This message is used to request a sample to be used for a verifcation verification typing in the lab of the sending registry.

Send (Post)

Retrieve (Post)

sampleRequestRequest

sampleRequestRetrieve

Expand

title	Request

Field

Details

request*

Expand

title	...

requestingRegistryReferenceCode	string maxLength: 15 example:XX12345
prod1*	{...}
prod2	{...}
prod3	{...}
prod4	{...}
earliestDateCanReceive*	string($date-time) Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd]
latestDateCanReceive*	string($date-time) nullable: true Latest date of sample reception REC_DATE2 Opt 8 yyyy-MM-dd [or yyyyMMdd]
acceptableReceptionDaysOfWeek*	integer nullable: true minLength: 7 maxLength: 7 example: 1111100 Weekdays acceptable for reception. Binary fixed length string for the 7 days in the week. E.g., 1110000 means acceptable days for reception are Monday, Tuesday and Wednesday, not acceptable days are Thursday, Friday, Saturday or Sunday.
institutionToSendSampleTo*	Embedded Address Block
institutionPaying*	Embedded Address Block
isUrgent	boolean Urgent request URGENT Opt 1
remark	string maxLength: 120 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

receivingRegistry*

integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the receiving registry

patient*

Embedded Patient Block

donor*

Donor ID

Expand

title	Response

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

The fields ”earliest and latest date of sample reception” represent the lower and upper limit of the period of time in which the blood sample has to be received. If the second date is missing, the sample may be received any time after the first date.
The quantity for the first product is optional when requesting DNA from a cord blood unit. In all other requests, the quantity fields for any of the corresponding product fields are required if a product is requested.
A number of tubes requested in a sample request or marrow request:
- The maximum amount of material, requested in one sample request or pre-collection sample request is 100 ml, if not stated otherwise in the national rules of the donor registry.
- If the number of tubes is unassigned, and not given in the request, the default value number of tubes is one.
A typical response to the Sample Request message is the Sample Arrival Date message. In addition to that, it is mandatory (by the accreditation standards) that the donor registry also sends an IDM Result message to inform the patient registry of the known diseases of the donor.

5.4 - Sample Information (SMP_INFO)

This message is used to send relevant secondary information which that may arise in the context of the sample request.

Send (Post)

Retrieve (Post)

sampleInfoRequest (comments refer to changes to the current API definition)

sampleInfoRetrieve

Expand

title	Request...

message*

Expand

title	...

requestingRegistryReferenceCode	string maxLength: 15 example:XX12345
referenceCode*	string($uuid)
informationType*	string maxLength: 3 minLength: 3 Information Type INFO_TYPE Req 3 Enum: Array [ 12 ]
remark	string nullable: true Remark REMARK Opt 120

receivingRegistry*

integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the receiving registry

patient*

Patient wmdaId

ID provided by the WMDA

donor*

Donor ID

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

PlantUML Macro

dropshadow	false
separation	false
format	PNG
align	left
title	Generic message flow

participant "Patient Registry" as PR

control "Match-Connect" as MC

control "Search & Match\nService" as SM

participant "Donor Registry" as DR

skinparam SequenceMessageAlign center

skinparam dpi 92

== Making Request ==
PR -[#dodgerblue]> DR : Send message

MC -> PR : 400 Bad Request (optional)
MC -> PR : 200 OK (possibly with warnings)

PR -> MC : Check not-picked up messages

MC -> PR : 200 OK - Array of messages not yet delivered

== Getting Response ==

DR -[#dodgerblue]> PR : Message response (ack, reject, warning) \nshould always include messageId of referring message

Extended Typing

PlantUML Render Macro

format	PNG
align	left
title	Extended Typing

participant "Patient Registry" as PR

control "Match-Connect" as MC

control "Search & Match\nService" as SM

participant "Donor Registry" as DR

skinparam SequenceMessageAlign center

skinparam dpi 92

== Register Patient ==

PR -> SM : Create Patient

activate SM #FFBBBB

SM -> PR : Return wmdaId

deactivate SM

== Start Search ==

PR -> SM : Start Search

activate SM #FFBBBB

SM -> PR : Return searchId

deactivate SM

PR -> SM : Check search status

activate SM #FFBBBB

SM -> PR : Return search status (Completed, Running, Errored)

deactivate SM

PR -> SM : Retrieve search results

activate SM #FFBBBB

SM -> PR : Return search results

deactivate SM

== Activate Patient ==

PR -> SM : Update patient status to ACT

== Making Request ==

PR -[#dodgerblue]> DR : Extended Typing Request (incl. Embedded Patient Block)

DR -[#dodgerblue]> PR : Reservation Response

PR -[#dodgerblue]> DR : Request Cancellation

== Getting Response ==

DR -[#dodgerblue]> PR : Request Rejection

DR -[#dodgerblue]> PR : Extended Typing Result (incl. Embedded Donor Block)

PlantUML Render Macro

format	PNG
align	left
title	Infectious Disease Marker Sample Request

participant "Patient Registry" as PR

control "Match-Connect" as MC

control "Search & Match\nService" as SM

participant "Donor Registry" as DR

skinparam SequenceMessageAlign center

skinparam dpi 92

== Register Patient ==

PR -> SM : Create Patient

activate SM #FFBBBB

SM -> PR : Return wmdaId

deactivate SM

== Start Search ==

PR -> SM : Start Search

activate SM #FFBBBB

SM -> PR : Return searchId

deactivate SM

PR -> SM : Check search status

activate SM #FFBBBB

SM -> PR : Return search status (Completed, Running, Errored)

deactivate SM

PR -> SM : Retrieve search results

activate SM #FFBBBB

SM -> PR : Return search results

deactivate SM

== Activate Patient ==

PR -> SM : Update patient status to ACT

== Making Request ==

PR -[#dodgerblue]> DR : IDM Sample Request (incl. Embedded Patient Block)

DR -[#dodgerblue]> PR : Reservation Response

PR -[#dodgerblue]> DR : Request Cancellation

== Getting Response ==DR -[#dodgerblue]> PR : No Result

DR -[#dodgerblue]> PR : Request RejectionSample Arrival

DR -[#dodgerblue]> PR : IDM Result (incl. Embedded Donor Block)result

DR -[#dodgerblue]> PR : Sample Information

== Getting Response ==

DR -[#dodgerblue]> PR : Request Rejection

PR -[#dodgerblue]> DR : Sample Result

PlantUML Render Macro

format	PNG
align	left
title	Sample Infectious Disease Marker Request

participant "Patient Registry" as PR

control "Match-Connect" as MC

control "Search & Match\nService" as SM

participant "Donor Registry" as DR

skinparam SequenceMessageAlign center

skinparam dpi 92

== Register Patient ==

PR -> SM : Create Patient

activate SM #FFBBBB

SM -> PR : Return wmdaId

deactivate SM

== Start Search ==

PR -> SM : Start Search

activate SM #FFBBBB

SM -> PR : Return searchId

deactivate SM

PR -> SM : Check search status

activate SM #FFBBBB

SM -> PR : Return search status (Completed, Running, Errored)

deactivate SM

PR -> SM : Retrieve search results

activate SM #FFBBBB

SM -> PR : Return search results

deactivate SM

== Activate Patient ==

PR -> SM : Update patient status to ACT

== Making Request ==

PR -[#dodgerblue]> DR : Sample IDM Request (incl. Embedded Patient Block)

DR -[#dodgerblue]> PR : Reservation Response

PR -[#dodgerblue]> DR : Request Cancellation

DR -[#dodgerblue]> PR : No Result

DR -[#dodgerblue]> PR : Sample Arrival

DR -[#dodgerblue]> PR : IDM result

DR -[#dodgerblue]> PR : Sample Information

== Getting Response ==

DR -[#dodgerblue]> PR : Request RejectionPR

DR -[#dodgerblue]> DR PR : Sample Result

...

IDM Result (incl. Embedded Donor Block)

PlantUML Render Macro

format	PNG
align	left
title	Reservation Request

participant "Patient Registry" as PR

control "Match-Connect" as MC

control "Search & Match\nService" as SM

participant "Donor Registry" as DR

skinparam SequenceMessageAlign center

skinparam dpi 92

== Register Patient ==

PR -> SM : Create Patient

activate SM #FFBBBB

SM -> PR : Return wmdaId

deactivate SM

== Start Search ==

PR -> SM : Start Search

activate SM #FFBBBB

SM -> PR : Return searchId

deactivate SM

PR -> SM : Check search status

activate SM #FFBBBB

SM -> PR : Return search status (Completed, Running, Errored)

deactivate SM

PR -> SM : Retrieve search results

activate SM #FFBBBB

SM -> PR : Return search results

deactivate SM

== Activate Patient ==

PR -> SM : Update patient status to ACT

== Making Request ==

PR -[#dodgerblue]> DR : Reservation Request (incl. Embedded Patient Block)

PR -[#dodgerblue]> DR : Request Cancellation

== Getting Response ==

DR -[#dodgerblue]> PR : Request Rejection

DR -[#dodgerblue]> PR : Reservation Response (incl. Embedded Donor Block)

PR -[#dodgerblue]> DR : Reservation Release Request

Page tree

Versions Compared

Old Version 235

New Version 236

Key

5.4 - Sample Information (SMP_INFO)

Extended Typing

Page tree

Page History

Versions Compared

Old Version 235

New Version 236

Key

5.4 - Sample Information (SMP_INFO)

Extended Typing