{
  "description": "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",
  "_filename": "StructureDefinition-CDSHookOrderSelectContext.json",
  "package_name": "hl7.fhir.uv.tools",
  "date": "2024-10-27T07:27:27+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": "CDSHookOrderSelectContext",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSelectContext",
  "experimental": "true",
  "resourceType": "StructureDefinition",
  "title": "CDS Hook Specific Context for order-select (Logical Definition)",
  "package_version": "0.3.0",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 2
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode": "fhir"
  } ],
  "snapshot": {
    "element": [ {
      "path": "CDSHookOrderSelectContext",
      "min": 0,
      "definition": "The context (hook specific)",
      "isModifier": false,
      "short": "The context for the order-select hook",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "max": "*",
      "id": "CDSHookOrderSelectContext",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      }
    }, {
      "id": "CDSHookOrderSelectContext.userId",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHookOrderSelectContext.userId"
      },
      "path": "CDSHookOrderSelectContext.userId",
      "type": [ {
        "code": "url"
      } ],
      "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": "CDSHookOrderSelectContext.patientId",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHookOrderSelectContext.patientId"
      },
      "path": "CDSHookOrderSelectContext.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": "CDSHookOrderSelectContext.encounterId",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "CDSHookOrderSelectContext.encounterId"
      },
      "path": "CDSHookOrderSelectContext.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"
    }, {
      "constraint": [ {
        "key": "ord-1",
        "human": "Must be in the format {type}/{id}",
        "severity": "error",
        "expression": "value.matches('^[\\\\d\\\\w]+\\\\/[\\\\d\\\\w-.]+$')"
      } ],
      "path": "CDSHookOrderSelectContext.selections",
      "min": 0,
      "definition": "The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103",
      "short": "The FHIR ids of the newly selected order(s)",
      "type": [ {
        "code": "uri"
      } ],
      "max": "*",
      "id": "CDSHookOrderSelectContext.selections",
      "base": {
        "max": "*",
        "min": 0,
        "path": "CDSHookOrderSelectContext.selections"
      }
    }, {
      "path": "CDSHookOrderSelectContext.draftOrders",
      "min": 1,
      "definition": "FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status",
      "short": "FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status",
      "type": [ {
        "code": "Bundle"
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
        "valueCode": "optional"
      } ],
      "max": "1",
      "id": "CDSHookOrderSelectContext.draftOrders",
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHookOrderSelectContext.draftOrders"
      }
    } ]
  },
  "status": "draft",
  "id": "5168041d-c8ba-4e42-8722-9762906d35db",
  "kind": "logical",
  "url": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSelectContext",
  "identifier": [ {
    "value": "urn:oid:2.16.840.1.113883.4.642.40.1.42.2",
    "system": "urn:ietf:rfc:3986"
  } ],
  "version": "0.3.0",
  "differential": {
    "element": [ {
      "id": "CDSHookOrderSelectContext",
      "path": "CDSHookOrderSelectContext",
      "short": "The context for the order-select hook"
    }, {
      "id": "CDSHookOrderSelectContext.userId",
      "max": "1",
      "min": 1,
      "path": "CDSHookOrderSelectContext.userId",
      "type": [ {
        "code": "url"
      } ],
      "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": "CDSHookOrderSelectContext.patientId",
      "max": "1",
      "min": 1,
      "path": "CDSHookOrderSelectContext.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": "CDSHookOrderSelectContext.encounterId",
      "max": "1",
      "min": 0,
      "path": "CDSHookOrderSelectContext.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"
    }, {
      "id": "CDSHookOrderSelectContext.selections",
      "max": "*",
      "min": 0,
      "path": "CDSHookOrderSelectContext.selections",
      "type": [ {
        "code": "uri"
      } ],
      "short": "The FHIR ids of the newly selected order(s)",
      "constraint": [ {
        "key": "ord-1",
        "human": "Must be in the format {type}/{id}",
        "severity": "error",
        "expression": "value.matches('^[\\\\d\\\\w]+\\\\/[\\\\d\\\\w-.]+$')"
      } ],
      "definition": "The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103"
    }, {
      "id": "CDSHookOrderSelectContext.draftOrders",
      "max": "1",
      "min": 1,
      "path": "CDSHookOrderSelectContext.draftOrders",
      "type": [ {
        "code": "Bundle"
      } ],
      "short": "FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
        "valueCode": "optional"
      } ],
      "definition": "FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status"
    } ]
  },
  "contact": [ {
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/fiwg",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/tools/StructureDefinition/CDSHookContext"
}