https://www.hl7.org/fhir/STU3/operations.html
https://www.hl7.org/fhir/STU3/operationdefinition.html
Status
In development. API spec subject to change.
Overview
This operation allows:
a Team Coordinator to deactivate an existing member of staff in their team.
a System user to deactivate an existing member of staff in a specified team.
a System user to deactivate an existing member of staff in a specified organisation...recursive deactivate within all teams within that organisation.
Endpoints
Mappings
Deactivate team member from Team 'A'
As user-type is not specified in the example then the user is deactivated from all roles within Team A.
Request
/Organization/<Team A UUID>/$deactivate-team-member body: { "resourceType": "Parameters", "parameter": [{ "name": "deactivate-team-member", "email-address": "jock.jones@mydomain.com" }]
}
The response indicates that the team member has been deactivated.
Response
{ "resourceType": "Parameters", "parameter": [ { "message": "Deactivated from 1 team" } ] }
Deactivate the same team member from Team 'B'
As user-type is not specified in the example then the user is deactivated from all roles within Team B.
Request
/Organization/<Team B UUID>/$deactivate-team-member body: { "resourceType": "Parameters", "parameter": [{ "name": "deactivate-team-member", "email-address": "jock.jones@mydomain.com" }]
}
The response indicates that the team member has been deactivated.
Response
{ "resourceType": "Parameters", "parameter": [ { "message": "Deactivated from 1 team" } ] }
Deactivate a user from Org A (all teams that are partOf Org A). System User only.
As user-type is not specified in the example then the user is deactivated from all roles in all teams that are part of the org.
Request
/Organization/<Org A UUID>/$deactivate-team-member body: { "resourceType": "Parameters", "parameter": [{ "name": "deactivate-team-member", "email-address": "david.lawson@mydomain.com" }]}
The response indicates that the team member has been deactivated from multiple teams.
Response
{ "resourceType": "Parameters", "parameter": [ { "message": "Deactivated from 10 teams" } ] }