Versions Compared

Old Version 30

changes.mady.by.user Jan Hofmann

Saved on

compared with

New Version 31

changes.mady.by.user Matt Prestegaard

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The additional meta-information "blocks" are added to ensure the receiving registry is aware of:

  • A message identifier
  • A timestamp
  • What registry sent the information (sender)
  • What type of information is contained
  • A message identifier
  • A timestamp
  • /* Pending */ Any failed validations detected by the Match Connect system


metaInformation

...

Field name
formatDescription
messageIdstring($uuid)
ID of the originally sent message
sentAtUtcstring($date-time)

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

senderstring
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 5678

4 digit ION of

the

sender

messageTypestring
To be designed and described. The idea is to help registry's MC admin to analyze possible issues reported in validationDetails field. AM: I think this is an excessive information, as messageId should be sufficient. validationDetailsTo be designed and described. The idea is to supply the concerns of the central hub validation system that are acceptable but require attention of the receiving registry.

...

Enum:
Array [ 1 ]

6.1.2 Embedded Address block

...

There is no register patient endpoint.  Instead, an embedded patient block will accompany all requests.  The embedded patient block looks as follows:

...


...

patient
wmdaId*integer
nullable: false
example: 1234

ID provided by the WMDA

patientId*string
maxLength: 17
nullable: false
example: P1234XX

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{...}
diseasePhasestring
nullable: trueEnum:
Array [ 48 ]
ethnicitystring
nullable: trueEnum:
Array [ 20 ]
poolCountryCodestring
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL

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

abostring
nullable: trueEnum:
Array [ 4 ]
rhesusstring
nullable: trueEnum:
Array [ 2 ]
weightinteger
nullable: true
minimum: 1
maximum: 999
example: 76
sexstring
nullable: trueEnum:
Array [ 2 ]
firstNamestring
maxLength: 30
nullable: true
example: John

First (given name) of the patient

lastNamestring
maxLength: 30
nullable: true
example: Doe

Last (family name) of the patient

6.1.4 Embedded Donor Block

...