JSON example
{
"PatientContactParty": [ {
"relationship": {
"coding": [
{
"display": "relative"
}
]
},
"name": {
"use": "official",
"text": "Shawna Green",
"family": "Green",
"given": "Shawna",
"prefix": "Mrs.",
"suffix": "Sr."
},
"telecom": [
{
"system": "email",
"value": "c@d3.com"
},
{
"system": "phone",
"value": "12345678",
"use": "temp",
"rank": 1
}
],
"address": {
"use": "temp",
"type": "postal",
"line": "Green Household"
},
"organization": {
"referenceResource": "Green Family Business",
"referenceId": "XYZId"
},
"gender": "female",
"periodStart": "1998-05-26T15:40:30.000Z",
"periodEnd": "2021-08-09T15:40:30.000Z",
} ]
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| additional​Information | Custom Field Value Input[] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 |
| address | FHIR Address Input | The address associated with the contact party, stored as ContactPointAddress records. | Optional | 53.0 |
| gender | String | The gender of the contact party. | Optional | 53.0 |
| name | FHIR Human Name Input | The name of the contact party, stored as PersonName records. | Optional | 53.0 |
| organisation | FHIR Reference Input | The organization associated with the contact party. | Optional | 53.0 |
| periodEnd | String | The date until when the contact is associated with the patient. | Optional | 53.0 |
| periodStart | String | The date from when the contact is associated with the patient. | Optional | 53.0 |
| relationship | FHIR Codeable Concept Input | The type of relationship between the contact party and the patient, recorded using a reference to Reciprocal Roles. | Optional | 53.0 |
| telecom | FHIR Contact Point Input[] | The telecom information for the contact party, stored as ContactPointPhone records. | Optional | 53.0 |