org.hl7.fhir.r4.utils

Interface IResourceValidator

public interface IResourceValidator

Interface to the instance validator. This takes a resource, in one of many forms, and checks whether it is valid

Author:

Grahame Grieve

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IResourceValidator.BestPracticeWarningLevel
static class	IResourceValidator.CheckDisplayOption
static class	IResourceValidator.IdStatus
static interface	IResourceValidator.IValidatorResourceFetcher
static class	IResourceValidator.ReferenceValidationPolicy

Method Summary

Modifier and Type	Method and Description
IResourceValidator.BestPracticeWarningLevel	getBestPracticeWarningLevel() whether the validator should enforce best practice guidelines as defined by various HL7 committees
IResourceValidator.CheckDisplayOption	getCheckDisplay() how much to check displays for coded elements
IResourceValidator.IValidatorResourceFetcher	getFetcher()
IResourceValidator.IdStatus	getResourceIdRule() whether the resource must have an id or not (depends on context)
String	getValidationLanguage()
boolean	isErrorForUnknownProfiles() Whether being unable to resolve a profile in found in Resource.meta.profile or ElementDefinition.type.profile or targetProfile is an error or just a warning
boolean	isNoBindingMsgSuppressed()
boolean	isNoExtensibleWarnings()
boolean	isNoInvariantChecks()
boolean	isNoTerminologyChecks()
IResourceValidator	setBestPracticeWarningLevel(IResourceValidator.BestPracticeWarningLevel value)
void	setCheckDisplay(IResourceValidator.CheckDisplayOption checkDisplay)
void	setErrorForUnknownProfiles(boolean errorForUnknownProfiles)
IResourceValidator	setFetcher(IResourceValidator.IValidatorResourceFetcher value)
IResourceValidator	setNoBindingMsgSuppressed(boolean noBindingMsgSuppressed)
IResourceValidator	setNoExtensibleWarnings(boolean noExtensibleWarnings)
IResourceValidator	setNoInvariantChecks(boolean value)
IResourceValidator	setNoTerminologyChecks(boolean noTerminologyChecks)
void	setResourceIdRule(IResourceValidator.IdStatus resourceIdRule)
void	setValidationLanguage(String value)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Document document)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Document document, String profile)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Document document, StructureDefinition profile)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Document document, ValidationProfileSet profiles)
void	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Element element) Validate suite you can validate one of the following representations of resources: stream - provide a format - this is the preferred choice Use one of these two if the content is known to be valid XML/JSON, and already parsed - a DOM element or Document - a Json Object In order to use these, the content must already be parsed - e.g.
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Element element)
void	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Element element, String profile)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Element element, String profile)
void	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Element element, StructureDefinition profile)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Element element, StructureDefinition profile)
void	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Element element, ValidationProfileSet profiles)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Element element, ValidationProfileSet profiles)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, InputStream stream, Manager.FhirFormat format)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, InputStream stream, Manager.FhirFormat format, String profile)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, InputStream stream, Manager.FhirFormat format, StructureDefinition profile)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, InputStream stream, Manager.FhirFormat format, ValidationProfileSet profiles)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, com.google.gson.JsonObject object)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, com.google.gson.JsonObject object, String profile)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, com.google.gson.JsonObject object, StructureDefinition profile)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, com.google.gson.JsonObject object, ValidationProfileSet profiles)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Resource resource)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Resource resource, String profile)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Resource resource, StructureDefinition profile)
Element	validate(Object Context, List<org.hl7.fhir.utilities.validation.ValidationMessage> errors, Resource resource, ValidationProfileSet profiles)

Method Detail

getCheckDisplay

IResourceValidator.CheckDisplayOption getCheckDisplay()

how much to check displays for coded elements

Returns:

setCheckDisplay

void setCheckDisplay(IResourceValidator.CheckDisplayOption checkDisplay)

getResourceIdRule

