CDS Hook Specific Context for order-select (Logical Definition)

FHIR Tooling Extensions IG
0.3.0 - Release 0.2.0 International flag

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

Logical Model: CDS Hook Specific Context for order-select (Logical Definition) ( Experimental )

Official URL: http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSelectContext		Version: 0.3.0
Draft as of 2024-10-27	Maturity Level: 2	Computable Name: CDSHookOrderSelectContext
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.2

This structure is defined to allow the FHIR Validator to validate a CDSHooks order-select context. TODO: This content will be moved to the CDS Hooks specification in the future

Usage:

This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from CDSHookContext

Name	Flags	Card.	Type	Description & Constraints
CDSHookOrderSelectContext		0..*	CDSHookContext	The context for the order-select hook Instances of this logical model are not marked to be the target of a Reference
userId		1..1	url	The id of the current user. Must be in the format [ResourceType]/[id].
patientId		1..1	id	The FHIR Patient.id of the current patient in context
encounterId		0..1	id	The FHIR Encounter.id of the current encounter in context
selections	C	0..*	uri	The FHIR ids of the newly selected order(s) ord-1: Must be in the format {type}/{id}
draftOrders		1..1	Bundle	FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status Id may or not be present (this is the default for elements but not resources)
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ord-1	error	CDSHookOrderSelectContext.selections	Must be in the format {type}/{id} : value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

Name	Flags	Card.	Type	Description & Constraints
CDSHookOrderSelectContext		0..*	CDSHookContext	The context for the order-select hook Instances of this logical model are not marked to be the target of a Reference
userId		1..1	url	The id of the current user. Must be in the format [ResourceType]/[id].
patientId		1..1	id	The FHIR Patient.id of the current patient in context
encounterId		0..1	id	The FHIR Encounter.id of the current encounter in context
selections	C	0..*	uri	The FHIR ids of the newly selected order(s) ord-1: Must be in the format {type}/{id}
draftOrders		1..1	Bundle	FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status Id may or not be present (this is the default for elements but not resources)
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ord-1	error	CDSHookOrderSelectContext.selections	Must be in the format {type}/{id} : value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

Name	Flags	Card.	Type	Description & Constraints
CDSHookOrderSelectContext		0..*	CDSHookContext	The context for the order-select hook Instances of this logical model are not marked to be the target of a Reference
userId		1..1	url	The id of the current user. Must be in the format [ResourceType]/[id].
patientId		1..1	id	The FHIR Patient.id of the current patient in context
encounterId		0..1	id	The FHIR Encounter.id of the current encounter in context
selections	C	0..*	uri	The FHIR ids of the newly selected order(s) ord-1: Must be in the format {type}/{id}
draftOrders		1..1	Bundle	FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status Id may or not be present (this is the default for elements but not resources)
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ord-1	error	CDSHookOrderSelectContext.selections	Must be in the format {type}/{id} : value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

This structure is derived from CDSHookContext

Summary

Mandatory: 0 element(3 nested mandatory elements)

Maturity: 2

Differential View

This structure is derived from CDSHookContext

Name	Flags	Card.	Type	Description & Constraints
CDSHookOrderSelectContext		0..*	CDSHookContext	The context for the order-select hook Instances of this logical model are not marked to be the target of a Reference
userId		1..1	url	The id of the current user. Must be in the format [ResourceType]/[id].
patientId		1..1	id	The FHIR Patient.id of the current patient in context
encounterId		0..1	id	The FHIR Encounter.id of the current encounter in context
selections	C	0..*	uri	The FHIR ids of the newly selected order(s) ord-1: Must be in the format {type}/{id}
draftOrders		1..1	Bundle	FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status Id may or not be present (this is the default for elements but not resources)
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ord-1	error	CDSHookOrderSelectContext.selections	Must be in the format {type}/{id} : value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
CDSHookOrderSelectContext		0..*	CDSHookContext	The context for the order-select hook Instances of this logical model are not marked to be the target of a Reference
userId		1..1	url	The id of the current user. Must be in the format [ResourceType]/[id].
patientId		1..1	id	The FHIR Patient.id of the current patient in context
encounterId		0..1	id	The FHIR Encounter.id of the current encounter in context
selections	C	0..*	uri	The FHIR ids of the newly selected order(s) ord-1: Must be in the format {type}/{id}
draftOrders		1..1	Bundle	FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status Id may or not be present (this is the default for elements but not resources)
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ord-1	error	CDSHookOrderSelectContext.selections	Must be in the format {type}/{id} : value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
CDSHookOrderSelectContext		0..*	CDSHookContext	The context for the order-select hook Instances of this logical model are not marked to be the target of a Reference
userId		1..1	url	The id of the current user. Must be in the format [ResourceType]/[id].
patientId		1..1	id	The FHIR Patient.id of the current patient in context
encounterId		0..1	id	The FHIR Encounter.id of the current encounter in context
selections	C	0..*	uri	The FHIR ids of the newly selected order(s) ord-1: Must be in the format {type}/{id}
draftOrders		1..1	Bundle	FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status Id may or not be present (this is the default for elements but not resources)
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ord-1	error	CDSHookOrderSelectContext.selections	Must be in the format {type}/{id} : value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

This structure is derived from CDSHookContext

Summary

Mandatory: 0 element(3 nested mandatory elements)

Maturity: 2

Other representations of profile: CSV, Excel

IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.tools#0.3.0 based on FHIR 5.0.0. Generated 2024-10-27
Links: Table of Contents | QA Report | Version History | | Propose a change