Swedish Healthcare Service - Health Condition Description - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Version History

Version History and Changelog

This page documents the version history of the Health Condition Description service domain.

Version 3.0.5 (Current)

Release Date: 2024-10-15
Status: Active

Overview

Minor update to version 3.0 with clarifications and corrections.

Changes

• Clarified date format specifications (YYYYMMDD without separators)
• Updated OID references for patient identifiers
• Corrected examples in documentation
• No breaking changes to service contracts

Affected Services

• GetCareDocumentation: v3.0 (unchanged contract)
• GetDiagnosis: v2.0 (unchanged)
• GetAlertInformation: v2.0 (unchanged)
• GetFunctionalStatus: v2.0 (unchanged)

Version 3.0.0 (GetCareDocumentation Major Update)

Release Date: 2023-09-01
Status: Active

Overview

Major update to GetCareDocumentation service with new message structure based on NPÖ RIV 2.2.0.

Breaking Changes

GetCareDocumentation v2.0 → v3.0

1. Message Structure Changed

• Old (v2.0): Based on NPÖ RIV 1.x format
• New (v3.0): Based on NPÖ RIV 2.2.0, HL7 CDA v.2 compatible

2. Patient ID Structure

<!-- OLD v2.0 -->
<patientId root="1.2.752.129.2.1.3.1" extension="197001011234"/>

<!-- NEW v3.0 -->
<patientId>
  <id>197001011234</id>
  <type>1.2.752.129.2.1.3.1</type>
</patientId>

3. Date Period Renamed

<!-- OLD v2.0 -->
<datePeriod>
  <start>20240101</start>
  <end>20241231</end>
</datePeriod>

<!-- NEW v3.0 -->
<timePeriod>
  <start>20240101</start>
  <end>20241231</end>
</timePeriod>

4. Care Unit Parameter Renamed

<!-- OLD v2.0 -->
<careUnit>SE2321000016-1234</careUnit>

<!-- NEW v3.0 -->
<careUnitHSAId>SE2321000016-1234</careUnitHSAId>

5. Source System Parameter Renamed

<!-- OLD v2.0 -->
<sourceSystemId root="1.2.752.129.2.1.4.1" extension="SE2321000016-SYS1"/>

<!-- NEW v3.0 -->
<sourceSystemHSAId>SE2321000016-SYS1</sourceSystemHSAId>

6. Response Structure Changes

• More structured care documentation headers
• Enhanced metadata fields
• Better support for CDA document types
• Improved time coding

Migration Guide v2.0 → v3.0

Consumer Migration

Step 1: Update Request Mapping

// OLD
request.setPatientId(new IIType("1.2.752.129.2.1.3.1", "197001011234"));
request.setDatePeriod(new DatePeriodType("20240101", "20241231"));
request.getCareUnit().add("SE2321000016-1234");

// NEW
PatientIdType patientId = new PatientIdType();
patientId.setId("197001011234");
patientId.setType("1.2.752.129.2.1.3.1");
request.setPatientId(patientId);

TimePeriodType timePeriod = new TimePeriodType();
timePeriod.setStart("20240101");
timePeriod.setEnd("20241231");
request.setTimePeriod(timePeriod);

request.getCareUnitHSAId().add("SE2321000016-1234");

Step 2: Update Response Processing

• Review response structure mapping
• Update XPath or object model navigation
• Test thoroughly with v3.0 endpoint

Step 3: Update Endpoint

# OLD
endpoint.v2=.../GetCareDocumentation/2

# NEW
endpoint.v3=.../GetCareDocumentation/3

Step 4: Parallel Operation

• Maintain v2.0 capability during transition
• Gradually migrate to v3.0
• Monitor both versions

Producer Migration

Step 1: Implement v3.0 Contract

• Deploy v3.0 endpoint alongside v2.0
• Implement new message structure
• Map internal data model to v3.0 format

Step 2: Testing

• Test with v3.0 consumers
• Validate response structure
• Verify backward compatibility (v2.0 still works)

Step 3: Communication

• Notify consumers of v3.0 availability
• Provide migration timeline
• Offer support during transition

Step 4: Deprecation

• Announce v2.0 deprecation date
• Monitor v2.0 usage decline
• Sunset v2.0 after transition period

Timeline

• 2023-09-01: v3.0 released, v2.0 parallel operation begins
• 2024-01-01: v2.0 deprecated (still available)
• 2024-12-31: v2.0 sunset deadline

Non-Breaking Changes (Other Services)

• GetDiagnosis, GetAlertInformation, GetFunctionalStatus remain at v2.0
• Minor documentation updates
• No migration required for these services

Version 2.0.0

Release Date: 2020-03-15
Status: Deprecated (GetCareDocumentation), Active (other services)

Overview

Standardized version across all four services in the domain.

Changes

• GetDiagnosis updated to v2.0
• GetAlertInformation updated to v2.0
• GetFunctionalStatus updated to v2.0
• GetCareDocumentation at v2.0 (now superseded by v3.0)

Features Added

• Partial data retrieval support (hasMoreReference)
• Enhanced error handling
• Improved aggregation logic
• Performance optimizations

Migration from v1.0

Breaking Changes:

• Error code structure standardized
• Result element structure changed
• Additional required fields in requests

Backward Compatibility:

• v1.0 endpoints maintained for 12 months
• Gradual migration supported

Version 1.0.0

Release Date: 2015-06-01
Status: Obsolete (sunset 2021-06-01)

Overview

Initial release of the Health Condition Description service domain.

Services

• GetCareDocumentation v1.0
• GetDiagnosis v1.0
• GetAlertInformation v1.0
• GetFunctionalStatus v1.0

Features

• Basic patient data retrieval
• Care unit filtering
• Date period filtering
• Aggregating service support
• Engagement index integration

Compatibility Matrix

Deprecation Policy

Timeline

1. Announcement: New version released, old version enters parallel operation
2. Deprecation (6 months): Old version marked deprecated but still available
3. Sunset Warning (3 months before): Final notice, migration deadline announced
4. Sunset: Old version decommissioned

Current Status

• GetCareDocumentation v2.0: Deprecated, sunset 2024-12-31
• Other services: Stable at v2.0

Upcoming Changes

Planned for 2025

Under Consideration:

• FHIR R4 API alternatives (RESTful)
• Real-time notification enhancements
• Enhanced search capabilities
• Performance improvements

Status: Requirements gathering

Future Roadmap

2025-2026:

• Potential minor updates to v2.0 services
• Continued v3.0 GetCareDocumentation refinements
• Investigation of FHIR-based alternatives

Beyond 2026:

• Major version updates as needed
• Technology modernization
• Integration with new national infrastructure

Version Identification

In WSDL

<wsdl:definitions
  targetNamespace="urn:riv:clinicalprocess:healthcond:description:GetCareDocumentationResponder:3"
  ...>

In SOAP Message

<soap:Header>
  <Action>urn:riv:clinicalprocess:healthcond:description:GetCareDocumentationResponder:3:GetCareDocumentation</Action>
</soap:Header>

In Service Catalog

• Service name includes version number
• Contract URN includes version
• Endpoint URL includes version

Migration Support

Available Resources

• Migration guides (this page)
• Code examples for each version
• Test environments with all versions
• Technical support during transition

Contact Information

• Technical Support: support@inera.se
• Migration Assistance: integration@inera.se
• Documentation: https://inera.se/fhir/ig/clinicalprocess-healthcond-description/

References

• Architecture - Versioning strategy
• Testing - Version testing
• Deployment - Version deployment
• Common Components - Data type changes