Package ca.uhn.fhir.rest.server.interceptor.validation.address

Interface IAddressValidator

All Known Implementing Classes:

BaseRestfulValidator, LoquateAddressValidator

public interface IAddressValidator

Contract for validating addresses.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDRESS_GEO_ACCURACY_EXTENSION_URL	URL for an optional geocoding accuracy extensions that may be added to addresses.
static final String	ADDRESS_QUALITY_EXTENSION_URL	URL for an optional address quality extensions that may be added to addresses.
static final String	ADDRESS_VALIDATION_EXTENSION_URL	URL for validation results that should be placed on addresses.
static final String	ADDRESS_VERIFICATION_CODE_EXTENSION_URL	URL for an optional address verification extensions that may be added to addresses.
static final String	FHIR_GEOCODE_EXTENSION_URL	URL for an optional FHIR geolocation extension.

Method Summary

Modifier and Type	Method	Description
AddressValidationResult	isValid(org.hl7.fhir.instance.model.api.IBase theAddress, ca.uhn.fhir.context.FhirContext theFhirContext)	Validates address against a service

Field Details

ADDRESS_VALIDATION_EXTENSION_URL

static final String ADDRESS_VALIDATION_EXTENSION_URL

URL for validation results that should be placed on addresses. Extension with boolean value "true" indicates there there is an address validation error.

See Also:

• Constant Field Values

ADDRESS_QUALITY_EXTENSION_URL

static final String ADDRESS_QUALITY_EXTENSION_URL

URL for an optional address quality extensions that may be added to addresses.

See Also:

• Constant Field Values

ADDRESS_GEO_ACCURACY_EXTENSION_URL

static final String ADDRESS_GEO_ACCURACY_EXTENSION_URL

URL for an optional geocoding accuracy extensions that may be added to addresses.

See Also:

• Constant Field Values

ADDRESS_VERIFICATION_CODE_EXTENSION_URL

static final String ADDRESS_VERIFICATION_CODE_EXTENSION_URL

URL for an optional address verification extensions that may be added to addresses.

See Also:

• Constant Field Values

FHIR_GEOCODE_EXTENSION_URL

static final String FHIR_GEOCODE_EXTENSION_URL

URL for an optional FHIR geolocation extension.

See Also:

• Constant Field Values

Method Details

isValid

AddressValidationResult isValid(org.hl7.fhir.instance.model.api.IBase theAddress,
 ca.uhn.fhir.context.FhirContext theFhirContext)
                         throws AddressValidationException

Validates address against a service

Parameters:

theAddress - Address to be validated

theFhirContext - Current FHIR context

Returns:

Returns true in case address represents a valid

Throws:

AddressValidationException - AddressValidationException is thrown in case validation can not be completed successfully.