FHIR Tooling Extensions IG
0.2.0 - Release 0.2.0
FHIR Tooling Extensions IG
0.2.0 - Release 0.2.0
This page is part of the HL7 Tools Extension IG (v0.2.0: Releases - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Draft as of 2024-04-26 | Maturity Level: 2 |
Definitions for the CDSHookOrderSelectContext logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. CDSHookOrderSelectContext | |
| Short | The context for the order-select hook |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext.selections | |
| Definition | The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103 |
| Short | The FHIR ids of the newly selected order(s) |
| Control | 0..* |
| Type | uri |
| 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} (value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')) |
| 10. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext | |
| Definition | The context (hook specific) Base definition for all types defined in FHIR type system. |
| Short | The context for the order-select 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. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext.selections | |
| Definition | The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103 |
| Short | The FHIR ids of the newly selected order(s) |
| Control | 0..* |
| Type | uri |
| 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} (value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')) |
| 10. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext | |
| Definition | The context (hook specific) |
| Short | The context for the order-select hook |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext.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. CDSHookOrderSelectContext.selections | |
| Definition | The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103 |
| Short | The FHIR ids of the newly selected order(s) |
| Control | 0..* |
| Type | uri |
| 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} (value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')) |
| 10. CDSHookOrderSelectContext.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) |
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.tools#0.2.0 based on FHIR 5.0.0. Generated 2024-04-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change