Name |
Field Name |
Type |
Value |
Description |
Required |
Patient MRN |
MRN |
- |
eg. GIY8J1RLX0 |
Patient MRN to update the record |
No |
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 |
Profile Photo |
photo[].data |
- |
iVBORw0KGgoAAA... |
base64 format
photo[].contentType needs to be image/png
|
No |
Emergency Contact Name |
contact[].name.text |
- |
- |
Emergency Contact Name |
No |
Emergency Relationship |
contact[].relationship[0].text |
- |
- |
Relationship to the patient |
No |
Emergency Contact Email |
contact[].telecom[].value |
- |
- |
Email Address
telecom[].system needs to be set to email
telecom[].use needs to be set to home
|
No |
Emergency Contact Phone |
contact[].telecom[].value |
- |
- |
Phone Number
telecom[].system needs to be set to phone
telecom[].use needs to be set to home
|
No |
Request Type
PUT
Request URL
https://test-api.carespan.clinic/R4/Patient/{{patient_mrn}}
Request Json
{
"id": "{{patient_mrn}}",
"resourceType": "Patient",
"name": [
{
"family": "Anderson",
"given": [
"Sam"
]
}
],
"gender": "male",
"birthDate": "1990-01-01",
"telecom": [
{
"system": "phone",
"value": "+1 555-370-8810",
"use": "home"
},
{
"system": "phone",
"value": "+1 310-370-8810",
"use": "mobile"
},
{
"system": "email",
"value": "sam.anderson@mwell.com",
"use": "home"
}
],
"address": [
{
"line": [
"1046 Kutch Heights Unit 9"
],
"city": "Madison",
"state": "WI",
"postalCode": "53597",
"country": "US"
}
],
"contact": [{
"name": {
"text": "Karan Vijay"
},
"relationship": [{
"text": "Spouse"
}],
"telecom": [{
"system": "email",
"value": "test@care.com",
"use": "home"
}, {
"system": "phone",
"value": "+56333333333",
"use": "home"
}],
"address": {
"use": "home",
"type": "physical",
"line": ["Independencia 765, casa 3"],
"city": "Yerbas Buenas",
"district": "Linares",
"country": "Chile"
}
}]
}
Response Json
{
"id": "GYR2I2D8ZC",
"resourceType": "Patient",
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR"
}
]
},
"value": "GYR2I2D8ZC"
},
{
"system": "https://www.mwell.com",
"value": "abc123xyz"
}
],
"name": [
{
"family": "Anderson",
"given": [
"Sam"
]
}
],
"gender": "male",
"birthDate": "1990-01-01",
"address": [
{
"line": [
"1046 Kutch Heights Unit 9"
],
"city": "Madison",
"state": "WI",
"postalCode": "53597",
"country": "US"
}
],
"telecom": [{
"system": "phone",
"value": "+1 555-370-8810",
"use": "home"
},
{
"system": "phone",
"value": "+1 310-370-8810",
"use": "mobile"
}, {
"system": "email",
"value": "sam.anderson@mwell.com",
"use": "home"
}
],
"contact": [{
"name": {
"text": "Karan Vijay"
},
"relationship": [{
"text": "Spouse"
}],
"telecom": [{
"system": "email",
"value": "test@care.com",
"use": "home"
}, {
"system": "phone",
"value": "+56333333333",
"use": "home"
}],
"address": {
"use": "home",
"type": "physical",
"line": ["Independencia 765, casa 3"],
"city": "Yerbas Buenas",
"district": "Linares",
"country": "Chile"
}
}]
}