FHIR Cross-Version Extensions package for FHIR R4 from FHIR R2 - Version 0.0.1-snapshot-2. See the Directory of published versions

Home

Official URL: http://hl7.org/fhir/1.0/ImplementationGuide/hl7.fhir.uv.xver-r2.r4				Version: 0.0.1-snapshot-2
IG Standards status: Informative			Maturity Level: 0	Computable Name: Hl7_fhir_uv_xver_r2_r4

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.

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

Intellectual Property Statements

This publication includes IP covered under the following statements.

• "Material on this site is the copyrighted property of the United States Postal Service® (Postal Service™). All rights reserved. The information and images presented here may not under any circumstances be reproduced or used without prior written permission. Users may view and download material from this site only for the following purposes: (a) for personal, non-commercial home use; (b) where the materials clearly state that these materials may be copied and reproduced according to the terms stated in those particular pages; or (c) with the express written permission of the Postal Service. In all other cases, you will need written permission from the Postal Service to reproduce, republish, upload, post, transmit, distribute or publicly display material from this Web site. Users agree not to use the site for sale, trade or other commercial purposes. Users may not use language that is threatening, abusive, vulgar, discourteous or criminal. Users also may not post or transmit information or materials that would violate rights of any third party or which contains a virus or other harmful component. The Postal Service reserves the right to remove or edit any messages or material submitted by users."For more information, see https://about.usps.com/who/legal/terms-of-use.htm .
  Show Usage
  • USPS State Codes: R2_usps_state_for_R4
• Copyright © 2012-2013 National E-Health Transition Authority Ltd : This document contains information which is protected by copyright. All Rights Reserved. No part of this work may be reproduced or used in any form or by any means--graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems--without the permission of NEHTA. All copies of this document must include the copyright and other information contained on this page. Revision 1 Telephone: 1300 901 001 or email: servicedesk@nehta.gov.au Disclaimer: The National E-Health Transition Authority Ltd (NEHTA) makes the information and other material ('Information') in this document available in good faith but without any representation or warranty as to its accuracy or completeness. NEHTA cannot accept any responsibility for the consequences of any use of the Information. As the Information is of a general nature only, it is up to any person using or relying on the Information to ensure that it is accurate, complete and suitable for the circumstances of its use.
  Show Usage
  • Patient Medicine Change Types: R2_list_item_flag_for_R4
• HL7 Inc.
  Show Usage
  • Claim Processing Codes: Ext_R2_ClaimResponse_outcome and Ext_R2_ExplanationOfBenefit_outcome
• ISO maintains the copyright on the country codes, and controls its use carefully. For further details see the ISO 3166 web page: https://www.iso.org/iso-3166-country-codes.html
  Show Usage
  • ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code: Ext_R2_DataElement_useContext, R2_anzsco_occupations_for_R4 and R2_use_context_for_R4
• Most of the information on the CDC and ATSDR websites is not subject to copyright, is in the public domain, and may be freely used or reproduced without obtaining copyright permission. For information and exceptions regarding use of CDC material please see https://www.cdc.gov/other/agencymaterials.html
  Show Usage
  • Vaccine Administered Code Set (CVX): R2_daf_cvx_for_R4 and R2_vaccine_code_for_R4
• NDF-RT is released as part of UMLS. Therefore, each successive release has the date of the UMLS release as its version.
  Show Usage
  • National Drug File Reference Terminology (NDF-RT): R2_substance_ndfrt_for_R4
• The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
  Show Usage
  • Unified Code for Units of Measure (UCUM): R2_age_units_for_R4, R2_daf_ucum_vitals_common_for_R4, R2_ucum_common_for_R4 and R2_uslab_units_for_R4
• This is an example set.
  Show Usage
  • Additional Material Codes: Ext_R2_Claim_additionalMaterials and R2_additionalmaterials_for_R4
  • Teeth Codes: Ext_R2_Claim_missingTeeth and R2_teeth_for_R4
  • Oral Prostho Material type Codes: Ext_R2_Claim_it_prosthesis and R2_oral_prosthodontic_material_for_R4
  • Example Pharmacy Service Codes: R2_service_pharmacy_for_R4
  • Example Service/Product Codes: R2_service_product_for_R4
  • UDI Codes: Ext_R2_Claim_it_de_su_udi, Ext_R2_Claim_it_de_udi, Ext_R2_Claim_it_udi and R2_udi_for_R4
  • FM Condition Codes: Ext_R2_Claim_condition and R2_fm_conditions_for_R4
  • Intervention Codes: Ext_R2_Claim_interventionException and R2_intervention_for_R4
  • Beneficiary Relationship Codes: Ext_R2_ClaimResponse_co_relationship, Ext_R2_Claim_co_relationship, Ext_R2_EnrollmentRequest_relationship and R2_relationship_for_R4
