$subsumes

Subsumption Testing

activeFHIR Core package4.3.0operation6 inputs1 output

Test the subsumption relationship between code/Coding A and code/Coding B given the semantics of subsumption in the underlying code system (see hierarchyMeaning).

When invoking this operation, a client SHALL provide both a and 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

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes
Code
$subsumes
Kind
operation
Affects State
No
Publisher
HL7 (FHIR Project)

Invocation Context

Can be invoked at:
Type LevelInstance Level
Target Resources:
CodeSystem
Affects State:No

Input Parameters (6)

NameTypeCard.Description
codeAcode0..1The "A" code that is to be tested. If a code is provided, a system must be provided
codeBcode0..1The "B" code that is to be tested. If a code is provided, a system must be provided
systemuri0..1The code system in which subsumption testing is to be performed. This must be provided unless the operation is invoked on a code system instance
versionstring0..1The version of the code system, if one was provided in the source data
codingACoding0..1The "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
codingBCoding0..1The "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

Output Parameters (1)

NameTypeCard.Description
outcomecode1..1The 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.

Additional Information

Version
4.3.0
Date
2022-05-28T12:47:40+10:00