Skip to content

Commit a0f94f5

Browse files
authored
require patient alongside access token
if scopes are "patient". Fixes https://jira.hl7.org/browse/FHIR-28761 Breaking change
1 parent a9b1152 commit a0f94f5

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/specification/current.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ curl
159159
"access_token": "some-opaque-fhir-access-token",
160160
"token_type": "Bearer",
161161
"expires_in": 300,
162-
"scope": "patient/Patient.read patient/Observation.read",
162+
"scope": "user/Patient.read user/Observation.read",
163163
"subject": "cds-service4"
164164
},
165165
"context": {
@@ -442,8 +442,9 @@ Field | Optionality | Type | Description
442442
`expires_in` | REQUIRED | *integer* | The lifetime in seconds of the access token.
443443
`scope` | REQUIRED | *string* | The scopes the access token grants the CDS Service.
444444
`subject` | REQUIRED | *string* | The [OAuth 2.0][OAuth 2.0] client identifier of the CDS Service, as registered with the CDS Client's authorization server.
445+
'patient` | CONDITIONAL | *string* | If the granted SMART scopes include patient scopes (i.e. "patient/"), the access token is restricted to a specific patient. This field identies the FHIR id of that patient.
445446

446-
The scopes granted to the CDS Service via the `scope` field are defined by the [SMART on FHIR specification](http://hl7.org/fhir/smart-app-launch/1.0.0/scopes-and-launch-context/).
447+
The scopes granted to the CDS Service via the `scope` field are defined by the [SMART on FHIR specification](http://hl7.org/fhir/smart-app-launch/1.0.0/scopes-and-launch-context/).
447448

448449
The `expires_in` value is established by the authorization server and SHOULD BE very short lived, as the access token MUST be treated as a transient value by the CDS Service. CDS Clients MAY revoke an issued access token upon the completion of the CDS Hooks request/response to limit the validity period of the token.
449450

@@ -455,7 +456,7 @@ Below is an example `fhirAuthorization` parameter:
455456
"access_token": "some-opaque-fhir-access-token",
456457
"token_type": "Bearer",
457458
"expires_in": 300,
458-
"scope": "patient/Patient.read patient/Observation.read",
459+
"scope": "user/Patient.read user/Observation.read",
459460
"subject": "cds-service4"
460461
}
461462
}

0 commit comments

Comments
 (0)