Versions Compared

Old Version 1

changes.mady.by.user Andrew Turner

Saved on

compared with

New Version Current

changes.mady.by.user Tom Pick

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

  • parameter[x]: BackboneElement

    • name =  "given-name"

    • use =  "in"

    • min =  1

    • max =  "1"

    • type =  "string"

  • parameter[x]: BackboneElement

    • name =  "last-name"

    • use =  "in"

    • min =  1

    • max =  "1"

    • type =  "string"

  • parameter[x]: BackboneElement

    • name =  "email-address"

    • use =  "in"

    • min =  1

    • max =  "1"

    • type =  "string"

  • 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 "

  • parameter[x]: BackboneElement

    • name =  "message"

    • use =  "out"

    • min = " 1"

    • max =  "1"

    • type =  "string"

  • parameter[x]: BackboneElement

    • name =  "id"

    • use =  "out"

    • min = " 1"

    • max =  "1"

    • type =  "string"

  user-type options:

  • PKB_TEAM_PRO

  • PKB_TEAM_COORD

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




id - (UUID of invited [[Practitioner]]):

...

/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" }]}

...

/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" }]}

...

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

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.