Operation-codesystem-subsumes.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "CodeSystem-subsumes",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes",
  "name": "Subsumption Testing",
  "status": "draft",
  "kind": "operation",
  "date": "2016-12-06T12:22:34+11:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "Test whether code \"sub\" is subsumed by code \"super\" 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 \"sub\" 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 \"super\" code that is to be validated. If a code is provided, a system must be provided",
      "type": "code"
    },
    {
      "name": "system",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The 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 system, if one was provided in the source data",
      "type": "string"
    },
    {
      "name": "codingA",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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",
      "type": "Coding"
    },
    {
      "name": "codingB",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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",
      "type": "Coding"
    },
    {
      "name": "outcome",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "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)",
      "type": "code"
    }
  ]
}