Skip to content
Open
2 changes: 1 addition & 1 deletion source/capabilitystatement/capabilitystatement-notes.xml
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ For a discussion of the use of these two types of resources, see <a href="profil
<a name="additional"> </a>
<h3>Using additional resources in CapabilityStatements</h3>
<p>
CapabilityStatements may represent the use of <a href="resource.html#additional">additional resource</a>.
CapabilityStatements may represent the use of <a href="resource.html#additional">additional resources</a>.
When doing so, <code>CapabilityStatement.rest.resource.type</code> contains the type of the resource
as defined in the <a href="https://chat.fhir.org/#narrow/channel/491058-Additional-Resource-Proposals">HL7 registry</a>,
along with a reference to the definition of the resource in <code>CapabilityStatement.rest.resource.definition</code>.
Expand Down
2 changes: 1 addition & 1 deletion source/consent/consent-event-mapping-exceptions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
<resource value="Date the consent instance was agreed to."/>
</definitionUnmatched>
<commentsUnmatched reason="Unknown">
<_pattern value="This indicates when the activity actually occurred or is occurring, not when it was asked/requested/ordered to occur. For the latter, look at the occurrence element of the Request this {{event}} is &quot;basedOn&quot;. The status code allows differentiation of whether the timing reflects a historic event or an ongoing event. Ongoing events should not include an upper bound in the Period or Timing.bounds.&#10;."/>
<_pattern value="This indicates when the activity actually occurred or is occurring, not when it was asked/requested/ordered to occur. For the latter, look at the occurence element of the Request this {{event}} is &quot;basedOn&quot;. The status code allows differentiation of whether the timing reflects a historic event or an ongoing event. Ongoing events should not include an upper bound in the Period or Timing.bounds.&#10;."/>
<resource value=""/>
</commentsUnmatched>
</divergentElement>
Expand Down
19 changes: 7 additions & 12 deletions source/references.html
Original file line number Diff line number Diff line change
Expand Up @@ -313,22 +313,17 @@ <h3>Additional References</h3>
don't even exist in the version of FHIR being used, in which case the target would be a Basic
instance using the <a href="versions.html#extensions">inter-version conversion rules</a>.</li>
<li>An <a href="resource.html#additional">additional resource</a> has been defined that is a logical target for the element. Core elements
aren't permitted to have resource targets that are additional resources, though profiles might
wish to allow pointing to them.</li>
aren't permitted to have resource targets that are additional resources. When defining additional resources, the
<a href="[%extensions-location%]StructureDefinition-additional-resource-reference-target.html">additional-resource-reference-target</a>
extension allows the relevant work group to indicate and approve that a core element (or another additional resource)
may refer to the resource. This allows the use of normal <code>Reference.reference</code> in deployments where both
the core and additional resource definitions are in scope.</li>
</ul>
<p>
In both of these cases, the solution is to use the <a href="https://hl7.org/fhir/extensions/5.3.0-ballot-tc1/StructureDefinition-alternate-reference.html">alternate-reference</a> extension. It allows
referencing any type of resource - including additional resources. The targetProfile used when
profiling this extension is free to point to a narrower profile than a resource - e.g., a specific
When the approach mentioned above does not apply, the solution is to use the <a href="https://hl7.org/fhir/extensions/5.3.0-ballot-tc1/StructureDefinition-alternate-reference.html">alternate-reference</a> extension.
The targetProfile used when profiling the extension is free to point to a narrower profile than a resource - e.g., a specific
inter-version resource profile on Basic.
</p>
<p>
In some cases, an additional resource may migrate to be a core resource and become allowed as a
target resource. Systems that have not yet updated to support that new core resource may
struggle with the migration of the reference from the <code>additional-reference</code> to the standard
<code>Reference.reference</code> element. Communication partners will need to manage this transition."
</p>

<a name="canonical"></a>
<h3>Canonical URLs</h3>
<p>
Expand Down
5 changes: 3 additions & 2 deletions source/resource/resource-introduction.xml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Note: there is documentation for the <a href="formats.html">Structure</a>, <a hr
</p>

<a name="additional"></a>
<h3>Additional Resources defined Outside This Specification</h3>
<h3>Additional Resources Defined Outside This Specification</h3>
<p>
This specification defines the base <%res-type-count%> resources that comprise
the "FHIR resources". Additional resources may be defined in other specifications,
Expand All @@ -56,7 +56,7 @@ other resources, or find that they need to, the following rules apply:
<ul>
<li>Additional Resources to be used like this SHALL be registered with HL7</li>
<li>Unapproved resources SHALL NOT be used</li>
<li>Registered and approved resources are given a name by HL7, and this is the name that must be used for the resource</li>
<li>Registered and approved resources are given a name by HL7, and this is the name that SHALL be used for the resource</li>
<li>All such registered and approved resources SHALL have a publicly available definition using a <a href="structuredefinition.html">StructureDefinition</a>
published as part of an <a href="implementationguide.html">ImplementationGuide</a>, published at the canonical URL. Note that the definitions will be reviewed for quality by HL7 prior to approval</li>
</ul>
Expand All @@ -78,6 +78,7 @@ encountered through this specification:
<li><a href="domainresource.html#additional">DomainResource.contained</a></li>
<li><a href="parameters.html#additional">Parameters.parameter.resource</a></li>
</ul>
<p>The introduction of 'custom' resource not defined through the process documented here is not conformant with the FHIR specification. Instances communicating resources not defined in this core specification or via the additional resources registration process cannot be called FHIR conformant.</p>

