new release v1.4.1-STU2.1

nightingaleproject · Apr 20, 2023 · 65a5e1f · 65a5e1f
1 parent 30158f8
commit 65a5e1f
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 ## Changelog
 
+### v1.4.1-STU2.1 - 2023-04-20
+
+* Numerous bug fixes found as part of testing certification with UT
+* Race Literal handling update as per VRDR IG
+
 ### v1.4.0-STU2 - 2023-02-10
 
 * Added support for VRDR Messaging IG

diff --git a/README.md b/README.md
@@ -1,5 +1,11 @@
 # VRDR_javalib
-Java library implementation of the FHIR VRDR and FHIR VRDR Messaging standards
+
+Java library implementation of the FHIR VRDR and FHIR VRDR Messaging standards.  This repository includes Java code for:
+
+- Producing and consuming the Vital Records Death Reporting (VRDR) Health Level 7 (HL7) Fast Healthcare Interoperability Resources (FHIR) standard. [Click here to view the FHIR Implementation Guide STU2.1](http://hl7.org/fhir/us/vrdr/).
+- Producing and consuming FHIR messages for the exchange of VRDR documents.
+- Example VRDR FHIR documents and messages in JSON and XML formats
+- Numerous test cases illustrating proper usage of the library
 
 # Standards
 
@@ -10,7 +16,7 @@ This java library implements the FHIR VRDR and VRDR Messaging standards ```http:
 
 # Info
 
-This project uses the hapi-fhir java libraries extensively to create it's representation.
+This project uses the hapi-fhir java libraries extensively to create its representation.
 
 It is recommended to have a strong understanding of the resource extension section of the hapi-fhir library before diving into the code. Info can be found here. https://hapifhir.io/hapi-fhir/docs/model/custom_structures.html
 
@@ -47,3 +53,16 @@ Optionally, use the command line tool to generate example records for Canary tes
 
 You can also output XML instead of JSON by passing the ```--xml``` option.
 
+# Publishing a Version
+
+To create a new release of the VRDR Java Library:
+
+1. Update the CHANGELOG.md file with information on what is changing in the release
+1. Create a pull request and merge the above changes to master
+1. Create a GitHub release
+    1. Go to the Releases page
+    1. Click on "Draft a new release"
+    1. Create a new release version on the tag and release (e.g., v1.4.0-STU2.1)
+    1. Copy the information from the CHANGELOG.md file from this version into the release description
+    1. Do not check the "pre-release" button, even for preview releases, since those don't show up on the main GitHub page
+