FHIR IG analytics| Package | hl7.fhir.uv.cds-hooks-library |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-CDSHookEncounterStartContext.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/HL7/cds-hooks-library/StructureDefinition-CDSHookEncounterStartContext.html |
| URL | http://cds-hooks.hl7.org/hooks/StructureDefinition/CDSHookEncounterStartContext |
| Version | 2.0.0-cibuild |
| Status | draft |
| Date | 2026-04-22T14:59:47+00:00 |
| Name | CDSHookEncounterStartContext |
| Title | CDS Hooks Specific Context for encounter-start (Logical Definition) |
| Realm | uv |
| Authority | hl7 |
| Description | This structure is defined to allow the FHIR Validator to validate a CDSHooks encounter-start context. |
| Type | http://cds-hooks.hl7.org/hooks/StructureDefinition/CDSHookEncounterStartContext |
| Kind | logical |
No resources found
| StructureDefinition | ||
| hl7.fhir.uv.tools#current | CDSHookContext | CDS Hook Specific Context (Logical Definition) |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition CDSHookEncounterStartContext
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CDSHookEncounterStartContext | 0..* | CDSHookContext | The context for the encounter-start hook | |
  userId | C | 1..1 | string | The id of the current user. Must be in the format [ResourceType]/[id]. Constraints: ord-1 |
| patientId | 1..1 | id | The FHIR Patient.id of the current patient in context | |
 encounterId | 1..1 | id | The FHIR Encounter.id of the current encounter in context | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "CDSHookEncounterStartContext",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/json-suppress-resourcetype",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cds"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://cds-hooks.hl7.org/hooks/ImplementationGuide/hl7.fhir.uv.cds-hooks-library"
}
]
}
}
],
"url": "http://cds-hooks.hl7.org/hooks/StructureDefinition/CDSHookEncounterStartContext",
"version": "2.0.0-cibuild",
"name": "CDSHookEncounterStartContext",
"title": "CDS Hooks Specific Context for encounter-start (Logical Definition)",
"status": "draft",
"experimental": true,
"date": "2026-04-22T14:59:47+00:00",
"publisher": "Clinical Decision Support WG",
"contact": [
{
"name": "Clinical Decision Support WG",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/dss/index.cfm"
},
{
"system": "email",
"value": "cds@lists.HL7.org"
}
]
}
],
"description": "This structure is defined to allow the FHIR Validator to validate a CDSHooks encounter-start context.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://cds-hooks.hl7.org/hooks/StructureDefinition/CDSHookEncounterStartContext",
"baseDefinition": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookContext",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "1.1.0"
}
],
"element": [
{
"id": "CDSHookEncounterStartContext",
"path": "CDSHookEncounterStartContext",
"short": "The context for the encounter-start hook",
"definition": "This structure is defined to allow the FHIR Validator to validate a CDSHooks encounter-start context.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "CDSHookEncounterStartContext.userId",
"path": "CDSHookEncounterStartContext.userId",
"short": "The id of the current user. Must be in the format [ResourceType]/[id].",
"definition": "For this hook, the user is expected to be of type Practitioner or PractitionerRole. For example, Practitioner/abc.",
"min": 1,
"max": "1",
"base": {
"path": "CDSHookEncounterStartContext.userId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ord-1",
"severity": "error",
"human": "Must be in the format {type}/{id}",
"expression": "$this.matches('^[\\\\d\\\\w]+\\\\/[\\\\d\\\\w-.]+[%content%]#39;)",
"source": "http://cds-hooks.hl7.org/hooks/StructureDefinition/CDSHookEncounterStartContext"
}
]
},
{
"id": "CDSHookEncounterStartContext.patientId",
"path": "CDSHookEncounterStartContext.patientId",
"short": "The FHIR Patient.id of the current patient in context",
"definition": "The FHIR Patient.id of the current patient in context",
"min": 1,
"max": "1",
"base": {
"path": "CDSHookEncounterStartContext.patientId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "id"
}
]
},
{
"id": "CDSHookEncounterStartContext.encounterId",
"path": "CDSHookEncounterStartContext.encounterId",
"short": "The FHIR Encounter.id of the current encounter in context",
"definition": "The FHIR Encounter.id of the current encounter in context",
"min": 1,
"max": "1",
"base": {
"path": "CDSHookEncounterStartContext.encounterId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "id"
}
]
}
]
},
"differential": {
"element": [
{
"id": "CDSHookEncounterStartContext",
"path": "CDSHookEncounterStartContext",
"short": "The context for the encounter-start hook",
"definition": "This structure is defined to allow the FHIR Validator to validate a CDSHooks encounter-start context."
},
{
"id": "CDSHookEncounterStartContext.userId",
"path": "CDSHookEncounterStartContext.userId",
"short": "The id of the current user. Must be in the format [ResourceType]/[id].",
"definition": "For this hook, the user is expected to be of type Practitioner or PractitionerRole. For example, Practitioner/abc.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ord-1",
"severity": "error",
"human": "Must be in the format {type}/{id}",
"expression": "$this.matches('^[\\\\d\\\\w]+\\\\/[\\\\d\\\\w-.]+[%content%]#39;)",
"source": "http://cds-hooks.hl7.org/hooks/StructureDefinition/CDSHookEncounterStartContext"
}
]
},
{
"id": "CDSHookEncounterStartContext.patientId",
"path": "CDSHookEncounterStartContext.patientId",
"short": "The FHIR Patient.id of the current patient in context",
"definition": "The FHIR Patient.id of the current patient in context",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"id": "CDSHookEncounterStartContext.encounterId",
"path": "CDSHookEncounterStartContext.encounterId",
"short": "The FHIR Encounter.id of the current encounter in context",
"definition": "The FHIR Encounter.id of the current encounter in context",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
]
}
]
}
}