FHIR
Release
3
(STU)
CI-Build
Conformance
This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
|
Responsible
Owner:
|
|
|
Raw JSON ( canonical form + also see JSON Format Specification )
Operation Definition
{
"resourceType": "OperationDefinition",
"id": "CodeSystem-subsumes",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
"resourceType" : "OperationDefinition",
"id" : "CodeSystem-subsumes",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition CodeSystem-subsumes</b></p><a name=\"CodeSystem-subsumes\"> </a><a name=\"hcCodeSystem-subsumes\"> </a><p>URL: [base]/CodeSystem/$subsumes</p><p>URL: [base]/CodeSystem/[id]/$subsumes</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>codeA</td><td/><td>0..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>The "A" code that is to be tested. If a code is provided, a system must be provided</p>\n</div></td></tr><tr><td>IN</td><td>codeB</td><td/><td>0..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>The "B" code that is to be tested. If a code is provided, a system must be provided</p>\n</div></td></tr><tr><td>IN</td><td>system</td><td>type</td><td>0..1</td><td><a href=\"datatypes.html#uri\">uri</a></td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td>type</td><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The version of the code system, if one was provided in the source data</p>\n</div></td></tr><tr><td>IN</td><td>codingA</td><td/><td>0..1</td><td><a href=\"datatypes.html#Coding\">Coding</a></td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>IN</td><td>codingB</td><td/><td>0..1</td><td><a href=\"datatypes.html#Coding\">Coding</a></td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>OUT</td><td>outcome</td><td/><td>1..1</td><td><a href=\"datatypes.html#code\">code</a></td><td><a href=\"valueset-concept-subsumption-outcome.html\">Concept Subsumption Outcome</a> (Required)</td><td><div><p>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.</p>\n</div></td></tr></table></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes",
"name": "Subsumption Testing",
"status": "draft",
"kind": "operation",
"date": "2019-10-24T11:53:00+11:00",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "Test the subsumption relationship between code/Coding A and code/Coding B given the semantics of subsumption in the underlying code system (see hierarchyMeaning)",
"code": "subsumes",
"resource": [
"CodeSystem"
],
"system": false,
"type": true,
"instance": true,
"parameter": [
{
"name": "codeA",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The \"A\" code that is to be tested. If a code is provided, a system must be provided",
"type": "code"
},
{
"name": "codeB",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The \"B\" code that is to be tested. If a code is provided, a system must be provided",
"type": "code"
},
{
"name": "system",
"use": "in",
"min": 0,
"max": "1",
"documentation": "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": "uri"
},
{
"name": "version",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The version of the code system, if one was provided in the source data",
"type": "string"
},
{
"name": "codingA",
"use": "in",
"min": 0,
"max": "1",
"documentation": "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": "Coding"
},
{
"name": "codingB",
"use": "in",
"min": 0,
"max": "1",
"documentation": "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": "Coding"
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "vocab"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes",
"version" : "6.0.0-ballot3",
"name" : "Subsumes",
"title" : "Subsumption Testing",
"status" : "active",
"kind" : "operation",
"experimental" : false,
"date" : "2025-12-17T09:50:17+00:00",
"publisher" : "HL7 International / Terminology Infrastructure",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"name": "outcome",
"use": "out",
"min": 1,
"max": "1",
"documentation": "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. If the server is unable to determine the relationship between the codes/Codings, then it returns an error (i.e. an OperationOutcome)",
"type": "code"
"system" : "email",
"value" : "fhir@lists.hl7.org"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/Vocab"
}]
}],
"description" : "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)).\n\nWhen 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" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}]
}],
"affectsState" : false,
"code" : "subsumes",
"resource" : ["CodeSystem"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "codeA",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The \"A\" code that is to be tested. If a code is provided, a system must be provided",
"type" : "code"
},
{
"name" : "codeB",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The \"B\" code that is to be tested. If a code is provided, a system must be provided",
"type" : "code"
},
{
"name" : "system",
"use" : "in",
"scope" : ["type"],
"min" : 0,
"max" : "1",
"documentation" : "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" : "uri"
},
{
"name" : "version",
"use" : "in",
"scope" : ["type"],
"min" : 0,
"max" : "1",
"documentation" : "The version of the code system, if one was provided in the source data",
"type" : "string"
},
{
"name" : "codingA",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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" : "Coding"
},
{
"name" : "codingB",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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" : "Coding"
},
{
"name" : "outcome",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "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" : "code",
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConceptSubsumptionOutcome"
}],
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/concept-subsumption-outcome|6.0.0-ballot3"
}
]
}]
}
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.
FHIR
®©
HL7.org
2011+.
FHIR
Release
3
(STU;
v3.0.2-11200)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Thurs,
Oct
24,
2019
11:53+1100.
QA
Page
Wed,
Dec
17,
2025
09:51+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
DSTU2
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change