The Cross-Version Extensions for FHIR (XVer) project provides a set of packages that define extensions, profiles, and value sets for cross-version compatibility in FHIR. These packages are designed to support the validation and interoperability of FHIR resources across different versions.
About This Guide
Cross-version extension content is generated via a combination of automatic differential detection and manual editing.
For details or questions, please reach out on Zulip or
to the FHIR Infrastructure WorkGroup.
Frequently Asked Questions and related guidance can be found on the Confluence Cross-Version FAQs Page
Goals
Ability to use elements from another version of FHIR
Encode information added in a newer version of FHIR
Community identified additional data that is needed
Need to provide a consistent way of representing it in an earlier version of FHIR
Encode information removed in a newer version of FHIR
Community decided data was no longer necessary
Need to provide a consistent way of representing it in a later version of FHIR
Version migration requires interoperability between versions and cannot break old expectations
Scenarios where data needs to round-trip conversion between different versions
Known Limitations
Not 100% coverage of all elements in all versions
Resource type elements are excluded (e.g., R5:Bundle.issues)
Mappings are generally between adjacent versions, so "back-and-forth" conversions may be needlessly verbose
Large / infinite value sets (e.g., UCUM, LOINC, MIME) are excluded and assumed 'equivalent' across versions
Mapping elements that split into multiple elements has a lot of complications that are out-of-scope for this package, but should be noted when using it.
E.g., when mapping from a single CodeableReference element to CodeableConcept and Reference elements, decisions must be made about any existing extensions, etc.
Intellectual Property Statements
This publication includes IP covered under the following statements.
These codes are excerpted from ISO Standard, TS 21089-2017 - Health Informatics - Trusted End-to-End Information Flows, Copyright by ISO International. Copies of this standard are available through the ISO Web Site at www.iso.org.
These codes have been appropriated from the UB04 code set
owned and managed by the AHA
. Users require a license from the AHA
in order to use these codes. Note: the codes have been withdrawn in a later version
This is an example set based on ASTM Standard, E1762-95 (2013) HL7 RoleClass OID 2.16.840.1.113883.5.110, HL7 Role Code 2.16.840.1.113883.5.111, HL7 ParticipationType OID: 2.16.840.1.113883.5.90, HL7 ParticipationFunction codes at OID: 2.16.840.1.113883.5.88, and HL7 Security and Privacy Domain Analysis Model roles classes.
This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
This resource includes content from SNOMED Clinical Terms® (SNOMED CT®) which is copyright of the International Health Terminology Standards Development Organisation (IHTSDO). Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact http://www.snomed.org/snomed-ct/get-snomed-ct or info@snomed.org