Package ca.uhn.hapi.converters.canonical

Class VersionCanonicalizer

java.lang.Object
ca.uhn.hapi.converters.canonical.VersionCanonicalizer
public class VersionCanonicalizer extends Object
This class converts versions of various resources to/from a canonical version of the resource. The specific version that is considered canonical is arbitrary for historical reasons, generally it will be R4 or R5 but this varies by resource type.

This class is an internal HAPI FHIR API and can change without notice at any time. Use with caution!

  • Constructor Summary

    Constructors
    Constructor
    Description
    VersionCanonicalizer(ca.uhn.fhir.context.FhirContext theTargetContext)
     
    VersionCanonicalizer(ca.uhn.fhir.context.FhirVersionEnum theTargetVersion)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.hl7.fhir.instance.model.api.IBaseResource
    auditEventFromCanonical(org.hl7.fhir.r4.model.AuditEvent theResource)
     
    org.hl7.fhir.instance.model.api.IBaseConformance
    capabilityStatementFromCanonical(org.hl7.fhir.r5.model.CapabilityStatement theCapabilityStatement)
    Canonical version: R5
    org.hl7.fhir.r5.model.CapabilityStatement
    capabilityStatementToCanonical(org.hl7.fhir.instance.model.api.IBaseResource theCapabilityStatement)
     
    org.hl7.fhir.r4.model.CodeableConcept
    codeableConceptToCanonical(org.hl7.fhir.instance.model.api.IBaseDatatype theCodeableConcept)
    Canonical version: R4
    org.hl7.fhir.r4.model.CodeSystem
    codeSystemToCanonical(org.hl7.fhir.instance.model.api.IBaseResource theCodeSystem)
    Canonical version: R4
    org.hl7.fhir.r5.model.CodeSystem
    codeSystemToValidatorCanonical(org.hl7.fhir.instance.model.api.IBaseResource theResource)
     
    org.hl7.fhir.r4.model.Coding
    codingToCanonical(org.hl7.fhir.instance.model.api.IBaseCoding theCodingToValidate)
    Canonical version: R4
    org.hl7.fhir.r4.model.ConceptMap
    conceptMapToCanonical(org.hl7.fhir.instance.model.api.IBaseResource theConceptMap)
    Canonical version: R4
    org.hl7.fhir.instance.model.api.IBaseParameters
    parametersFromCanonical(org.hl7.fhir.r4.model.Parameters theParameters)
     
    org.hl7.fhir.r5.model.Resource
    resourceToValidatorCanonical(org.hl7.fhir.instance.model.api.IBaseResource theResource)
     
    org.hl7.fhir.instance.model.api.IBaseResource
    searchParameterFromCanonical(org.hl7.fhir.r5.model.SearchParameter theSearchParameter)
     
    <T extends org.hl7.fhir.instance.model.api.IBaseResource>
    org.hl7.fhir.r5.model.SearchParameter
    searchParameterToCanonical(T theSearchParameter)
    Canonical version: R5
    org.hl7.fhir.instance.model.api.IBaseResource
    structureDefinitionFromCanonical(org.hl7.fhir.r5.model.StructureDefinition theResource)
     
    org.hl7.fhir.r5.model.StructureDefinition
    structureDefinitionToCanonical(org.hl7.fhir.instance.model.api.IBaseResource theResource)
     
    org.hl7.fhir.instance.model.api.IBaseResource
    valueSetFromCanonical(org.hl7.fhir.r4.model.ValueSet theValueSet)
    Canonical version: R4
    org.hl7.fhir.instance.model.api.IBaseResource
    valueSetFromValidatorCanonical(org.hl7.fhir.r5.model.ValueSet theResource)
     
    org.hl7.fhir.r4.model.ValueSet
    valueSetToCanonical(org.hl7.fhir.instance.model.api.IBaseResource theValueSet)
    Canonical version: R4
    org.hl7.fhir.r5.model.ValueSet
    valueSetToValidatorCanonical(org.hl7.fhir.instance.model.api.IBaseResource theResource)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • VersionCanonicalizer

      public VersionCanonicalizer(ca.uhn.fhir.context.FhirVersionEnum theTargetVersion)

    • VersionCanonicalizer

      public VersionCanonicalizer(ca.uhn.fhir.context.FhirContext theTargetContext)

  • Method Details

    • capabilityStatementToCanonical

      public org.hl7.fhir.r5.model.CapabilityStatement capabilityStatementToCanonical(org.hl7.fhir.instance.model.api.IBaseResource theCapabilityStatement)

    • capabilityStatementFromCanonical

      public org.hl7.fhir.instance.model.api.IBaseConformance capabilityStatementFromCanonical(org.hl7.fhir.r5.model.CapabilityStatement theCapabilityStatement)
      Canonical version: R5

    • codeableConceptToCanonical

      public org.hl7.fhir.r4.model.CodeableConcept codeableConceptToCanonical(org.hl7.fhir.instance.model.api.IBaseDatatype theCodeableConcept)
      Canonical version: R4

    • codingToCanonical

      public org.hl7.fhir.r4.model.Coding codingToCanonical(org.hl7.fhir.instance.model.api.IBaseCoding theCodingToValidate)
      Canonical version: R4

    • valueSetToCanonical

      public org.hl7.fhir.r4.model.ValueSet valueSetToCanonical(org.hl7.fhir.instance.model.api.IBaseResource theValueSet)
      Canonical version: R4

    • codeSystemToCanonical

      public org.hl7.fhir.r4.model.CodeSystem codeSystemToCanonical(org.hl7.fhir.instance.model.api.IBaseResource theCodeSystem)
      Canonical version: R4

    • valueSetFromCanonical

      public org.hl7.fhir.instance.model.api.IBaseResource valueSetFromCanonical(org.hl7.fhir.r4.model.ValueSet theValueSet)
      Canonical version: R4

    • conceptMapToCanonical

      public org.hl7.fhir.r4.model.ConceptMap conceptMapToCanonical(org.hl7.fhir.instance.model.api.IBaseResource theConceptMap)
      Canonical version: R4

    • searchParameterToCanonical

      public <T extends org.hl7.fhir.instance.model.api.IBaseResource> org.hl7.fhir.r5.model.SearchParameter searchParameterToCanonical(T theSearchParameter)
      Canonical version: R5

      Note that this method will look for any nonstandard resource types specified in SearchParameter.base or SearchParameter.target and move them into extensions with the URLs HapiExtensions.EXTENSION_SEARCHPARAM_CUSTOM_BASE_RESOURCE and HapiExtensions.EXTENSION_SEARCHPARAM_CUSTOM_TARGET_RESOURCE respectively. If any nonstandard resource types are found, all resource types in the respective list are moved into the extension (including standard types) and the source list is cleared.

    • searchParameterFromCanonical

      public org.hl7.fhir.instance.model.api.IBaseResource searchParameterFromCanonical(org.hl7.fhir.r5.model.SearchParameter theSearchParameter)

    • parametersFromCanonical

      public org.hl7.fhir.instance.model.api.IBaseParameters parametersFromCanonical(org.hl7.fhir.r4.model.Parameters theParameters)

    • structureDefinitionToCanonical

      public org.hl7.fhir.r5.model.StructureDefinition structureDefinitionToCanonical(org.hl7.fhir.instance.model.api.IBaseResource theResource)

    • structureDefinitionFromCanonical

      public org.hl7.fhir.instance.model.api.IBaseResource structureDefinitionFromCanonical(org.hl7.fhir.r5.model.StructureDefinition theResource)

    • valueSetFromValidatorCanonical

      public org.hl7.fhir.instance.model.api.IBaseResource valueSetFromValidatorCanonical(org.hl7.fhir.r5.model.ValueSet theResource)

    • resourceToValidatorCanonical

      public org.hl7.fhir.r5.model.Resource resourceToValidatorCanonical(org.hl7.fhir.instance.model.api.IBaseResource theResource)

    • valueSetToValidatorCanonical

      public org.hl7.fhir.r5.model.ValueSet valueSetToValidatorCanonical(org.hl7.fhir.instance.model.api.IBaseResource theResource)

    • codeSystemToValidatorCanonical

      public org.hl7.fhir.r5.model.CodeSystem codeSystemToValidatorCanonical(org.hl7.fhir.instance.model.api.IBaseResource theResource)

    • auditEventFromCanonical

      public org.hl7.fhir.instance.model.api.IBaseResource auditEventFromCanonical(org.hl7.fhir.r4.model.AuditEvent theResource)