Invite Team Member

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 invite (or re-invite) a Professional or Team Coordinator to join their team.

  • a System user to invite (or re-invite) a Professional or Team Coordinator to join a specified team.

Endpoints

Mappings

Examples

Invite a professional

Request

/Organization/<team-uuid>/$invite-team-member body:{ "resourceType": "Parameters", "parameter": [{ "name": "invite-team-member", "title": "Mr", "given-name" : "Jock", "last-name" : "Jones", "email-address": "jock.jones@mydomain.com", "user-type" : "PKB_TEAM_PRO" }]}

The response indicates that the team member has been invited.

Response

{ "resourceType": "Parameters", "parameter": [ { "message": "Invitation sent", "id": "<UUID>", } ] }

Invite a team coordinator

Request

/Organization/<team-uuid>/$invite-team-member body:{ "resourceType": "Parameters", "parameter": [{ "name": "invite-team-member", "title": "Mr", "given-name" : "David", "last-name" : "Lawson", "email-address": "david.lawson@mydomain.com", "user-type" : "PKB_TEAM_COORD" }]}

The response indicates that the team member has been invited.

Response

{ "resourceType": "Parameters", "parameter": [ { "message": "Invitation sent", "id": "<UUID>", } ] }