{
  "description": "This structure is defined to allow the FHIR Validator to validate a CDSHooks encounter-start context. TODO: This content will be moved to the CDS Hooks specification in the future",
  "_filename": "StructureDefinition-CDSHookEncounterStartContext.json",
  "package_name": "hl7.fhir.uv.tools.r3",
  "date": "2025-08-05T20:09:06+10:00",
  "derivation": "specialization",
  "publisher": "HL7 International / FHIR Infrastructure",
  "fhirVersion": "3.0.2",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
    } ]
  } ],
  "name": "CDSHookEncounterStartContext",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookEncounterStartContext",
  "experimental": "true",
  "resourceType": "StructureDefinition",
  "title": "CDS Hooks Specific Context for encounter-start (Logical Definition)",
  "package_version": "0.8.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": "draft"
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status-reason",
    "valueCode": "Logical Models that have been modified for R3 are still draft while real-world experience is collected"
  } ],
  "snapshot": {
    "element": [ {
      "id": "CDSHookEncounterStartContext",
      "max": "*",
      "min": 0,
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      },
      "path": "CDSHookEncounterStartContext",
      "short": "The context for the encounter-start hook",
      "definition": "The context (hook specific)",
      "isModifier": false
    }, {
      "id": "CDSHookEncounterStartContext.userId",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHookEncounterStartContext.userId"
      },
      "path": "CDSHookEncounterStartContext.userId",
      "type": [ {
        "code": "uri"
      } ],
      "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, 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."
    }, {
      "id": "CDSHookEncounterStartContext.patientId",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHookEncounterStartContext.patientId"
      },
      "path": "CDSHookEncounterStartContext.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": "CDSHookEncounterStartContext.encounterId",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "CDSHookEncounterStartContext.encounterId"
      },
      "path": "CDSHookEncounterStartContext.encounterId",
      "type": [ {
        "code": "id"
      } ],
      "short": "The FHIR Encounter.id of the current encounter in context",
      "definition": "The FHIR Encounter.id of the current encounter in context"
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "0.8.0"
    } ]
  },
  "status": "draft",
  "id": "7697e4a1-56b6-4002-91df-30418fc870af",
  "kind": "logical",
  "url": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookEncounterStartContext",
  "identifier": [ {
    "value": "urn:oid:2.16.840.1.113883.4.642.40.1.42.72",
    "system": "urn:ietf:rfc:3986"
  } ],
  "version": "0.8.0",
  "differential": {
    "element": [ {
      "id": "CDSHookEncounterStartContext",
      "path": "CDSHookEncounterStartContext",
      "short": "The context for the encounter-start hook"
    }, {
      "id": "CDSHookEncounterStartContext.userId",
      "max": "1",
      "min": 1,
      "path": "CDSHookEncounterStartContext.userId",
      "type": [ {
        "code": "uri"
      } ],
      "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, 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."
    }, {
      "id": "CDSHookEncounterStartContext.patientId",
      "max": "1",
      "min": 1,
      "path": "CDSHookEncounterStartContext.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": "CDSHookEncounterStartContext.encounterId",
      "max": "1",
      "min": 0,
      "path": "CDSHookEncounterStartContext.encounterId",
      "type": [ {
        "code": "id"
      } ],
      "short": "The FHIR Encounter.id of the current encounter in context",
      "definition": "The FHIR Encounter.id of the current encounter in context"
    } ]
  },
  "contact": [ {
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/fiwg",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookContext"
}