CDS Hooks Library
2.0.0-cibuild - ci-build
CDS Hooks Library
2.0.0-cibuild - ci-build
CDS Hooks Library, published by Clinical Decision Support WG. This guide is not an authorized publication; it is the continuous build for version 2.0.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cds-hooks-library/ and changes regularly. See the Directory of published versions
| Page standards status: Informative |
Definitions for the CDSHookAppointmentBookContext logical model
Guidance on how to interpret the contents of this table can be foundhere
| 0. CDSHookAppointmentBookContext | |
| Definition | This structure is defined to allow the FHIR Validator to validate a CDSHooks Appointment-Book context. |
| Short | The context for the appointment-book hook |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHookAppointmentBookContext.userId | |
| 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. |
| Short | The id of the current user. Must be in the format [ResourceType]/[id]. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ord-1: Must be in the format {type}/{id} ($this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')) |
| 4. CDSHookAppointmentBookContext.patientId | |
| Definition | The FHIR Patient.id of the current patient in context |
| Short | The FHIR Patient.id of the current patient in context |
| Control | 1..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. CDSHookAppointmentBookContext.encounterId | |
| Definition | The FHIR Encounter.id of the current encounter in context |
| Short | The FHIR Encounter.id of the current encounter in context |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. CDSHookAppointmentBookContext.appointments | |
| Definition | FHIR Bundle of Appointments |
| Short | FHIR Bundle of Appointments |
| Control | 1..1 |
| Type | Bundle |
| ID Expectation | Id may or not be present (this is the default for elements but not resources) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. CDSHookAppointmentBookContext | |
| Definition | This structure is defined to allow the FHIR Validator to validate a CDSHooks Appointment-Book context. |
| Short | The context for the appointment-book hook |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHookAppointmentBookContext.userId | |
| 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. |
| Short | The id of the current user. Must be in the format [ResourceType]/[id]. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ord-1: Must be in the format {type}/{id} ($this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')) |
| 4. CDSHookAppointmentBookContext.patientId | |
| Definition | The FHIR Patient.id of the current patient in context |
| Short | The FHIR Patient.id of the current patient in context |
| Control | 1..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. CDSHookAppointmentBookContext.encounterId | |
| Definition | The FHIR Encounter.id of the current encounter in context |
| Short | The FHIR Encounter.id of the current encounter in context |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. CDSHookAppointmentBookContext.appointments | |
| Definition | FHIR Bundle of Appointments |
| Short | FHIR Bundle of Appointments |
| Control | 1..1 |
| Type | Bundle |
| ID Expectation | Id may or not be present (this is the default for elements but not resources) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. CDSHookAppointmentBookContext | |
| Definition | This structure is defined to allow the FHIR Validator to validate a CDSHooks Appointment-Book context. |
| Short | The context for the appointment-book hook |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHookAppointmentBookContext.userId | |
| 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. |
| Short | The id of the current user. Must be in the format [ResourceType]/[id]. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ord-1: Must be in the format {type}/{id} ($this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')) |
| 4. CDSHookAppointmentBookContext.patientId | |
| Definition | The FHIR Patient.id of the current patient in context |
| Short | The FHIR Patient.id of the current patient in context |
| Control | 1..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. CDSHookAppointmentBookContext.encounterId | |
| Definition | The FHIR Encounter.id of the current encounter in context |
| Short | The FHIR Encounter.id of the current encounter in context |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. CDSHookAppointmentBookContext.appointments | |
| Definition | FHIR Bundle of Appointments |
| Short | FHIR Bundle of Appointments |
| Control | 1..1 |
| Type | Bundle |
| ID Expectation | Id may or not be present (this is the default for elements but not resources) |
IG © 2019+ Clinical Decision Support WG.
Package hl7.fhir.uv.cds-hooks-library#2.0.0-cibuild based on FHIR 4.0.1.
Generated
2026-04-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change