Deprecated API

Contents

• Terminally Deprecated
• Exception Classes
• Fields
• Methods
• Constructors
• Enum Constants
• Annotation Interface Elements

Terminally Deprecated Elements

Element	Description
ca.uhn.fhir.context.FhirContext.getPrimitiveBoolean(Boolean)
ca.uhn.fhir.context.FhirVersionEnum.newContext()	since 7.7. Use FhirContext.forVersion(FhirVersionEnum) instead
ca.uhn.fhir.context.FhirVersionEnum.newContextCached()	since 7.7. Use FhirContext.forCached(FhirVersionEnum) instead
ca.uhn.fhir.interceptor.executor.BaseInterceptorService(Class<POINTCUT>, String)	The name parameter is not used for anything
ca.uhn.fhir.interceptor.executor.BaseInterceptorService.setName(String)	This value is not used anywhere
ca.uhn.fhir.interceptor.executor.InterceptorService(String)
ca.uhn.fhir.rest.client.api.IGenericClient.fetchConformance()	As of HAPI 3.0.0 this method has been deprecated, as the operation is now called "capabilities". Use IGenericClient.capabilities() instead
ca.uhn.fhir.util.OperationOutcomeUtil.getFirstIssueDetails(FhirContext, IBaseOperationOutcome)	Use OperationOutcomeUtil.getFirstIssueDiagnostics(FhirContext, IBaseOperationOutcome) instead. This method has always been misnamed for historical reasons.

Deprecated Exception Classes

Exception Class	Description
ca.uhn.fhir.rest.server.exceptions.ResourceVersionNotSpecifiedException	Use PreconditionFailedException instead - This exception is strangely named and will be removed at some point.

Deprecated Fields

Field	Description
ca.uhn.fhir.model.api.ResourceMetadataKeyEnum.VERSION	The IResource.getId() resource ID will now be populated with the version ID via the IdDt.getVersionIdPart() method
ca.uhn.fhir.model.api.ResourceMetadataKeyEnum.VERSION_ID	The IResource.getId() resource ID will now be populated with the version ID via the IdDt.getVersionIdPart() method

Deprecated Methods

