Versions Compared

Old Version 137

changes.mady.by.user Rimke Postel

Saved on

compared with

New Version 138

changes.mady.by.user Rimke Postel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: NEW VERSION: aligned semantics with current specs (not done yet)

...

  • A message identifier
  • A timestamp
  • Which registry sent the information (sending registry)
  • What type of response is provided by the WMDA Match Connect system
  • Any failed validations detected by the Match Connect system
  • A sequence number, so that the receiving registry knows if any message is missing. 
metaInformation*
Expand
title...
FieldDetails
referenceMessageId*string($uuid)
deliveredAtUtc*string($date-time)

Server-supplied timestamp showing UTC time of Message delivery to receiving registry's inbox queue.

sendingRegistry*integer
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 5678

4-digit ION of the sending registry

responseType

string

Enum:
Array [ Warning]

wmdaRemarks

One or more remarks, each in its own object


Expand
title...
FieldDetails
remarkType

string 
Array [ InvalidHLA ]

descriptionstring
messageSequenceNumber*

integer
example:12345

Incrementing integer set by WMDA MatchConnect system that indicates the order in which the messages were received by the WMDA and therefore the order in which messages should be processed. Each receiving registry has its own unique sequence.

messageType*

string

Array [ attachment, alert, updatedPatient, ping, textMessage, genericRequest, extendedTypingRequest, extendedTypingResponse, sampleRequest, sampleInfo, sampleArrival, sampleResponse, infectiousDiseaseMarkerRequest, infectiousDiseaseMarkerResult, reservationRequest, reservationResponse, reservationRelease, requestCancellation, requestRejected, resultReminder, messageResponse, cordBloodUnitReportRequest, cordBloodUnitReportResponse ]

the type of message just sent by calling this endpoint

6.1.2 Embedded Address block (NEW_ADD)

...

  • Hubs are required to keep this contact information up to date.
  • It’s not only useless but forbidden to give a postbox (POB) in a LAB address since this address is used for the delivery of samples. For the same reason ZIP code, City, and Country are required in the address block.The contactPerson is required if the INST_TYPE is ”LAB”.

  • Organisation unique identifier for the institution (formerly known as INST_ID):

    • Should remain stable over time and must not be assigned to different institutions
    • Is a unique reference to an institution
    • Allows local address management if needed (e.g. for other use cases) by receiving registry and backward compatibility to existing EMDIS implementations. 
    • Provided by the local registry system.  
    • Should be worldwide unique.
      • Should follow the construct of ION + local address id. 
        • The ION to be used is the ION of the patient registering registry (PR).
    • Should be provided as a user-friendly (displayable) id for use on screens and on documentation.


In the Match-Connect system, the addresses will be embedded in the donor requests. See Chapter Requests for details.

Message structure:

...

addressRetrieve

...

.

Field

Details

organisationId

string
nullable: true
minLength:

false

5
maxLength:

10

19

minLength

example:

5

9999123456

Organisation unique identifier for the institution.

  1. Unique reference to an institution
  2. Allows local address management if needed (e.g. for other use cases) by receiving registry and backward compatibility to existing EMDIS implementations. 
  • Provided by the local registry system.  
  • Should be worldwide unique.
    • Should follow the construct of ION + local address id. 
      • The ION to be used is the ION of the patient registering registry (PR).
  • Should be provided as a user-friendly (displayable) id for use on screens and on documentation.
addressLine1
organisation*

string
nullable: false

maxLength: 60

Address line 1

Expand
title...
FieldDetails
name*
addressLine2

string

nullable

maxLength:

 true

50

maxLength

example:

60

Address line 2

Institute A

Name of the destination organisation

addressLine1*
addressLine3

string
maxLength: 50
nullable:

 true

false

maxLength

example:

60

Schipholweg 57

Address line 3

First line of address. Generally the street and house number.

addressLine2
postalCode*

string

nullable

maxLength:

false

50

maxLength

nullable:

10

true
example: Second floor

Second line of address

addressLine3
city*

string
nullable: false

maxLength: 40

country*

string

nullable

maxLength:

false

50

minLength

nullable:

2

true

maxLength

example:

22 character ISO country code ( ISO 3166-1 alpha-2)type

Unit 15

Third line of address

postalCode*

string
maxLength: 10
nullable: false

minLength

example:

3

2316 ZL

city*

string

maxLength:

3

HUB = EMDIS Hub
DON = Donor center
TRA = Transplant center
HAR = Harvesting center
LAB = Typing laboratory
FIN = Financial institution
CBB = Cord Blood Bank

contactPerson

string
nullable: true

maxLength: 40

Contact person. Required if type = LAB.

phone*

string
nullable: false

maxLength: 20

fax

string
nullable: true

maxLength: 20

email

string
nullable: true

maxLength: 60

receivingRegistry*string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of the receiving registry

Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
limitinteger
default: 100
shouldPeekboolean
default: false

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

50
nullable: false
example: Leiden

The name of the city, town, suburb, village or other community or delivery center.

country*

string
minLength: 2
maxLength: 2
nullable: false
example: NL

2 character ISO country code ( ISO 3166-1 alpha-2)

type*

string
nullable: false

Array [ node, donorCentre, transplantCentre, collectionCentre, lab, financialInstitution, cordBloodBank ]

contactPerson*
Expand
title...
FieldDetails
name*

string
maxLength: 50
example: Jane Doe

The name of the contact person.

phone*

string
maxLength: 50
nullable: false
example: +31 123456789

The value is a telephone number used for voice calls.

fax

string
maxLength: 50
nullable: true
example: +31 123456790

The value is a fax machine.

email

string
maxLength: 320
nullable: true

The value is an email address.

Expand
titleResponse...
FieldDetailsoriginalMessage{...}metaInformationEmbedded Meta Block


6.1.3 Embedded Patient Block

...

Here is the comparison of the DONOR_CB and the API endpoints: EMDIS vs API.xlsx

6.1.6 Embedded

...

general information block

The WMDA will provide a standard response that contains the parameters used to request retrieve messages sent to in Match-Connect.  Its structure is as follows:

generalInformation*
Expand
title...
FieldDetails
deliveredAtUtc

limit*
string($date-time)

Server-supplied timestamp showing time of Message delivery to receiving registry's inbox queue

integer($int32)
default: 100
totalCount*integer($int32)
minimum: 0
example: 1
remainingCount*integer($int32)
minimum: 0

isSuccessful*

boolean
example: true


summary*String
maxLength: 255
example: 1 message retrieved successfully. 0 remaining messages.
referenceMessageId*string($uuid)responseType*

stringEnum:
Array [ Success, Warning, Failed]

messages can be failed, if the message has a structure or information that prevent delivery to the receiving registry. This could be incorrect JSON structure and non-existent ION or because the receiving registry does not allow messages from your registry. 

receivingRegistryMessageSequenceNumber

integer
example: 12345

Incrementing integer set by WMDA MatchConnect systems that indicates the order in which the messages were received by the WMDA and therefore the order in which messages should be processed. Each receiving registry has its own unique sequence.

wmdaRemarks[...]

6.1.7 Embedded 'generalInformation' Response block

...