<a name="moving"></a>
<h3>Moving Additional Resources to FHIR Core</h3>
Expand Down
4 changes: 4 additions & 0 deletions source/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -3255,6 +3255,10 @@ <h4>reference</h4>
SHOULD match instances that match the reference in it contains a versioned reference.</span></li>
</ul>
</p>
<p>
Instead of <code>Reference.reference</code>, some elements might instead contain the <a href="https://hl7.org/fhir/extensions/5.3.0-ballot-tc1/StructureDefinition-alternate-reference.html"><code>additionalReference</code></a> extension.
<span class="fhir-conformance">Systems SHOULD support indexing and searching against content found in this extension as well unless there are constraints in place that ensure that additionalReference is never present.</span>
</p>
<p>
For example, if the base URL of a server is http://example.org/fhir, the search:
<span class="http-search-example">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<url value="http://hl7.org/fhir/build/SearchParameter/SearchParameter-base"/>
<description value="The resource type(s) this search parameter applies to"/>
<code value="base"/>
<type value="token"/>
<type value="uri"/>
<expression value="SearchParameter.base"/>
<processingMode value="normal"/>
</SearchParameter>
Expand Down Expand Up @@ -348,7 +348,7 @@
<url value="http://hl7.org/fhir/build/SearchParameter/SearchParameter-target"/>
<description value="Types of resource (if a resource reference)"/>
<code value="target"/>
<type value="token"/>
<type value="uri"/>
<expression value="SearchParameter.target"/>
<processingMode value="normal"/>
</SearchParameter>
Expand Down
2 changes: 1 addition & 1 deletion source/searchparameter/searchparameter-example.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<purpose value="Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain"/>
<code value="_id"/>
<aliasCode value="logical-id"/>
<base value="Resource"/>
<base value="Patient"/>
<type value="token"/>
<expression value="id"/>
<processingMode value="normal"/>
Expand Down
2 changes: 1 addition & 1 deletion source/searchparameter/searchparameter-filter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@
<description value="This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html)"/>
<purpose value="Support combination searches when the simple name=value basis of search cannot express what is required"/>
<code value="_filter"/>
<base value="Resource"/>
<base value="Patient"/>
<type value="special"/>
</SearchParameter>
12 changes: 6 additions & 6 deletions source/searchparameter/structuredefinition-SearchParameter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -510,16 +510,16 @@
<min value="1"/>
<max value="*"/>
<type>
<code value="code"/>
<code value="uri"/>
</type>
<isSummary value="true"/>
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FHIRTypes"/>
</extension>
<strength value="required"/>
<description value="A type of resource, or a Reference (from all versions)"/>
<valueSet value="http://hl7.org/fhir/ValueSet/version-independent-all-resource-types"/>
<description value="One of the resource types defined as part of this version of FHIR. Note that this includes additional resources, and is not a fixed list"/>
<valueSet value="http://hl7.org/fhir/ValueSet/extended-resource-types"/>
<additional>
<key value="b-sp-1"/>
<purpose value="ui"/>
Expand Down Expand Up @@ -601,15 +601,15 @@
<min value="0"/>
<max value="*"/>
<type>
<code value="code"/>
<code value="uri"/>
</type>
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FHIRTypes"/>
</extension>
<strength value="required"/>
<description value="A type of resource, or a Reference (from all versions)"/>
<valueSet value="http://hl7.org/fhir/ValueSet/version-independent-all-resource-types"/>
<description value="One of the resource types defined as part of this version of FHIR. Note that this includes additional resources, and is not a fixed list"/>
<valueSet value="http://hl7.org/fhir/ValueSet/extended-resource-types"/>
<additional>
<key value="b-sp-2"/>
<purpose value="ui"/>
Expand Down
6 changes: 3 additions & 3 deletions source/structuredefinition/structuredefinition-notes.xml
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ This technique has many uses:
following these rules:
</p>
<ul>
<li>The canonical URL of the definition is in some other canonical space than <code>http://hl7.org/fhir</code></li>
<li>The canonical URL of the definition is in the canonical space <code>http://hl7.org/fhir</code></li>
<li>The fhirVersion SHALL be <code>6.0.0</code> or a subsequent published version of FHIR</li>
<li>The kind SHALL be <code>resource</code></li>
<li>abstract SHALL be <code>false</code></li>
Expand All @@ -252,11 +252,11 @@ Here is an example with other properties removed:
<pre class="json">
{
"resourceType" : "StructureDefinition",
"url" : "http://hl7.org/fhir/uv/sql-on-fhir/StructureDefinition/ViewDefinition",
"url" : "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"fhirVersion" : "6.0.0",
"kind" : "resource",
"abstract" : false,
"type" : "http://hl7.org/fhir/uv/sql-on-fhir/StructureDefinition/ViewDefinition",
"type" : "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/CanonicalResource",
"derivation" : "specialization",
"differential" : {
Expand Down
Loading