FHIR IG analytics

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

No narrative content found in resource

Source1

{
  "resourceType": "StructureDefinition",
  "id": "CDSHookAppointmentBookContext",
  "language": "en",
  "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": "fhir"
    }
  ],
  "url": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookAppointmentBookContext",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.40.1.42.71"
    }
  ],
  "version": "1.1.2",
  "name": "CDSHookAppointmentBookContext",
  "title": "CDS Hooks Specific Context for appointment-book (Logical Definition)",
  "status": "active",
  "experimental": false,
  "date": "2026-03-24T11:13:30+11:00",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "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": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "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/CDSHookContext",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "1.1.2"
      }
    ],
    "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"
          }
        ]
      }
    ]
  }
}