org.hl7.fhir.r4.hapi.ctx

Class DefaultProfileValidationSupport

java.lang.Object

org.hl7.fhir.r4.hapi.ctx.DefaultProfileValidationSupport

All Implemented Interfaces:

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

public class DefaultProfileValidationSupport
extends Object
implements IValidationSupport

Nested Class Summary

Nested classes/interfaces inherited from interface org.hl7.fhir.r4.hapi.ctx.IValidationSupport

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

Constructor Summary

Constructors

Constructor and Description
DefaultProfileValidationSupport()

Method Summary

Modifier and Type	Method and Description
org.hl7.fhir.r4.terminologies.ValueSetExpander.ValueSetExpansionOutcome	expandValueSet(ca.uhn.fhir.context.FhirContext theContext, org.hl7.fhir.r4.model.ValueSet.ConceptSetComponent theInclude) Expands the given portion of a ValueSet
List<org.hl7.fhir.instance.model.api.IBaseResource>	fetchAllConformanceResources(ca.uhn.fhir.context.FhirContext theContext)
List<org.hl7.fhir.r4.model.StructureDefinition>	fetchAllStructureDefinitions(ca.uhn.fhir.context.FhirContext theContext) Load and return all possible structure definitions
org.hl7.fhir.r4.model.CodeSystem	fetchCodeSystem(ca.uhn.fhir.context.FhirContext theContext, String theSystem) 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)
org.hl7.fhir.r4.model.StructureDefinition	fetchStructureDefinition(ca.uhn.fhir.context.FhirContext theContext, String theUrl)
org.hl7.fhir.r4.model.ValueSet	fetchValueSet(ca.uhn.fhir.context.FhirContext theContext, String uri) Fetch a valueset by Uri
void	flush()
org.hl7.fhir.r4.model.StructureDefinition	generateSnapshot(org.hl7.fhir.r4.model.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
ca.uhn.fhir.context.support.IContextValidationSupport.LookupCodeResult	lookupCode(ca.uhn.fhir.context.FhirContext theContext, String theSystem, String theCode)
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 class java.lang.Object

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

Constructor Detail

DefaultProfileValidationSupport

public DefaultProfileValidationSupport()

Method Detail

expandValueSet

public org.hl7.fhir.r4.terminologies.ValueSetExpander.ValueSetExpansionOutcome expandValueSet(ca.uhn.fhir.context.FhirContext theContext,
                                                                                              org.hl7.fhir.r4.model.ValueSet.ConceptSetComponent theInclude)

Description copied from interface: IValidationSupport

Expands the given portion of a ValueSet

Specified by:

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

Specified by:

expandValueSet in interface IValidationSupport

theInclude - The portion to include

Returns:

The expansion

fetchAllConformanceResources

public List<org.hl7.fhir.instance.model.api.IBaseResource> fetchAllConformanceResources(ca.uhn.fhir.context.FhirContext theContext)

Specified by:

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

fetchAllStructureDefinitions

public List<org.hl7.fhir.r4.model.StructureDefinition> fetchAllStructureDefinitions(ca.uhn.fhir.context.FhirContext theContext)

Description copied from interface: IValidationSupport

Load and return all possible structure definitions

Specified by:

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

Specified by:

fetchAllStructureDefinitions in interface IValidationSupport

fetchCodeSystem

public org.hl7.fhir.r4.model.CodeSystem fetchCodeSystem(ca.uhn.fhir.context.FhirContext theContext,
                                                        String theSystem)

Description copied from interface: IValidationSupport

Fetch a code system by Uri

Specified by:

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

Specified by:

fetchCodeSystem in interface IValidationSupport

theSystem - Canonical Uri of the code system

Returns:

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

fetchResource

public <T extends org.hl7.fhir.instance.model.api.IBaseResource> T fetchResource(ca.uhn.fhir.context.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 ca.uhn.fhir.context.support.IContextValidationSupport<org.hl7.fhir.r4.model.ValueSet.ConceptSetComponent,org.hl7.fhir.r4.terminologies.ValueSetExpander.ValueSetExpansionOutcome,org.hl7.fhir.r4.model.StructureDefinition,org.hl7.fhir.r4.model.CodeSystem,org.hl7.fhir.r4.model.CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.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 org.hl7.fhir.r4.model.StructureDefinition fetchStructureDefinition(ca.uhn.fhir.context.FhirContext theContext,
                                                                          String theUrl)

Specified by:

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

Specified by:

fetchStructureDefinition in interface IValidationSupport

fetchValueSet

public org.hl7.fhir.r4.model.ValueSet fetchValueSet(ca.uhn.fhir.context.FhirContext theContext,
                                                    String uri)

Description copied from interface: IValidationSupport

Fetch a valueset by Uri

Specified by:

fetchValueSet in interface IValidationSupport

uri - Canonical Uri of the ValueSet

Returns:

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

flush

public void flush()

isCodeSystemSupported

public boolean isCodeSystemSupported(ca.uhn.fhir.context.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 ca.uhn.fhir.context.support.IContextValidationSupport<org.hl7.fhir.r4.model.ValueSet.ConceptSetComponent,org.hl7.fhir.r4.terminologies.ValueSetExpander.ValueSetExpansionOutcome,org.hl7.fhir.r4.model.StructureDefinition,org.hl7.fhir.r4.model.CodeSystem,org.hl7.fhir.r4.model.CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.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

generateSnapshot

public org.hl7.fhir.r4.model.StructureDefinition generateSnapshot(org.hl7.fhir.r4.model.StructureDefinition theInput,
                                                                  String theUrl,
                                                                  String theWebUrl,
                                                                  String theProfileName)

Description copied from interface: IValidationSupport

Generate a snapshot from the given differential profile.

Specified by:

generateSnapshot in interface IValidationSupport

Returns:

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

validateCode

public IValidationSupport.CodeValidationResult validateCode(ca.uhn.fhir.context.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 ca.uhn.fhir.context.support.IContextValidationSupport<org.hl7.fhir.r4.model.ValueSet.ConceptSetComponent,org.hl7.fhir.r4.terminologies.ValueSetExpander.ValueSetExpansionOutcome,org.hl7.fhir.r4.model.StructureDefinition,org.hl7.fhir.r4.model.CodeSystem,org.hl7.fhir.r4.model.CodeSystem.ConceptDefinitionComponent,org.hl7.fhir.utilities.validation.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

lookupCode

public ca.uhn.fhir.context.support.IContextValidationSupport.LookupCodeResult lookupCode(ca.uhn.fhir.context.FhirContext theContext,
                                                                                         String theSystem,
                                                                                         String theCode)

Specified by:

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