This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Terminology Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
This is the narrative for the resource. See also the XML, JSON or Turtle format.
Note that this is the formal definition for the subsumes operation as an OperationDefinition on CodeSystem. See the Operation documentation
URL: [base]/CodeSystem/$subsumes
URL: [base]/CodeSystem/[id]/$subsumes
Parameters
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | codeA | 0..1 | code | The "A" code that is to be tested. If a code is provided, a system must be provided | ||
IN | codeB | 0..1 | code | The "B" code that is to be tested. If a code is provided, a system must be provided | ||
IN | 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 | |
IN | version | type | 0..1 | string | The version of the code system, if one was provided in the source data | |
IN | 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 | ||
IN | 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. |
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.