Package org.hl7.fhir.r5.utils.validation

Interface IValidationPolicyAdvisor

public interface IValidationPolicyAdvisor

Method Summary

Modifier and Type	Method	Description
CodedContentValidationPolicy	policyForCodedContent(IResourceValidator validator, Object appContext, String stackPath, ElementDefinition definition, StructureDefinition structure, BindingKind kind, ValueSet valueSet, List<String> systems)	Called before validating a concept in an instance against the terminology sub-system There's two reasons to use this policy advisor feature: - save time by not calling the terminology server for validation that don't bring value to the context calling the validation - suppressing known issues from being listed as a problem Note that the terminology subsystem has two parts: a mini-terminology server running inside the validator, and then calling out to an external terminology service (usually tx.fhir.org, though you run your own local copy of this - see https://confluence.hl7.org/display/FHIR/Running+your+own+copy+of+tx.fhir.org).
ContainedReferenceValidationPolicy	policyForContained(IResourceValidator validator, Object appContext, String containerType, String containerId, Element.SpecialElement containingResourceType, String path, String url)	//TODO pass through the actual containing Element as opposed to the type, id
ReferenceValidationPolicy	policyForReference(IResourceValidator validator, Object appContext, String path, String url)

Method Detail

policyForReference

ReferenceValidationPolicy policyForReference(IResourceValidator validator,
                                             Object appContext,
                                             String path,
                                             String url)

Parameters:

validator -

appContext - What was originally provided from the app for it's context

path - Path that led us to this resource.

url - Url of the profile the container resource is being validated against.

Returns:

ReferenceValidationPolicy

policyForContained

ContainedReferenceValidationPolicy policyForContained(IResourceValidator validator,
                                                      Object appContext,
                                                      String containerType,
                                                      String containerId,
                                                      Element.SpecialElement containingResourceType,
                                                      String path,
                                                      String url)

//TODO pass through the actual containing Element as opposed to the type, id

Parameters:

validator -

appContext - What was originally provided from the app for it's context

containerType - Type of the resources that contains the resource being validated

containerId - Id of the resources that contains the resource being validated

containingResourceType - Type of the resource that will be validated (BUNDLE_ENTRY, BUNDLE_OUTCOME, CONTAINED_RESOURCE, PARAMETER)

path - Path that led us to this resource.

url - Url of the profile the container resource is being validated against.

Returns:

ReferenceValidationPolicy

policyForCodedContent

CodedContentValidationPolicy policyForCodedContent(IResourceValidator validator,
                                                   Object appContext,
                                                   String stackPath,
                                                   ElementDefinition definition,
                                                   StructureDefinition structure,
                                                   BindingKind kind,
                                                   ValueSet valueSet,
                                                   List<String> systems)

Called before validating a concept in an instance against the terminology sub-system There's two reasons to use this policy advisor feature: - save time by not calling the terminology server for validation that don't bring value to the context calling the validation - suppressing known issues from being listed as a problem Note that the terminology subsystem has two parts: a mini-terminology server running inside the validator, and then calling out to an external terminology service (usually tx.fhir.org, though you run your own local copy of this - see https://confluence.hl7.org/display/FHIR/Running+your+own+copy+of+tx.fhir.org). You can't tell which subsystem will handle the terminology validation directly from the content provided here which subsystem will be called - you'll haev to investigate based on your set up. (matters, since it makes a huge performance difference, though it also depends on caching, and the impact of caching is also not known at this point)

Parameters:

validator -

appContext - What was originally provided from the app for it's context

stackPath - The current path for the stack. Note that the because of cross-references and FHIRPath conformsTo() statements, the stack can wind through the content unpredictably.

definition - the definition being validated against (might be useful: ElementDefinition.base.path, ElementDefinition.type, ElementDefinition.binding

structure - The structure definition that contains the element definition being validated against (may be from the base spec, may be from a profile)

kind - The part of the binding being validated

valueSet - The value set for the binding part that's being validated

systems - A list of canonical URls (including versions if known) of the systems in the instance that's being validated. Note that if a plain code is being validated, then there'll be no known system when this is called (systems will be empty, not null)

Returns:

CodedContentValidationPolicy