<status value="active"/> <kind value="operation"/> <experimental value="false"/> <date value="2026-04-01T17:59:15+00:00"/> <publisher value="HL7 International / Terminology Infrastructure"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <telecom> <system value="email"/> <value value="fhir@lists.hl7.org"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/Vocab"/> </telecom> </contact> <description value="Test the subsumption relationship between code/Coding A and code/Coding B given the semantics of subsumption in the underlying code system (see [hierarchyMeaning](codesystem-definitions.html#CodeSystem.hierarchyMeaning)). When invoking this operation, a client SHALL provide both A and B codes, either as code or Coding parameters. The system parameter is required unless the operation is invoked on an instance of a code system resource. Other parameters are optional"/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <affectsState value="false"/> <code value="subsumes"/> <resource value="CodeSystem"/> <system value="false"/> <type value="true"/> <instance value="true"/> <parameter> <name value="codeA"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The "A" code that is to be tested. If a code is provided, a system must be provided"/> <type value="code"/> </parameter> <parameter> <name value="codeB"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The "B" code that is to be tested. If a code is provided, a system must be provided"/> <type value="code"/> </parameter> <parameter> <name value="system"/> <use value="in"/> <scope value="type"/> <min value="0"/> <max value="1"/> <documentation value="The code system in which subsumption testing is to be performed. This must be provided unless the operation is invoked on a code system instance"/> <type value="uri"/> </parameter> <parameter> <name value="version"/> <use value="in"/> <scope value="type"/> <min value="0"/> <max value="1"/> <documentation value="The version of the code system, if one was provided in the source data"/> <type value="string"/> </parameter> <parameter> <name value="codingA"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The "A" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established"/> <type value="Coding"/> </parameter> <parameter> <name value="codingB"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The "B" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established"/> <type value="Coding"/> </parameter> <parameter> <name value="outcome"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="The subsumption relationship between code/Coding "A" and code/Coding "B". There are 4 possible codes to be returned (equivalent, subsumes, subsumed-by, and not-subsumed) as defined in the concept-subsumption-outcome value set. If the server is unable to determine the relationship between the codes/Codings, then it returns an error response with an OperationOutcome."/> <type value="code"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ConceptSubsumptionOutcome"/> </extension> <strength value="required"/> <valueSet value="http://hl7.org/fhir/ValueSet/concept-subsumption-outcome|6.0.0-ballot4"/> </binding> </parameter> </OperationDefinition>

Generated Narrative: OperationDefinition CodeSystem-subsumes

URL: [base]/CodeSystem/$subsumes

URL: [base]/CodeSystem/[id]/$subsumes

Parameters

Use

Name

Scope

Cardinality

Type

Binding

Documentation

codeA

0..1

code

The "A" code that is to be tested. If a code is provided, a system must be provided

codeB

0..1

code

The "B" code that is to be tested. If a code is provided, a system must be provided

system

type

0..1

uri

The code system in which subsumption testing is to be performed. This must be provided unless the operation is invoked on a code system instance

version

type

0..1

string

The version of the code system, if one was provided in the source data

codingA

0..1

Coding

The "A" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established

codingB

0..1

Coding

The "B" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established

OUT

outcome

1..1

code

Concept Subsumption Outcome (Required)

The subsumption relationship between code/Coding "A" and code/Coding "B". There are 4 possible codes to be returned (equivalent, subsumes, subsumed-by, and not-subsumed) as defined in the concept-subsumption-outcome value set. If the server is unable to determine the relationship between the codes/Codings, then it returns an error response with an OperationOutcome.