---
title: "Invite Team Member"
canonical: "https://wiki.patientsknowbest.com/space/api/3364421746/Invite%20Team%20Member"
format: markdown
---
[https://www.hl7.org/fhir/STU3/operations.html](https://www.hl7.org/fhir/STU3/operations.html)

[https://www.hl7.org/fhir/STU3/operationdefinition.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

|  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- |
| Interaction | HTTP | URL | Supported Parameters | Permitted User Types | Description |
| [operation](https://www.hl7.org/fhir/STU3/operations.html) | POST | /Organization/<id>/$invite-team-member | All mandatory:<br>- title
- given-name
- last-name
- email-address
- user-type<br>Reference 'in' mappings below. | - Team Coordinator
- System | Create and invite a [[Professional]] to the specified PKB [[Team]].<br>If the [[Professional]] already exists then re-invite them.<br><id> must match to a [[Team]].  The Invite can not be at [[Organisation]] level.<br>Parameter user-type must match one of the PKB permitted values - reference mappings.  User type indicates whether to invite the user in a t eam coordinator or team professional capacity. |

Mappings

|  |  |  |
| --- | --- | --- |
| FHIR | PKB | Notes |
| OperationDefinition.url | "[http://fhir.patientsknowbest.com/operation/invite-team-member](http://fhir.patientsknowbest.com/operation/invite-team-member)" |  |
| OperationDefinition.name | "invite-team-member" |  |
| OperationDefinition.status | "active" |  |
| OperationDefinition.kind | "operation" |  |
| OperationDefinition.code | "invite-team-member" |  |
| OperationDefinition.resource | - "Organization" |  |
| OperationDefinition.system | false |  |
| OperationDefinition.type | false |  |
| OperationDefinition.instance | true |  |
| OperationDefinition.parameter | - parameter[x]: BackboneElement
  - name =  "title"
  - use =  "in"
  - min =  1
  - max =  "1"
  - type =  "string"<br>- parameter[x]: BackboneElement
  - name =  "given-name"
  - use =  "in"
  - min =  1
  - max =  "1"
  - type =  "string"<br>- parameter[x]: BackboneElement
  - name =  "last-name"
  - use =  "in"
  - min =  1
  - max =  "1"
  - type =  "string"<br>- parameter[x]: BackboneElement
  - name =  "email-address"
  - use =  "in"
  - min =  1
  - max =  "1"
  - type =  "string"<br>- parameter[x]: BackboneElement
  - name =  "user-type"
  - use =  "in"
  - min = " 1"
  - max =  "1"
  - type =  "string"
  - binding.valueSet = " PKB PractitionerRole.code   codeset "
  - documentation = " The code that is to be the PracitionerRole.code "<br>- parameter[x]: BackboneElement
  - name =  "message"
  - use =  "out"
  - min = " 1"
  - max =  "1"
  - type =  "string"<br>- parameter[x]: BackboneElement
  - name =  "id"
  - use =  "out"
  - min = " 1"
  - max =  "1"
  - type =  "string" | user-type options:<br>- PKB_TEAM_PRO
- PKB_TEAM_COORD<br>message - (static success message). "Invitation sent".<br>id - (UUID of invited [[Practitioner]]): |

### Examples

Invite a professional

<u>Request</u>

/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.

<u>Response</u>

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

Invite a team coordinator

<u>Request</u>

/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.

<u>Response</u>

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