Da Vinci - Coverage Requirements Discovery
2.2.0-ballot - STU 2.2 Ballot United States of America flag

This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.2.0-ballot: STU 2.2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.1.0. For a full list of available versions, see the Directory of published versions

: CRD Metric Codes - JSON Representation

Page standards status: Trial-use Maturity Level: 4

Raw json | Download

{
  "resourceType" : "CodeSystem",
  "id" : "crd-metric-codes",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem crd-metric-codes</b></p><a name=\"crd-metric-codes\"> </a><a name=\"hccrd-metric-codes\"> </a><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class=\"grid\"><tr><td><b>Name</b></td><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td></tr><tr><td>Not Selectable</td><td>abstract</td><td>http://hl7.org/fhir/concept-properties#notSelectable</td><td>boolean</td></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://hl7.org/fhir/us/davinci-crd/CodeSystem/crd-metric-codes</code> defines the following codes in a Is-A hierarchy:</p><table class=\"codes\"><tr><td><b>Lvl</b></td><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>Not Selectable</b></td></tr><tr><td>1</td><td style=\"white-space:nowrap\">used<a name=\"crd-metric-codes-used\"> </a></td><td>Authorization Token Used</td><td>An authorization token was used by the payer to access additional information from the provider system as part of the CDS Hooks call</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0rejected<a name=\"crd-metric-codes-rejected\"> </a></td><td>Authorization Token Rejected</td><td>The payer attempted to use an authorization token to access additional information from the provider system as part of the CDS Hooks call, however the access request failed.  (This is not used if the request succeeded but returned no records.)</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">not-used<a name=\"crd-metric-codes-not-used\"> </a></td><td>Authorization Token Not Used</td><td>The payer did not attempt to use an authorization token to access additional information from the provider system as part of the CDS Hooks call</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">provider-src<a name=\"crd-metric-codes-provider-src\"> </a></td><td>Provider-sourced</td><td>The metric information was captured from the provider system's perspective</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">payer-src<a name=\"crd-metric-codes-payer-src\"> </a></td><td>Payer-sourced</td><td>The metric information was captured from the payer system's perspective</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">_HookType<a name=\"crd-metric-codes-_HookType\"> </a></td><td>CDS Hooks Type (abstract)</td><td>A collector for the different types of CDS Hooks</td><td>true</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0appointment-book<a name=\"crd-metric-codes-appointment-book\"> </a></td><td>Appointment Book</td><td>CDS Hooks Appointment Book Hook</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0encounter-start<a name=\"crd-metric-codes-encounter-start\"> </a></td><td>Encounter Start</td><td>CDS Hooks Encounter Start Hook</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0encounter-discharge<a name=\"crd-metric-codes-encounter-discharge\"> </a></td><td>Encounter Discharge</td><td>CDS Hooks Encounter Discharge Hook</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0order-dispatch<a name=\"crd-metric-codes-order-dispatch\"> </a></td><td>Order Dispatch</td><td>CDS Hooks Order Dispatch Hook</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0order-select<a name=\"crd-metric-codes-order-select\"> </a></td><td>Order Select</td><td>CDS Hooks Order Select Hook</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0order-sign<a name=\"crd-metric-codes-order-sign\"> </a></td><td>Order Sign</td><td>CDS Hooks Order Sign Hook</td><td/></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fm"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 4,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/davinci-crd/CodeSystem/crd-metric-codes",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.40.18.16.3"
    }
  ],
  "version" : "2.2.0-ballot",
  "name" : "CRDMetricCodes",
  "title" : "CRD Metric Codes",
  "status" : "active",
  "experimental" : false,
  "date" : "2025-08-06T17:27:13+00:00",
  "publisher" : "HL7 International / Financial Management",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fm"
        }
      ]
    }
  ],
  "description" : "Codes used within 'code' elements in the CRD Metric logical model.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "caseSensitive" : true,
  "hierarchyMeaning" : "is-a",
  "content" : "complete",
  "count" : 12,
  "property" : [
    {
      "code" : "abstract",
      "uri" : "http://hl7.org/fhir/concept-properties#notSelectable",
      "type" : "boolean"
    }
  ],
  "concept" : [
    {
      "code" : "used",
      "display" : "Authorization Token Used",
      "definition" : "An authorization token was used by the payer to access additional information from the provider system as part of the CDS Hooks call",
      "concept" : [
        {
          "code" : "rejected",
          "display" : "Authorization Token Rejected",
          "definition" : "The payer attempted to use an authorization token to access additional information from the provider system as part of the CDS Hooks call, however the access request failed.  (This is not used if the request succeeded but returned no records.)"
        }
      ]
    },
    {
      "code" : "not-used",
      "display" : "Authorization Token Not Used",
      "definition" : "The payer did not attempt to use an authorization token to access additional information from the provider system as part of the CDS Hooks call"
    },
    {
      "code" : "provider-src",
      "display" : "Provider-sourced",
      "definition" : "The metric information was captured from the provider system's perspective"
    },
    {
      "code" : "payer-src",
      "display" : "Payer-sourced",
      "definition" : "The metric information was captured from the payer system's perspective"
    },
    {
      "code" : "_HookType",
      "display" : "CDS Hooks Type (abstract)",
      "definition" : "A collector for the different types of CDS Hooks",
      "property" : [
        {
          "code" : "abstract",
          "valueBoolean" : true
        }
      ],
      "concept" : [
        {
          "code" : "appointment-book",
          "display" : "Appointment Book",
          "definition" : "CDS Hooks Appointment Book Hook"
        },
        {
          "code" : "encounter-start",
          "display" : "Encounter Start",
          "definition" : "CDS Hooks Encounter Start Hook"
        },
        {
          "code" : "encounter-discharge",
          "display" : "Encounter Discharge",
          "definition" : "CDS Hooks Encounter Discharge Hook"
        },
        {
          "code" : "order-dispatch",
          "display" : "Order Dispatch",
          "definition" : "CDS Hooks Order Dispatch Hook"
        },
        {
          "code" : "order-select",
          "display" : "Order Select",
          "definition" : "CDS Hooks Order Select Hook"
        },
        {
          "code" : "order-sign",
          "display" : "Order Sign",
          "definition" : "CDS Hooks Order Sign Hook"
        }
      ]
    }
  ]
}