Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions

Home

Official URL: http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3				Version: 0.1.0
IG Standards status: Trial-use			Maturity Level: 0	Computable Name: Hl7_fhir_uv_xver_r4b_r3

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.

• HL7 Inc.
  Show Usage
  • Coverage Class Codes: R4BCoverageClassForR3
  • Coverage CoPay Type Codes: ExtensionCoverage_CostToBeneficiary and R4BCoverageCopayTypeForR3
  • CoverageEligibilityResponse Auth Support Codes: ExtensionCoverageEligibilityResponse_Insurance_Item_AuthorizationSupporting and R4BCoverageeligibilityresponseExAuthSupportForR3
  • Example Coverage Financial Exceptions Code: ExtensionCoverage_CostToBeneficiary and R4BCoverageFinancialExceptionForR3
• 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
  Show Usage
  • Example Diagnosis on Admission Codes: ExtensionClaim_Diagnosis_OnAdmission, ExtensionExplanationOfBenefit_Diagnosis_OnAdmission and R4BExDiagnosisOnAdmissionForR3
• This is an example set.
  Show Usage
  • Surface Codes: ExtensionClaimResponse_AddItem_SubSite and ExtensionExplanationOfBenefit_AddItem_SubSite
  • Adjudication Value Codes: ExtensionClaimResponse_Item_Adjudication, ExtensionClaimResponse_Total, ExtensionExplanationOfBenefit_Item_Adjudication and ExtensionExplanationOfBenefit_Total
  • Adjudication Reason Codes: ExtensionClaimResponse_Item_Adjudication and ExtensionExplanationOfBenefit_Item_Adjudication
  • Consent Action Codes: ExtensionConsent_Provision
  • Contract Term Type Codes: ExtensionContract_Term_Offer
  • USCLS Codes: ExtensionClaimResponse_AddItem_Detail_SubDetail, ExtensionCoverageEligibilityRequest_Item and ExtensionExplanationOfBenefit_AddItem_Detail_SubDetail
  • Example Claim SubType Codes: ExtensionClaimResponse_SubType
  • Example Claim Type Codes: ExtensionClaimResponse_Type
  • Example Program Reason Codes: ExtensionClaimResponse_AddItem_ProgramCode and ExtensionExplanationOfBenefit_AddItem_ProgramCode
  • Example Service Place Codes: ExtensionClaimResponse_AddItem_Location and ExtensionExplanationOfBenefit_AddItem_Location
  • Oral Site Codes: ExtensionClaimResponse_AddItem_BodySite and ExtensionExplanationOfBenefit_AddItem_BodySite
  • Funds Reservation Codes: ExtensionClaimResponse_FundsReserve, ExtensionExplanationOfBenefit_FundsReserve and ExtensionExplanationOfBenefit_FundsReserveRequested
  • Modifier type Codes: ExtensionClaimResponse_AddItem_Detail_SubDetail, ExtensionCoverageEligibilityRequest_Item, ExtensionCoverageEligibilityResponse_Insurance_Item_Modifier and ExtensionExplanationOfBenefit_AddItem_Detail_SubDetail
  • Process Priority Codes: ExtensionExplanationOfBenefit_Priority
  • Consent Scope Codes: ExtensionConsent_Scope and R4BConsentScopeForR3
  • Benefit Category Codes: ExtensionCoverageEligibilityRequest_Item and R4BExBenefitcategoryForR3
  • Example Procedure Type Codes: ExtensionClaim_Procedure_Type, ExtensionExplanationOfBenefit_Procedure_Type and R4BExProcedureTypeForR3
  • Contract Action Codes: ExtensionContract_Term_Action_Type
  • Contract Actor Role Codes: ExtensionContract_Term_Action_Subject
• This is an extensible set.
  Show Usage
  • Subscriber Relationship Codes: R4BSubscriberRelationshipForR3
• 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.
  Show Usage
  • SNOMED Clinical Terms® (SNOMED CT®): Code system summary example for ACME body sites
• This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  • Benefit cost applicability: ExtensionInsurancePlan_Plan and R4BInsuranceplanApplicabilityForR3
  • Can-push-updates: ExtensionVerificationResult_PrimarySource and R4BVerificationresultCanPushUpdatesForR3
  • Failure-action: ExtensionVerificationResult_FailureAction and R4BVerificationresultFailureActionForR3
  • Insurance plan type: ExtensionInsurancePlan_Type and R4BInsuranceplanTypeForR3
  • Need: ExtensionVerificationResult_Need and R4BVerificationresultNeedForR3
  • Primary-source-type: ExtensionVerificationResult_PrimarySource and R4BVerificationresultPrimarySourceTypeForR3
  • Push-type-available: ExtensionVerificationResult_PrimarySource and R4BVerificationresultPushTypeAvailableForR3
  • Subscription Error Codes: ExtensionSubscriptionStatus_Error and R4BSubscriptionErrorForR3
  • event: ExtensionSubscriptionTopic_EventTrigger and R4BV20003ForR3
  • diagnosticServiceSectionId: R4BDiagnosticServiceSectionsForR3
  • specimenType: ExtensionSpecimenDefinition_TypeCollected, ExtensionSpecimenDefinition_TypeTested and R4BV20487ForR3
  • ActCode: R4BV3ActCodeForR3
  • ActReason: R4BV3ActReasonForR3
  • DataOperation: R4BProvenanceHistoryRecordActivityForR3
  • ObservationInterpretation: R4BObservationInterpretationForR3
  • ParticipationMode: R4BQuestionnaireresponseModeForR3
  • ParticipationType: ExtensionImagingStudy_Series_Performer_Function, ExtensionProvenance_Activity... Show 4 more, R4BPerformerFunctionForR3, R4BProvenanceActivityTypeForR3, R4BProvenanceHistoryAgentTypeForR3 and R4BSeriesPerformerFunctionForR3
  • Validation-process: ExtensionVerificationResult_ValidationProcess and R4BVerificationresultValidationProcessForR3
  • Validation-status: ExtensionVerificationResult_PrimarySource and R4BVerificationresultValidationStatusForR3
  • Validation-type: ExtensionVerificationResult_ValidationType and R4BVerificationresultValidationTypeForR3
  • VerificationResult Communication Method: ExtensionVerificationResult_Attestation, ExtensionVerificationResult_PrimarySource and R4BVerificationresultCommunicationMethodForR3