FHIR Tooling Extensions IG
0.1.0 - Release International flag

This page is part of the HL7 Tools Extension IG (v0.1.0: Releases - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. . 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.1.0
Draft as of 2023-12-19 Maturity Level: 2 Computable Name: CDSHookOrderSelectContext

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.

This structure is derived from CDSHookContext

NameFlagsCard.TypeDescription & Constraintsdoco
.. CDSHookOrderSelectContext 0..*CDSHookContextThe context for the order-select hook
Instances of this logical model are not marked to be the target of a Reference
... userId 1..1urlThe id of the current user. Must be in the format [ResourceType]/[id].
... patientId 1..1idThe FHIR Patient.id of the current patient in context
... encounterId 0..1idThe FHIR Encounter.id of the current encounter in context
... draftOrders 1..1BundleFHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status
Id may or not be present (this is the default for elements but not resources)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ord-1errorCDSHookOrderSelectContext.selectionsMust be in the format {type}/{id}
: value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. CDSHookOrderSelectContext 0..*CDSHookContextThe context for the order-select hook
Instances of this logical model are not marked to be the target of a Reference
... userId 1..1urlThe id of the current user. Must be in the format [ResourceType]/[id].
... patientId 1..1idThe FHIR Patient.id of the current patient in context
... encounterId 0..1idThe FHIR Encounter.id of the current encounter in context
... draftOrders 1..1BundleFHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status
Id may or not be present (this is the default for elements but not resources)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ord-1errorCDSHookOrderSelectContext.selectionsMust be in the format {type}/{id}
: value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. CDSHookOrderSelectContext 0..*CDSHookContextThe context for the order-select hook
Instances of this logical model are not marked to be the target of a Reference
... userId 1..1urlThe id of the current user. Must be in the format [ResourceType]/[id].
... patientId 1..1idThe FHIR Patient.id of the current patient in context
... encounterId 0..1idThe FHIR Encounter.id of the current encounter in context
... draftOrders 1..1BundleFHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status
Id may or not be present (this is the default for elements but not resources)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ord-1errorCDSHookOrderSelectContext.selectionsMust 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CDSHookOrderSelectContext 0..*CDSHookContextThe context for the order-select hook
Instances of this logical model are not marked to be the target of a Reference
... userId 1..1urlThe id of the current user. Must be in the format [ResourceType]/[id].
... patientId 1..1idThe FHIR Patient.id of the current patient in context
... encounterId 0..1idThe FHIR Encounter.id of the current encounter in context
... draftOrders 1..1BundleFHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status
Id may or not be present (this is the default for elements but not resources)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ord-1errorCDSHookOrderSelectContext.selectionsMust be in the format {type}/{id}
: value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CDSHookOrderSelectContext 0..*CDSHookContextThe context for the order-select hook
Instances of this logical model are not marked to be the target of a Reference
... userId 1..1urlThe id of the current user. Must be in the format [ResourceType]/[id].
... patientId 1..1idThe FHIR Patient.id of the current patient in context
... encounterId 0..1idThe FHIR Encounter.id of the current encounter in context
... draftOrders 1..1BundleFHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status
Id may or not be present (this is the default for elements but not resources)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ord-1errorCDSHookOrderSelectContext.selectionsMust be in the format {type}/{id}
: value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CDSHookOrderSelectContext 0..*CDSHookContextThe context for the order-select hook
Instances of this logical model are not marked to be the target of a Reference
... userId 1..1urlThe id of the current user. Must be in the format [ResourceType]/[id].
... patientId 1..1idThe FHIR Patient.id of the current patient in context
... encounterId 0..1idThe FHIR Encounter.id of the current encounter in context
... draftOrders 1..1BundleFHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status
Id may or not be present (this is the default for elements but not resources)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ord-1errorCDSHookOrderSelectContext.selectionsMust 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