Versions Compared

Old Version 138

changes.mady.by.user Rimke Postel

Saved on

compared with

New Version 139

changes.mady.by.user Rimke Postel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: V1.02 - Aligned semantics with current API specs

...

  • 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)

...

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

Field

Details

organisationId

string
nullable: true
minLength: 5
maxLength: 19
example: 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.
organisation*
Expand
title...
FieldDetails
name*

string
maxLength: 50
example: Institute A

Name of the destination organisation

addressLine1*

string
maxLength: 50
nullable: false
example: Schipholweg 57

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

addressLine2

string
maxLength: 50
nullable: true
example: Second floor

Second line of address

addressLine3

string
maxLength: 50
nullable: true
example: Unit 15

Third line of address

postalCode*

string
maxLength: 10
nullable: false
example: 2316 ZL

city*

string
maxLength: 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.


6.1.3 Embedded Patient Block

...

stringnullable:true
maxLength: 10

date of CMV NAT test

a
mica
FieldDetails
grid*

string
nullable:true
maxLength: 19
minLength: 19
example: 9991012070433202000

dateOfBirth*

string
nullable: true

Donor date of birth

false
minLength: 10
maxLength: 10
example: 1961-05-27

sexsexstring
nullable:true
Enum: [M, F]antiCmvStatus

string
nullable:true
Enum: [

P, G,

M,

B, H, O, N

F]

antiCmvDate
hla*


Expand
hla
Expand
title...
title...

a

*

dna* {...}

description: HLA node with DNA

b*

dna* {...}

description: HLA node with DNA

c

dna {...}

description: HLA node with DNA

drb1*

dna* {...}

description: HLA node with DNA

drb3

dna {...}

description: HLA node with DNA

drb4

dna {...}

description: HLA node with DNA

drb5

dna {...}

description: HLA node with DNA

dqa1

dna {...}

description: HLA node with DNA

dqb1

dna {...}

description: HLA node with DNA

dpa1

dna {...}

description: HLA node with DNA

dpb1

dna {...}

description: HLA node with DNA


gls {...}

description: HLA node with GLS

micb

gls {...}

description: HLA node with GLS

abostring
nullable:true
Enum: [A, B, O, AB]
rhesusstring
nullable:true
Enum: [P, N]

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 retrieve messages in Match-Connect.  Its structure is as follows:

...

title...
donorRegistryIon*

integer($int32)
nullable: false
minimum: 1000
maximum: 9999
example: 1234

Unique number provided by ICCBBA for the registry that is responsible for the donor/CBU

status*

string
nullable: false
Enum: [ AV, TU ]

ethnicity

string
nullable: true

Enum:
Array [ UK, AF, AS, CA, HI, AFNA, AFSS, ASSW, ASSO, ASCE, ASSE, ASNE, ASOC, CAEU, CAER, CANA, CAAU, HICA, HISA, MX, OT ]

idm

[ ... ]

lastContactDate

string($date)
nullable: true
minimum: 10
maximum: 10

marrowDonationsCount

integer($int32)
nullable: true
example: 0

pbscDonationsCount

integer($int32)
nullable: true
example: 1

donorAttribute

string
nullable: true
maximum: 3

weight

integer
nullable: true
minimum: 1
maximum: 999
example: 76

height

integer($int32)
nullable: true
minimum: 1
maximum: 999
example: 161

kir

[ ... ]

collectionType

string
nullable: true
Enum: [ M, P, B ]

Collection type, i.e. the willingness of the donor to donate in a specific manner. M = Marrow P = PBSC B = Both PBSC & Marrow

transfusionsCount

integer($int32)
nullable: true
example: 1

pregnanciesCount

integer($int32)
nullable: true
example: 2

reservedPatientId

string
nullable: true
example: 1234222ss

statusEndDate

string($date)
nullable: true
maximum: 10

statusReason

string
nullable: true
Enum: [ DO, DD, MR, PR, TX, MO, UC, OT, TQ, UK ]

DO = Donor is too old, DD = Donor died, MR = Medical reasons, PR = Personal reasons, TX = After transplantation, MO = Donor has moved, UC = Unable to contact donor, OT = Other reasons, TQ = Typing questionable, UK = Unknown

mic{...}
ccr5string
nullable: true
Enum: [ DD, DW, WW ]
lastMedicalCheckupDate

string($date)
nullable: true
minimum: 10
maximum: 10

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 retrieve messages sent to in Match-Connect.  Its structure is as follows:

generalInformation*
Expand
title...
FieldDetails
limit*integer($int32)
default: 100
shouldPeekboolean
default: false
totalCount*integer($int32)
minimum: 0
example: 1
remainingCount
remainingCount*integer($int32)
minimum: 0
isSuccessful*

boolean

default

example: true

summary*
string
String
maxLength: 255
example: 1 message retrieved successfully. 0 remaining messages.

6.2 Message Response

The message response is intended as an automated response to every user generated message. It serves three purposes:

...