Versions Compared

Old Version 136

changes.mady.by.user Mark Melchers

Saved on

compared with

New Version 137

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)

...

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
remarkTypestring

string 
[ 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

...

FieldDetails
wmdaId*integer
nullable: false
example: 1234

ID provided by the WMDA

patientId*string
maxLength: 17
nullable: false
example: 99991234P

MUST Start with ION of patient registry. Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here.

hla*{...}
idm{...}
dateOfBirthstring($date)
nullable: true
maxLength: 10
example: 1961-05-27
diagnosis{...}
diseasePhase

string
nullable: true

Enum:
Array [  48 ] PF, PI, AP, BC, AD, SD, RD, NA, C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, R0, R1, R2, R3, R4, R5, R6, R7, R8, R9, N0, N1, N2, N3, N4, N5, N6, N7, N8, N9 ]

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

ethnicity

string
nullable: true

Enum:
Array [ 20  ]

poolCountryCodestring
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL

ISO 3166-1 alpha-2 Country Code (capitalized)

abo

string
nullable: true

Enum:
Array [  4  A, B, O, AB ]

rhesus

string
nullable: true

Enum:
Array [  2  P, N ]

weightinteger
nullable: true
minimum: 1
maximum: 999
example: 76
sex

string
nullable: true

Enum:
Array [  2  M, F ]

firstNamestring
maxLength: 3050
nullable: true
example: John

First (given name) of the patient

lastNamestring
maxLength: 3050
nullable: true
example: Doe

Last (family name) of the patientpatient

mic{...}

6.1.4 Embedded Donor Block (donor in request)

...

Only sending a grid, cordId or adcuId for message types with static donor information enhances privacy and security through data minimization.

Donor typeDetails
adult
Expand
title...

grid*

string
nullable: true
maxLength: 19
minLength: 19
example: 9991012070433202000
donor*cbu
Expand
title...

cordIddonorType*

string
maxLengthenum: 17
example: CB1234567

CBU Identification2 (formerly CB_ID)

adcu

Array [ adult, adcu, cbu ]
Expand
title...
adcuId: 13

maxLength: 13
example: A99991412345612N

N/A in EMDIS, available in the future

donorId

*

string
oneOf: 

grid { "maxLength": 19, "minLength

": 19, "example": 9991012070433202000 }

adcuId { "maxLength": 13, "minLength": 13, "example": "A999916123456" } 

cordId { "maxLength": 17, "example": "CB1234567" }

6.1.5 Embedded Donor Block (donor in response)

...