Skip to content

CHANGELOG.md

Latest commit

 

History

History
613 lines (450 loc) · 28.8 KB

CHANGELOG.md

File metadata and controls

613 lines (450 loc) · 28.8 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog,

[Unreleased]

[3.3.3] - 2026-09-10

Fixed

  • Updated skeleton processing to recognise RCMR_IN030000UK07 as a valid full-message skeleton type in addition to RCMR_IN030000UK06, ensuring the service correctly replaces the inbound payload when a UK07 skeleton is received.

  • Add Spring retry to MHS queue consumer to facilitate a more reasonable retry delay.

[3.3.2] - 2026-08-19

Fixed

  • Fixed spelling error in measurement unit "milliliter".
  • Add thread-safe synchronisation when merging and uncompressing a large EHR Extract bundle to avoid a race condition occurring where multiple threads may attempt to merge and uncompress the same EHR Extract bundle at the same time. This could result in a corrupted EHR Extract bundle.

[3.3.1] - 2026-06-01

Added

  • Added fallback to use the EhrComposition author when Condition.asserter when the EhrCompoosition does not have a participant2 set.

Fixed

  • Fixed handling of multiple <given> name fields in practitioner XML to JSON mapping to now correctly map multiple <given> names.

[3.3.0] - 2026-04-08

Updated

  • Updated error handling when when processing skeleton payloads to throw a meaningful IllegalArgumentException when a payload node cannot be matched to a skeleton document ID, replacing an uninformative NullPointerException.
  • Updated Skeleton processing service now removes any leading _ before matching the skeleton document ID to the payload node.

[3.2.0] - 2026-03-18

Added

  • Add new accepted values for Medication Statement Prescribing Agency extension to handle differing types of prescribing agency (e.g. NHS prescription, OTC sale).
  • Add feature to handle differing EMIS Prescription Types.
  • Add startup validation for required environment variables.

Updated

  • Updated the length of varchar columns in patient_attachment_log table to 1024 characters.

Fixed

  • Fixed the EHRExtract interaction identifier used by timeout handling from RCMR_IN030000UK06 to RCMR_IN030000UK07.

[3.1.3] - 2025-09-19

Fixed

  • Blood pressure observations are retrieved only once to prevent duplicate entries.

Changed

  • Changed the default output to 'Defaulted to Minor' when the adaptor receives GP2GP xml and finds a problem that is either coded as ‘unspecified significance’ or no severity qualifier is present.

[3.1.2] - 2025-07-29

Added

  • If a ehrComposition (which includes a NarrativeStatement with a reference to a document ) record includes a confidentialityCode then the meta.security field of the corresponding translated FHIR DocumentReference resource will now be appropriately populated.

[3.1.1] - 2025-07-10

Fixed

  • Fixed a bug where redactions were being removed from some Observations after being added.

[3.1.0] - 2025-06-19

Added

  • Added migration timeout override option as environment variable MIGRATION_TIMEOUT_OVERRIDE. Setting this value to true will ensure that the migration will time out after a period of 48 hours has passed.

Changed

  • [Breaking Change - GP Connect 1.6.2] When an agentPerson is provided with either an empty or missing name name element, this would previously result in a resource[Practitioner] with name[0].family set to Unknown. This will no longer be set, but instead resource[Practitioner].name[0].text will now be populated with Unknown.
  • [Breaking Change - GP Connect 1.6.2] When an agentPerson is provided with either an empty or missing agentPerson / name / family then this will result in a resource[practitioner].name[0] without family, prefix or given populated. The field resource[practitioner].name[0].text will instead now be populated with these values.

[3.0.11] - 2025-05-15

Fixed

  • Adjusted MedicationRequestPlan date to use ehrSupplyPrescribe for acute re-issues, maintaining ehrSupplyAuthorise for originals.

[3.0.10] - 2025-02-28

Fixed

  • Resolved an issue where the receiving adapter did not add a NOPAT entry into Condition when an observationStatement was referenced from linkSet.

