...
| Send | Retrieve | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| addressRequest | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
Consider to use address block structure according to HL7-FHIR standard with extensions (https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-structures-r4/org/hl7/fhir/r4/model/Address.html), e.g.
...
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.
- 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 hub code + local address id.
- The hub code usually are the two-character ISO country code of the registry (e.g. NL for Netherlands)
- In the case of multiple registries in one country, a replacement code will be assigned.
- Should follow the construct of hub code + local address id.
- Should be provided as a user-friendly (displayable) id for use on screens and on documentation.
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
6.1.3 Embedded Patient Block
...