English Generated Narrative: StructureDefinition CDSHooksRequest Name Flags Card. Type Description & Constraints CDSHooksRequest C 0..* CDSHooksElement Elements defined in Ancestors:extension The response to the discovery endpoint Constraints: cds-r-1 #xD; hook 1..1 code The hook that triggered this CDS Service call #xD; hookInstance 1..1 uuid A universally unique identifier (UUID) for this particular hook call When this element is read urn:uuid: is prefixed to the value before validation #xD; fhirServer 0..1 url The base URL of the CDS Client's FHIR server #xD; fhirAuthorization C 0..1 CDSHooksElement 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 Constraints: cds-r-2 #xD; accessToken 1..1 string This is the OAuth 2.0 access token that provides access to the FHIR server JSON Property Name: access_token #xD; tokenType 1..1 code Fixed value: Bearer JSON Property Name: token_type Fixed Value: Bearer #xD; expiresIn 1..1 integer The lifetime in seconds of the access token. JSON Property Name: expires_in #xD; scope 1..1 string The scopes the access token grants the CDS Service #xD; subject 1..1 string The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server #xD; patient 0..1 id The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server #xD; context 1..1 CDSHookContext Hook-specific contextual data that the CDS service will need JSON: If%resource.hook = 'patient-view'then the type is CDSHookPatientViewContext JSON: If%resource.hook = 'order-sign'then the type is CDSHookOrderSignContext JSON: If%resource.hook = 'order-select'then the type is CDSHookOrderSelectContext #xD; prefetch 0..* Base Key/value pairs of FHIR queries the CDS Client provides on each call JSON: Represented as a single JSON Object with named properties using the value of the key child as the key #xD; key 1..1 code Key of FHIR query - name for client to use when sending to Request #xD; value 1..1 Resource Value of FHIR query - FHIR Query for client to perform Id may or not be present (this is the default for elements but not resources) JSON: This object can be represented as null in the JSON structure (which counts as 'present' for cardinality purposes) #xD; Documentation for this format Spanish Generated Narrative: StructureDefinition CDSHooksRequest Name Flags Card. Type Description & Constraints CDSHooksRequest C 0..* CDSHooksElement Elements defined in Ancestors:extension The response to the discovery endpoint Constraints: cds-r-1 #xD; hook 1..1 code The hook that triggered this CDS Service call #xD; hookInstance 1..1 uuid A universally unique identifier (UUID) for this particular hook call When this element is read urn:uuid: is prefixed to the value before validation #xD; fhirServer 0..1 url The base URL of the CDS Client's FHIR server #xD; fhirAuthorization C 0..1 CDSHooksElement 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 Constraints: cds-r-2 #xD; accessToken 1..1 string This is the OAuth 2.0 access token that provides access to the FHIR server JSON Property Name: access_token #xD; tokenType 1..1 code Fixed value: Bearer JSON Property Name: token_type Fixed Value: Bearer #xD; expiresIn 1..1 integer The lifetime in seconds of the access token. JSON Property Name: expires_in #xD; scope 1..1 string The scopes the access token grants the CDS Service #xD; subject 1..1 string The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server #xD; patient 0..1 id The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server #xD; context 1..1 CDSHookContext Hook-specific contextual data that the CDS service will need JSON: If%resource.hook = 'patient-view'then the type is CDSHookPatientViewContext JSON: If%resource.hook = 'order-sign'then the type is CDSHookOrderSignContext JSON: If%resource.hook = 'order-select'then the type is CDSHookOrderSelectContext #xD; prefetch 0..* Base Key/value pairs of FHIR queries the CDS Client provides on each call JSON: Represented as a single JSON Object with named properties using the value of the key child as the key #xD; key 1..1 code Key of FHIR query - name for client to use when sending to Request #xD; value 1..1 Resource Value of FHIR query - FHIR Query for client to perform Id may or not be present (this is the default for elements but not resources) JSON: This object can be represented as null in the JSON structure (which counts as 'present' for cardinality purposes) #xD; Documentation for this format
This structure is defined to allow the FHIR Validator to validate a CDSHooks Request Body. TODO: This content will be moved to the CDS Hooks specification in the future
if fhirAuthorization details are provided, a fhirServer SHALL be specified
fhirAuthorization.exists() implies fhirServer.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
The hook that triggered this CDS Service call
A universally unique identifier (UUID) for this particular hook 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
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()
This is the OAuth 2.0 access token that provides access to the FHIR server
The lifetime in seconds of the access token.
The scopes the access token grants 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
Key/value pairs of FHIR queries the CDS Client provides on each call
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
Key of FHIR query - name for client to use when sending to Request
Value of FHIR query - FHIR Query for client to perform