User creation resources and payloads on fhir-web

[peterMuriuki]

User creation request and payload currently done by the web

Keycloak User

use
Access control

endpoint
POST https://keycloak-stage.smartregister.org/auth/admin/realms/<realm>/users

ref

• https://www.keycloak.org/docs-api/latest/rest-api/#UserRepresentation
• https://www.keycloak.org/docs-api/latest/rest-api/#_users
• fhir-core-app-id: [FHIR Road Map]: Update User management to add the FHIR Core App ID assignment.  #1147

payload

{
	"firstName": <fname>,
	"id":<generated on server>,
	"lastName":<lname>,
	"email": <email>
	"username":<username>,
	"enabled":true,
	"attributes":
		{
			"fhir_core_app_id":[<client-id>]
		}
}

---

Practitioner Resource

prerequisite
create keycloak user

use
Represents a fhir keycloak user in the fhir hapi server.

endpoint
PUT: https://fhir.labs.smartregister.org/fhir/Practitioner/<guid>

ref

• https://hl7.org/fhir/r4b/practitioner.html#resource

payload:

{
  "resourceType": practitionerResourceType,
  "id": <guid>,
  "identifier": 
  	[
  		{
  			use: "Official", 
  			value: <id-guid>
  		}, 
  		{
      "use": IdentifierUseCodes.SECONDARY,
      "type" : {
          "coding": [
              {
                  "system": "http://hl7.org/fhir/identifier-type",
                  "code": "KUID",
                  "display": "Keycloak user ID"
              }
          ],
          "text" : "Keycloak user ID"
      	},
      "value": "$keycloak_user_uuid"
    	}
  	],
  "active": <true if keycloak user enabled else false>,
  "name": [
    {
      use: IdentifierUseCodes.OFFICIAL,
      family: values.lastName,
      given: [values.firstName, ''],
    },
  ],
  "telecom": [
    {
      system: 'email',
      value: values.email,
    },
  ],
}

---

PractiitonerRole Resource

prerequisite
create user
create practitioner

use
To categorize users as either supervisor or Normal Practitioners
see #1095

endpoint
PUT: https://fhir.labs.smartregister.org/fhir/PractitionerRole/<guid>

ref

• https://hl7.org/fhir/r4b/practitionerrole.html#resource
• [FHIR Road Map]: Add the Practitioner Roles assignment to users during user creation.  #1095 (comment)

payload

{
  "resourceType": "PractitionerRole",
  "id": <guid>,
  "identifier": [
    {
      "use": IdentifierUseCodes.SECONDARY,
      "type" : {
          "coding": [
              {
                  "system": "http://hl7.org/fhir/identifier-type",
                  "code": "KUID",
                  "display": "Keycloak user ID"
              }
          ],
          "text" : "Keycloak user ID"
      	},
      "value": "$keycloak_user_uuid"
    }
  ],
  "active": <true if keycloak user enabled else false>,
  "practitioner": {
    "reference": `Practitioner/${practitionerID}`,
    "display": <string formatted name for practitioner>,
  },
  "code": <codeable-concept for either supervisor or just practitioner>, // see issue comment
}

---

Fhir Group Resource

prerequisite
create user
create practitioner

use
#1094

endpoint
PUT: https://fhir.labs.smartregister.org/fhir/Group/<guid>

ref

• https://hl7.org/fhir/r4b/Group.html#resource
• [FHIR Road Map]: Update the User Management module to create a Group resource for the practitioner resource.  #1094 (comment)

payload

{
  "resourceType": "Group",
  "id": <guid>,
  "identifier": [
    {
      "use": IdentifierUseCodes.SECONDARY,
      "type" : {
          "coding": [
              {
                  "system": "http://hl7.org/fhir/identifier-type",
                  "code": "KUID",
                  "display": "Keycloak user ID"
              }
          ],
          "text" : "Keycloak user ID"
      	},
      "value": "$keycloak_user_uuid"
      }
  ],
  "active": <true if keycloak user is enabled else false>,
  "type": 'practitioner',
  "actual": true,
  "code": {
    "coding": [
      {
        "system": 'http://snomed.info/sct',
        "code": PRACTITIONER_USER_TYPE_CODE,
        "display": 'Assigned practitioner',
      },
    ],
  },
  "name": <keycloak-user-name>,
  "member": [
    {
      "entity": {
        "reference": `Practitioner/${practitionerID}`,
        "display": <practitioner-name>
      },
    },
  ],
};