| Package | hl7.fhir.us.davinci-crd |
| Type | StructureDefinition |
| Id | CRDAppointmentBookContext |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-crd/https://build.fhir.org/ig/HL7/davinci-crd/StructureDefinition-CRDAppointmentBookContext.html |
| URL | http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDAppointmentBookContext |
| Version | 2.2.0-ballot |
| Status | draft |
| Date | 2025-07-22T17:00:27+00:00 |
| Name | CRDAppointmentBookContext |
| Title | CRD CDS Hook Specific Context for appointment-book (Logical Definition) |
| Realm | us |
| Authority | hl7 |
| Description | CRD-specific constraints on the appointment-book CDS Hook context |
| Type | http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CDSHookAppointmentBookContext |
| Kind | logical |
No resources found
| StructureDefinition | |
| CDSHookAppointmentBookContext | CDS Hook Specific Context for appointment-book (Logical Definition) |
| profile-bundle-appointment | CRD Bundle of Appointments |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition CRDAppointmentBookContext
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CDSHookAppointmentBookContext | 0..* | CDSHookAppointmentBookContext | Elements defined in Ancestors:userId, patientId, encounterId, appointments The context for the appointment-book hook | |
  appointments | 1..1 | CRDAppointmentBundle | Contains a collection of resources | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "CRDAppointmentBookContext",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"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"
}
]
}
}
],
"url": "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDAppointmentBookContext",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.4.642.40.18.42.32"
}
],
"version": "2.2.0-ballot",
"name": "CRDAppointmentBookContext",
"title": "CRD 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": "CRD-specific constraints on the appointment-book CDS Hook context",
"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/us/davinci-crd/StructureDefinition/CDSHookAppointmentBookContext",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "2.2.0-ballot"
}
],
"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": "Contains a collection of resources",
"definition": "A container for a collection of resources.",
"min": 1,
"max": "1",
"base": {
"path": "CDSHookAppointmentBookContext.appointments",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Bundle",
"profile": [
"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-bundle-appointment"
]
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "cda",
"map": "ClinicalDocument, if bundle.type = document"
}
]
}
]
},
"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"
]
}
]
}
]
}
}