• This material contains content from LOINC. LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.
  Show Usage
  • LOINC: Ext_R2_DiagnosticOrder_item, R2_c80_doc_classcodes_for_R4... Show 21 more, R2_c80_doc_typecodes_for_R4, R2_daf_list_DAFMedListCode_for_R4, R2_daf_observation_CCDAVitalSignResult_for_R4, R2_dataelement_sdccode_for_R4, R2_dataelement_sdcobjectclass_for_R4, R2_dataelement_sdcobjectclassproperty_for_R4, R2_diagnostic_requests_for_R4, R2_doc_classcodes_for_R4, R2_doc_section_codes_for_R4, R2_doc_typecodes_for_R4, R2_example_expansion_for_R4, R2_example_extensional_for_R4, R2_example_intensional_for_R4, R2_ldlcholesterol_codes_for_R4, R2_observation_codes_for_R4, R2_profile_code_for_R4, R2_questionnaire_questions_for_R4, R2_report_codes_for_R4, R2_sdcde_dataelement_sdccode_for_R4, R2_uslab_obs_codes_for_R4 and R2_v3_ObservationType_for_R4
• 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®): Ext_R2_Appointment_reason, Ext_R2_CarePlan_participant... Show 113 more, Ext_R2_ClinicalImpression_fi_item, Ext_R2_ClinicalImpression_resolved, Ext_R2_ClinicalImpression_ruledOut, Ext_R2_ClinicalImpression_trigger, Ext_R2_DiagnosticOrder_event, Ext_R2_DiagnosticOrder_item, Ext_R2_EpisodeOfCare_careTeam, Ext_R2_HealthcareService_serviceType, Ext_R2_Immunization_explanation, Ext_R2_MA_do_site, Ext_R2_MedicationDispense_dosageInstruction, Ext_R2_MedicationOrder_dosageInstruction, Ext_R2_MedicationOrder_reason, Ext_R2_MedicationStatement_dosage, Ext_R2_MedicationStatement_reasonForUse, Ext_R2_Medication_package, Ext_R2_Medication_product, Ext_R2_ProcedureRequest_reason, Ext_R2_Procedure_reason, Ext_R2_Procedure_reasonNotPerformed, Ext_R2_Questionnaire_gr_qu_option, Ext_R2_ReferralRequest_serviceRequested, Ext_R2_SupplyRequest_when, Ext_R2_ValueSet_codeSystem, R2_activity_reason_for_R4, R2_allergyintolerance_substance_code_for_R4, R2_approach_site_codes_for_R4, R2_body_site_for_R4, R2_bodysite_laterality_for_R4, R2_bodysite_relative_location_for_R4, R2_c80_facilitycodes_for_R4, R2_c80_practice_codes_for_R4, R2_care_plan_activity_for_R4, R2_care_plan_category_for_R4, R2_clinical_findings_for_R4, R2_condition_cause_for_R4, R2_condition_code_for_R4, R2_condition_outcome_for_R4, R2_condition_predecessor_for_R4, R2_condition_severity_for_R4, R2_condition_stage_for_R4, R2_consistency_type_for_R4, R2_daf_bodysite_for_R4, R2_daf_encounter_reason_for_R4, R2_daf_manifestation_ccda_codes_for_R4, R2_daf_observation_ccdasmokingstatus_for_R4, R2_daf_problem_for_R4, R2_daf_procedure_type_for_R4, R2_daf_substance_for_R4, R2_dataelement_sdccode_for_R4, R2_dataelement_sdcobjectclass_for_R4, R2_dataelement_sdcobjectclassproperty_for_R4, R2_designation_use_for_R4, R2_diagnostic_order_event_for_R4, R2_diet_type_for_R4, R2_digital_media_subtype_for_R4, R2_encounter_reason_for_R4, R2_entformula_type_for_R4, R2_flag_code_for_R4, R2_focal_subject_for_R4, R2_food_type_for_R4, R2_goal_start_event_for_R4, R2_immunization_reason_for_R4, R2_investigation_sets_for_R4, R2_manifestation_codes_for_R4, R2_manifestation_or_symptom_for_R4, R2_media_view_for_R4, R2_medication_codes_for_R4, R2_medication_form_codes_for_R4, R2_medication_package_form_codes_for_R4, R2_modified_foodtype_for_R4, R2_no_immunization_reason_for_R4, R2_nutrient_code_for_R4, R2_observation_methods_for_R4, R2_participant_role_for_R4, R2_performer_role_for_R4, R2_procedure_category_for_R4, R2_procedure_code_for_R4, R2_procedure_followup_for_R4, R2_procedure_not_performed_reason_for_R4, R2_procedure_outcome_for_R4, R2_procedure_reason_for_R4, R2_profile_code_for_R4, R2_qicore_allergyintolerance_reason_refuted_for_R4, R2_qicore_communication_reason_not_performed_for_R4, R2_qicore_condition_certainty_for_R4, R2_qicore_deviceuserequest_reason_rejected_for_R4, R2_qicore_diagnosticorder_reason_rejected_for_R4, R2_qicore_encounter_canceled_reason_for_R4, R2_qicore_encounter_condition_role_for_R4, R2_qicore_goal_reason_rejected_for_R4, R2_qicore_medication_dose_type_for_R4, R2_qicore_observation_body_position_for_R4, R2_qicore_patient_disability_for_R4, R2_qicore_priority_for_R4, R2_qicore_referralrequest_reason_rejected_for_R4, R2_questionnaire_answers_for_R4, R2_questionnaire_category_for_R4, R2_referencerange_meaning_for_R4, R2_route_codes_for_R4, R2_sdcde_dataelement_sdccode_for_R4, R2_specimen_collection_method_for_R4, R2_specimen_container_type_for_R4, R2_substance_code_for_R4, R2_substance_sct_for_R4, R2_supplement_type_for_R4, R2_supplyrequest_when_for_R4, R2_texture_code_for_R4, R2_uslab_clinical_findings_for_R4, R2_uslab_obs_codedresults_for_R4, R2_uslab_spec_bodysite_for_R4, R2_uslab_spec_type_for_R4 and R2_vaccination_protocol_dose_target_for_R4
• 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
  • Claim Type Codes: Ext_R2_Claim_type
  • Example Vision Prescription Product Codes: Ext_R2_VisionPrescription_di_product
  • ActCode: Ext_R2_Claim_accidentType, Ext_R2_Claim_it_de_su_type, Ext_R2_Claim_it_de_type, Ext_R2_Claim_it_type and Ext_R2_Coverage_type
  • ActReason: Ext_R2_AuditEvent_event, Ext_R2_AuditEvent_pa_purposeOfUse, Ext_R2_Contract_actionReason, Ext_R2_Contract_te_actionReason and Ext_R2_Provenance_reason
  • Substance Admin Substitution: Ext_R2_MedicationOrder_su_type
