This page is part of the HL7 Tools Extension IG (v0.3.0: Release - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 0.8.0. For a full list of available versions, see the Directory of published versions
| Draft as of 2024-10-27 | Maturity Level: 2 |
Definitions for the CDSHookOrderSignContext logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. CDSHookOrderSignContext | |
| Short | The context for the order-sign hook |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHookOrderSignContext.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 | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. CDSHookOrderSignContext.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. CDSHookOrderSignContext.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. CDSHookOrderSignContext.draftOrders | |
| Definition | FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status |
| Short | FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status |
| 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 found here
| 0. CDSHookOrderSignContext | |
| Definition | The context (hook specific) Base definition for all types defined in FHIR type system. |
| Short | The context for the order-sign hookBase for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHookOrderSignContext.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 | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. CDSHookOrderSignContext.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. CDSHookOrderSignContext.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. CDSHookOrderSignContext.draftOrders | |
| Definition | FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status |
| Short | FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status |
| 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 found here
| 0. CDSHookOrderSignContext | |
| Definition | The context (hook specific) |
| Short | The context for the order-sign hook |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHookOrderSignContext.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 | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. CDSHookOrderSignContext.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. CDSHookOrderSignContext.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. CDSHookOrderSignContext.draftOrders | |
| Definition | FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status |
| Short | FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status |
| Control | 1..1 |
| Type | Bundle |
| ID Expectation | Id may or not be present (this is the default for elements but not resources) |