FHIR Patient Input

The Patient FHIR resource maps to the Patient objects in Salesforce​. Patients are modeled using Person Accounts.

JSON example

1{
2  "active": true,
3  "identifier": [
4    {
5      "assigner": {
6        "referenceResource": "Organization",
7        "referenceId": "Org12345XYZ"
8      },
9      "type": {
10        "text": "Passport Number",
11        "coding": [
12          {
13            "display": "Passport number",
14            "code": "PPN",
15            "isActive": true,
16            "use": "Identifier"
17          }
18        ]
19      },
20      "value": "ABCD5678XYZ"
21    }
22  ],
23  "name": [
24    {
25      "use": "alias",
26      "text": "Charles Green",
27      "family": "Green",
28      "given": "Charles",
29      "prefix": "Mr.",
30      "suffix": "Sr."
31    }
32  ],
33  "communication": [
34    {
35      "language": "English",
36      "preferenceRank": 1
37    }
38  ],
39  "address": [
40    {
41      "use": "temp",
42      "type": "postal",
43      "line": "Green Household"
44    }
45  ],
46  "telecom": [
47    {
48      "system": "email",
49      "value": "a@bc.com"
50    }
51  ],
52  "gender": "male",
53  "birthDate": "2000-09-12T18:13:41Z",
54  "maritalStatus": "married",
55  "contact": [
56    {
57      "relationship": {
58        "coding": [
59          {
60            "display": "Partner"
61          }
62        ]
63      },
64      "name": {
65        "use": "Temp",
66        "text": "Shawna Green",
67        "family": "Green",
68        "given": "Shawna",
69        "prefix": "Mrs.",
70        "suffix": "Jr."
71      },
72      "telecom": [
73        {
74          "system": "email",
75          "value": "c@de.com"
76        },
77        {
78          "system": "phone",
79          "value": "12345678",
80          "use": "temp",
81          "rank": 1
82        }
83      ],
84      "address": {
85        "use": "temp",
86        "type": "postal",
87        "line": "Green Household"
88      }
89    }
90  ],
91  "generalPractitioner": [
92    {
93      "referenceResource": "Practitioner",
94      "referenceId": "PRAC789XYZ",
95      "relationship": "Plastic Surgeon"
96    }
97  ],
98  "managingOrganisation": {
99    "referenceResource": "Organization",
100    "referenceId": "MI9007GBE"
101  }
102}

Properties

Name	Type	Description	Required or Optional	Available Version
active	Boolean	Indicates whether the patient record is active or not.	Optional	53.0
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 of the patient.	Optional	53.0
birthDate	String	The date of birth of the patient.	Optional	53.0
communication	Patient Communication Language Input[]	The languages of communication associated with the patient.	Optional	53.0
contact	Contact Party For Patient Input[]	The contact associated with the patient record, modeled as a person account. Contacts are connected to patients using the Contact​Contact​Relation__c junction object.	Optional	53.0
deceased​​​DateTime	String	The date and time of the patient’s death.	Optional	53.0
gender	String	The gender of the patient.	Optional	53.0
general​Practitioner	FHIR Reference Input[]	The practitioners associated with the patient, modeled as either person accounts or Contacts and HealthcareProvider records. Practitioners are connected to patients using the Contact​Contact​Relation__c junction object​.	Optional	53.0
identifier	FHIR Identifier Input[]	The identifier information for the patient, stored as Identifier records that reference the patient record using their Identifier​.Parent​RecordId field.	Optional	53.0
managing​Organisation	FHIR Reference Input	The organization that manages the patient record, referenced using a lookup to the Account object. Managing organizations are connected to patients using the Account​Contact​Relation​ junction object​.	Optional	53.0
maritalStatus	String	The current marital status of the patient.	Optional	53.0
multiple​BirthInteger	Integer	The birth order of the patient, in the event that the patient was a part of a multiple birth event.	Optional	53.0
name	FHIR Human Name Input[]	The names of the patient, stored as a PersonName record.	Optional	53.0
sourceSystemId	String	The source system ID associated with a patient record.	Optional	53.0
telecom	FHIR Contact Point Input[]	Contact details of the patient, such as phone numbers and email addresses. These contact details are stored as Contact​Point​Phone records that reference the patient records using their Contact​Point​Phone​.ParentId field.	Optional	53.0