{
"description": "This structure is defined to allow the FHIR Validator to validate a CDSHooks order-dispatch context. TODO: This content will be moved to the CDS Hooks specification in the future",
"_filename": "StructureDefinition-CDSHookOrderDispatchContext.json",
"package_name": "hl7.fhir.uv.tools.r5",
"date": "2025-12-16T23:18:40+11:00",
"derivation": "specialization",
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
} ]
} ],
"name": "CDSHookOrderDispatchContext",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderDispatchContext",
"experimental": "true",
"resourceType": "StructureDefinition",
"title": "CDS Hooks Specific Context for order-dispatch (Logical Definition)",
"package_version": "0.9.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/json-suppress-resourcetype",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/tools/ImplementationGuide/hl7.fhir.uv.tools"
} ]
}
} ],
"snapshot": {
"element": [ {
"path": "CDSHookOrderDispatchContext",
"min": 0,
"definition": "The context (hook specific)",
"isModifier": false,
"short": "The context for the order-dispatch hook",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"max": "*",
"id": "CDSHookOrderDispatchContext",
"base": {
"max": "*",
"min": 0,
"path": "Base"
}
}, {
"id": "CDSHookOrderDispatchContext.patientId",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "CDSHookOrderDispatchContext.patientId"
},
"path": "CDSHookOrderDispatchContext.patientId",
"type": [ {
"code": "id"
} ],
"short": "The FHIR Patient.id of the current patient in context",
"definition": "The FHIR Patient.id of the current patient in context"
}, {
"path": "CDSHookOrderDispatchContext.dispatchedOrders",
"min": 1,
"definition": "Collection of the FHIR local references for the Request resource(s) for which fulfillment is sought E.g. `ServiceRequest/123`",
"short": "FHIR Bundle of Request resources",
"type": [ {
"code": "Bundle"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
"valueCode": "optional"
} ],
"max": "1",
"id": "CDSHookOrderDispatchContext.dispatchedOrders",
"base": {
"max": "1",
"min": 1,
"path": "CDSHookOrderDispatchContext.dispatchedOrders"
}
}, {
"id": "CDSHookOrderDispatchContext.performer",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CDSHookOrderDispatchContext.performer"
},
"path": "CDSHookOrderDispatchContext.performer",
"type": [ {
"code": "url"
} ],
"short": "Who orders are dispatched to in form [ResourceType]/[ResourceId]",
"definition": "The FHIR local reference for the Practitioner, PractitionerRole, Organization, CareTeam, etc. who is being asked to execute the order. E.g. `Practitioner/456`"
}, {
"path": "CDSHookOrderDispatchContext.fulfillmentTasks",
"min": 0,
"definition": "FHIR Bundle of Task resources",
"short": "FHIR Bundle of Task resources",
"type": [ {
"code": "Bundle"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
"valueCode": "optional"
} ],
"max": "1",
"id": "CDSHookOrderDispatchContext.fulfillmentTasks",
"base": {
"max": "1",
"min": 0,
"path": "CDSHookOrderDispatchContext.fulfillmentTasks"
}
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.9.0"
} ]
},
"status": "draft",
"id": "1d483c04-43d7-4db7-b8e4-22c0aaac985c",
"kind": "logical",
"url": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderDispatchContext",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.40.1.42.73",
"system": "urn:ietf:rfc:3986"
} ],
"version": "0.9.0",
"differential": {
"element": [ {
"id": "CDSHookOrderDispatchContext",
"path": "CDSHookOrderDispatchContext",
"short": "The context for the order-dispatch hook"
}, {
"id": "CDSHookOrderDispatchContext.patientId",
"max": "1",
"min": 1,
"path": "CDSHookOrderDispatchContext.patientId",
"type": [ {
"code": "id"
} ],
"short": "The FHIR Patient.id of the current patient in context",
"definition": "The FHIR Patient.id of the current patient in context"
}, {
"id": "CDSHookOrderDispatchContext.dispatchedOrders",
"max": "1",
"min": 1,
"path": "CDSHookOrderDispatchContext.dispatchedOrders",
"type": [ {
"code": "Bundle"
} ],
"short": "FHIR Bundle of Request resources",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
"valueCode": "optional"
} ],
"definition": "Collection of the FHIR local references for the Request resource(s) for which fulfillment is sought E.g. `ServiceRequest/123`"
}, {
"id": "CDSHookOrderDispatchContext.performer",
"max": "1",
"min": 0,
"path": "CDSHookOrderDispatchContext.performer",
"type": [ {
"code": "url"
} ],
"short": "Who orders are dispatched to in form [ResourceType]/[ResourceId]",
"definition": "The FHIR local reference for the Practitioner, PractitionerRole, Organization, CareTeam, etc. who is being asked to execute the order. E.g. `Practitioner/456`"
}, {
"id": "CDSHookOrderDispatchContext.fulfillmentTasks",
"max": "1",
"min": 0,
"path": "CDSHookOrderDispatchContext.fulfillmentTasks",
"type": [ {
"code": "Bundle"
} ],
"short": "FHIR Bundle of Task resources",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
"valueCode": "optional"
} ],
"definition": "FHIR Bundle of Task resources"
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookContext"
}