This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions
Page standards status: Informative |
Many of the extensions in this Extension Pack are deprecated. Deprecating an extension means two things for implementers:
Extensions are deprecated in this Extensions for multiple reasons. THe most common reason is because many of the extensions were added very early in the process, and HL7 has tightened up it's review and management of the extensions, and many are being withdrawn due to the increase in quality requirements. Others extensions have been deprecated because:
This last is actually a problem - such extensions are still valid and required in earlier versions, and should not be deprecated. HL7 is reviewing the deprecated extensions as of the ballot for 5.3.0 and some of the extensions will be brought back to life, marked for use with the appropriate versions.
It is possible that an extension defined for use in a particular FHIR release (e.g. R4) could be superseded by the introduction of that same functionality in a future version of FHIR (e.g. R5) and an automatic inter-version extension becoming available with the publication of that newer release. There are some guidelines to follow in this situation:
Such an IG SHOULD allow both the old extension and the new inter-version extension to be transmitted for a period of time for compatibility reasons and to reduce the pain of the breaking change.
The following guidelines apply for managing extensions:
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="deprecated">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status-reason">
<valueMarkdown value="Replaced by <a href="StructureDefinition-datatype-short-string.html">DataType Short String</a>"/>
</extension>
</valueCode>
</extension>
<context>
<extension url="http://hl7.org/fhir/StructureDefinition/version-specific-use">
<extension url="endFhirVersion">
<valueCode value="4.3"/>
</extension>
</extension>
<type value="element"/>
<expression value="CodeSystem"/>
</context>
Resource | Change | Status | Reason | Description |
Artifact Canonical Reference (StructureDefinition) | newly deprecated | retired |
DEPRECATED: A reference to a canonical resource. |
|
Artifact Reference (StructureDefinition) | newly deprecated | retired |
DEPRECATED: A reference to a resource, canonical resource, or non-FHIR resource. |
|
Candidate List (StructureDefinition) | newly deprecated | retired |
The list of candidates that perform a task is now achieved by using Task.requestedPerformer and this element can be implemented using the cross version extension mechanism (i.e., the extension is no longer needed). |
Identifies the individuals who are candidates for being the owner of the task. The list of candidates that perform a task is now achieved by using Task.requestedPerformer and this element can be implemented using the cross version extension mechanism (i.e., the extension is no longer needed). |
CanonicalResource Short Description (StructureDefinition) | newly deprecated | retired |
Replaced by DataType Short String |
A single paragraph plain string short description alternative to CanonicalResource.description for display in lists etc. |
CodeSystem History (StructureDefinition) | newly deprecated | retired |
This extension is retired. Recording history of a value set definition should be done using provenance instead |
Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes. This extension is retired. Recording history of a value set definition should be done using provenance instead. |
DiagnosticReport Addendum Of (StructureDefinition) | newly deprecated | retired |
This extension has been replaced by DiagnosticReport.relatesTo element in R6. |
The supplements or provides additional information for the target report. |
DiagnosticReport Extends (StructureDefinition) | newly deprecated | retired |
This extension has been replaced by DiagnosticReport.relatesTo element in R6. |
The report references related ("sibling") reports. |
DiagnosticReport Location Performed (StructureDefinition) | newly deprecated | retired |
This extension is deprecated. The DiagnosticReport Location Performed is same as Event Location extension |
This extension is deprecated. The DiagnosticReport Location Performed is same as Event Location extension. Old description: Facility location where this report was prepared. |
DiagnosticReport Replaces (StructureDefinition) | newly deprecated | retired |
This extension has been replaced by DiagnosticReport.relatesTo element in R6. |
The report replaces the target resource. For example, when a final anatomic pathology report replaces a preliminary anatomic pathology report replaces where the subsequent observation of case and report may be on more or different material (specimen). Note that this is not same concept as |
OAuth URIs (StructureDefinition) | newly deprecated | retired |
This is now handled with the .well-known/smart-configuration JSON file. |
Supports automated discovery of OAuth2 endpoints. |
Observation Delta (StructureDefinition) | newly deprecated | retired |
Shall be handled using a different mechanism. See Observation Notes for more information. |
The qualitative change in the value relative to the previous measurement. Usually only recorded if the change is clinically significant. Note: To perform a delta check one can instantiate a new observation (the comparison observation) with derivedFrom populated with references to the two prior Observations that triggered the delta check. Also, the Observation.interpretation of the comparison Observation has the code of the interpretation of the delta check. |
Observation Focal Subject Code (StructureDefinition) | newly deprecated | retired |
This extension is deprecated. There are alternate ways to represent this information through the use of Observation.focus and the elements of the referenced Resource |
This extension is deprecated. There are alternate ways to represent this information through the use of Observation.focus and the elements of the referenced Resource. Old description: A code representing the focus of an observation when the focus is not the patient of record. In other words, the focus of the observation is different from |
Observation Gateway Device (StructureDefinition) | newly deprecated | retired |
Use Device Gateway (device-gateway) extension which allows codeableReference (Device) in R6 and requires cross version extension for codeable reference. |
To be used when the actual gateway used at the time of the observation, and the referenced device is also specified. The gateway device may be acting as a communication/data collector, translator or controller; This extension is useful when there is more than one gateway device, for example, where there are apps on a phone and each are a device, and more than one app is used to pass on the data to a FHIR Server. In that case you need to be able to say from the observation which specific app was used to act as gateway. Note that the Provenance/AuditEvent resources can represent the same information. Use Device Gateway (device-gateway) extension which allows codeableReference (Device) in R6 and requires cross version extension for codeable reference. |
Observation Specimen Code (StructureDefinition) | newly deprecated | retired |
Given the ability to use the referenced Specimen resource to represent just a code, this extension is deprecated |
A code representing the the type of specimen used for this observation. Should only be used if not implicit in the code found in |
Operation Synchronicity Control (StructureDefinition) | newly deprecated | retired |
This is no longer relevant for R6 due to a matching element in R6 |
Indicates that an operation or interaction must always be handled as synchronous or asynchronous, or that the server must or does provide both, and clients can choose |
Patient Disability (StructureDefinition) | newly deprecated | retired | ||
Questionnaire Support Link (StructureDefinition) | newly deprecated | retired |
This extension has been deprecated in favor of Questionnaire Support Hyperlink , which allows display text to accompany each support link. This extension only conveyed the URI, making it unclear to users what each link referred to. |
A URL that resolves to additional supporting information or guidance related to the question. If there's more than one repetition of this extension, all a UI can do to help the user differentiate which to click on is displaying the URI (e.g. as a flyover). If displaying the URI might not be appropriate or helpful, it may be more useful to use a nested 'display' item of type 'helpText' which can then specify multiple hyperlinks with appropriate labels and/or surrounding guidance text. This extension has been deprecated in favor of |
ServiceRequest Precondition (StructureDefinition) | newly deprecated | retired |
Replaced by DiagnosticReport Interpretation Context |
The condition or state of the patient, prior or during the diagnostic procedure or test, for example, fasting, at-rest, or post-operative. This captures circumstances that may influence the measured value and have bearing on the interpretation of the result. |
ValueSet Expansion Source (StructureDefinition) | newly deprecated | retired |
ValueSet.url should be used instead of this extension |
The logical URL of the ValueSet definition that was used to generate this expansion. ValueSet.url should be used instead of this extension. |
ValueSet Unclosed (StructureDefinition) | newly deprecated | retired |
Unknown Reason |
Marks that the expansion is incomplete, and values other than those listed may be valid. This may be used when technical limitations prevent a full expansion, or when post-coordinated codes are allowed, and no complete expansion can be produced. This extension SHALL only be used when the client specifies that it will recognize and process an incomplete expansion. If the client has not specified it will recognize and process an incomplete expansion, the server SHALL return an error. |
ValueSet workflow (SearchParameter) | newly deprecated | retired |
The extension this search parameter refers to is also deprecated |
Optional Extensions Element |
Valueset Trusted Expansion (StructureDefinition) | newly deprecated | retired |
A trusted expansion makes no sense in the context of a code system |
A trusted FHIR terminology server endpoint (the [base] url of the FHIR server) where an expansion of the valueset may be performed. |
CodeSystem ConceptOrder (StructureDefinition) | un-deprecated | active |
Identifies the relative order in which concepts within the value set should be presented to a user. In R6+, the order property is used in place of this extension. |
|
Relative Date Criteria (StructureDefinition) | un-deprecated | active |
Specifies that a date is relative to some event. The event happens [Duration] after [Event]. |
|
ValueSet Concept Definition (StructureDefinition) | un-deprecated | active |
A definition that describes the meaning of this code when used as part of this value set. Use of this extension SHALL NOT result in a definition for a concept that changes the meaning of the concept as described in the code system. This SHALL only be used to further clarify or provide additional nuances to the meaning. |
|
Activity Status Date (StructureDefinition) | no change | retired |
The status of this extension is unclear, and it's being reviewed |
The date when the associated Value Set Definition Version activity status is in effect. |
Allele (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Allele information. |
Allele Database (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Allele Database. |
AllergyIntolerance AssertedDate (StructureDefinition) | no change | retired |
This extension is deprecated and replaced by condition-assertedDate extension |
The date on which the existence of the AllergyIntolerance was first asserted or acknowledged. This extension is deprecated and replaced by condition-assertedDate extension. |
AllergyIntolerance Resolution Age (StructureDefinition) | no change | retired |
This extension is deprecated and replaced by allergyintolerance-abatement |
The estimated patient age at which the allergy or intolerance resolved. Should be specified only if the status is resolved. This extension is deprecated and replaced by allergyintolerance-abatement. |
Amino Acid Change (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
AminoAcidChange information. |
An IANA timezone code for the timezone offset per BCP 175 (StructureDefinition) | no change | retired |
Replaced by Timezone Code |
An IANA timezone code for the timezone offset per BCP 175 . The offset is specified as part of a dateTime/instant (or using the tzOffset extension on a date if necessary). The timezone code may also be provided to allow for human display of the location associated with the offset. |
Analysis (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Knowledge-based comments on the effect of the sequence on patient's condition/medication reaction. |
Ancestry (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Ancestry information. |
Assessed Condition (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Used to denote condition context for genetic testing, which may influence reported variants and interpretation for large genomic testing panels e.g. lung cancer or familial breast cancer. |
CapabilityStatement WebSocket (StructureDefinition) | no change | retired |
This extension is deprecated because it's poorly defined and is also over-constrained to just 1 occurrence. If there is a need for an extension like this as a common extension, please submit a change request and we will create one that is better defined, clear about its purpose, and has an appropriate cardinality |
Where the server provides its web socket end-point. Note: this extension is deprecated because it's poorly defined and is also over-constrained to just 1 occurrence. If there is a need for an extension like this as a common extension, please submit a change request and we will create one that is better defined, clear about its purpose, and has an appropriate cardinality. |
Code System Author (StructureDefinition) | no change | retired |
Replaced by the extension Artifact Author prior to R5, and the element CodeSystem in R5 |
User or Org actually involved in creating the value set content. |
Code System EffectiveDate (StructureDefinition) | no change | retired |
Replaced by the extension Artifact Effective Period prior to R5, and the element CodeSystem in R5 |
This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date. |
CodeSystem Authoritative Source (StructureDefinition) | no change | retired |
This extension has been deprecated due to being poorly defined. |
A reference to the authoritative, human readable, source of truth for the code system information. This extension has been deprecated due to being poorly defined. External code system information can be found in THO or the relevant HTA confluence pages. |
CodeSystem Expiration Date (StructureDefinition) | no change | retired |
Replaced by the extension Artifact Effective Period prior to R5, and the element CodeSystem in R5 |
The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date. |
CodeSystem KeyWord (StructureDefinition) | no change | retired |
This extension is deprecated, use the CodeSystem.topic element instead |
Word or words used in an information retrieval system to indicate the content of the code system. |
CodeSystem Other Name (StructureDefinition) | no change | retired |
This extension has been deprecated in favor of the new relative-time extension. |
This extension has been deprecated. |
CodeSystem Source Reference (StructureDefinition) | no change | retired |
This extension has been deprecated as it is poorly defined and does not appear to make sense in the context of a codesystem |
This text is intended to act as a citation to work done elsewhere that is not part of the current stewarding process where the referenced source is in some way a basis of the current value set definition. This extension has been retired as it is poorly defined and does not appear to make sense in the context of a codesystem. |
CodeSystem Use Markdown (StructureDefinition) | no change | retired |
This extension is deprecated as the Terminology Infrastructure work group felt there wasn't a use case for the extension |
If true, the definitions of the concepts should be treated and rendered as markdown for improved presentation. This extension is deprecated as the Terminology Infrastructure work group felt there wasn't a use case for the extension. |
CodeSystem Workflow Status (StructureDefinition) | no change | retired |
This extension has been deprecated as it is an erroneous duplicate of valueset-workflowStatusDesription. |
Workflow Status is used to represent details of the value set development process while the value set has an Activity Status of Preliminary. The development of a value set often follows a formal workflow process from initiation to completion, and this element carries the state variable for this state machine. The assumption is that when first created a value set would have a workflow state of Draft. Additional workflow states may be used. This extension has been deprecated as it is an erroneous duplicate of valueset-workflowStatusDesription. |
Composition Other Confidentiality (StructureDefinition) | no change | retired |
Use Bundle.meta.security instead |
Carries additional confidentiality codes beyond the base fixed code specified in the CDA document. |
Composition Version Number (StructureDefinition) | no change | retired |
This extension is deprecated because since R5 Composition has a version element which should be used instead |
Version specific identifier for the composition, assigned when each version is created/updated. Note: this extension is deprecated because since R5 Composition has a version element which should be used instead. |
Confidential (StructureDefinition) | no change | retired |
This extension is deprecated, use the Inline-sec-label extension instead. The Inline-sec-label extension is generic and useable anywhere and has significant guidance around its use in the defining DS4P Implementation Guide |
Expresses the access policy associated with the element. |
Copy Number Event (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
A variation that increases or decreases the copy number of a given region ( SO:0001019 ). Values: amplification/deletion/LOH. |
DNARegionName (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
A human readable name for the region of interest. Typically Exon #, Intron # or other. NOTE: This is not standardized and is mainly for convenience and display purposes. LOINC Code: ( 47999-8 ). |
Dependent Profiles (StructureDefinition) | no change | retired |
Replaced by StructureDefinition Imposes Profile |
Instances can only be valid against this StructureDefinition, if they also sucessfully validate against the dependent profile identified in this extension. |
Deprecated (StructureDefinition) | no change | retired |
Replaced by StructureDefinition Standards Status |
If true, indicates that the concept is deprecated from the value set - that is, it should not be used, and is planned to be withdrawn. |
Encounter type (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
The type of the encounter. DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
Family Member History (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Significant health events and conditions for a person related to the patient relevant in the context of care for the patient. |
GLString (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
glstring. |
Gender Identity (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Gender Harmony Guide |
The gender the patient identifies with. The Patient's gender identity is used as guidance (e.g. for staff) about how to interact with the patient. |
Gene (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
A region (or regions) that includes all of the sequence elements necessary to encode a functional transcript. A gene may include regulatory regions, transcribed regions and/or other functional sequence regions ( SO:0000704 ). This element is the official gene symbol approved by the HGNC, which is a short abbreviated form of the gene name ( HGNC ). LOINC Code: ( 48018-6 ). |
Genomic Source Class (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Source of sample used to determine the sequence in sequencing lab -- germline, somatic, prenatal. LOINC Code: ( 48002-0 ). |
Genotyping Method (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
The platform, methodology and software applied at the time of the genotyping. |
Goal Reason Rejected (StructureDefinition) | no change | retired |
This extension is deprecated and replaced by Goal.statusReason |
The reason the goal was not accepted. Applies only if the status of the goal is rejected. This extension is deprecated and replaced by Goal.statusReason. |
Goal acceptance (StructureDefinition) | no change | retired |
This acceptance extension was elevated to the base Goal resource. |
Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders. This acceptance extension was elevated to the base Goal resource. |
Haploid (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
haploid. |
Identifier (StructureDefinition) | no change | retired |
Use either ElementDefinition.code or ElementDefinition.mapping to provide the mapping instead |
External Identifiers associated with this element - these are identifiers that are associated with the concept this element represents. DEPRECATED: Use either ElementDefinition.code or ElementDefinition.mapping to provide the mapping instead |
Initiating organization (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
The organization initiating the request. DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
Instantiates Canonical (StructureDefinition) | no change | retired |
Replaced by Generated from , Complies with or adheres to |
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by the event or request resource. |
Instantiates Uri (StructureDefinition) | no change | retired |
Replaced by Generated from , Complies with or adheres to |
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by the event or request resource. |
Interpretation (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Clinical Interpretations for variant. It's a reference to an Observation resource. |
Item (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested. |
Max value set (StructureDefinition) | no change | retired |
Use additionalBinding extension or element instead |
This acts as an overall 'required' binding for an element that already has a less restrictive binding. It is used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set that the codes must be drawn from is 'infinite'. The the base less restrictive binding SHALL be a proper subset of the max binding valueset. In most cases, this extension is used where the base binding is 'extensible'. DEPRECATED: Use additionalBinding extension or element instead |
Min value set (StructureDefinition) | no change | retired |
Use additionalBinding extension or element instead |
The minimum allowable value set, for use when the binding strength is 'required' or 'extensible'. This value set is the minimum value set that any conformant system SHALL support. DEPRECATED: Use additionalBinding extension or element instead |
Namespace (StructureDefinition) | no change | retired |
Replaced by Namespace |
Use this extension to indicate tha the element has an XML namespace different to http://hl7.org/fhir. |
No Order in XML (StructureDefinition) | no change | retired |
Replaced by No Order in XML |
Whether elements can come in any order in XML. |
Ordinal Value (StructureDefinition) | no change | retired |
Replaced by Item Weight |
A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. |
PQ Translation (StructureDefinition) | no change | retired |
Replaced by Quantity Translation |
An alternative representation of the same physical quantity expressed in a different unit from a different unit code system and possibly with a different value. |
Patient Born Status (StructureDefinition) | no change | retired |
This extension is deprecated and replaced by patient-fetalStatus extension |
The living/delivery status of the fetus (patient). This extension is deprecated and replaced by patient-fetalStatus extension. |
Phase Set (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Phase set information. |
Preferred (StructureDefinition) | no change | retired |
Use rank element or extension instead |
Flag denoting whether parent item is preferred - e.g., a preferred address or telephone number. DEPRECATED: Use rank element or extension instead |
Questionnaire Constraint (StructureDefinition) | no change | retired |
Use the |
DEPRECATED: Use the |
Reason Code (StructureDefinition) | no change | retired |
Replaced by Workflow Reason |
Describes why the event occurred in coded or textual form. |
Reason Reference (StructureDefinition) | no change | retired |
Replaced by Workflow Reason |
Indicates another resource whose existence justifies this event. |
Receiving organization (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
The organization that will receive the response. DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
Receiving person (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
The person in the receiving organization that will receive the response. DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
Recipient language (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
Preferred language of the person that will consume the content. DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
Recipient type (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
The type of individual that will consume the response content. This may be different from the requesting user type (e.g. if a clinician is getting disease management guidance for provision to a patient). E.g. patient, healthcare provider or specific type of healthcare provider (physician, nurse, etc.). DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
ReferenceFilter (StructureDefinition) | no change | retired |
This extension has been replaced by the Structured Data Capture candidateExpression extension |
Identifies a filter to apply when looking up candidate answers for the question. DEPRECATED: This extension has been replaced by the Structured Data Capture candidateExpression extension. |
References (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Additional bibliographic reference information about genetics, medications, clinical trials, etc. associated with knowledge-based information on genetics/genetic condition. |
Regex (StructureDefinition) | no change | retired |
This was deprecated in favor of using a constraint on the element using FHIRPath, since constraints allow for the provision of a human readable message associated with the regex |
A regular expression that defines the syntax for the data element to be considered valid. |
Relative date time (StructureDefinition) | no change | retired |
This extension has been deprecated in favor of the new relative-time extension. |
A date/time value that is determined based on a duration offset from a target event. DEPRECATED: This extension has been deprecated in favor of the new relative-time extension. |
SC Coding (StructureDefinition) | no change | retired |
Replaced by Coded string |
Provides a coded expression for the content represented in a string. |
Selector (StructureDefinition) | no change | retired |
This was never used. The relevant FHIRPath is automatically calculated by the tooling |
A FHIRPath statement that defines whether an element is in the slice. DEPRECATED: This was never used. The relevant FHIRPath is automatically calculated by the tooling. |
Specimen Processing Time (StructureDefinition) | no change | retired |
This is no longer relevant for R6 due to a matching element in R6 |
Period or duration of processing. This is no longer relevant for R6 due to a matching element in R6. This extension is now deprecated. |
System user language (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
Preferred language of the person using the system. DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
System user task context (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning |
The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources. DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
System user type (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.). DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
Target invariant (StructureDefinition) | no change | retired |
Use the |
DEPRECATED: Use the |
Uncertain date (StructureDefinition) | no change | retired |
Use uncertainPeriod instead. |
When present, this extension indicates that the date of a period start or end is uncertain and falls within its own period. DEPRECATED: use uncertainPeriod instead. |
Value Set Author (StructureDefinition) | no change | retired |
Replaced by the extension Artifact Author prior to R5, and the element ValueSet in R5 |
The entity or set of entities that create and may modify the Value Set Definition content. The name of a group or an individual, along with contact details. |
Value Set Effective Date (StructureDefinition) | no change | retired |
Replaced by the extension Artifact Effective Period prior to R5, and the element ValueSet in R5 |
This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date. |
ValueSet Expand Group (StructureDefinition) | no change | retired |
This extension is deprecated because it was underspecified and experience showed it was not usable. No replacement is planned |
This extension declares a group of concepts that is generated into the ValueSet.expansion.contains hierarchy when the expansion is generated for a UI. THere is no inherent assigned meaning to the hierarchy; it is used to help the user navigate the concepts. Each group has a display and/or a code, and a list of members, which are either concepts in the value set, or other groups (by code). |
ValueSet Expand Rules (StructureDefinition) | no change | retired |
This extension is deprecated because it was underspecified and experience showed it was not usable. No replacement is planned |
Defines how concepts are processed into the expansion when it's for UI presentation. |
ValueSet Expiration Date (StructureDefinition) | no change | retired |
Replaced by the extension Artifact Effective Period prior to R5, and the element ValueSet in R5 |
The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value SHALL present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date. |
ValueSet Include ValueSet Title (StructureDefinition) | no change | retired |
Replaced by DataType Short String |
Human readable name for the included Value Set. This extension is deprecated. Please use https://hl7.org/fhir/extensions/StructureDefinition-display.html to provide a value set title in a value set definition. |
ValueSet Keyword (StructureDefinition) | no change | retired |
This extension is deprecated, use the topic element of the CodeSystem resource instead. |
Word or words used in an information retrieval system to indicate the content of the value set. |
ValueSet Other Name (StructureDefinition) | no change | retired |
This extension is deprecated. The valueset-otherTitle extension should be used to provide other titles instead of this extension |
Natural language names identifying the value set. These names should be usable as an identifier for the module by machine processing applications such as code generation. This extension is deprecated. The valueset-otherTitle extension should be used to provide other titles instead of this extension. |
ValueSet Special Status (StructureDefinition) | no change | retired |
This extension is deprecated as Terminology Infrastructure was unable to determine a use for it |
A special note for implementers about the status of the resource. This extension is deprecated as Terminology Infrastructure was unable to determine a use for it. |
ValueSet Steward (StructureDefinition) | no change | retired |
Use ValueSet.publisher instead |
The entity that is responsible for the content of the Value Set Definition. This is a textual description of the organizational entity responsible for the content and maintenance. |
ValueSet System Name (StructureDefinition) | no change | retired |
This extension is deprecated. Please use https://hl7.org/fhir/extensions/StructureDefinition-display.html to provide a code system name in a value set definition |
The human-readable name for the code system. This extension is deprecated. Please use https://hl7.org/fhir/extensions/StructureDefinition-display.html to provide a code system name in a value set definition. |
ValueSet Workflow Status (StructureDefinition) | no change | retired |
Replaced by Workflow Status Description |
Workflow Status is used to represent details of the value set development process while in a single Activity Status. |
Valueset Too Costly (Expansion Truncated) (StructureDefinition) | no change | retired |
Marks that the expansion is incomplete, because the full value set is too large to represent, and the client asked for an incomplete fragment. Used in STU3 and earlier terminology services. The information it provides should be communicated with operation outcome code = too-costly by a terminology server based on a more recent FHIR version. |
|
Variant (StructureDefinition) | no change | retired |
This extension has been replaced by the profiles and extensions defined in the Genomics Reporting Guide |
Variant information. |
born status code system (CodeSystem) | no change | retired |
This CodeSystem is deprecated and replaced by patient-fetalstatus CodeSystem |
This birth status of a patient. This CodeSystem is deprecated and replaced by patient-fetalstatus CodeSystem. |
born status value set (ValueSet) | no change | retired |
Replaced by DataType Short String |
This birth status of a patient. This ValueSet is deprecated and replaced by patient-fetalstatus ValueSet. |
encounter class (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
The class of encounter (inpatient, outpatient, etc.). DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
initiating person (StructureDefinition) | no change | retired |
This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |
The person initiating the request. DEPRECATED: This extension was initially used to model decision support context. This information is now handled as part of CDS Hooks and Clinical Reasoning. |