| Name |
Field Name |
Type |
Value |
Description |
Required |
| First Name |
name[].given.0 |
- |
- |
First name |
Yes |
| Middle Name |
name[].given.1 |
- |
- |
Middle name |
No |
| Last Name |
name[].family |
- |
- |
Last name |
Yes |
| Date of Birth |
birthDate |
- |
eg. 1998-10-10 |
in YYYY-MM-DD format |
Yes |
| Gender |
gender |
- |
male | female |
- |
Yes |
| Email |
telecom[].value |
- |
test@test.com |
telecom[].system needs to be set to email
telecom[].use needs to be set to home
|
Yes |
| Mobile No. |
telecom[].value |
- |
9988776655 |
telecom[].system needs to be set to phone
telecom[].use needs to be set to mobile
|
Yes |
| Home Phone No. |
telecom[].value |
- |
3103775842 |
telecom[].system needs to be set to phone
telecom[].use needs to be set to Home
|
No |
| Address |
address[].line[] |
- |
- |
Street address lines (up to 3 lines) |
Yes |
| State |
address[].state |
- |
- |
Province |
Yes |
| City |
address[].city |
- |
- |
City |
Yes |
| Postal Code |
address[].postalCode |
- |
- |
Zip Code |
Yes |
| Country |
address[].country |
- |
US | PH |
2 letter country ode |
Yes |
| District |
address[].district |
- |
- |
barangay id |
No |
| Qualification/License |
qualification[].identifier.value |
- |
- |
The license/id/qualification number
If PRC (PH), use https://online2.prc.gov.ph/Verification as qualification[].identifier.system
|
Yes |
| Issued at |
qualification[].period.start |
- |
eg. 1980-01-18 |
YYYY-MM-DD format |
Yes |
| Expired at |
qualification[].period.end |
- |
eg. 2099-12-31 |
YYYY-MM-DD format |
Yes |
| Issuer name |
qualification[].issuer.display |
- |
- |
- |
Yes |
| Profile Photo |
photo[].data |
- |
iVBORw0KGgoAAA... |
base64 format
photo[].contentType needs to be image/png
|
No |
| Practitioner 3rd party ID |
identifier[].value |
- |
Unique MWell user ID |
Need to make sure identifier[].system is set to https://www.mwell.com |
No |
Request Type
POST
Request URL
https://test-api.carespan.clinic/R4/Practitioner
Request Json
{
"resourceType": "Practitioner",
"identifier": [
{
"system": "https://www.mwell.com",
"value": "MWELL123456"
}
],
"name": [
{
"family": "Holiday",
"prefix": [
"DR"
],
"given": [
"Mina",
"Louis"
]
}
],
"gender": "female",
"birthDate": "1965-01-18",
"qualification": [
{
"identifier": [
{
"system": "https://online2.prc.gov.ph/Verification",
"value": "12345"
}
],
"period": {
"start": "1980-01-18",
"end": "2025-01-18"
},
"issuer": {
"display": "PH PRC"
}
}
],
"telecom": [
{
"system": "phone",
"value": "+1 555-370-8810",
"use": "home"
},
{
"system": "phone",
"value": "+1 310-370-8810",
"use": "mobile"
},
{
"system": "email",
"value": "mina.holiday@test.com",
"use": "home"
}
],
"address": [
{
"line": [
"1046 Kutch Heights Unit 8"
],
"city": "Madison",
"state": "WI",
"postalCode": "53597",
"country": "PH"
}
],
"photo": [
{
"contentType": "image/png",
"data": "iVBORw0KGgoAA..."
}
]
}
Response Json (Success)
{
"id": "GYPPYKGL5R",
"resourceType": "Practitioner",
"identifier": [
{
"system": "https://www.mwell.com",
"value": "MWELL123456"
},
{
"system": "https://api.carespan.clinic/fhir/coding/practitioners",
"value": "GYPPYKGL5R"
}
],
"name": [
{
"family": "Holiday",
"prefix": [
"DR"
],
"given": [
"Mina",
"Louis"
]
}
],
"telecom": [
{
"system": "phone",
"value": "+1 555-370-8810",
"use": "home"
},
{
"system": "phone",
"value": "+1 310-370-8810",
"use": "mobile"
},
{
"system": "email",
"value": "mina.holiday@test.com",
"use": "home"
}
],
"address": [
{
"line": [
"1046 Kutch Heights Unit 8"
],
"city": "Madison",
"state": "WI",
"postalCode": "53597",
"country": "PH"
},
{
"line": [
"1046 Kutch Heights Unit 8"
],
"city": "Madison",
"state": "WI",
"postalCode": "53597",
"country": "PH"
}
],
"gender": "female",
"birthDate": "1965-01-18",
"photo": [
{
"contentType": "image/png",
"data": "iVBORw0KGgoAA..."
},
],
"qualification": [
{
"identifier": [
{
"system": "https://online2.prc.gov.ph/Verification",
"value": "12345"
}
],
"period": {
"start": "1980-01-18",
"end": "2025-01-18"
},
"issuer": {
"display": "PH PRC"
}
}
]
}
Response Json (Success)
{
"id": "GYPPYKGL5R",
"resourceType": "Practitioner",
"identifier": [
{
"system": "https://www.mwell.com",
"value": "MWELL123456"
},
{
"system": "https://api.carespan.clinic/fhir/coding/practitioners",
"value": "GYPPYKGL5R"
}
],
"name": [
{
"family": "Holiday",
"prefix": [
"DR"
],
"given": [
"Mina",
"Louis"
]
}
],
"telecom": [
{
"system": "phone",
"value": "+1 555-370-8810",
"use": "home"
},
{
"system": "phone",
"value": "+1 310-370-8810",
"use": "mobile"
},
{
"system": "email",
"value": "mina.holiday@test.com",
"use": "home"
}
],
"address": [
{
"line": [
"1046 Kutch Heights Unit 8"
],
"city": "Madison",
"state": "WI",
"postalCode": "53597",
"country": "PH"
},
{
"line": [
"1046 Kutch Heights Unit 8"
],
"city": "Madison",
"state": "WI",
"postalCode": "53597",
"country": "PH"
}
],
"gender": "female",
"birthDate": "1965-01-18",
"photo": [
{
"contentType": "image/png",
"data": "iVBORw0KGgoAA..."
},
],
"qualification": [
{
"identifier": [
{
"system": "https://online2.prc.gov.ph/Verification",
"value": "12345"
}
],
"period": {
"start": "1980-01-18",
"end": "2025-01-18"
},
"issuer": {
"display": "PH PRC"
}
}
]
}
Response Json (Similar User Found)
The user is not added
When this happens, we will need to intervene manually. We need to take their IDs and manually check if the users are the same and process separately.
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "warning",
"code": {
"coding": [
{
"coding": "FOUND_SIMILAR_USERS",
"text": "Similer user found"
}
]
},
"diagnostics": "[{\"allMatched\":true,\"matched\":{\"fname\":true,\"lname\":true,\"dob\":true,\"email\":true},\"fields\":{\"id\":\"587\",\"guid\":\"1547513102480047\",\"permission\":\"3\",\"mrn\":\"GYPPYKGL5R\",\"fname\":\"Mina\",\"lname\":\"Holiday\",\"dob\":\"1965-01-18\",\"email\":\"mina.holiday@test.com\",\"role\":\"Practitioner\"}}]"
}
]
}