| Name | Flags | Card. | Type |
Description & Constraints
|
|---|---|---|---|---|
CDSHooksRequest
|
C | CDSHooksElement |
The response to the discovery endpoint This logical model cannot be the target of a reference cds-r-1: if fhirAuthorization details are provided, a fhirServer SHALL be specified |
|
hook
|
1..1 | code | The hook that triggered this CDS Service call | |
|
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
|
|
|
fhirServer
|
0..1 | url | The base URL of the CDS Client's FHIR server | |
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 cds-r-2: 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. |
accessToken
|
1..1 | string |
This is the OAuth 2.0 access token that provides access to the FHIR server JSON Property Name: access_token |
|
|
tokenType
|
1..1 | code |
Fixed value: Bearer JSON Property Name: token_type Fixed Value: Bearer |
|
|
expiresIn
|
1..1 | integer |
The lifetime in seconds of the access token. JSON Property Name: expires_in |
|
|
scope
|
1..1 | string | The scopes the access token grants the CDS Service | |
|
subject
|
1..1 | string | The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server | |
patient
|
0..1 | id | The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server | |
|
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
|
|
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 |
|
key
|
1..1 | code | Key of FHIR query - name for client to use when sending to Request | |
|
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) |
|
|
Documentation for this format
|
||||