Generated Narrative: StructureDefinition CRDHooksRequest Name Flags Card. Type Description & Constraints CDSHooksRequest 0..* CDSHooksRequest Request for decision support #xD; extension 0..1 CDSHooksExtensions Extension #xD; hook S 1..1 code Hook event triggering call Binding: CDS Hook Types Value Set (required) #xD; hookInstance S 1..1 uuid Unique id for hook invocation #xD; fhirServer S 1..1 url Location to query for data #xD; fhirAuthorization S 1..1 CDSHooksElement Auth to use in queries #xD; accessToken S 1..1 string Auth token for query header #xD; tokenType S 1..1 code Bearer #xD; expiresIn S 1..1 integer Seconds token is valid #xD; scope S 1..1 string Granted access scopes #xD; subject S 1..1 string Patient id for access #xD; context S 1..1 CDSHookContext Context for decision support JSON: If%resource.hook = 'appointment-book'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookAppointmentBookContext JSON: If%resource.hook = 'encounter-start'then the type is http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterStartContext JSON: If%resource.hook = 'encounter-discharge'then the type is http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterDischargeContext JSON: If%resource.hook = 'order-dispatch'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDOrderDispatchContext JSON: If%resource.hook = 'order-select'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext JSON: If%resource.hook = 'order-sign'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext #xD; prefetch S 0..* Base Prefetch info requested by server #xD; key S 1..1 code Key as specfied in server prefetch config #xD; value S 1..1 Resource Resource(s) matching prefetch criteria #xD; Documentation for this format
CRD CDSHooks Request (Logical Definition)
HL7 International / Financial Management
Defines CRD-specific constraints on the CDS Hooks Request logical model
The data structure that used when invoking a CDS Hook service
if fhirAuthorization details are provided, a fhirServer SHALL be specified
fhirAuthorization.exists() implies fhirServer.exists()
The hook that triggered this CDS Service call
While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation
Note: the hookInstance is globally unique and should contain enough entropy to be un-guessable.
The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged
A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token
If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient.
scope.contains('Patient/') implies patient.exists()
Object that has Named Extension Properties
A JSON object that has properties where the names are defined by the extension definitions
Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty. How to handle complex extensions (objects) is not defined
This is the OAuth 2.0 access token that provides access to the FHIR server
The type of token provided. (Present to support future extensibility)
The lifetime in seconds of the access token.
The scopes the access token grants the CDS Service
If the granted SMART scopes include patient scopes (i.e. 'patient/'), the access token is restricted to a specific patient. This field SHOULD be populated to identify the FHIR id of that patient.
OAuth 2.0 client identifier of the CDS Service
The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server
Hook-specific contextual data that the CDS service will need
An object containing key/value pairs of FHIR queries that this Request is requesting the CDS Client to perform and provide on each Request call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query
While this is mustSupport, CRD clients are not required to pass any or all prefetch data requested by the CRD server.
Key as specfied in server prefetch config
Name of the FHIR query/read from the CDS Hooks Services object provided by the server
What was found by executing the search or read requested by the CDS Hooks Service in the context of this particular hook invocation