Versions Compared

Key

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

...

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 ADD_NEW

StringType

city

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

City CITY Req 40

StringType

country

Country - a nation as commonly understood or generally accepted.

Country 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, P.O.

Address Line 3 ADDR_3 Opt 40

Period

period

Time period when 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.

new - Opt

Enumeration
<Address.AddressType>

type

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g.

new - Req

Enumeration
<Address.AddressUse>

use

The purpose of this address.

Institution Type INST_TYPE Req 3


Missing fields from ADD_NEW with Albert's comments for consideration:

  • Institution Identification INST_ID Req 10 - not needed anymore, as the full address will be sent embedded in every request
  • Address Line 1 ADDR_1 Req 40
  • Address Line 2 ADDR_2 Opt 40
  • Address Line 3 ADDR_3 Opt 40
  • Contact person PERSON Opt 40
  • ZIP code ZIP Req 10
  • City CITY Req 40
  • Country COUNTRY Req 2
  • - needs to be added, as the structure above has it only in field "text" that seems optional
  • Contact person PERSON Opt 40 - better to have a separate field
  • Phone Number PHONE Req 20 - better to have a separate field
  • Fax Number FAX Opt 20 - better to have a separate field
  • Email address EMAIL Opt 60 - better to have a separate field
  • Accreditations obtained ACCREDITATION Opt 5 - is it still being used by anyone?
    • Position 1: NetCord-FACT
    • Position 2: AABB
    • Position 3: to be defined
    • Position 4: to be defined
    • Position 5: to be defined

6.1.3 Embedded Patient Block

...

Donor typePayload
Adult donor
Expand
titleDonor...

{

id*integer
nullable: false

example: 5176
donorRegistryIon*integer
nullable: false

minimum: 1000

maximum: 9999

example: 1234
abbreviationstring
example: NL-WMDA

maxLength: 24
haplotypeFrequencySetId*integer
nullable: true

minimum: 0

example: 15
status*string
nullable: false
Enum:
Array [ 3 ]
sex*string
nullable: true
Enum:
Array [ 2 ]
ethnicity*string
nullable: true
Enum:
Array [ 21 ]
idm*{...}
abo*string
nullable: true
Enum:
Array [ 4 ]
rhesus*string
nullable: true
Enum:
Array [ 2 ]
registryAccreditationStatusisSelected*stringboolean
nullable: true
Enum:
Array [ 2 ]

true when this record has been marked as selected

resolutionScorefirstAccreditationYear*number
minimum: 
19900
maximum: 
2100100
nullable: true

example: 
201954
matchClassresolutionString*string
exampleminLength: 9/10
nullable: false
nmdpGrade*string
5
maxLength: 5

example: 
MPPMPAP-A-
nullable: true

A - high-res match on ARD, P - probable matchlow or intermediate, M - sure Mismatchno typing

zeroMismatchProbabilitygrid*integer
minimumstring
nullable: true

maxLength: 
019
maximumminLength: 10019
nullableexample: true9991012070433202000
oneMismatchProbabilitydonorId*integerstring
nullable: true

example: ABC1234

minimummaxLength: 0
maximum: 100
twoMismatchProbability*25
donorType*string
nullable: false
Enum:
Array [ 2 ]
lastContactDate*integerstring($date)
nullable: true

minimumminLength: 010
maximummaxLength: 10010
aLocusMatchProbabilitymarrowDonationsCount*integer
nullable: true

minimumexample: 0maximum: 100
bLocusMatchProbabilitypbscDonationsCount*integer
nullable: true

minimumexample: 0
maximum: 100
cLocusMatchProbability*1
dateOfBirth*integerstring($date)
nullable: true

minimummaxLength: 010
maximumexample: 100
drLocusMatchProbability*1961-05-27
donorAttributeintegerstring
maxLength: 3

nullable: true
minimum: 0
maximum: 100
kir{...}
weightdqLocusMatchProbability*integer
nullable: true

minimum: 
01
maximum: 
100
inexplicable*boolean
matchingInformationDpb1*{...}
mismatches*[...]
searchResultRecordState*string
nullable: false

default: Existing
Enum:
Array [ 4 ]
999
example: 76
heightinteger
nullable: true

minimum: 1

maximum: 999

example: 161
collectionTypesearchResultRecordStateUpdatedAt*string($date-time)string
nullable: true

maxLength: 255

date and time when the last change was registered in the system

isSelected*boolean
nullable: true

true when this record has been marked as selected

resolutionScore*number
minimum: 0

maximum: 100

nullable: true

example: 54
resolutionString*string
minLength: 5

maxLength: 5

example: AP-A-

nullable: true

A - high-res P - low or intermediate, - no typing

grid*string
nullable: true

maxLength: 19

minLength: 19

example: 9991012070433202000
donorId*string
nullable: true

example: ABC1234

maxLength: 25
donorType*string
nullable: false
Enum:
Array [ 2 ]
lastContactDate*string($date)
nullable: true

minLength: 10

maxLength: 10
marrowDonationsCount*integer
nullable: true

example: 0
pbscDonationsCount*integer
nullable: true

example: 1
dateOfBirth*string($date)
nullable: true

maxLength: 10

example: 1961-05-27
donorAttributestring
maxLength: 3

nullable: true
kir{...}
weightinteger
nullable: true

minimum: 1

maximum: 999

example: 76
heightinteger
nullable: true

minimum: 1

maximum: 999

example: 161
collectionTypestring
nullable: true

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

Enum:
Array [ 3 ]
transfusionsCountinteger
nullable: true

example: 1
pregnanciesCountinteger
nullable: true

example: 2
reservedPatientIdstring
nullable: true

example: 1234222ss
statusEndDatestring($date)
maxLength: 10

nullable: true
statusReasonstring
nullable: true

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

Enum:
Array [ 10 ]
hla*{...}
mic*{...}
ccr5*string
nullable: true
Enum:
Array [ 3 ]
lastMedicalCheckupDatestring($date)
nullable: true

minLength: 10

maxLength: 10
registry*{...}

}

