FHIR Tooling Extensions IG
0.8.0 - Release 0.2.0
FHIR Tooling Extensions IG
0.8.0 - Release 0.2.0
This page is part of the HL7 Tools Extension IG (v0.8.0: Release - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
| Page standards status: Informative | Maturity Level: 1 |
Definitions for the CDSHookEncounterStartContext logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. CDSHookEncounterStartContext | |
| Definition | The context (hook specific) Base definition for all types defined in FHIR type system. |
| Short | The context for the encounter-start 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. CDSHookEncounterStartContext.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. CDSHookEncounterStartContext.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. CDSHookEncounterStartContext.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 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. CDSHookEncounterStartContext | |
| Short | The context for the encounter-start hook |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHookEncounterStartContext.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. CDSHookEncounterStartContext.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. CDSHookEncounterStartContext.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 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. CDSHookEncounterStartContext | |
| Definition | The context (hook specific) |
| Short | The context for the encounter-start hook |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHookEncounterStartContext.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. CDSHookEncounterStartContext.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. CDSHookEncounterStartContext.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 |
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.tools#0.8.0 based on FHIR 5.0.0. Generated 2025-08-05
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change