STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Operation-codesystem-subsumes

This is the narrative for the resource. See also the XML or JSON format.

Subsumption Testing

OPERATION: Subsumption Testing

Test whether code "sub" is subsumed by code "super" given the semantics of subsumption in the underlying code system (see hierarchyMeaning)

URL: [base]/CodeSystem/$subsumes

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

Parameters

UseNameCardinalityTypeBindingDocumentation
INcodeA0..1code

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

INcodeB0..1code

The "super" code that is to be validated. If a code is provided, a system must be provided

INsystem0..1uri

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

INversion0..1string

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

INcodingA0..1Coding

The "sub" coding to test. The coding system does not have to match the specified subsumption system, but the relationships between the systems must be well established

INcodingB0..1Coding

The "super" coding to test. The coding system does not have to match the specified subsumption system, but the relationships between the systems must be well established

OUToutcome1..1code

Whether "sub" is subsumed by "super". 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, then it returns an error (i.e. 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.