Introduction
The Extension Pack defines the FHIR extensions that are globally defined and available in
all implementation contexts. Prior to R5
these extensions were defined in the core specification, but starting from R5
they have been moved out of the specification into a separate extensions pack
so that the extensions can be updated more often than the base specification.
This extension pack also defines some search parameters for the extensions.
The FHIR Extension Pack is intended for use with
all supported versions of FHIR.
While the Extension Pack definitions are based on R5, most of the extensions can
be used as-is or with a little modification with earlier versions of the
specification:
- There is information on each extension description describing the use of the extension with other FHIR Versions
- A very few extensions can't be used in earlier versions
- There are packages for use with older versions with tooling based packages:
hl7.fhir.uv.extensions.r4
and hl7.fhir.uv.extensions.r3
- The version of the Extensions Pack (5.3.0-ballot) is not the same as the FHIR version, since it applies equally to
FHIR versions R5, R4, R4B, and R3
Note to Balloters
This is the ballot for release 5.3.0 of the Extension Pack. While comment is welcome on all extensions,
please pay particular consideration to the following matters:
- New Extensions: Profile Mapping Extension, Operation Synchronicity Control, CodeSystem Global LangPack, DetectedIssue Dose Type, Device ConformsTo, Device Endpoint, Device Gateway, Device Operation Cycle, Device Operation Duration, Device Operation Mode, DiagnosticReport Interpretation Context, EvidenceVariableHandlingDetail, Medication Manufacturer, Medication Type, Text Link, Observation Structure Laterality, PractitionerRole Doing Business As, Questionnaire Index Answer, ResearchStudy Interventionalist Recruitment, ResearchStudy Investigator Recruitment, Additional Language, Artifact Extended Contact Detail, Web Source, ServiceRequest Specimen Suggestion, Additional Resource Compartment, Inherit Obligations, Intended Context, Obligation Profile Flag, Previous Delivery, ValueSet Expansion Parameter, ContactPoint Multiple Use, Related Requirement, DataType Short String, Element Source, Identifier Jurisdiction, Narrative Language Control, Narrative Source Control, Preferred Value Alternatives, Time Precision, Publication Date, Complies With Canonical, Library Alias, Device Alert Detection Extension, Quantity Accuracy, Quantity Confidence Interval, Questionnaire Support Hyperlink, RelatesTo Classifier and Workflow Status Reason
- Removed Extensions: (none)
- Changed Extensions: You can see which extensions have changed by looking in the Δ v5.2.0 column on right of the Extension Summary Table. Unfortunately, the change list has grown to include most extension courtesy of addressing QA issues in the extension pack in this ballot
- Deprecated Extensions: There are 108 deprecated extensions: see the deprecated Extensions page. Balloters might want to pay particular attention to this list - there has been some lack of clarity about whether extensions should be deprecated when elements are added to resources in R5/6
- The conversion maps have been removed from this release - they have moved to the cross-extensions publications
- A significant new feature in this release is that extensions are transformed to R4 and R3 versions, so that the
extension definitions found in the .r4 and .r3 packages fully valid. This involve: making sure that appropriate
CodeSystem and ValueSet resources are included, and using sets of extensions in place of data types defined in
later versions. A summary of this work is provided.
The FHIR Management Group recognizes the difficulty of balloting the extensions pack
for the community. The Extensions Pack ballot serves as a checkpoint for the continuous
development of the Extension pack content prior to publishing the normal formal milestone,
and is an opportunity for the community to review and comment on Extensions of interest.
Given that there are 680
extensions that span the entire span of the FHIR implementation
space, there is no expectation that ballot reviewers will be able to review all the
resources. For this reason, ballot cycles of the extensions pack do not contribute towards
extension maturity after the first ballot. There are, however, several structural
enhancements aimed at addressing extension use tracking and useability:
Content Registries
Update Policy
Extensions
References to the extensions defined in this extension pack are found in Extension.url
or in profile references to defined extensions in ElementDefinition.type.profile.
While the profile references may be versioned using canonical versioned references,
the most important references are in Extension.url
and these are version-less.
For this reason, the extensions defined in this extension pack are managed very conservatively with regard to
breaking changes:
- Extensions that are active are not subject to breaking changes. New extensions will be introduced if necessary
- Extensions labelled 'draft' may have breaking changes if the FHIR Management Group is satisfied that they are not in
use in production, or if all the existing users are agree to making the change. The exact rules and processes still
being discussed, but not all 'draft' extensions are subject to change
- In this regard, the definitions for breaking change to Normative artifacts
apply. Note that the focus of these rules is preserving the validity and meaning of existing extensions, not preventing applications
processing extensions from having to change
- The extensions all have the status of 'trial-use' but once they are active they are treated as normative. The FHIR
Management Group has not yet decided how these extensions will be balloted in the future
- If a breaking change needs to be introduced to an extension, the original extension will be marked as deprecated and a new one will be created. If the scope of the extension has significantly changed, it may be given a completely new URL. If the scope is largely the same, the url will remain the same, except that a version will be appended. E.g. "[original url]-v2". The deprecated extension will have a note added that points to the replacing extension.
For more information, see FHIR Extension Pack Policy.
Intellectual Property Considerations
This implementation guide and the underlying FHIR specification are licensed as public domain under the FHIR license. The
license page also describes rules for the use of the FHIR name and logo.
This guide includes extensions making use of terminologies such
as LOINC and SNOMED CT that have more restrictive licensing requirements. Implementers should make themselves familiar with licensing and
any other constraints of terminologies used as part of their implementation process.
Licencing requirements may limit the systems to which data recorded using certain codes may be shared.
This publication includes IP covered under the following statements.
- IEEE maintains copyright on all content from IEEE 11073 standards. All rights reserved. Implementers should obtain official copies of all applicable standards documents directly from IEEE. The inclusion of IEEE 11073 terminology codes and definitions in HL7 messages and related implementation guides is permitted under existing agreements. For permission regarding any other usage, please contact IEEE at copyrights@ieee.org.
Show Usage
- 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
- Public domain
Show Usage
- 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
- These codes are excerpted from ASTM Standard, E1762-95(2013) - Standard Guide for Electronic Authentication of Health Care Information, Copyright by ASTM International, 100 Barr Harbor Drive, West Conshohocken, PA 19428. Copies of this standard are available through the ASTM Web Site at www.astm.org.
Show Usage
- These codes are excerpted from Digital Imaging and Communications in Medicine (DICOM) Standard, Part 16: Content Mapping Resource, Copyright © 2011 by the National Electrical Manufacturers Association.
Show Usage
- These codes are excerpted from ETSI Standard for Digital Signatures and XAdES, Copyright by ETSI International. Copies of this standard are available through the ETSI Web Site at www.etsi.org.
Show Usage
- 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.
Show Usage
- 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
- 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®): AILocation, AISubstanceExposureRisk... Show 38 more, AnimalBreeds, AnimalSpecies, BDPManipulation, BDPProcessing, Barrier, BestPractice, ConditionCauseCodes, ConditionCourseCodes, ConditionDiseaseCourse, ConditionDueTo, ConditionOccurredFollowing, ConditionOutcome, ConditionPredecessorCodes, DataElementSDCObjectClass, DataElementSDCObjectClassProperty, DeviceGateway, FMHSeverity, FeedingDeviceCodes, FocalSubjectCodes, MedicationType, MedicationTypeVS, NttAdaptiveFeedingDevice, ObjectClass, ObjectClassProperty, ObsDeviceCode, ObsFocusCode, PGenderIdentity, PRAnimalSpecies, PatAnimal, PatSexParameterForClinicalUse, ProtectiveFactor, ReasonCode, SpecimenAdditive, SpecimenAdditiveSubstanceCodes, StructureLaterality, StructureLateralityValueSet, WorkflowBarrier and WorkflowReason
- 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
- 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
Dependencies
This IG depends on the following additional IGs:
There are no Global profiles defined