Versions Compared

Key

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

...

  • 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 PERSON is required if the INST_TYPE is ”LAB”.
  • The EMDIS ID (INST_ID) of an institution should remain stable over time and should not be assigned to different institutions.

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

...

Suggested format

Suggested field

Description

Mapping to NEW_ADD

StringType

City

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

City Req 40

StringType

country

Country - a nation as commonly understood or generally accepted.

Country Req 2

StringType

District

The name of the administrative area (county).

Address Line 2 ADDR_2 Opt 40

List <StringType>

line

This component contains the house number, apartment number, street name, street direction, and P.O.

Address Line 3 ADDR_3 Opt 40

Period

period

The time period when the address was/is in use.

new - Opt

StringType

postalCode

A postal code designating a region defined by the postal service.

ZIP code ZIP Req 10

StringType

state

Sub-unit of a country with limited sovereignty in a federally organized country.

new - Opt

StringType

text

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Address Line 1 to Address Line 3, City, Country, Zip code - Opt

Enumeration <Address.AddressType>

type

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses. Most addresses are both.). This is the underlying object with id, value, and extensions. The accessor "getType" gives direct access to the value.

new - Req

Enumeration <Address.AddressUse>

use

The purpose of this address.

Institution Type INST_TYPE Req 3

StringType

contact person

The name of the contact person.

Contact person PERSON Opt 40

StringType

phone

The value is a telephone number used for voice calls.

Phone Number PHONE Req 20

StringType

fax

The value is a fax machine.

Fax Number FAX Opt 20

StringType

email

The value is an email address.

Email address EMAIL Opt 60

StringType

ID

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. 

Not needed anymore, as the full address will be sent embedded in every request.

INST_ID Req 10



Obsolete. S&M provides accreditation on the match list.

Accreditation Opt 5

...

SendRetrieve
MessageResponse
Expand
titleRequest...
FieldDetails
organisationResponse
Expand
title...
FieldDetails
retrievedAtUtc*string($date-time)

Server-supplied timestamp showing time of Message retrieval and storage in organisation's own systems

referenceMessageId*string($uuid)
responseType*

string

Enum:
Array [ 3 ]

remark

string


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

Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

SendRetrieve
textMessageRequest
Expand
titleRequest...
Field

Details

text*

string
nullable: true

Text. Message for a human at receiving registry.

receivingRegistry*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4 digit ION of the receiving registry

patient*Patient ID
donor*Donor ID
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

Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...