honeymoose
/
hapi-fhir
mirror of https://github.com/hapifhir/hapi-fhir.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Set default for Populate Identifier in Auto-Created Placeholder Reference Targets to true; update javadocs accordingly

This commit is contained in:
Diederik Muylwyk 2021-03-04 18:54:04 -05:00
parent 1d1d9a2f7c
commit e3ba4bd1b6
3 changed files with 81 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
hapi-fhir-base/src/main/java/ca/uhn/fhir/util/HapiExtensions.java
View File

@ -113,8 +113,9 @@ public class HapiExtensions {
/**
* URL for boolean extension added to all placeholder resources
*
* @deprecated Deprecated in 5.4.0 in favour of {@link HapiExtensions#EXT_RESOURCE_PLACEHOLDER}
*/
// FIXME: DM 2021-03-04 - This should probably be removed, and replaced with EXT_RESOURCE_PLACEHOLDER above.
public static final String EXT_RESOURCE_META_PLACEHOLDER = "http://hapifhir.io/fhir/StructureDefinition/resource-meta-placeholder";

78
hapi-fhir-jpaserver-api/src/main/java/ca/uhn/fhir/jpa/api/config/DaoConfig.java
View File

@ -186,9 +186,11 @@ public class DaoConfig {
private int myPreExpandValueSetsMaxCount = 1000;
/**
* Do not change default of {@code true}!
*
* @since 4.2.0
*/
private boolean myPopulateIdentifierInAutoCreatedPlaceholderReferenceTargets;
private boolean myPopulateIdentifierInAutoCreatedPlaceholderReferenceTargets = true;
/**
* @since 5.0.0
@ -1102,7 +1104,7 @@ public class DaoConfig {
/**
* When {@link #setAutoCreatePlaceholderReferenceTargets(boolean)} is enabled, if this
* setting is set to <code>true</code> (default is <code>false</code>) and the source
* setting is set to <code>true</code> (default is <code>true</code>) and the source
* reference has an identifier populated, the identifier will be copied to the target
* resource.
* <p>
@ -1144,6 +1146,41 @@ public class DaoConfig {
* }
* }
* </pre>
* <p>
* Note that the default for this setting was previously <code>false</code>, and was changed to <code>true</code>
* in 5.4.0 with consideration to the following:
* </p>
* <pre>
* CP = Auto-Create Placeholder Reference Targets
* PI = Populate Identifier in Auto-Created Placeholder Reference Targets
*
* CP | PI
* -------
* F | F <- PI=F is ignored
* F | T <- PI=T is ignored
* T | F <- resources may reference placeholder reference targets that are never updated : (
* T | T <- placeholder reference targets can be updated : )
* </pre>
* <p>
* Where CP=T and PI=F, the following could happen:
* </p>
* <ol>
* <li>
* Resource instance A is created with a reference to resource instance B. B is a placeholder reference target
* without an identifier.
* </li>
* <li>
* Resource instance C is conditionally created using a match URL. It is not matched to B although these
* resources represent the same entity.
* </li>
* <li>
* A continues to reference placeholder B, and does not reference populated C.
* </li>
* </ol>
* <p>
* There may be cases where configuring this setting to <code>false</code> would be appropriate; however, these are
* exceptional cases that should be opt-in.
* </p>
*
* @since 4.2.0
*/
@ -1153,7 +1190,7 @@ public class DaoConfig {
/**
* When {@link #setAutoCreatePlaceholderReferenceTargets(boolean)} is enabled, if this
* setting is set to <code>true</code> (default is <code>false</code>) and the source
* setting is set to <code>true</code> (default is <code>true</code>) and the source
* reference has an identifier populated, the identifier will be copied to the target
* resource.
* <p>
@ -1195,6 +1232,41 @@ public class DaoConfig {
* }
* }
* </pre>
* <p>
* Note that the default for this setting was previously <code>false</code>, and was changed to <code>true</code>
* in 5.4.0 with consideration to the following:
* </p>
* <pre>
* CP = Auto-Create Placeholder Reference Targets
* PI = Populate Identifier in Auto-Created Placeholder Reference Targets
*
* CP | PI
* -------
* F | F <- PI=F is ignored
* F | T <- PI=T is ignored
* T | F <- resources may reference placeholder reference targets that are never updated : (
* T | T <- placeholder reference targets can be updated : )
* </pre>
* <p>
* Where CP=T and PI=F, the following could happen:
* </p>
* <ol>
* <li>
* Resource instance A is created with a reference to resource instance B. B is a placeholder reference target
* without an identifier.
* </li>
* <li>
* Resource instance C is conditionally created using a match URL. It is not matched to B although these
* resources represent the same entity.
* </li>
* <li>
* A continues to reference placeholder B, and does not reference populated C.
* </li>
* </ol>
* <p>
* There may be cases where configuring this setting to <code>false</code> would be appropriate; however, these are
* exceptional cases that should be opt-in.
* </p>
*
* @since 4.2.0
*/

10
hapi-fhir-jpaserver-base/src/test/java/ca/uhn/fhir/jpa/dao/r4/FhirResourceDaoCreatePlaceholdersR4Test.java
View File

@ -268,9 +268,10 @@ public class FhirResourceDaoCreatePlaceholdersR4Test extends BaseJpaR4Test {
}
@Test
public void testCreatePlaceholderWithMatchUrl_IdentifierNotCopiedByDefault() {
public void testCreatePlaceholderWithMatchUrl_IdentifierNotCopied() {
myDaoConfig.setAutoCreatePlaceholderReferenceTargets(true);
myDaoConfig.setAllowInlineMatchUrlReferences(true);
myDaoConfig.setPopulateIdentifierInAutoCreatedPlaceholderReferenceTargets(false);
Observation obsToCreate = new Observation();
obsToCreate.setStatus(ObservationStatus.FINAL);
@ -288,7 +289,7 @@ public class FhirResourceDaoCreatePlaceholdersR4Test extends BaseJpaR4Test {
// FIXME: DM 2021-03-04 - This test fails; placeholder identifier isn't populated by default.
@Test
public void testCreatePlaceholderWithMatchUrl_PopulateIdentifierSetToDefault_WithUpdateToTarget() {
public void testCreatePlaceholderWithMatchUrl_IdentifierCopiedByDefault_WithUpdateToTarget() {
myDaoConfig.setAutoCreatePlaceholderReferenceTargets(true);
myDaoConfig.setAllowInlineMatchUrlReferences(true);
@ -338,10 +339,9 @@ public class FhirResourceDaoCreatePlaceholdersR4Test extends BaseJpaR4Test {
}
@Test
public void testCreatePlaceholderWithMatchUrl_IdentifierCopied_NotPreExisting() {
public void testCreatePlaceholderWithMatchUrl_IdentifierCopiedByDefault_NotPreExisting() {
myDaoConfig.setAutoCreatePlaceholderReferenceTargets(true);
myDaoConfig.setAllowInlineMatchUrlReferences(true);
myDaoConfig.setPopulateIdentifierInAutoCreatedPlaceholderReferenceTargets(true);
Observation obsToCreate = new Observation();
obsToCreate.setStatus(ObservationStatus.FINAL);
@ -363,7 +363,6 @@ public class FhirResourceDaoCreatePlaceholdersR4Test extends BaseJpaR4Test {
public void testCreatePlaceholderWithMatchUrl_IdentifierNotCopiedBecauseNoFieldMatches() {
myDaoConfig.setAutoCreatePlaceholderReferenceTargets(true);
myDaoConfig.setAllowInlineMatchUrlReferences(true);
myDaoConfig.setPopulateIdentifierInAutoCreatedPlaceholderReferenceTargets(true);
myDaoConfig.setBundleTypesAllowedForStorage(Sets.newHashSet(""));
AuditEvent eventToCreate = new AuditEvent();
@ -382,7 +381,6 @@ public class FhirResourceDaoCreatePlaceholdersR4Test extends BaseJpaR4Test {
public void testCreatePlaceholderWithMatchUrl_PreExisting() {
myDaoConfig.setAutoCreatePlaceholderReferenceTargets(true);
myDaoConfig.setAllowInlineMatchUrlReferences(true);
myDaoConfig.setPopulateIdentifierInAutoCreatedPlaceholderReferenceTargets(true);
Patient patient = new Patient();
patient.setId("ABC");