Method	Description
ca.uhn.fhir.context.FhirContext.getPrimitiveBoolean(Boolean)
ca.uhn.fhir.context.FhirContext.newFluentPath()	Deprecated in HAPI FHIR 5.0.0. Use FhirContext.newFhirPath() instead.
ca.uhn.fhir.context.FhirVersionEnum.newContext()	since 7.7. Use FhirContext.forVersion(FhirVersionEnum) instead
ca.uhn.fhir.context.FhirVersionEnum.newContextCached()	since 7.7. Use FhirContext.forCached(FhirVersionEnum) instead
ca.uhn.fhir.context.phonetic.PhoneticEncoderEnum.getPhoneticEncoder()
ca.uhn.fhir.context.RuntimeResourceDefinition.getResourceProfile()
ca.uhn.fhir.context.RuntimeResourceDefinition.toProfile()
ca.uhn.fhir.context.support.IValidationSupport.CodeValidationIssue.getCode()	Please use IValidationSupport.CodeValidationIssue.getType() instead.
ca.uhn.fhir.context.support.IValidationSupport.CodeValidationIssue.getCoding()	Please use IValidationSupport.CodeValidationIssue.getDetails() instead. That has support for multiple codings.
ca.uhn.fhir.context.support.IValidationSupport.CodeValidationIssue.getMessage()	Please use IValidationSupport.CodeValidationIssue.getDiagnostics() instead.
ca.uhn.fhir.context.support.IValidationSupport.CodeValidationResult.addCodeValidationIssue(IValidationSupport.CodeValidationIssue)	Please use method IValidationSupport.CodeValidationResult.addIssue(CodeValidationIssue) instead.
ca.uhn.fhir.context.support.IValidationSupport.CodeValidationResult.getCodeValidationIssues()	Please use method IValidationSupport.CodeValidationResult.getIssues() instead.
ca.uhn.fhir.context.support.IValidationSupport.CodeValidationResult.setCodeValidationIssues(List<IValidationSupport.CodeValidationIssue>)	Please use method IValidationSupport.CodeValidationResult.setIssues(List) instead.
ca.uhn.fhir.context.support.IValidationSupport.CodeValidationResult.setSeverityCode(String)
ca.uhn.fhir.context.support.IValidationSupport.lookupCode(ValidationSupportContext, String, String)	This method has been deprecated in HAPI FHIR 7.0.0. Use IValidationSupport.lookupCode(ValidationSupportContext, LookupCodeRequest) instead.
ca.uhn.fhir.context.support.IValidationSupport.lookupCode(ValidationSupportContext, String, String, String)	This method has been deprecated in HAPI FHIR 7.0.0. Use IValidationSupport.lookupCode(ValidationSupportContext, LookupCodeRequest) instead.
ca.uhn.fhir.interceptor.executor.BaseInterceptorService.setName(String)	This value is not used anywhere
ca.uhn.fhir.interceptor.model.RequestPartitionId.hasDefaultPartitionId()	use RequestPartitionId.hasDefaultPartitionId(Integer) or invalid reference IRequestPartitionHelperSvc.hasDefaultPartitionId instead
ca.uhn.fhir.interceptor.model.RequestPartitionId.isDefaultPartition()	use RequestPartitionId.isDefaultPartition(Integer) or invalid reference IRequestPartitionHelperSvc.isDefaultPartition instead .
ca.uhn.fhir.model.api.annotation.Block.name()	Do not use, will be removed
ca.uhn.fhir.model.api.annotation.Description.formalDefinition()	Use Description.value() instead. Deprecated in 5.4.0.
ca.uhn.fhir.model.api.BaseIdentifiableElement.getId()	Use BaseIdentifiableElement.getElementSpecificId() instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.api.BaseIdentifiableElement.setId(IdDt)	Use BaseIdentifiableElement.setElementSpecificId(String) instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.api.BaseIdentifiableElement.setId(String)	Use BaseIdentifiableElement.setElementSpecificId(String) instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.api.ExtensionDt.getAllPopulatedChildElementsOfType(Class<T>)
ca.uhn.fhir.model.api.ICompositeElement.getAllPopulatedChildElementsOfType(Class<T>)	This method is not used by HAPI at this point, so there isn't much point to keeping it around. We are not deleting it just so that we don't break existing implementer code, but you do not need to supply an implementation of this code in your own structures. Deprecated in HAPI FHIR 2.3 (Jan 2017). See See for a discussion about this.
ca.uhn.fhir.model.api.IIdentifiableElement.getId()	Use IIdentifiableElement.getElementSpecificId() instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.api.IIdentifiableElement.setId(IdDt)	Use IIdentifiableElement.setElementSpecificId(String) instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.api.IIdentifiableElement.setId(String)	Use IIdentifiableElement.setElementSpecificId(String) instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.api.TagList.addTag()	Tags wil become immutable in a future release of HAPI, so TagList.addTag(String, String, String) should be used instead
ca.uhn.fhir.model.base.composite.BaseCodingDt.getMissing()	get/setMissing is not supported in StringDt. Use TokenParam instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseCodingDt.setMissing(Boolean)	get/setMissing is not supported in StringDt. Use TokenParam instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseIdentifierDt.getMissing()	get/setMissing is not supported in StringDt. Use StringParam instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseIdentifierDt.setMissing(Boolean)	get/setMissing is not supported in StringDt. Use StringParam instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseQuantityDt.getMissing()	get/setMissing is not supported in StringDt. Use QuantityParam instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseQuantityDt.setMissing(Boolean)	get/setMissing is not supported in StringDt. Use QuantityParam instead if you need this functionality
ca.uhn.fhir.model.base.resource.BaseOperationOutcome.BaseIssue.setDetails(String)	Use BaseOperationOutcome.BaseIssue.setDiagnostics(String) instead - Field was renamed in DSTU2
ca.uhn.fhir.model.primitive.IdDt.asBigDecimal()	Use IdDt.getIdPartAsBigDecimal() instead (this method was deprocated because its name is ambiguous)
ca.uhn.fhir.model.primitive.IdDt.setId(IdDt)
ca.uhn.fhir.model.primitive.StringDt.getMissing()	get/setMissing is not supported in StringDt. Use StringParam instead if you need this functionality
ca.uhn.fhir.model.primitive.StringDt.setMissing(Boolean)	get/setMissing is not supported in StringDt. Use StringParam instead if you need this functionality
ca.uhn.fhir.parser.BaseParser.getSuppressNarratives()	Use BaseParser.isSuppressNarratives()
ca.uhn.fhir.rest.api.IVersionSpecificBundleFactory.initializeBundleFromResourceList(String, List<? extends IBaseResource>, String, String, int, BundleTypeEnum)	This was deprecated in HAPI FHIR 4.1.0 as it provides duplicate functionality to the IVersionSpecificBundleFactory.addRootPropertiesToBundle(String, BundleLinks, Integer, IPrimitiveType<Date>) and IVersionSpecificBundleFactory.addResourcesToBundle(List, BundleTypeEnum, String, BundleInclusionRule, Set) methods
ca.uhn.fhir.rest.client.api.IGenericClient.fetchConformance()	As of HAPI 3.0.0 this method has been deprecated, as the operation is now called "capabilities". Use IGenericClient.capabilities() instead
ca.uhn.fhir.rest.client.api.IGenericClient.read(UriDt)	Use read() fluent method instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.read(Class<T>, UriDt)	Use read() fluent method instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.read(Class<T>, String)	Use read() fluent method instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.setLogRequestAndResponse(boolean)	Use LoggingInterceptor as a client interceptor registered to your client instead, as this provides much more fine-grained control over what is logged. This method will be removed at some point (deprecated in HAPI 1.6 - 2016-06-16)
ca.uhn.fhir.rest.client.api.IGenericClient.update(IdDt, IBaseResource)	Use update() fluent method instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.update(String, IBaseResource)	Use update() fluent method instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.validate(IBaseResource)	Use validate() fluent method instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.vread(Class<T>, IdDt)	Use read() fluent method instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.vread(Class<T>, String, String)	Use read() fluent method instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IRestfulClientFactory.getServerValidationModeEnum()	Use IRestfulClientFactory.getServerValidationMode() instead (this method is a synonym for that method, but this method is poorly named and will be removed at some point)
ca.uhn.fhir.rest.client.api.IRestfulClientFactory.setServerValidationModeEnum(ServerValidationModeEnum)	Use IRestfulClientFactory.setServerValidationMode(ServerValidationModeEnum) instead. This method was incorrectly named.
ca.uhn.fhir.rest.gclient.IClientExecutable.andLogRequestAndResponse(boolean)	Use the client logging interceptor to log requests and responses instead. See here for more information.
ca.uhn.fhir.rest.gclient.IHistoryUntyped.andReturnBundle(Class<T>)	Use IHistoryUntyped.returnBundle(Class) instead, which has the exact same functionality. This was deprecated in HAPI FHIR 4.0.0 in order to be consistent with the similar method on the search operation.
ca.uhn.fhir.rest.gclient.IQuery.limitTo(int)	This parameter is badly named, since FHIR calls this parameter "_count" and not "_limit". Use IQuery.count(int) instead (it also sets the _count parameter)
ca.uhn.fhir.rest.gclient.UriClientParam.matches(String)	theValue does not do anything, use UriClientParam.matches() instead
ca.uhn.fhir.rest.param.InternalCodingDt.getAllPopulatedChildElementsOfType(Class<T>)
ca.uhn.fhir.rest.param.InternalCodingDt.getMissing()
ca.uhn.fhir.rest.param.InternalCodingDt.getVersion()
ca.uhn.fhir.rest.param.InternalCodingDt.setMissing(Boolean)
ca.uhn.fhir.rest.param.QuantityParam.getSystemAsUriDt()	Use {QuantityParam.getSystem()} instead
ca.uhn.fhir.rest.param.TokenParam.setText(boolean)	Use TokenParam.setModifier(TokenParamModifier) instead
ca.uhn.fhir.util.ObjectUtil.equals(Object, Object)	Just use Objects.equals() instead;
ca.uhn.fhir.util.OperationOutcomeUtil.getFirstIssueDetails(FhirContext, IBaseOperationOutcome)	Use OperationOutcomeUtil.getFirstIssueDiagnostics(FhirContext, IBaseOperationOutcome) instead. This method has always been misnamed for historical reasons.
ca.uhn.fhir.validation.ValidationResult.getOperationOutcome()	Use ValidationResult.toOperationOutcome() instead since this method returns a view. ValidationResult.toOperationOutcome() is identical to this method, but has a more suitable name so this method will be removed at some point.

Deprecated Constructors

Constructor	Description
ca.uhn.fhir.context.FhirContext()	It is recommended that you use one of the static initializer methods instead of this method, e.g. FhirContext.forDstu2() or FhirContext.forDstu3() or FhirContext.forR4()
ca.uhn.fhir.context.FhirContext(Class<?>...)	It is recommended that you use one of the static initializer methods instead of this method, e.g. FhirContext.forDstu2() or FhirContext.forDstu3() or FhirContext.forR4()
ca.uhn.fhir.context.FhirContext(Class<? extends IBaseResource>)	It is recommended that you use one of the static initializer methods instead of this method, e.g. FhirContext.forDstu2() or FhirContext.forDstu3() or FhirContext.forR4()
ca.uhn.fhir.context.FhirContext(Collection<Class<? extends IBaseResource>>)	It is recommended that you use one of the static initializer methods instead of this method, e.g. FhirContext.forDstu2() or FhirContext.forDstu3() or FhirContext.forR4()
ca.uhn.fhir.interceptor.executor.BaseInterceptorService(Class<POINTCUT>, String)	The name parameter is not used for anything
ca.uhn.fhir.interceptor.executor.InterceptorService(String)
ca.uhn.fhir.model.api.Tag(String)	There is no reason to create a tag with a term and not a scheme, so this constructor will be removed
ca.uhn.fhir.model.primitive.BoundCodeDt()	This constructor is provided only for serialization support. Do not call it directly!
ca.uhn.fhir.rest.server.exceptions.ResourceGoneException(Class<? extends IBaseResource>, BaseIdentifierDt)	This constructor has a dependency on a specific model version and will be removed. Deprecated in HAPI 1.6 - 2016-07-02
ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException(Class<? extends IResource>, BaseIdentifierDt)	This doesn't make sense, since an identifier is not a resource ID and shouldn't generate a 404 if it isn't found - Should be removed
ca.uhn.fhir.rest.server.exceptions.UnprocessableEntityException(IBaseOperationOutcome)	Use constructor with FhirContext argument

Deprecated Enum Constants

Enum Constant	Description
ca.uhn.fhir.context.api.AddProfileTagEnum.ALWAYS	This mode causes even FHIR's default profiles to be exported in the resource metadata section. This is not generally expected behaviour from other systems and it offers no real benefit, so it will be removed at some point. This option was deprecated in HAPI 1.5
ca.uhn.fhir.interceptor.api.Pointcut.STORAGE_BINARY_ASSIGN_BLOB_ID_PREFIX
ca.uhn.fhir.util.VersionEnum.V4_3_0

Deprecated Annotation Interface Elements

Annotation Interface Element	Description
ca.uhn.fhir.model.api.annotation.Block.name()	Do not use, will be removed
ca.uhn.fhir.model.api.annotation.Description.formalDefinition()	Use Description.value() instead. Deprecated in 5.4.0.