This page is part of the HL7 Tools Extension IG (v0.3.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-10-27 | Maturity Level: 2 |
Definitions for the CDSHookPatientViewContext logical model.
Guidance on how to interpret the contents of this table can be found here
0. CDSHookPatientViewContext | |
Short | The context for the patient-view hook |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. CDSHookPatientViewContext.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. CDSHookPatientViewContext.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. CDSHookPatientViewContext.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 found here
0. CDSHookPatientViewContext | |
Definition | The context (hook specific) Base definition for all types defined in FHIR type system. |
Short | The context for the patient-view 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. CDSHookPatientViewContext.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. CDSHookPatientViewContext.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. CDSHookPatientViewContext.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 found here
0. CDSHookPatientViewContext | |
Definition | The context (hook specific) |
Short | The context for the patient-view hook |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. CDSHookPatientViewContext.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. CDSHookPatientViewContext.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. CDSHookPatientViewContext.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 |