IResourceValidator.IdStatus getResourceIdRule()

whether the resource must have an id or not (depends on context)

Returns:

setResourceIdRule

void setResourceIdRule(IResourceValidator.IdStatus resourceIdRule)

getBestPracticeWarningLevel

IResourceValidator.BestPracticeWarningLevel getBestPracticeWarningLevel()

whether the validator should enforce best practice guidelines as defined by various HL7 committees

setBestPracticeWarningLevel

IResourceValidator setBestPracticeWarningLevel(IResourceValidator.BestPracticeWarningLevel value)

getFetcher

IResourceValidator.IValidatorResourceFetcher getFetcher()

setFetcher

IResourceValidator setFetcher(IResourceValidator.IValidatorResourceFetcher value)

isNoBindingMsgSuppressed

boolean isNoBindingMsgSuppressed()

setNoBindingMsgSuppressed

IResourceValidator setNoBindingMsgSuppressed(boolean noBindingMsgSuppressed)

isNoInvariantChecks

boolean isNoInvariantChecks()

setNoInvariantChecks

IResourceValidator setNoInvariantChecks(boolean value)

isNoTerminologyChecks

boolean isNoTerminologyChecks()

setNoTerminologyChecks

IResourceValidator setNoTerminologyChecks(boolean noTerminologyChecks)

isNoExtensibleWarnings

boolean isNoExtensibleWarnings()

setNoExtensibleWarnings

IResourceValidator setNoExtensibleWarnings(boolean noExtensibleWarnings)

isErrorForUnknownProfiles

boolean isErrorForUnknownProfiles()

Whether being unable to resolve a profile in found in Resource.meta.profile or ElementDefinition.type.profile or targetProfile is an error or just a warning

Returns:

setErrorForUnknownProfiles

void setErrorForUnknownProfiles(boolean errorForUnknownProfiles)

getValidationLanguage

String getValidationLanguage()

setValidationLanguage

void setValidationLanguage(String value)

validate

void validate(Object Context,
              List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
              Element element)
       throws org.hl7.fhir.exceptions.FHIRException

Validate suite you can validate one of the following representations of resources: stream - provide a format - this is the preferred choice Use one of these two if the content is known to be valid XML/JSON, and already parsed - a DOM element or Document - a Json Object In order to use these, the content must already be parsed - e.g. it must syntactically valid - a native resource - a elementmodel resource in addition, you can pass one or more profiles ti validate beyond the base standard - as structure definitions or canonical URLs

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

validate

void validate(Object Context,
              List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
              Element element,
              ValidationProfileSet profiles)
       throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

void validate(Object Context,
              List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
              Element element,
              String profile)
       throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

void validate(Object Context,
              List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
              Element element,
              StructureDefinition profile)
       throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 InputStream stream,
                 Manager.FhirFormat format)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 InputStream stream,
                 Manager.FhirFormat format,
                 ValidationProfileSet profiles)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 InputStream stream,
                 Manager.FhirFormat format,
                 String profile)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 InputStream stream,
                 Manager.FhirFormat format,
                 StructureDefinition profile)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Resource resource)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Resource resource,
                 ValidationProfileSet profiles)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Resource resource,
                 String profile)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Resource resource,
                 StructureDefinition profile)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Element element)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Element element,
                 ValidationProfileSet profiles)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Element element,
                 String profile)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Element element,
                 StructureDefinition profile)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Document document)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Document document,
                 ValidationProfileSet profiles)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Document document,
                 String profile)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 Document document,
                 StructureDefinition profile)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 com.google.gson.JsonObject object)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 com.google.gson.JsonObject object,
                 ValidationProfileSet profiles)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 com.google.gson.JsonObject object,
                 String profile)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validate

Element validate(Object Context,
                 List<org.hl7.fhir.utilities.validation.ValidationMessage> errors,
                 com.google.gson.JsonObject object,
                 StructureDefinition profile)
          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException