FHIR IG Statistics: StructureDefinition/CDSHookAppointmentBookContext

Resources that use this resource

Resources that this resource uses

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition CDSHookAppointmentBookContext

Name	Flags	Card.	Type	Description & Constraints
CDSHookAppointmentBookContext		0..*	CDSHookContext	The context for the appointment-book hook
userId		1..1	url	The id of the current user. Must be in the format [ResourceType]/[id].
patientId		1..1	id	The FHIR Patient.id of the current patient in context
encounterId		0..1	id	The FHIR Encounter.id of the current encounter in context
appointments		1..1	Bundle	FHIR Bundle of Appointments Id may or not be present (this is the default for elements but not resources)
Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "CDSHookAppointmentBookContext",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1
    },
    {
      "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/CDSHookAppointmentBookContext",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.40.18.42.30"
    }
  ],
  "version": "2.2.0-ballot",
  "name": "CDSHookAppointmentBookContext",
  "title": "CDS Hook Specific Context for appointment-book (Logical Definition)",
  "status": "draft",
  "experimental": true,
  "date": "2025-07-22T17:00:27+00:00",
  "publisher": "HL7 International / Financial Management",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fm"
        }
      ]
    }
  ],
  "description": "This structure is defined to allow the FHIR Validator to validate a CDSHooks Appointment-Book context. TODO: This content will be moved to the CDS Hooks specification in the future",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CDSHookAppointmentBookContext",
  "baseDefinition": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookContext",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.7.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": "FHIR Bundle of Appointments",
        "definition": "FHIR Bundle of Appointments",
        "min": 1,
        "max": "1",
        "base": {
          "path": "CDSHookAppointmentBookContext.appointments",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Bundle"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "CDSHookAppointmentBookContext",
        "path": "CDSHookAppointmentBookContext",
        "short": "The context for the appointment-book hook"
      },
      {
        "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",
        "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",
        "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",
        "type": [
          {
            "code": "id"
          }
        ]
      },
      {
        "id": "CDSHookAppointmentBookContext.appointments",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
            "valueCode": "optional"
          }
        ],
        "path": "CDSHookAppointmentBookContext.appointments",
        "short": "FHIR Bundle of Appointments",
        "definition": "FHIR Bundle of Appointments",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Bundle"
          }
        ]
      }
    ]
  }
}