Versions Compared

Old Version 1

changes.mady.by.user Andrew Turner (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Tom Pick (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

https://www.hl7.org/fhir/STU3/operations.html

https://www.hl7.org/fhir/STU3/operationdefinition.html

Status

In development. API spec subject to change.

...

FHIR

PKB

Notes

OperationDefinition.url

"http://fhir.patientsknowbest.com/operation/deactivate-team-member"

 

OperationDefinition.name

"deactivate-team-member"

 

OperationDefinition.status

"active"

 

OperationDefinition.kind

"operation"

 

OperationDefinition.code

"deactivate-team-member"

 

OperationDefinition.resource

  • "Organization"

 

OperationDefinition.system

false

 

OperationDefinition.type

false

 

OperationDefinition.instance

true

 

OperationDefinition.parameter


  • parameter[x]: BackboneElement

    • name =  "email-address"

    • use =  "in"

    • min = " 1"

    • max =  "1"

    • type =  "string"

  • parameter[x]: BackboneElement

    • name =  "user-type"

    • use =  "in"

    • min = "0"

    • max =  "1"

    • type =  "string"

    • binding.valueSet =  " PKB PractitionerRole.code   codeset "

    • documentation = " " The code that will match the PracitionerRole.code "

  • parameter[x]: BackboneElement

    • name =  "message"

    • use =  "out"

    • min =  1

    • max =  "1"

    • type =  "string"

user-type options:

  • PKB_TEAM_PRO

  • PKB_TEAM_COORD


message - (static success message). "Invitation sent"

...

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

...

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

...

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

...

{ "resourceType": "Parameters", "parameter": [ { "message": "Deactivated from 10 teams" } ] }

PKB customer sites: deploy | developer | information governance | procurement | manual

© Patients Know Best, Ltd. Registered in England and Wales Number: 6517382. VAT Number: GB 944 9739 67.

...

This API specification and design is licensed under a Creative Commons Attribution 4.0 International License.