org.hl7.fhir.dstu3.hapi.validation

Class PrePopulatedValidationSupport

java.lang.Object

org.hl7.fhir.dstu3.hapi.validation.PrePopulatedValidationSupport

All Implemented Interfaces:

IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,ValidationMessage.IssueSeverity>, IValidationSupport

public class PrePopulatedValidationSupport
extends Object
implements IValidationSupport

This class is an implementation of IValidationSupport which may be pre-populated with a collection of validation resources to be used by the validator.

Nested Class Summary

Nested classes/interfaces inherited from interface org.hl7.fhir.dstu3.hapi.validation.IValidationSupport

IValidationSupport.CodeValidationResult

Constructor Summary

Constructors

Constructor and Description
PrePopulatedValidationSupport() Constructor
PrePopulatedValidationSupport(Map<String,StructureDefinition> theStructureDefinitions, Map<String,ValueSet> theValueSets, Map<String,CodeSystem> theCodeSystems) Constructor

Method Summary

Modifier and Type	Method and Description
void	addCodeSystem(CodeSystem theCodeSystem) Add a new CodeSystem resource which will be available to the validator.
void	addStructureDefinition(StructureDefinition theStructureDefinition) Add a new StructureDefinition resource which will be available to the validator.
void	addValueSet(ValueSet theValueSet) Add a new ValueSet resource which will be available to the validator.
ValueSet.ValueSetExpansionComponent	expandValueSet(FhirContext theContext, ValueSet.ConceptSetComponent theInclude) Expands the given portion of a ValueSet
List<StructureDefinition>	fetchAllStructureDefinitions(FhirContext theContext) Load and return all possible structure definitions
CodeSystem	fetchCodeSystem(FhirContext theContext, String theSystem) Fetch a code system by ID
<T extends IBaseResource> T	fetchResource(FhirContext theContext, Class<T> theClass, String theUri) Loads a resource needed by the validation (a StructureDefinition, or a ValueSet)
StructureDefinition	fetchStructureDefinition(FhirContext theCtx, String theUrl)
boolean	isCodeSystemSupported(FhirContext theContext, String theSystem) Returns true if codes in the given code system can be expanded or validated
IValidationSupport.CodeValidationResult	validateCode(FhirContext theContext, String theCodeSystem, String theCode, String theDisplay) Validates that the given code exists and if possible returns a display name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrePopulatedValidationSupport

public PrePopulatedValidationSupport()

Constructor

PrePopulatedValidationSupport

public PrePopulatedValidationSupport(Map<String,StructureDefinition> theStructureDefinitions,
                                     Map<String,ValueSet> theValueSets,
                                     Map<String,CodeSystem> theCodeSystems)

Constructor

Parameters:

theStructureDefinitions - The StructureDefinitions to be returned by this module. Keys are the logical URL for the resource, and values are the resource itself.

theValueSets - The ValueSets to be returned by this module. Keys are the logical URL for the resource, and values are the resource itself.

theCodeSystems - The CodeSystems to be returned by this module. Keys are the logical URL for the resource, and values are the resource itself.

Method Detail

addStructureDefinition

public void addStructureDefinition(StructureDefinition theStructureDefinition)

Add a new StructureDefinition resource which will be available to the validator. Note that {@link StructureDefinition#getUrl() the URL field) in this resource must contain a value as this value will be used as the logical URL.

addValueSet

public void addValueSet(ValueSet theValueSet)

Add a new ValueSet resource which will be available to the validator. Note that {@link ValueSet#getUrl() the URL field) in this resource must contain a value as this value will be used as the logical URL.

addCodeSystem

public void addCodeSystem(CodeSystem theCodeSystem)

Add a new CodeSystem resource which will be available to the validator. Note that {@link CodeSystem#getUrl() the URL field) in this resource must contain a value as this value will be used as the logical URL.

expandValueSet

public ValueSet.ValueSetExpansionComponent expandValueSet(FhirContext theContext,
                                                          ValueSet.ConceptSetComponent theInclude)

Description copied from interface: IValidationSupport

Expands the given portion of a ValueSet

Specified by:

expandValueSet in interface IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,ValidationMessage.IssueSeverity>

Specified by:

expandValueSet in interface IValidationSupport

theInclude - The portion to include

Returns:

The expansion

fetchAllStructureDefinitions

public List<StructureDefinition> fetchAllStructureDefinitions(FhirContext theContext)

Description copied from interface: IValidationSupport

Load and return all possible structure definitions

Specified by:

fetchAllStructureDefinitions in interface IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,ValidationMessage.IssueSeverity>

Specified by:

fetchAllStructureDefinitions in interface IValidationSupport

fetchCodeSystem

public CodeSystem fetchCodeSystem(FhirContext theContext,
                                  String theSystem)

Description copied from interface: IValidationSupport

Fetch a code system by ID

Specified by:

fetchCodeSystem in interface IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,ValidationMessage.IssueSeverity>

Specified by:

fetchCodeSystem in interface IValidationSupport

theSystem - The code system

Returns:

The valueset (must not be null, but can be an empty ValueSet)

fetchResource

public <T extends IBaseResource> T fetchResource(FhirContext theContext,
                                                 Class<T> theClass,
                                                 String theUri)

Description copied from interface: IValidationSupport

Loads a resource needed by the validation (a StructureDefinition, or a ValueSet)

Specified by:

fetchResource in interface IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,ValidationMessage.IssueSeverity>

Specified by:

fetchResource in interface IValidationSupport

Parameters:

theContext - The HAPI FHIR Context object current in use by the validator

theClass - The type of the resource to load

theUri - The resource URI

Returns:

Returns the resource, or null if no resource with the given URI can be found

fetchStructureDefinition

public StructureDefinition fetchStructureDefinition(FhirContext theCtx,
                                                    String theUrl)

Specified by:

fetchStructureDefinition in interface IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,ValidationMessage.IssueSeverity>

Specified by:

fetchStructureDefinition in interface IValidationSupport

isCodeSystemSupported

public boolean isCodeSystemSupported(FhirContext theContext,
                                     String theSystem)

Description copied from interface: IValidationSupport

Returns true if codes in the given code system can be expanded or validated

Specified by:

isCodeSystemSupported in interface IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,ValidationMessage.IssueSeverity>

Specified by:

isCodeSystemSupported in interface IValidationSupport

theSystem - The URI for the code system, e.g. "http://loinc.org"

Returns:

Returns true if codes in the given code system can be validated

validateCode

public IValidationSupport.CodeValidationResult validateCode(FhirContext theContext,
                                                            String theCodeSystem,
                                                            String theCode,
                                                            String theDisplay)

Description copied from interface: IValidationSupport

Validates that the given code exists and if possible returns a display name. This method is called to check codes which are found in "example" binding fields (e.g. Observation.code in the default profile.

Specified by:

validateCode in interface IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,ValidationMessage.IssueSeverity>

Specified by:

validateCode in interface IValidationSupport

theCodeSystem - The code system, e.g. "http://loinc.org"

theCode - The code, e.g. "1234-5"

theDisplay - The display name, if it should also be validated

Returns:

Returns a validation result object