Da Vinci - Coverage Requirements Discovery
2.2.0-snapshot - STU 2.2 Peer Review

Da Vinci - Coverage Requirements Discovery, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.0-snapshot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-crd/ and changes regularly. See the Directory of published versions

## Logical Model: CRD CDS Hooks Specific Context for appointment-book (Logical Definition) - JSON Profile

Page standards status: Informative

JSON representation of the CRDAppointmentBookContext logical model.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "CRDAppointmentBookContext",
      "language" : "en",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition CRDAppointmentBookContext</b></p><a name=\"CRDAppointmentBookContext\"> </a><a name=\"hcCRDAppointmentBookContext\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description &amp; Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CRDAppointmentBookContext-definitions.html#CDSHookAppointmentBookContext\">CDSHookAppointmentBookContext</a><a name=\"CDSHookAppointmentBookContext\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/tools/1.0.0/StructureDefinition-CDSHookAppointmentBookContext.html\">CDSHookAppointmentBookContext</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">The context for the appointment-book hook</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CRDAppointmentBookContext-definitions.html#CDSHookAppointmentBookContext.appointments\">appointments</a><a name=\"CDSHookAppointmentBookContext.appointments\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-profile-bundle-appointment.html\" title=\"Bundle\">CRDAppointmentBundle</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Contains a collection of resources</span></td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-suppress-resourcetype",
          "valueBoolean" : true
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
          "valueCode" : "fm"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
          "valueCode" : "informative",
          "_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/StructureDefinition/CRDAppointmentBookContext",
      "identifier" : [
        {
          "system" : "urn:ietf:rfc:3986",
          "value" : "urn:oid:2.16.840.1.113883.4.642.40.18.42.32"
        }
      ],
      "version" : "2.2.0-snapshot",
      "name" : "CRDAppointmentBookContext",
      "title" : "CRD CDS Hooks Specific Context for appointment-book (Logical Definition)",
      "status" : "draft",
      "experimental" : true,
      "date" : "2026-02-19T15:54:35+00:00",
      "publisher" : "HL7 International / Financial Management",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/fm"
            }
          ]
        }
      ],
      "description" : "CRD-specific constraints on the appointment-book CDS Hook context",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US"
            }
          ]
        }
      ],
      "fhirVersion" : "4.0.1",
      "mapping" : [
        {
          "identity" : "rim",
          "uri" : "http://hl7.org/v3",
          "name" : "RIM Mapping"
        }
      ],
      "kind" : "logical",
      "abstract" : false,
      "type" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookAppointmentBookContext",
      "baseDefinition" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookAppointmentBookContext",
      "derivation" : "constraint",
      "snapshot" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
            "valueString" : "1.0.0"
          }
        ],
        "element" : [
          {
            "id" : "CDSHookAppointmentBookContext",
            "path" : "CDSHookAppointmentBookContext",
            "short" : "The context for the appointment-book hook",
            "definition" : "The context (hook specific)",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Base",
              "min" : 0,
              "max" : "*"
            },
            "isModifier" : false
          },
          {
            "id" : "CDSHookAppointmentBookContext.userId",
            "path" : "CDSHookAppointmentBookContext.userId",
            "short" : "The id of the current user. Must be in the format [ResourceType]/[id].",
            "definition" : "For this hook, the user is expected to be of type Practitioner, PractitionerRole, Patient, or RelatedPerson. Patient or RelatedPerson are appropriate when a patient or their proxy are viewing the record. For example, Practitioner/abc or Patient/123.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHookAppointmentBookContext.userId",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "url"
              }
            ]
          },
          {
            "id" : "CDSHookAppointmentBookContext.patientId",
            "path" : "CDSHookAppointmentBookContext.patientId",
            "short" : "The FHIR Patient.id of the current patient in context",
            "definition" : "The FHIR Patient.id of the current patient in context",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHookAppointmentBookContext.patientId",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "id"
              }
            ]
          },
          {
            "id" : "CDSHookAppointmentBookContext.encounterId",
            "path" : "CDSHookAppointmentBookContext.encounterId",
            "short" : "The FHIR Encounter.id of the current encounter in context",
            "definition" : "The FHIR Encounter.id of the current encounter in context",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "CDSHookAppointmentBookContext.encounterId",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "id"
              }
            ]
          },
          {
            "id" : "CDSHookAppointmentBookContext.appointments",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
                "valueCode" : "optional"
              }
            ],
            "path" : "CDSHookAppointmentBookContext.appointments",
            "short" : "Contains a collection of resources",
            "definition" : "A container for a collection of resources.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHookAppointmentBookContext.appointments",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "Bundle",
                "profile" : [
                  🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-bundle-appointment"
                ]
              }
            ],
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "Entity. Role, or Act"
              },
              {
                "identity" : "v2",
                "map" : "N/A"
              },
              {
                "identity" : "rim",
                "map" : "N/A"
              },
              {
                "identity" : "cda",
                "map" : "ClinicalDocument, if bundle.type = document"
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "CDSHookAppointmentBookContext",
            "path" : "CDSHookAppointmentBookContext"
          },
          {
            "id" : "CDSHookAppointmentBookContext.appointments",
            "path" : "CDSHookAppointmentBookContext.appointments",
            "type" : [
              {
                "code" : "Bundle",
                "profile" : [
                  🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-bundle-appointment"
                ]
              }
            ]
          }
        ]
      }
    }