Added

  • the relatedProblemHeader extension is populated in the GP Connect Topic List when mapping an ehrComposition with a flat structure

[3.0.9] - 2025-01-22

Fixed

  • In the event of patient migration request which has failed, the adaptor would previously reject an XML Electronic Health Record which had been resent to it. Now the adaptor will instead accept the resent EHR and perform the translation to FHIR.
  • When sending a negative acknowledgement to the sending system in the event of a failure, include the textual description of the reason, e.g. "EHR Extract message not well-formed or not able to be processed". This behaviour while not required by the spec, has been implemented by other GP2GP systems, and is expected to be provided by one implementation.

[3.0.8] - 2024-11-22

Fixed

  • When a LinkSet which is a linkage between a ReferralRequest and one or more DocumentReferences is mapped then a Condition will no longer be mapped for this Linkset. Instead, the statementRefs will be added to the supportingInfo when mapping the ReferralRequest as DocumentReferences

[3.0.7] - 2024-11-19

Fixed

  • When provided an agentPerson without a name element, the adaptor will no longer throw an exception, but will instead map the Practitioner with a familyName of "unknown".

[3.0.6] - 2024-11-11

Fixed

  • Remove 20 MB data processing limit to enable the Adaptor to handle larger pieces of data.

[3.0.5] - 2024-11-05

Added

  • Documented how the Adaptor behaves when dependent services are unavailable.
  • Expanded the functionality added in version 2.1.0 to deduplicate SystmOne Problems. Handle the case where a duplicate, empty ObservationStatement is provided by SystmOne and ignore it from the generated FHIR output.

[3.0.4] - 2024-10-28

Fixed

  • In the event that an inbound MHS message cannot be processed and needs to be sent to the dead letter queue, the adaptor will now emit a log message at INFO level as opposed to DEBUG level.
  • Fixed a bug when mapping a post-dated acute prescription with multiple issues, whereby the adaptor was generating a MedicationRequest [Plan] which was being referenced by multiple MedicationRequest [Order]. Now each acute prescription issue gets its own MedicationRequest [Plan], with the priorPrescription field linking the plans together.

[3.0.3] - 2024-08-23

Note

Upgrade information This release includes an update to the SNOMED database Users will need to perform an update of their SNOMED database. This will need to be performed first, followed by deploying the updated version of the translator image.

Added

  • If a medicationStatement or medicationRequest record includes a confidentialityCode, the meta.security field of the corresponding FHIR resource will now be appropriately populated.
  • If a referralRequest record includes a confidentialityCode, the meta.security field of the corresponding FHIR resource will now be appropriately populated.
  • If a procedureRequest record includes a confidentialityCode, the meta.security field of the corresponding FHIR resource will now be appropriately populated.
  • If a linkset record includes a confidentialityCode, the meta.security field of the corresponding FHIR resource will now be appropriately populated.
  • If a documentReference record includes a confidentialityCode, the meta.security field of the corresponding FHIR resource will now be appropriately populated.
  • If an immunization record includes a confidentialityCode, the meta.security field of the corresponding FHIR resource will now be appropriately populated.
  • If a bloodPressure record includes a confidentialityCode, the meta.security field of the corresponding FHIR resource will now be appropriately populated.
  • If a Observation, Specimen, DiagnosticReport record includes a confidentialityCode, the meta.security field of the corresponding FHIR resource will now be appropriately populated.

Fixed

  • Resolved issue where the SNOMED import script would reject a password containing a '%' character.
  • Fixed some Test Results being given a duplicated Observation.category entries for Laboratory.
  • Fixed issue where the GPC Facade was not returning an error when an invalid ConversationId header was provided. The Facade will now return a 400 instead of a 500 HTTP response.
  • Filing Comments were creating with incorrect effectiveDateTime, this is now set from the ehrComposition /author / time instead.
  • Filing Comments were creating with an incorrect performer, this now references the ehrComposition / author / agentRef instead.
  • Addressed a bug where immunizations were incorrectly mapped to observations when the Snomed CT code being sent was a Description ID. The adaptor previously only checked against known vaccination Concept IDs.