CBU

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

Enum:
Array [ 3 ]
transfusionsCount
Expand
titleCBU...

{

id*integer
nullable: false

example: 5176
donorRegistryIon*integer
nullable: false

minimum: 1000

maximum: 9999

example: 1234
abbreviationstring
example: NL-WMDA

maxLength: 24
haplotypeFrequencySetId*integer
nullable: true

minimum: 0

example: 151
status*pregnanciesCountintegerstring
nullable: false
Enum:
Array [ 3 ]
true
example: 2
reservedPatientIdsex*string
nullable: true
Enum
example:

Array [ 2 ]
 1234222ss
statusEndDateethnicity*string($date)
nullablemaxLength: true
Enum:
Array [ 21 ]
idm*{...}
10
nullable: true
statusReasonabo*string
nullable: true
Enum:
Array [ 4 ]

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

Enum: Array [ 10 ]
hla*{...}
mic*{...}
ccr5*string
nullable: true
Enum:
Array [ 3 ]
lastMedicalCheckupDatestring($date)
nullable: true

minLength: 10

maxLength: 10
registry*{...}

}

CBU
Expand
titleCBU...

{

id
rhesus*string
nullable: true
Enum:
Array [ 2 ]
registryAccreditationStatus*string
nullable: true
Enum:
Array [ 2 ]
firstAccreditationYear*number
minimum: 1990

maximum: 2100

nullable: true

example: 2019
matchClass*string
example: 9/10

nullable: false
nmdpGrade*string
maxLength: 5

example: MPPMP

nullable: true

A - high-res match on ARD, P - probable match, M - sure Mismatch

zeroMismatchProbability*integer
minimum: 0

maximum: 100

nullable: true
oneMismatchProbability*integer
nullable: 
truefalse
minimumexample: 0
maximum: 100
5176
donorRegistryIontwoMismatchProbability*integer
nullable: 
truefalse
minimum: 
01000
maximum: 
100
aLocusMatchProbability*integer
nullable: true

minimum: 0

maximum: 100
9999
example: 1234
abbreviationstring
example: NL-WMDA

maxLength: 24
haplotypeFrequencySetIdbLocusMatchProbability*integer
nullable: true

minimum: 0

maximumexample: 10015
cLocusMatchProbabilitystatus*integerstring
nullable: 
true
minimum: 0

maximum: 100
drLocusMatchProbability*falseEnum:
Array [ 3 ]
sex*integerstring
nullable: true

minimumEnum: 0
maximum: 100
dqLocusMatchProbability*integer
nullable: true

minimum: 0

maximum: 100
inexplicable*boolean

Array [ 2 ]
ethnicity*string
nullable: true
Enum:
Array [ 21 ]
idmmatchingInformationDpb1*{...}
mismatches*[...]
searchResultRecordStateabo*string
nullable: 
false
default: Existing
trueEnum:
Array [ 4 ]
searchResultRecordStateUpdatedAtrhesus*string($date-time)
nullable: true

maxLengthEnum: 255date and time when the last change was registered in the system
Array [ 2 ]
isSelected*boolean
nullable: true

true when this record has been marked as a selected

resolutionScore*number
minimum: 0

maximum: 100

nullable: true

example: 54
resolutionString*string
minLength: 5

maxLength: 5

example: AP-A-

nullable: true

A - high-res P - low or intermediate, - no typing

cordIdstring
nullable: true

maxLength: 25

example: 9991012070433202000
donorType*string
nullable: false
Enum:
Array [ 2 ]
collectionDatestring($date)
minLength: 10

maxLength: 10

nullable: true

example: 2021-05-27
volume*integer
example: 25

nullable: true
tncCount*number
example: 1140000000

nullable: true
cd34Count*number
example: 3900000

nullable: true
viability*integer
minimum: 0

maximum: 100

example: 97

nullable: true
attachedSegmentsCountinteger
nullable: true

minimum: 0

maximum: 99

example: 2
bankManufacturerIdWmda*integer
example: 5432

nullable: true
cbbAccreditationStatus*string
nullable: true
Enum:
Array [ 3 ]
localIdstring
example: 12345ABC

nullable: true
bagIdstring
example: ABCDE1234

nullable: true
dateOfBirth*string($date)
nullable: true

maxLength: 10

example: 1961-05-27
processingDatestring($date)
nullable: true

minLength: 10

maxLength: 10
processingMethodstring
nullable: true

HES = Hydroxy-Ethyl-Starch, DGS = Density Gradient Separation, CEN = Centrifuge, FIL = Filtration, FIC = FICOL, PER = PERCOL, OTH = Other

Enum:
Array [ 7 ]
processingMethodTypestring
nullable: true
Enum:
Array [ 5 ]
freezeDatestring($date)
nullable: true
freezeMethodstring
nullable: true
Enum:
Array [ 2 ]
reservedPatientIdstring
nullable: true

example: 1234222ss
productModificationsstring
nullable: true
Enum:
Array [ 7 ]
bagTypestring
nullable: true
Enum:
Array [ 4 ]
bagsCountinteger
minimum: 1

maximum: 99

example: 2

nullable: true
bankDistributionIdWmdainteger
nullable: true

example: 1234
bacterialCultureResultsstring
nullable: true

P = Positive N = Negative D = Not done

Enum:
Array [ 3 ]
fungalCultureResultsstring
nullable: true

P = Positive N = Negative D = Not done

Enum:
Array [ 3 ]
hemoglobinopathyScreeningStatusstring
nullable: true

DN = "Screening done, normal results" DU = "Screening done, unusual findings" NS = "No screening done" CD = "Can be done at time of release" NC = "Cannot be done" DT = "Thalassemia" DD = "Drepanocytosis"

Enum:
Array [ 7 ]
viabilityCellTypestring
nullable: true

type of cell tested for viability

Enum:
Array [ 3 ]
viabilityMethodstring
nullable: true

7A = 7AAD PI = Propidium Iodide TB = Trypan Blue OT = Other

Enum:
Array [ 4 ]
viabilityDatestring($date)
nullable: true
volumeFrozen*integer
example: 25

nullable: true
tncFrozenCount*number
example: 1020000000

nullable: true
cd34FrozenCount*number
example: 3700000

nullable: true
cfuFrozenCountinteger
nullable: true

minimum: 10000

maximum: 99990000

Total count of colony forming units (post processing, prior to cryopreservation)

mncFrozenCount*number
example: 430000000

nullable: true
ccr5string
nullable: true
Enum:
Array [ 3 ]
kir{...}
plasmaAliquotsCountinteger
minimum: 0

maximum: 99

nullable: true

Number of plasma aliquots available

redCellAliquotsCountinteger
minimum: 0

maximum: 99

nullable: true

Number of red cell fraction aliquots

nucleatedRbcFrozenCountinteger
minimum: 0

maximum: 9999000000

nullable: true

Total number of nucleated red blood cells (post processing, prior to cryopreservation)

serumAliquotsCountinteger
minimum: 0

maximum: 99

nullable: true
serumQuantitynumber
minimum: 0

maximum: 99.9

nullable: true
plasmaQuantitynumber
minimum: 0

maximum: 99.9

nullable: true
ctCompletionDatestring($date)
maxLength: 10
ctSampleTypestring
nullable: true

maxLength: 2

AS = CBU Contiguous Attached Segment, WB = Whole Blood Sample, RC = Red Cell Fraction (pellet), FP = Blood Spotted Filter Paper, ED = Extracted DNA

Enum:
Array [ 5 ]
dnaSamplesAvailableboolean
nullable: true
otherSamplesAvailableboolean
nullable: true
donorAttributestring
maxLength: 3

nullable: true
statusEndDatestring($date)
maxLength: 10

nullable: true
statusReasonstring
nullable: true

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

Enum:
Array [ 10 ]
hla*{...}
mic{...}
registry{...}
cbb{...}
maternalInfo{...}

}

ADCU


...