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

Update Conversion package docs (#1257) 

* Reorganize README.md, expand details

* Update conversion README.md document
This commit is contained in:
dotasek 2023-05-09 17:33:55 -04:00 committed by GitHub
parent fd630de50f
commit 9b91f1389f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 211 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

251
org.hl7.fhir.convertors/README.md
View File

@ -11,12 +11,33 @@ Implementers should regard this code as a 'scaffold' for actual reliable convers
_Ideally, this should be via unit tests in your code, or better yet [unit tests contributed to FHIR](#test-cases)._ _Ideally, this should be via unit tests in your code, or better yet [unit tests contributed to FHIR](#test-cases)._
### A note regarding syntax ## Using the Conversion package
### Basic Usage
The majority of conversion tasks should be performed by the Version Convertor factories:
* VersionConvertorFactory_10_30
* VersionConvertorFactory_10_40
* VersionConvertorFactory_10_50
* VersionConvertorFactory_14_30
* VersionConvertorFactory_14_40
* VersionConvertorFactory_14_50
* VersionConvertorFactory_30_40
* VersionConvertorFactory_30_50
* VersionConvertorFactory_40_50
* VersionConvertorFactory_43_50
These factories all use the following convention:
`VersionConvertorFactory_` + `(VERSION A)` + `_` + `(VERSION B)`
Each factory allows conversion between two versions of FHIR, specified by `VERSION A` and `VERSION B`. The syntax of each version is described briefly in the following section.
### Conversion Version Syntax
----- -----
Within the code, we use a set naming convention to organize the classes used for conversion between the various versions Within the code, we use a set naming convention to organize the classes used for conversion between the various versions of FHIR.
of FHIR.
| Version | Code | | Version | Code |
| :--- | :---: | | :--- | :---: |
@ -26,27 +47,12 @@ of FHIR.
| r4 | 40 | | r4 | 40 |
| r5 | 50 | | r5 | 50 |
The files themselves follow the naming convention: So, for example, VersionConvertorFactory_10_40 allows the conversion of resources and types to and from dtu2 (10) and r4 (50).
`(NAME)` + `(VERSION CODE)` + `_` + `(VERSION CODE)` ### Conversion Factory Usage
Where `NAME` is the proper name of the resource or datatype being converted, and the two `VERSION CODE` indicate the two
versions of FHIR that the code will convert the given resource or datatype between.
So, in the repository, you may come across a file name `Account30_40`. This would indicate that the code in this
file is related to the conversion of the Account resource between versions [dstu3](http://hl7.org/fhir/STU3/account.html)
and [r4](http://hl7.org/fhir/R4/account.html)
**N.B.** This information is only for code navigation purposes. It is important that when converting between versions
you use the provided conversion factory classes as your entry point.
## Using the conversion library
----- -----
The majority of use cases for conversion will involve using the provided VersionConvertorFactory_V1_V2 classes to convert Each VersionConvertorFactory provides two statically accessed base methods for converting resources:
to and from the various versions of FHIR.
They provide two statically accessed base methods for converting resources:
`public static (V1 Resource) convertResource((V2 Resource) src)` `public static (V1 Resource) convertResource((V2 Resource) src)`
@ -65,41 +71,131 @@ case of r5), so the result will need to be cast to the correct class.
Example: Example:
```java ```java
// Converting a r5 StructureDefinition to dstu3. // Converting a r4 AllergyIntolerance to r5.
org.hl7.fhir.r5.model.StructureDefinition r5_structure_def = new StructureDefinition(); org.hl7.fhir.r5.model.Resource r5Resource = VersionConvertorFactory_40_50.convertResource(r4AllergyIntolerance);
org.hl7.fhir.dstu3.model.StructureDefinition dstu3_converted_structure_def org.hl7.fhir.r5.model.AllergyIntolerance r5AllergyIntolerance = (org.hl7.fhir.r5.model.AllergyIntolerance) r5Resource;
= (StructureDefinition) VersionConvertorFactory_30_50.convertResource(r5_structure_def);
``` ```
### It gets complicated... ## Developers Notes
----- If you are developing or debugging conversion routines, you will likely need to access the individual Resource, DataType, and Primitive conversion classes.
As the specification has evolved over time, the versions of FHIR have built on top of one another, adding new fields These are located in the following packages:
within existing resources, changing the name of existing resources, or adding entirely new resources altogether. As a
result of this conversions are inherently lossy operations.
A quick example of this would be [ValueSet Expression](https://www.hl7.org/fhir/extension-valueset-expression.html) * org.hl7.fhir.convertors.conv10_30
extension type. This exists in the r4 version of the specification, but no such type exists in dstu2. * org.hl7.fhir.convertors.conv10_40
* org.hl7.fhir.convertors.conv10_50
* org.hl7.fhir.convertors.conv14_30
* org.hl7.fhir.convertors.conv14_40
* org.hl7.fhir.convertors.conv14_50
* org.hl7.fhir.convertors.conv30_40
* org.hl7.fhir.convertors.conv30_50
* org.hl7.fhir.convertors.conv40_50
* org.hl7.fhir.convertors.conv43_50
If we were to convert a R4 resource, such as a questionnaire, that contained an extension of this type from r4 -> dstu2, These classes follow the convention:
without any special intervention, the extension would be ignored, and the data would be lost in the conversion process.
`(NAME)` + `(VERSION A)` + `_` + `(VERSION B)`
Where `NAME` is the proper name of the resource or datatype being converted, and `VERSION A` and `VERSION B` indicate the two versions of FHIR that the code will convert the given resource or datatype between (See [Conversion Version Syntax](#-conversion-version-syntax) for version details).
So, in the repository, you may come across a file name `AllergyIntolerance40_50`. This would indicate that the code in this file is related to the conversion of the AllergyIntolerance resource between versions [r4](http://hl7.org/fhir/r4/allergyintolerance.html) and [r5](https://hl7.org/fhir/r5/allergyintolerance.html)
Note that these classes are not intended to be used directly. When actually converting resources, the provided conversion factory classes are intended to be used as the entry point. For example, to convert a dstu3 AllergyIntolerance resource, the above conversion would not use `AllergyIntolerance40_50` directly, but would instead call: `VersionConvertorFactory_40_50.convertResource(dstu3AllergyIntolerance)`. `VersionConvertorFactory_40_50` would call `AllergyIntolerance40_50` internally to convert `r4AllergyIntolerance`.
### Common Conversion Scenarios
Conversion classes are implemented using some simple, repeatable patterns. `AllegeryIntolerance40_50` will be used as an example of this. Each conversion class for a resource will have two entry points, allowing for conversions to be done to and from the two versions in the convertor.
```java
public static org.hl7.fhir.r5.model.AllergyIntolerance convertAllergyIntolerance(org.hl7.fhir.r4.model.AllergyIntolerance src);
public static org.hl7.fhir.r4.model.AllergyIntolerance convertAllergyIntolerance(org.hl7.fhir.r5.model.AllergyIntolerance src)
```
Initially, a target resource is created in the appropriate method. Upon the completion of the conversion, this target resource is returned. In our case, the target resource is
version 50, or r5.
```java
public static org.hl7.fhir.r5.model.AllergyIntolerance convertAllergyIntolerance(org.hl7.fhir.r4.model.AllergyIntolerance src){
//...
org.hl7.fhir.r5.model.AllergyIntolerance tgt = new org.hl7.fhir.r5.model.AllergyIntolerance();
//...
}
```
After the target resource is created, the elements of the source resource need to be converted to the target version, and added to the target resource. Many elements can be copied automatically using the static methods provided in the `ConversionContext` and `VersionConvertor` classes. These classes follow the convention:
`ConversionContext` + `(VERSION A)` + `_` + `(VERSION B)`
and
`VersionConvertor` + `(VERSION A)` + `_` + `(VERSION B)`
An example usage is in the copying of [DomainResource](https://build.fhir.org/domainresource.html) elements (`text`, `contained`, `extension`, and `modifierExtension`). In FHIR, all listed Resources except Bundle, Parameters and Binary extend DomainResource. Copying DomainResource elements is done using the following code:
```java
ConversionContext40_50.INSTANCE.getVersionConvertor_40_50().copyDomainResource(src, tgt);
```
For elements more specific to the resource being converted, we find the appropriate type convertor class, and set the target element directly:
```java
if (src.hasClinicalStatus())
tgt.setClinicalStatus(CodeableConcept40_50.convertCodeableConcept(src.getClinicalStatus()));
```
### Converting Extensions
A special case exists for the conversion of extensions. As mentioned above, the `copyDomainResource(src, tgt)` method is used to copy the extensions from one resource to another. This applies a default conversion process to all extensions (see [Using conversion advisors](#using-conversion-advisors) for details).
However, in some conversion cases, an extension may exist that can be converted into a resource element. An example of this is the `acceptUnknown` element in the dstu3 [CapabilityStatement](http://hl7.org/fhir/STU3/capabilitystatement-definitions.html#CapabilityStatement.acceptUnknown) resource. This element does not exist in versions r4 and up, so is converted into an extension with the url `http://hl7.org/fhir/3.0/StructureDefinition/extension-CapabilityStatement.acceptUnknown`. Should this extension exist in a resource being converted to a CapabilityStatement in dstu3, the convertor needs to convert this extension to an element, and to indicate to the copyDomainResource method that the extension should not be copied.
First, since the copyDomainResource occurs early in the conversion process, we need to indicate all the ignored URLs using the vararg parameter `extensionUrlsToIgnore`:
```java
// Call copyDomainResource(DomainResource src, DomainResource tgt, String... extensionUrlsToIgnore)
ConversionContext30_50.INSTANCE.getVersionConvertor_30_50().copyDomainResource(src, tgt, ACCEPT_UNKNOWN_EXTENSION_URL);
```
Then, we need to handle any instances matching that extension URL. In this case, the `acceptUnknown` element can be set.
```java
if (src.hasExtension(ACCEPT_UNKNOWN_EXTENSION_URL))
tgt.setAcceptUnknown(org.hl7.fhir.dstu3.model.CapabilityStatement.UnknownContentCode.fromCode(src.getExtensionByUrl(ACCEPT_UNKNOWN_EXTENSION_URL).getValue().primitiveValue()));
```
A similar pattern is used to manage extensions in resource elements:
```
copyElement(DomainResource src, DomainResource tgt,, String... extensionUrlsToIgnore)
```
After all necessary elements are converted, the conversion is complete, and the target resource is returned.
## Extending Conversion Functionality
As the FHIR specification has evolved over time, the versions of FHIR have built on top of one another, adding new fields within existing resources, changing the name of existing resources, or adding entirely new resources altogether. As a result of this conversions are inherently lossy operations.
A quick example of this would be [ValueSet Expression](https://www.hl7.org/fhir/extension-valueset-expression.html) extension type. This exists in the r4 version of the specification, but no such type exists in dstu2.
If we were to convert a R4 resource, such as a questionnaire, that contained an extension of this type from r4 -> dstu2, without any special intervention, the extension would be ignored, and the data would be lost in the conversion process.
This is where advisors come in. This is where advisors come in.
### Using conversion advisors ### Using conversion advisors
----- -----
When you call the base conversion factory methods `convertType(...)` or `convertResource(...)`, the library does a When you call the base conversion factory methods `convertType(...)` or `convertResource(...)`, the library does a predefined conversion, using the standard conversion (which could be a lossy one, or one that makes assumptions).
predefined conversion, using the standard conversion (which could be a lossy one, or one that makes assumptions).
These defaults/assumptions are defined in the convertor advisor classes. Each pair of versions has a BaseAdvisor, which These defaults/assumptions are defined in the convertor advisor classes. Each pair of versions has a BaseAdvisor, which is used by default when you call the factory methods. For example, here is the advisor class which handles conversions between dstu2 and r5:
is used by default when you call the factory methods. For example, here is the advisor class which handles conversions
between dstu2 and r5:
```java ```java
public class BaseAdvisor_10_50 extends BaseAdvisor50<org.hl7.fhir.dstu2.model.Extension> { public class BaseAdvisor_10_50 extends BaseAdvisor50<org.hl7.fhir.dstu2.model.Extension> {
final List<String> conformanceIgnoredUrls = Collections.singletonList("http://hl7.org/fhir/3.0/StructureDefinition/extension-CapabilityStatement.acceptUnknown");
private final List<Class<?>> ignoredExtensionTypes = new ArrayList<>(Collections.singletonList(Expression.class)); private final List<Class<?>> ignoredExtensionTypes = new ArrayList<>(Collections.singletonList(Expression.class));
public BaseAdvisor_10_50() { public BaseAdvisor_10_50() {
@ -111,8 +207,8 @@ public class BaseAdvisor_10_50 extends BaseAdvisor50<org.hl7.fhir.dstu2.model.Ex
public boolean ignoreExtension(@Nonnull String path, public boolean ignoreExtension(@Nonnull String path,
@Nonnull String url) { @Nonnull String url) {
List<String> paths = Arrays.asList(path.split(",")); // no globally ignored extensions here.
return (paths.get(paths.size() - 1).equals("Conformance")) && (conformanceIgnoredUrls.contains(url)); return false;
} }
public boolean ignoreType(@Nonnull String path, public boolean ignoreType(@Nonnull String path,
@ -122,12 +218,9 @@ public class BaseAdvisor_10_50 extends BaseAdvisor50<org.hl7.fhir.dstu2.model.Ex
} }
``` ```
You can see in the above, that when converting extensions, we check if the given conversion is for a `Conformance` You can see in the `ignoreType` implementation above that we check if we are converting a DataType of the `Expression` class. The `Expression` DataType did not exist in dstu2, and is ignored when doing this particular conversion.
resource, and if we are converting an `Extension` within that `Conformance` with a set url, we ignore it.
As mentioned above, we provide a stock set of implied conversion rules that are used by default. However, there may be As mentioned above, we provide a stock set of implied conversion rules that are used by default. However, there may be cases where you need to add specific behavior to your conversion. Within the `BaseAdvisor` class, there exist a number of overrideable methods that can be used to modify the outcome of any given conversion:
cases where you need to add specific behavior to your conversion. Within the `BaseAdvisor` class, there exist a number
of overrideable methods that can be used to modify the outcome of any given conversion:
```java ```java
public void handleCodeSystem(@Nonnull CodeSystem tgtcs, @Nonnull ValueSet source) public void handleCodeSystem(@Nonnull CodeSystem tgtcs, @Nonnull ValueSet source)
@ -155,47 +248,42 @@ of overrideable methods that can be used to modify the outcome of any given conv
public void handleExtension(@Nonnull String path, @Nonnull T src, @Nonnull Extension tgt) throws FHIRException public void handleExtension(@Nonnull String path, @Nonnull T src, @Nonnull Extension tgt) throws FHIRException
``` ```
Through overriding these methods and implementing your own custom advisor, you can customize the output of any given Through overriding these methods and implementing your own custom advisor, you can customize the output of any given conversion operation to suit your specific use-case.
conversion operation to suit your specific usecase.
For example, above we briefly mentioned [ValueSet Expression](https://www.hl7.org/fhir/extension-valueset-expression.html) For example, the [Expression](https://www.hl7.org/fhir/extension-valueset-expression.html)
extension type. This exists in the r4 version of the specification, but no such type exists in dstu2. extension type exists in the r5 version of the specification, but no such type exists in dstu2.
Our stock advisor just ignores this extension when converting from r5 to dstu2. However, if we wanted, we could create Our stock advisor just ignores this extension when converting from r5 to dstu2. However, if we wanted, we could create our own conversion advisor, as follows:
our own conversion advisor, as follows:
```java ```java
public class ExpressionAdvisor50 extends BaseAdvisor_10_50 { public class ExpressionAdvisor50 extends BaseAdvisor_10_50 {
public boolean useAdvisorForExtension(@Nonnull String path, @Nonnull org.hl7.fhir.r5.model.Extension ext) { public boolean useAdvisorForExtension(@Nonnull String path, @Nonnull org.hl7.fhir.r5.model.Extension ext) {
return ext.hasValue() && ext.getValue() instanceof org.hl7.fhir.r5.model.Expression; return ext.hasValue() && ext.getValue() instanceof org.hl7.fhir.r5.model.Expression;
} }
public void handleExtension(@Nonnull String path, public void handleExtension(@Nonnull String path,
@Nonnull org.hl7.fhir.r5.model.Extension src, @Nonnull org.hl7.fhir.r5.model.Extension src,
@Nonnull org.hl7.fhir.dstu2.model.Extension tgt) { @Nonnull org.hl7.fhir.dstu2.model.Extension tgt) {
if (src.getValue() instanceof org.hl7.fhir.r5.model.Expression) { if (src.getValue() instanceof org.hl7.fhir.r5.model.Expression) {
StringType type = new StringType(); StringType type = new StringType();
if (src.getValue() == null) { if (src.getValue() == null) {
throw new NullPointerException("null cannot be cast to non-null type org.hl7.fhir.r5.model.Expression"); throw new NullPointerException("null cannot be cast to non-null type org.hl7.fhir.r5.model.Expression");
} else { } else {
type.setValueAsString(((Expression) src.getValue()).getExpression()); type.setValueAsString(((Expression) src.getValue()).getExpression());
tgt.setValue(type); tgt.setValue(type);
if (src.hasUrlElement()) { if (src.hasUrlElement()) {
tgt.setUrlElement(Uri10_50.convertUri(src.getUrlElement())); tgt.setUrlElement(Uri10_50.convertUri(src.getUrlElement()));
} }
} }
} else { } else {
throw new FHIRException("Unknown extension type passed in to custom convertor method."); throw new FHIRException("Unknown extension type passed in to custom convertor method.");
} }
} }
} }
``` ```
Here, we first check to see if the extension is of type `org.hl7.fhir.r5.model.Expression` and has a value set in the Here, we first check to see if the extension is of type `org.hl7.fhir.r5.model.Expression` and has a value set in the `useAdvisorForExtension` method, then in the `handleExtension` method, we manually create a `StringType` extension, and copy the value from the r5 `Expression` into it. This results in no data being lost, and a the new custom conversion behavior for our particular use-case.
`useAdvisorForExtension` method, then in the `handleExtension` method, we manually create a `StringType` extension, and
copy the value from the r5 `Expression` into it. This results in no data being lost, and a the new custom conversion
behavior for our particular usecase.
Once you've created your new advisor, they can be provided as an argument when calling the conversion factory classes. Once you've created your new advisor, they can be provided as an argument when calling the conversion factory classes.
@ -203,6 +291,13 @@ Once you've created your new advisor, they can be provided as an argument when c
`public static (V2 Resource) convertResource((V1 Resource) src, <T extends BaseAdvisor> advisor)` `public static (V2 Resource) convertResource((V1 Resource) src, <T extends BaseAdvisor> advisor)`
For example, the example `ExpressionAdvisor50` class can be used in converting a Questionnaire resource like so:
```java
VersionConvertorFactory_10_50.convertResource(r5_input, new ExpressionAdvisor50());
```
## Development notes ## Development notes
----- -----

2
org.hl7.fhir.convertors/src/test/java/org/hl7/fhir/convertors/advisors/Expression50Test.java
View File

@ -35,7 +35,7 @@ public class Expression50Test {
@Test @Test
@DisplayName("Ensure base advisor ignores Expression types and doesn't explode.") @DisplayName("Ensure base advisor ignores Expression types and doesn't explode.")
public void testBaseAdvisorExpressionIgore() throws IOException { public void testBaseAdvisorExpressionIgnore() throws IOException {
Expression exp = new Expression(); Expression exp = new Expression();
exp.setExpression("x + y = z"); exp.setExpression("x + y = z");
Extension ext = new Extension(); Extension ext = new Extension();

2
org.hl7.fhir.convertors/src/test/java/org/hl7/fhir/convertors/conv10_30/AllergyIntolerance10_30Test.java
View File

@ -28,7 +28,7 @@ public class AllergyIntolerance10_30Test {
InputStream stu_exepected_input = this.getClass().getResourceAsStream(stu_path); InputStream stu_exepected_input = this.getClass().getResourceAsStream(stu_path);
org.hl7.fhir.dstu2.model.AllergyIntolerance dstu2 = (org.hl7.fhir.dstu2.model.AllergyIntolerance) new org.hl7.fhir.dstu2.formats.JsonParser().parse(dstu2_input); org.hl7.fhir.dstu2.model.AllergyIntolerance dstu2 = (org.hl7.fhir.dstu2.model.AllergyIntolerance) new org.hl7.fhir.dstu2.formats.JsonParser().parse(dstu2_input);
org.hl7.fhir.dstu3.model.Resource stu_actual = VersionConvertorFactory_10_30.convertResource(dstu2, new BaseAdvisor_10_30()); org.hl7.fhir.dstu3.model.Resource stu_actual = VersionConvertorFactory_10_30.convertResource(dstu2);
org.hl7.fhir.dstu3.formats.JsonParser stu_parser = new org.hl7.fhir.dstu3.formats.JsonParser(); org.hl7.fhir.dstu3.formats.JsonParser stu_parser = new org.hl7.fhir.dstu3.formats.JsonParser();
org.hl7.fhir.dstu3.model.Resource stu_expected = stu_parser.parse(stu_exepected_input); org.hl7.fhir.dstu3.model.Resource stu_expected = stu_parser.parse(stu_exepected_input);

36
org.hl7.fhir.convertors/src/test/java/org/hl7/fhir/convertors/conv40_50/AllergyIntolerance40_50Test.java Normal file
View File

@ -0,0 +1,36 @@
package org.hl7.fhir.convertors.conv40_50;
import org.hl7.fhir.convertors.factory.VersionConvertorFactory_30_40;
import org.hl7.fhir.convertors.factory.VersionConvertorFactory_40_50;
import org.hl7.fhir.r4.model.AllergyIntolerance;
import org.hl7.fhir.r4.model.CodeableConcept;
import org.hl7.fhir.r4.model.Coding;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import java.util.List;
public class AllergyIntolerance40_50Test {
@Test
@DisplayName("Test r4 -> r5 conversion for AllergyIntolerance with resolved clinical status")
public void test1() {
// Given resource with dstu3 resource with resolved clinicalStatus
org.hl7.fhir.r4.model.AllergyIntolerance r4AllergyIntolerance = new org.hl7.fhir.r4.model.AllergyIntolerance();
r4AllergyIntolerance.setClinicalStatus(new CodeableConcept(new Coding().setCode("resolved")));
// When convertor is called
org.hl7.fhir.r5.model.Resource r5Resource = VersionConvertorFactory_40_50.convertResource(r4AllergyIntolerance);
// Then r5 resource should have resolved clinicalStatus
Assertions.assertTrue(r5Resource instanceof org.hl7.fhir.r5.model.AllergyIntolerance);
org.hl7.fhir.r5.model.AllergyIntolerance r5AllergyIntolerance = (org.hl7.fhir.r5.model.AllergyIntolerance) r5Resource;
List<org.hl7.fhir.r5.model.Coding> r5AllergyCodeableConcept = r5AllergyIntolerance.getClinicalStatus().getCoding();
Assertions.assertEquals(1, r5AllergyCodeableConcept.size());
String r5AllergyCode = r5AllergyCodeableConcept.get(0).getCode();
Assertions.assertEquals("resolved", r5AllergyCode);
}
}