Package org.hl7.fhir.r4.hapi.ctx

Interface IValidationSupport

All Superinterfaces:

ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSetExpander.ValueSetExpansionOutcome,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

All Known Implementing Classes:

DefaultProfileValidationSupport

public interface IValidationSupport
extends ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSetExpander.ValueSetExpansionOutcome,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

Nested Class Summary

Nested classes/interfaces inherited from interface ca.uhn.fhir.context.support.IContextValidationSupport

ca.uhn.fhir.context.support.IContextValidationSupport.BaseConceptProperty, ca.uhn.fhir.context.support.IContextValidationSupport.CodeValidationResult, ca.uhn.fhir.context.support.IContextValidationSupport.CodingConceptProperty, ca.uhn.fhir.context.support.IContextValidationSupport.ConceptDesignation, ca.uhn.fhir.context.support.IContextValidationSupport.LookupCodeResult, ca.uhn.fhir.context.support.IContextValidationSupport.StringConceptProperty

Method Summary

Modifier and Type	Method	Description
ValueSetExpander.ValueSetExpansionOutcome	expandValueSet(ca.uhn.fhir.context.FhirContext theContext, ValueSet.ConceptSetComponent theInclude)	Expands the given portion of a ValueSet
List<StructureDefinition>	fetchAllStructureDefinitions(ca.uhn.fhir.context.FhirContext theContext)	Load and return all possible structure definitions
CodeSystem	fetchCodeSystem(ca.uhn.fhir.context.FhirContext theContext, String uri)	Fetch a code system by Uri
<T extends org.hl7.fhir.instance.model.api.IBaseResource> T	fetchResource(ca.uhn.fhir.context.FhirContext theContext, Class<T> theClass, String theUri)	Loads a resource needed by the validation (a StructureDefinition, or a ValueSet)
StructureDefinition	fetchStructureDefinition(ca.uhn.fhir.context.FhirContext theCtx, String theUrl)
ValueSet	fetchValueSet(ca.uhn.fhir.context.FhirContext theContext, String uri)	Fetch a valueset by Uri
StructureDefinition	generateSnapshot(StructureDefinition theInput, String theUrl, String theWebUrl, String theProfileName)	Generate a snapshot from the given differential profile.
boolean	isCodeSystemSupported(ca.uhn.fhir.context.FhirContext theContext, String theSystem)	Returns true if codes in the given code system can be expanded or validated
default boolean	isValueSetSupported(ca.uhn.fhir.context.FhirContext theContext, String theValueSetUrl)	Returns true if the given valueset can be validated by the given validation support module

Methods inherited from interface ca.uhn.fhir.context.support.IContextValidationSupport

fetchAllConformanceResources, lookupCode, validateCode, validateCodeInValueSet

Method Detail

expandValueSet

ValueSetExpander.ValueSetExpansionOutcome expandValueSet(ca.uhn.fhir.context.FhirContext theContext,
                                                         ValueSet.ConceptSetComponent theInclude)

Expands the given portion of a ValueSet

Specified by:

expandValueSet in interface ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSetExpander.ValueSetExpansionOutcome,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

Parameters:

theInclude - The portion to include

Returns:

The expansion

fetchAllStructureDefinitions

List<StructureDefinition> fetchAllStructureDefinitions(ca.uhn.fhir.context.FhirContext theContext)

Load and return all possible structure definitions

Specified by:

fetchAllStructureDefinitions in interface ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSetExpander.ValueSetExpansionOutcome,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

fetchCodeSystem

CodeSystem fetchCodeSystem(ca.uhn.fhir.context.FhirContext theContext,
                           String uri)

Fetch a code system by Uri

Specified by:

fetchCodeSystem in interface ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSetExpander.ValueSetExpansionOutcome,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

Parameters:

uri - Canonical Uri of the code system

Returns:

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

fetchValueSet

ValueSet fetchValueSet(ca.uhn.fhir.context.FhirContext theContext,
                       String uri)

Fetch a valueset by Uri

Specified by:

fetchValueSet in interface ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSetExpander.ValueSetExpansionOutcome,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

Parameters:

uri - Canonical Uri of the ValueSet

Returns:

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

fetchResource

<T extends org.hl7.fhir.instance.model.api.IBaseResource> T fetchResource(ca.uhn.fhir.context.FhirContext theContext,
                                                                          Class<T> theClass,
                                                                          String theUri)

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

Specified by:

fetchResource in interface ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSetExpander.ValueSetExpansionOutcome,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

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

StructureDefinition fetchStructureDefinition(ca.uhn.fhir.context.FhirContext theCtx,
                                             String theUrl)

Specified by:

fetchStructureDefinition in interface ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSetExpander.ValueSetExpansionOutcome,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

isCodeSystemSupported

boolean isCodeSystemSupported(ca.uhn.fhir.context.FhirContext theContext,
                              String theSystem)

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

Specified by:

isCodeSystemSupported in interface ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSetExpander.ValueSetExpansionOutcome,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

Parameters:

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

isValueSetSupported

default boolean isValueSetSupported(ca.uhn.fhir.context.FhirContext theContext,
                                    String theValueSetUrl)

Returns true if the given valueset can be validated by the given validation support module

Parameters:

theContext - The FHIR context

theValueSetUrl - The URL

generateSnapshot

StructureDefinition generateSnapshot(StructureDefinition theInput,
                                     String theUrl,
                                     String theWebUrl,
                                     String theProfileName)

Generate a snapshot from the given differential profile.

Returns:

Returns null if this module does not know how to handle this request