[3.0.2] - 2024-07-18

Added

  • If a ehrComposition record includes a confidentialityCode, the meta.security field of the corresponding Encounter FHIR resource will now be appropriately populated.
  • Add support for an Organization being referenced within the ReferralRequest.recipient field.

[3.0.1] - 2024-07-12

Added

  • The AllergyIntoleranceMapper has been enhanced to support the redaction fix. If an Allergy Intolerance record includes a confidentialityCode, the meta.security field of the corresponding FHIR resource will now be appropriately populated.

  • When the SNOMED DB ingest script has not completed successfully, The GP2GP Translator Service will now exit and throw a RuntimeException with the following message:

    FATAL: Expected Immunization codes not found in snomedct.immunization_codes view.
SNOMED CT Database not set up correctly.
Please update / reload the SNOMED DB.

Fixed

  • DiagnosticReport.results now preserve original ordering provided in the HL7.

[3.0.0] - 2024-07-02

Removed

  • The adaptor no longer checks incoming attachment content types aginst the SUPPORTED_FILE_TYPES list. This functionality can be implemented outside the adaptor if still desired.

[2.1.2] - 2024-06-28

Changed

  • The /$gpc.ack endpoint is now case insensitive and supports uppercase and lowercase values for the conversationId header values.

Added

  • Retry mechanism has been added for when the MHS outbound returns a 500 server response when acknowledging COPC messages.

Fixed

  • Mapping of issued for Test Group Headers, Test Results, Filing Comment and has been updated to use time value from the GP2GP ObservationStatement / availabilityTime field and use EhrComposition / author / time if not available.

[2.1.1] - 2024-06-19

Changed

  • Cron time schedule has been changed from 6h to 2h so that the timeouts can be identified earlier

Fixed

  • When mapping a MedicationRequest (PLAN), if the text in the original text is duplicated by a pertinent information text, then the original text is disregarded to avoid the unnecessary duplication.

[2.1.0] - 2024-04-17

