{
  "description": "CRD-specific constraints on the appointment-book CDS Hook context",
  "_filename": "StructureDefinition-CRDAppointmentBookContext.json",
  "package_name": "hl7.fhir.us.davinci-crd",
  "date": "2025-08-06T17:27:13+00:00",
  "derivation": "constraint",
  "publisher": "HL7 International / Financial Management",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "US",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "name": "CRDAppointmentBookContext",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookAppointmentBookContext",
  "experimental": "true",
  "resourceType": "StructureDefinition",
  "title": "CRD CDS Hooks Specific Context for appointment-book (Logical Definition)",
  "package_version": "2.2.0-ballot",
  "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"
      } ]
    }
  } ],
  "snapshot": {
    "element": [ {
      "id": "CDSHookAppointmentBookContext",
      "max": "*",
      "min": 0,
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      },
      "path": "CDSHookAppointmentBookContext",
      "short": "The context for the appointment-book hook",
      "definition": "The context (hook specific)",
      "isModifier": false
    }, {
      "id": "CDSHookAppointmentBookContext.userId",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHookAppointmentBookContext.userId"
      },
      "path": "CDSHookAppointmentBookContext.userId",
      "type": [ {
        "code": "url"
      } ],
      "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."
    }, {
      "id": "CDSHookAppointmentBookContext.patientId",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHookAppointmentBookContext.patientId"
      },
      "path": "CDSHookAppointmentBookContext.patientId",
      "type": [ {
        "code": "id"
      } ],
      "short": "The FHIR Patient.id of the current patient in context",
      "definition": "The FHIR Patient.id of the current patient in context"
    }, {
      "id": "CDSHookAppointmentBookContext.encounterId",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "CDSHookAppointmentBookContext.encounterId"
      },
      "path": "CDSHookAppointmentBookContext.encounterId",
      "type": [ {
        "code": "id"
      } ],
      "short": "The FHIR Encounter.id of the current encounter in context",
      "definition": "The FHIR Encounter.id of the current encounter in context"
    }, {
      "path": "CDSHookAppointmentBookContext.appointments",
      "min": 1,
      "definition": "A container for a collection of resources.",
      "short": "Contains a collection of resources",
      "mapping": [ {
        "map": "Entity. Role, or Act",
        "identity": "rim"
      }, {
        "map": "N/A",
        "identity": "v2"
      }, {
        "map": "N/A",
        "identity": "rim"
      }, {
        "map": "ClinicalDocument, if bundle.type = document",
        "identity": "cda"
      } ],
      "type": [ {
        "code": "Bundle",
        "profile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-bundle-appointment" ]
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
        "valueCode": "optional"
      } ],
      "max": "1",
      "id": "CDSHookAppointmentBookContext.appointments",
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHookAppointmentBookContext.appointments"
      }
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "0.8.0"
    } ]
  },
  "status": "draft",
  "id": "79aac6b9-e873-4136-96c1-eb35d4af9cf2",
  "kind": "logical",
  "url": "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDAppointmentBookContext",
  "identifier": [ {
    "value": "urn:oid:2.16.840.1.113883.4.642.40.18.42.32",
    "system": "urn:ietf:rfc:3986"
  } ],
  "version": "2.2.0-ballot",
  "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" ]
      } ]
    } ]
  },
  "contact": [ {
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/fm",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookAppointmentBookContext"
}