CDS Hooks Library
2.0.0-ballot - R2 Normative Ballot International flag

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-ballot 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

Logical Model: CDS Hooks Specific Context for appointment-book (Logical Definition) ( Experimental )

Official URL: http://cds-hooks.hl7.org/hooks/StructureDefinition/CDSHookAppointmentBookContext Version: 2.0.0-ballot
Standards status: Informative Computable Name: CDSHookAppointmentBookContext
Other Identifiers: OID:2.16.840.1.113883.4.642.40.94.42.1

This structure is defined to allow the FHIR Validator to validate a CDSHooks Appointment-Book context.

Usages:

  • This Logical Model is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

This structure is derived from CDSHookContext

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHookAppointmentBookContext 0..* CDSHookContext The context for the appointment-book hook
CDSHookAppointmentBookContext.userId C 1..1 string The id of the current user. Must be in the format [ResourceType]/[id].
Constraints: ord-1
CDSHookAppointmentBookContext.patientId 1..1 id The FHIR Patient.id of the current patient in context
CDSHookAppointmentBookContext.encounterId 0..1 id The FHIR Encounter.id of the current encounter in context

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ord-1 error CDSHookAppointmentBookContext.userId Must be in the format {type}/{id} $this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')
NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHookAppointmentBookContext 0..* CDSHookContext The context for the appointment-book hook
CDSHookAppointmentBookContext.userId C 1..1 string The id of the current user. Must be in the format [ResourceType]/[id].
Constraints: ord-1
CDSHookAppointmentBookContext.patientId 1..1 id The FHIR Patient.id of the current patient in context
CDSHookAppointmentBookContext.encounterId 0..1 id The FHIR Encounter.id of the current encounter in context
CDSHookAppointmentBookContext.appointments 1..1 Bundle FHIR Bundle of Appointments
Id may or not be present (this is the default for elements but not resources)

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ord-1 error CDSHookAppointmentBookContext.userId Must be in the format {type}/{id} $this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

This structure is derived from CDSHookContext

Summary

Mandatory: 0 element(3 nested mandatory elements)

Differential View

This structure is derived from CDSHookContext

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHookAppointmentBookContext 0..* CDSHookContext The context for the appointment-book hook
CDSHookAppointmentBookContext.userId C 1..1 string The id of the current user. Must be in the format [ResourceType]/[id].
Constraints: ord-1
CDSHookAppointmentBookContext.patientId 1..1 id The FHIR Patient.id of the current patient in context
CDSHookAppointmentBookContext.encounterId 0..1 id The FHIR Encounter.id of the current encounter in context
CDSHookAppointmentBookContext.appointments 1..1 Bundle FHIR Bundle of Appointments
Id may or not be present (this is the default for elements but not resources)

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ord-1 error CDSHookAppointmentBookContext.userId Must be in the format {type}/{id} $this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHookAppointmentBookContext 0..* CDSHookContext The context for the appointment-book hook
CDSHookAppointmentBookContext.userId C 1..1 string The id of the current user. Must be in the format [ResourceType]/[id].
Constraints: ord-1
CDSHookAppointmentBookContext.patientId 1..1 id The FHIR Patient.id of the current patient in context
CDSHookAppointmentBookContext.encounterId 0..1 id The FHIR Encounter.id of the current encounter in context
CDSHookAppointmentBookContext.appointments 1..1 Bundle FHIR Bundle of Appointments
Id may or not be present (this is the default for elements but not resources)

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ord-1 error CDSHookAppointmentBookContext.userId Must be in the format {type}/{id} $this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

This structure is derived from CDSHookContext

Summary

Mandatory: 0 element(3 nested mandatory elements)

 

Other representations of profile: CSV, Excel