Added

  • SystmOne send a problem over GP2GP as two ObservationStatements, where one is truncated and one isn't. This truncation can be identified where an ObservationStatement is part of a problem, and the note ends in '...'. The adaptor will now identify this duplication, and merge the two into one ObservationStatement.

    Example Original XML: 
    <ehrComposition xmlns="urn:hl7-org:v3" classCode="COMPOSITION" moodCode="EVN">
  <id root="e9105749-5aef-400d-8ad4-649ff03ac879"/>
  <code code="25671000000102" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="Surgery Consultation Note"/>
  <statusCode code="COMPLETE"/>
  ...
  <component typeCode="COMP">
      <ObservationStatement classCode="OBS" moodCode="EVN">
          <id root="ba4edfcd-142e-4090-8a81-9ca2790849a8"/>
          <code code="14J.." codeSystem="2.16.840.1.113883.2.1.3.2.4.14" displayName="H/O: injury">
              <translation code="161586000" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="H/O: injury"/>
              <translation code="14J..00" codeSystem="2.16.840.1.113883.2.1.6.2" displayName="H/O: injury"/>
          </code>
          <statusCode code="COMPLETE"/>
          <effectiveTime>
              <low value="20001004"/>
              <high value="19000101000000"/>
          </effectiveTime>
          <availabilityTime value="20001004"/>
          <pertinentInformation typeCode="PERT">
              <sequenceNumber value="+1"/>
              <pertinentAnnotation classCode="OBS" moodCode="EVN">
                  <text>Problem severity: Minor H/O: injury to little finger left hand poss gla...</text>
              </pertinentAnnotation>
          </pertinentInformation>
      </ObservationStatement>
  </component>
  <component typeCode="COMP">
      <LinkSet classCode="OBS" moodCode="EVN">
          <id root="7f384915-a2f9-44df-b407-e9c339707297"/>
          <code code="394775005" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="Inactive Problem"/>
          <statusCode code="COMPLETE"/>
          <effectiveTime>
              <low value="20001004"/>
              <high value="19000101000000"/>
          </effectiveTime>
          <availabilityTime value="20001004"/>
          <conditionNamed inversionInd="true" typeCode="NAME">
              <namedStatementRef classCode="OBS" moodCode="EVN">
                  <id root="ba4edfcd-142e-4090-8a81-9ca2790849a8"/>
              </namedStatementRef>
          </conditionNamed>
      </LinkSet>
  </component>
  <component typeCode="COMP">
      <ObservationStatement classCode="OBS" moodCode="EVN">
          <id root="f04d2995-c6f8-4cf0-8e07-5362a950e2a5"/>
          <code code="14J.." codeSystem="2.16.840.1.113883.2.1.3.2.4.14" displayName="H/O: injury">
              <translation code="161586000" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="H/O: injury"/>
              <translation code="14J..00" codeSystem="2.16.840.1.113883.2.1.6.2" displayName="H/O: injury"/>
          </code>
          <statusCode code="COMPLETE"/>
          <effectiveTime>
              <center nullFlavor="NI"/>
          </effectiveTime>
          <availabilityTime value="20001004"/>
          <pertinentInformation typeCode="PERT">
              <sequenceNumber value="+1"/>
              <pertinentAnnotation classCode="OBS" moodCode="EVN">
                  <text>(New Episode). H/O: injury to little finger left hand poss glass in wound therefore refered to A+E</text>
              </pertinentAnnotation>
          </pertinentInformation>
      </ObservationStatement>
  </component>
</ehrComposition>
    Gets merged into: 
    <ehrComposition xmlns="urn:hl7-org:v3" classCode="COMPOSITION" moodCode="EVN">
  <id root="e9105749-5aef-400d-8ad4-649ff03ac879"/>
  <code code="25671000000102" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="Surgery Consultation Note"/>
  <statusCode code="COMPLETE"/>
  ...
  <component typeCode="COMP">
      <ObservationStatement classCode="OBS" moodCode="EVN">
          <id root="ba4edfcd-142e-4090-8a81-9ca2790849a8"/>
          <code code="14J.." codeSystem="2.16.840.1.113883.2.1.3.2.4.14" displayName="H/O: injury">
              <translation code="161586000" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="H/O: injury"/>
              <translation code="14J..00" codeSystem="2.16.840.1.113883.2.1.6.2" displayName="H/O: injury"/>
          </code>
          <statusCode code="COMPLETE"/>
          <effectiveTime>
              <low value="20001004"/>
              <high value="19000101000000"/>
          </effectiveTime>
          <availabilityTime value="20001004"/>
          <pertinentInformation typeCode="PERT">
              <sequenceNumber value="+1"/>
              <pertinentAnnotation classCode="OBS" moodCode="EVN">
                  <text>Problem severity: Minor (New Episode). H/O: injury to little finger left hand poss glass in wound therefore refered to A+E</text>
              </pertinentAnnotation>
          </pertinentInformation>
      </ObservationStatement>
  </component>
  <component typeCode="COMP">
      <LinkSet classCode="OBS" moodCode="EVN">
          <id root="7f384915-a2f9-44df-b407-e9c339707297"/>
          <code code="394775005" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="Inactive Problem"/>
          <statusCode code="COMPLETE"/>
          <effectiveTime>
              <low value="20001004"/>
              <high value="19000101000000"/>
          </effectiveTime>
          <availabilityTime value="20001004"/>
          <conditionNamed inversionInd="true" typeCode="NAME">
              <namedStatementRef classCode="OBS" moodCode="EVN">
                  <id root="ba4edfcd-142e-4090-8a81-9ca2790849a8"/>
              </namedStatementRef>
          </conditionNamed>
      </LinkSet>
  </component>