• 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
  Show Usage
  • Animal species: R2_animal_species_for_R4
  • Procedure Device Action Codes: Ext_R2_Procedure_fo_action and R2_device_action_for_R4
• This value set includes content from SNOMED CT, which is copyright 2002 International Health Terminology Standards Development Organisation (IHTSDO), and distributed by agreement between IHTSDO and HL7. Implementer use of SNOMED CT is not covered by this agreement.
  Show Usage
  • SNOMED CT Reason Medication Not Given Codes: R2_reason_medication_not_given_codes_for_R4
• Unless otherwise noted, the contents of the FDA website (www.fda.gov) — both text and graphics — are not copyrighted. They are in the public domain and may be republished, reprinted and otherwise used freely by anyone without the need to obtain permission from FDA. Credit to the U.S. Food and Drug Administration as the source is appreciated but not required.
  Show Usage
  • Unique Ingredient Identifier (UNII): R2_substance_unii_for_R4
• Using RxNorm codes of type SAB=RXNORM as this specification describes does not require a UMLS license. Access to the full set of RxNorm definitions, and/or additional use of other RxNorm structures and information requires a UMLS license. The use of RxNorm in this specification is pursuant to HL7's status as a licensee of the NLM UMLS. HL7's license does not convey the right to use RxNorm to any users of this specification; implementers must acquire a license to use RxNorm in their own right.
  Show Usage
  • RxNorm: R2_daf_medication_codes_for_R4, R2_dataelement_sdccode_for_R4... Show 4 more, R2_dataelement_sdcobjectclass_for_R4, R2_dataelement_sdcobjectclassproperty_for_R4, R2_sdcde_dataelement_sdccode_for_R4 and R2_substance_rxnorm_for_R4