Skip to content

CapabilityStatement ticket implementations #4129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bvdh wants to merge 10 commits into
base: master
Choose a base branch
from
Open

CapabilityStatement ticket implementations #4129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
adbf0a4
FHIR-54053: Remove obsolete CapabilityStatement messaging rules note
bvdh Jun 5, 2026
bd58d79
FHIR-54057: Deprecate conditional CapabilityStatement fields
bvdh Jun 5, 2026
c3ecab1
FHIR-55150: Clarify CapabilityStatement.kind fallback guidance
bvdh Jun 5, 2026
d1a4323
build artifacts
bvdh Jun 5, 2026
8cdfe69
FHIR-55151: Clarify version-independent fhirVersion binding
bvdh Jun 5, 2026
6d4a2a3
FHIR-55154: Add other to type REST interaction binding
bvdh Jun 5, 2026
806425a
FHIR-55155: Clarify searchParam.type down-conversion guidance
bvdh Jun 5, 2026
d61f3d1
FHIR-55156: Add other to system REST interactions
bvdh Jun 5, 2026
7136b6c
FHIR-51160: Correct rest.searchParam comment wording
bvdh Jun 5, 2026
962b301
Merge branch 'HL7:master' into CapabilityStatement
bvdh Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions source/capabilitystatement/capabilitystatement-notes.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,6 @@ Notes:
<li>Resource Types or operations that are not listed are not supported</li>
</ul>
</li>
<li>Messaging CapabilityStatement rules:
<ul class="dense">
<li>The interpretation of request and response depends on the mode. If the mode is sender,
then request specifies what the application sends, and response specifies what it accepts.
If the mode is "receiver", then this is reversed</li>
<li>If a request or response is not specified for an event, then no rules are made for it</li>
<li>Events that are not listed are not supported</li>
<li>The <a href="messagedefinition.html">MessageDefinition</a> resource is newly proposed and is still considered 'draft'.
The <code>supportedMessage</code> element can be used in place of the <code>event</code> and the work group believes it may meet
implementer needs better, however because the new mechanism has not yet been reviewed by ballot, the older 'event' mechanism has
been retained. Implementers may use one or the other to define their capabilities. Feedback is welcome.</li>
</ul>
</li>
<li>Document CapabilityStatement rules:
<ul class="dense">
<li>Document profiles should directly constrain the Document.information.class &amp; type elements so
Expand Down
8 changes: 6 additions & 2 deletions source/capabilitystatement/codesystem-conditional-delete-status.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@
<valueCode value="fhir"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="normative"/>
<valueCode value="deprecated">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status-reason">
<valueMarkdown value="Use `interaction.code = delete-conditional-single` and `interaction.code = delete-conditional-multiple` instead"/>
</extension>
</valueCode>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="5"/>
Expand Down Expand Up @@ -43,7 +47,7 @@
<value value="fhir@lists.hl7.org"/>
</telecom>
</contact>
<description value="A code that indicates how the server supports conditional delete."/>
<description value="DEPRECATED: A code that indicates how the server supports conditional delete. Use interaction codes delete-conditional-single and delete-conditional-multiple instead."/>
<caseSensitive value="true"/>
<valueSet value="http://hl7.org/fhir/ValueSet/conditional-delete-status"/>
<content value="complete"/>
Expand Down
8 changes: 6 additions & 2 deletions source/capabilitystatement/codesystem-conditional-read-status.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@
<valueCode value="fhir"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="normative"/>
<valueCode value="deprecated">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status-reason">
<valueMarkdown value="Use `interaction.code = read-conditional-modified-since` and `interaction.code = read-conditional-not-match` instead"/>
</extension>
</valueCode>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="5"/>
Expand Down Expand Up @@ -38,7 +42,7 @@
<value value="fhir@lists.hl7.org"/>
</telecom>
</contact>
<description value="A code that indicates how the server supports conditional read."/>
<description value="DEPRECATED: A code that indicates how the server supports conditional read. Use interaction codes read-conditional-modified-since and read-conditional-not-match instead."/>
<caseSensitive value="true"/>
<valueSet value="http://hl7.org/fhir/ValueSet/conditional-read-status"/>
<content value="complete"/>
Expand Down
81 changes: 60 additions & 21 deletions source/capabilitystatement/structuredefinition-CapabilityStatement.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,8 @@
<element id="CapabilityStatement.kind">
<path value="CapabilityStatement.kind"/>
<short value="instance | capability | requirements"/>
<definition value="The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase)."/>
<definition value="The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a general statement of implementation expectations (e.g. a desired purchase, a formal specification, etc.)."/>
<comment value="Unless knowledge of a specific system or implementation are known, use 'requirements'."/>
<requirements value="Allow searching the 3 modes."/>
<min value="1"/>
<max value="1"/>
Expand Down Expand Up @@ -642,7 +643,7 @@
<path value="CapabilityStatement.fhirVersion"/>
<short value="FHIR Version the system supports"/>
<definition value="The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value."/>
<comment value="Servers may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement-operation-versions.html) operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server's default version."/>
<comment value="Servers may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement-operation-versions.html) operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server's default version. Tooling should treat this binding as version-independent, including for prior releases."/>
<min value="1"/>
<max value="1"/>
<type>
Expand All @@ -656,6 +657,9 @@
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
<valueBoolean value="true"/>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition">
<valueString value="This binding is version-independent. Use codes from the FHIR Version value set and interpret prior releases using the same version-independent binding semantics."/>
</extension>
<strength value="required"/>
<description value="All published FHIR Versions."/>
<valueSet value="http://hl7.org/fhir/ValueSet/FHIR-version"/>
Expand Down Expand Up @@ -987,7 +991,7 @@
</element>
<element id="CapabilityStatement.rest.resource.interaction.code">
<path value="CapabilityStatement.rest.resource.interaction.code"/>
<short value="read | vread | update | update-conditional | patch | patch-conditional | delete | delete-conditional-single | delete-conditional-multiple | delete-history | delete-history-version | history-instance | history-type | create | create-conditional | search-type"/>
<short value="read | vread | read-conditional-modified-since | read-conditional-not-match | update | update-conditional | patch | patch-conditional | delete | delete-conditional-single | delete-conditional-multiple | delete-history | delete-history-version | history-instance | history-type | create | create-conditional | search-type | other"/>
<definition value="Coded identifier of the interaction, supported by the system resource."/>
<min value="1"/>
<max value="1"/>
Expand Down Expand Up @@ -1059,21 +1063,35 @@
</type>
</element>
<element id="CapabilityStatement.rest.resource.conditionalCreate">
<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="Use `interaction.code = create-conditional` instead"/>
</extension>
</valueCode>
</extension>
<path value="CapabilityStatement.rest.resource.conditionalCreate"/>
<short value="If allows/uses conditional create"/>
<definition value="A flag that indicates that the server supports conditional create."/>
<comment value="Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2."/>
<short value="DEPRECATED: If allows/uses conditional create"/>
<definition value="DEPRECATED: A flag that indicates that the server supports conditional create. Use interaction.code = create-conditional instead."/>
<comment value="DEPRECATED: Use interaction.code = create-conditional instead. Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
</type>
</element>
<element id="CapabilityStatement.rest.resource.conditionalRead">
<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="Use `interaction.code = read-conditional-modified-since` and `interaction.code = read-conditional-not-match` instead"/>
</extension>
</valueCode>
</extension>
<path value="CapabilityStatement.rest.resource.conditionalRead"/>
<short value="not-supported | modified-since | not-match | full-support"/>
<definition value="A code that indicates how the server supports conditional read."/>
<comment value="Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2."/>
<short value="DEPRECATED: not-supported | modified-since | not-match | full-support"/>
<definition value="DEPRECATED: A code that indicates how the server supports conditional read. Use interaction codes read-conditional-modified-since and read-conditional-not-match instead."/>
<comment value="DEPRECATED: Use interaction codes read-conditional-modified-since and read-conditional-not-match instead. Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2."/>
<min value="0"/>
<max value="1"/>
<type>
Expand All @@ -1089,32 +1107,53 @@
</binding>
</element>
<element id="CapabilityStatement.rest.resource.conditionalUpdate">
<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="Use `interaction.code = update-conditional` instead"/>
</extension>
</valueCode>
</extension>
<path value="CapabilityStatement.rest.resource.conditionalUpdate"/>
<short value="If allows/uses conditional update"/>
<definition value="A flag that indicates that the server supports conditional update."/>
<comment value="Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2."/>
<short value="DEPRECATED: If allows/uses conditional update"/>
<definition value="DEPRECATED: A flag that indicates that the server supports conditional update. Use interaction.code = update-conditional instead."/>
<comment value="DEPRECATED: Use interaction.code = update-conditional instead. Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
</type>
</element>
<element id="CapabilityStatement.rest.resource.conditionalPatch">
<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="Use `interaction.code = patch-conditional` instead"/>
</extension>
</valueCode>
</extension>
<path value="CapabilityStatement.rest.resource.conditionalPatch"/>
<short value="If allows/uses conditional patch"/>
<definition value="A flag that indicates that the server supports conditional patch."/>
<comment value="Conditional Patch is mainly appropriate for interface engine scripts converting from other formats, such as v2."/>
<short value="DEPRECATED: If allows/uses conditional patch"/>
<definition value="DEPRECATED: A flag that indicates that the server supports conditional patch. Use interaction.code = patch-conditional instead."/>
<comment value="DEPRECATED: Use interaction.code = patch-conditional instead. Conditional Patch is mainly appropriate for interface engine scripts converting from other formats, such as v2."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
</type>
</element>
<element id="CapabilityStatement.rest.resource.conditionalDelete">
<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="Use `interaction.code = delete-conditional-single` and `interaction.code = delete-conditional-multiple` instead"/>
</extension>
</valueCode>
</extension>
<path value="CapabilityStatement.rest.resource.conditionalDelete"/>
<short value="not-supported | single | multiple - how conditional delete is supported"/>
<definition value="A code that indicates how the server supports conditional delete."/>
<comment value="Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2."/>
<short value="DEPRECATED: not-supported | single | multiple - how conditional delete is supported"/>
<definition value="DEPRECATED: A code that indicates how the server supports conditional delete. Use interaction codes delete-conditional-single and delete-conditional-multiple instead."/>
<comment value="DEPRECATED: Use interaction codes delete-conditional-single and delete-conditional-multiple instead. Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2."/>
<min value="0"/>
<max value="1"/>
<type>
Expand Down Expand Up @@ -1212,7 +1251,7 @@
<path value="CapabilityStatement.rest.resource.searchParam.type"/>
<short value="number | date | string | token | reference | composite | quantity | uri | special | resource"/>
<definition value="The type of value a search parameter refers to, and how the content is interpreted."/>
<comment value="While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition."/>
<comment value="While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition. If down-converting from a version of FHIR that has additional types, they would map to 'special'."/>
<min value="1"/>
<max value="1"/>
<type>
Expand Down Expand Up @@ -1311,7 +1350,7 @@
</element>
<element id="CapabilityStatement.rest.interaction.code">
<path value="CapabilityStatement.rest.interaction.code"/>
<short value="transaction | batch | search-system | history-system"/>
<short value="transaction | batch | search-system | history-system | other"/>
<definition value="A coded identifier of the interaction, supported by the system."/>
<min value="1"/>
<max value="1"/>
Expand Down Expand Up @@ -1347,7 +1386,7 @@
<path value="CapabilityStatement.rest.searchParam"/>
<short value="Search parameters for searching all resources"/>
<definition value="Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. This is only for searches executed against the system-level endpoint."/>
<comment value="Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions. &#xA;If documenting a parameter that is not a 'true' SearchParameter (such as _format, _count, etc.), the .definition element SHALL be omitted and the type SHOULD be 'special'."/>
<comment value="Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that apply to all resources. The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions. &#xA;If documenting a parameter that is not a 'true' SearchParameter (such as _format, _count, etc.), the .definition element SHALL be omitted and the type SHOULD be 'special'."/>
<min value="0"/>
<max value="*"/>
<contentReference value="#CapabilityStatement.rest.resource.searchParam"/>
Expand Down
8 changes: 6 additions & 2 deletions source/capabilitystatement/valueset-conditional-delete-status.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@
<valueCode value="fhir"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="normative"/>
<valueCode value="deprecated">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status-reason">
<valueMarkdown value="Use `interaction.code = delete-conditional-single` and `interaction.code = delete-conditional-multiple` instead"/>
</extension>
</valueCode>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="5"/>
Expand Down Expand Up @@ -43,7 +47,7 @@
<value value="fhir@lists.hl7.org"/>
</telecom>
</contact>
<description value="A code that indicates how the server supports conditional delete."/>
<description value="DEPRECATED: A code that indicates how the server supports conditional delete. Use interaction codes delete-conditional-single and delete-conditional-multiple instead."/>
<immutable value="true"/>
<compose>
<include>
Expand Down
8 changes: 6 additions & 2 deletions source/capabilitystatement/valueset-conditional-read-status.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@
<valueCode value="fhir"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="normative"/>
<valueCode value="deprecated">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status-reason">
<valueMarkdown value="Use `interaction.code = read-conditional-modified-since` and `interaction.code = read-conditional-not-match` instead"/>
</extension>
</valueCode>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="5"/>
Expand Down Expand Up @@ -38,7 +42,7 @@
<value value="fhir@lists.hl7.org"/>
</telecom>
</contact>
<description value="A code that indicates how the server supports conditional read."/>
<description value="DEPRECATED: A code that indicates how the server supports conditional read. Use interaction codes read-conditional-modified-since and read-conditional-not-match instead."/>
<immutable value="true"/>
<compose>
<include>
Expand Down
Loading
Loading