org.hl7.fhir.r4.hapi.ctx

Interface IValidationSupport

All Superinterfaces:

ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSet.ValueSetExpansionComponent,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,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IValidationSupport.CodeValidationResult

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.CodingConceptProperty, ca.uhn.fhir.context.support.IContextValidationSupport.StringConceptProperty

Method Summary

Modifier and Type	Method and Description
ValueSet.ValueSetExpansionComponent	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 theSystem) Fetch a code system by ID
<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)
boolean	isCodeSystemSupported(ca.uhn.fhir.context.FhirContext theContext, String theSystem) Returns true if codes in the given code system can be expanded or validated
IValidationSupport.CodeValidationResult	validateCode(ca.uhn.fhir.context.FhirContext theContext, String theCodeSystem, String theCode, String theDisplay) Validates that the given code exists and if possible returns a display name.

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

fetchAllConformanceResources

Method Detail

expandValueSet

ValueSet.ValueSetExpansionComponent 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,ValueSet.ValueSetExpansionComponent,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,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

fetchCodeSystem

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

Fetch a code system by ID

Specified by:

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

Parameters:

theSystem - The code system

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,ValueSet.ValueSetExpansionComponent,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,ValueSet.ValueSetExpansionComponent,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,ValueSet.ValueSetExpansionComponent,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

validateCode

IValidationSupport.CodeValidationResult validateCode(ca.uhn.fhir.context.FhirContext theContext,
                                                     String theCodeSystem,
                                                     String theCode,
                                                     String theDisplay)

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 ca.uhn.fhir.context.support.IContextValidationSupport<ValueSet.ConceptSetComponent,ValueSet.ValueSetExpansionComponent,StructureDefinition,CodeSystem,CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity>

Parameters:

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