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 README.md 

Formatting improvements. Additional links.
This commit is contained in:
dotasek 2022-01-05 15:54:06 -05:00 committed by GitHub
parent 0edcf819ea
commit 189a7ebdfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,14 +1,15 @@
# Resource Conversion
## IMPORTANT
-----
_The conversion code in this module is maintained as part of the development of the standard, but always under
considerable time pressure. Only part of the code is rigorously tested [as detailed here](#reliable-conversion-code)
considerable time pressure. Only part of the code is rigorously tested [as detailed here](#reliable-conversion-code).
Implementers should regard this code as a 'scaffold' for actual reliable conversions._
**Always test any conversion routines before using them in production**
**ALWAYS TEST ANY CONVERSION ROUTINES BEFORE USING THEM IN PRODUCTION!**
_Ideally, this should be via unit tests in your code, or better yet [unit tests in this module](#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
@ -39,7 +40,7 @@ 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
## Using the conversion library
-----
The majority of use cases for conversion will involve using the provided VersionConvertorFactory_V1_V2 classes to convert
@ -203,6 +204,7 @@ 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)`
## Development notes
-----
### Reliable conversion code
@ -225,5 +227,6 @@ These can be relied on and are subject to extensive testing.
Some conversions have test cases for particular resources and particular version combinations. Where test cases exist,
they will continue to be maintained and expected to pass.
Contributing test cases is encouraged! To contribute, create a PRs to the core library, or even better, to the FHIR
test cases library.
Contributing test cases is highly encouraged! To contribute, create a PRs to the
[core library](https://github.com/hapifhir/org.hl7.fhir.core), or even better, to the
[FHIR test cases library](https://github.com/FHIR/fhir-test-cases).