</ehrComposition>

  • When a CommentType: USER COMMENT NarrativeStatement is located within the BATTERY of a Filed Report, the adaptor now generates a new filing comment Observation and references this in the result property of the parent DiagnosticReport. This change makes the adaptor more closely resemble the GP Connect specification for DiagnosticReport and filing comments. The generated Observation filing comment will have the status of unknown.

[2.0.0] - 2024-04-12

Fixed

  • Breaking Change Identifier values and code systems where an OID is provided (such as 2.16.840.1.113883.2.1.6.9) will now be provided as a URN (i.e. urn:oid:2.16.840.1.113883.2.1.6.9), as per GP Connect specification.

[1.4.7] - 2024-04-02

Changed

  • The source of date for List (Consultation) is now ehrComposition author time otherwise from the following fields in order of precedence:
    • ehrComposition availibiltyTime
    • ehrComposition effectiveTime - center
    • EhrComposition effectiveTime - high
    • EhrComposition effectiveTime - low

[1.4.6] - 2024-03-21

  • Condition.onsetDateTime is now set to NULL when low or center entries of effectiveTime are nullFlavor="UNK".

[1.4.5] - 2024-03-01

Fixed

  • Removed the EhrExtract / AvailabilityTime field as a fallback value from:

    • Condition.assertedDate
    • List.date
    • DiagnosticReport.issued
    • Observation.issuedDate

  • Replaced the EhrExtract / AvailabilityTime field as a fallback value with EhrComposition / author / time[@value] for:

    • AllergyIntolerance.assertedDate
    • MedicationRequest.authoredOn

[1.4.4] - 2024-02-28

Fixed

  • Plan Statements (Recalls) were previously mapped with a fixed value of active for the Status field. The adaptor will now interrogate the text field to see if a status has been provided, otherwise defaulting to unknown.

[1.4.3] - 2024-02-15

Added

  • Added Materialised View in the SnomedCT database to be used when querying for preferred terms.

Note

Upgrade information This release includes an update to the SNOMED database Users will need to perform an update of their SNOMED database. This will need to be performed first, followed by deploying the updated version of the translator image.

[1.4.2] - 2024-01-31

Added

  • Added Episodicity information to comment property of Observations.

Fixed

  • Fixed malformed role coding defect introduced in version 1.4.1

[1.4.1] - 2024-01-17

Added

  • Assigning a role to a practitioner who records vaccinations

Fixed

  • Fixed an issue where Observation Test Group or Observation Test Results were incorrectly creating a relationship to Filing Comments using the has-member relationship
  • ProcedureRequestMapper.authoredOn is no longer populated with EhrExtract / availabilityTime as a fallback, but does use EhrComposition / author / time as a fallback instead now.

[1.4.0] - 2024-01-10

Changed

  • REST buffer size has been set to 150Mb

Fixed

  • Fixed issue where mapping failed due to a Referral Request Priority not being found.
  • Codings are now provided (code, display and system) in PractionionerRole.code and Organization.type fields, where only the text attribute was provided previously.
  • Fixed a bug which could lead to medication resource not being mapped if a failure had occurred when processing the previous EhrExtract during the medication mapping stage

[1.3.0] - 2023-12-11

Added

  • In the event of a GP2GP failure, the raw error code is now available in the /Patient/$gpc.migratestructuredrecord response section with code system 2.16.840.1.113883.2.1.3.2.4.17.101.

Changed

  • Removed surplus references to Medication Statements from the Topic and Category entry arrays. The GP Connect documentation states Medications should be referenced using the Medication Request resource, which is already done.
  • Updated postman collection to include attachment tests.

[1.2.1] - 2023-11-23

Fixed

  • Swapped the mixed-up population of 'author' and 'practitioner' fields in AllergyIntolerance.
  • A SystmOne attachment split into multiple chunks can arrive with the same filename "Untitled". Previously each fragment would be stored using the filename provided, which in the case of SystmOne caused chunks to overwrite each other. The adaptor now generates a UUID which is prepended to the filename of a provided chunk to ensure uniqueness.

[1.2.0] - 2023-11-17

Added

  • Populate identifier field for Practitioner resources using the General Practitioner (GMP) number if available.

Fixed

  • Prevent NarrativeStatement / text sat within a blood pressure CompoundStatement from being mapped into separate "Comment note" Observation resources. This information is already populated within the blood pressure Observation.comment field, so creating a separate resource was duplicating this info.

Changed

  • Changed ReferralRequest mapping to use ASAP instead of the Stat value.

[1.1.0] - 2023-11-09

Changed

  • Updated the way immunization codes are loaded to build these from the relationships reference set in the SNOMED CT release rather than a static set of values. The previous static list of values was incomplete and included invalid codes. More information about how this improved functionality works can be found in the SNOMED database documentation.

Note

Upgrade information This release includes a database migration. This database migration will need to be performed first, followed by deploying the updated version of the facade and translator images. Finally users will need to perform an update of their SNOMED database.

[1.0.1] - 2023-11-21

This release backported the following fix to the v1.0 release.

Fixed

  • A SystmOne attachment split into multiple chunks can arrive with the same filename "Untitled". Previously each fragment would be stored using the filename provided, which in the case of SystmOne caused chunks to overwrite each other. The adaptor now generates a UUID which is prepended to the filename of a provided chunk to ensure uniqueness.

[1.0.0] - 2023-11-01 🎉

Added

  • Added functionality to include episodicity qualifiers when mapping allergy intolerances.

Changed

  • Preserve the ordering of code / translation elements when mapping Codeable Concepts.

Fixed

  • Fix invalid state transition bug which caused the adaptor to move from a failed state to an in-progress state when a positive acknowledgement was received.

[0.16] - 2023-10-31

Fixed

  • Add additional error handling for exceptions raised when processing PSS queue, and MHS queue messages.
  • Fix bug in some SQL statements which caused excessively large amounts of data to be returned, sometimes resulting in a PostgresSQL Out of Memory error.

[0.15] - 2023-10-24

  • Fixed issue with some ObservationStatement coded as blood pressure readings not being output into Bundle.
  • Fixed issue with AllergyIntolerance recorder and asserter fields mapping.

[0.14] - 2023-10-17

Added

Fixed

  • Fix issue where continue message was not accepted by EMIS
  • Fixed issue where EMIS cid references caused large message merging to fail
  • Fix issue where attachments were given the incorrect object storage URL
  • Fix issue where attachments were not de-compressed
  • Enable logging of migration status updates when PS_LOGGING_LEVEL is set to DEBUG
  • Fix acknowledgement message as it was not accepted by system one
  • Fix SDS failing as part of GP2GP transfer process

[0.13] - 2023-09-13

Added

  • Add details about object storage to operating documentation.
  • Enable AWS Instance Roles to be used for connecting to S3

Fixed

  • Fix issue where attachments with filenames containing special characters causes the transfer to fail.
  • Fix issue where some resource types do not contain a degraded code when a SNOMED code has not been provided.
  • Fix issue where unnecessary length checks on inline attachments could cause a transfer to fail.

[0.12] - 2023-08-29

Changed

  • Change the codeable concept mapping to map Egton Codes found in code elements.
  • Change the codeable concept mapping to map Read Codes (READV2, CTV3) found in code elements.
  • Change the codeable concept mapping to map unknown code systems found in code elements.

Fixed

  • Fix issue where Inbound Adaptor rejects an EHR Extract from EMIS containing inline attachments where the description contains only the filename.
  • Fix issue where Allergy Intolerances are referenced incorrectly when they are referenced from a list.
  • Fix issue where a Condition is not correctly mapping the code element in all instances.