FHIR Patient Input

Input representation for the FHIR patient resource.

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 
NameTypeDescriptionRequired or OptionalAvailable Version
activeBooleanIndicates whether the patient record is active or not.Optional53.0
additional​InformationCustom Field Value Input[]Adds additional information to any fields not mapped in this API.Optional53.0
addressFHIR Address Input[]The address of the patient.Optional53.0
birthDateStringThe date of birth of the patient.Optional53.0
communicationPatient Communication Language Input[]The languages of communication associated with the patient.Optional53.0
contactContact 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.Optional53.0
deceased​​​DateTimeStringThe date and time of the patient’s death.Optional53.0
genderStringThe gender of the patient.Optional53.0
general​PractitionerFHIR 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​.Optional53.0
identifierFHIR Identifier Input[]The identifier information for the patient, stored as Identifier records that reference the patient record using their Identifier​.Parent​RecordId field.Optional53.0
managing​OrganisationFHIR Reference InputThe 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​.Optional53.0
maritalStatusStringThe current marital status of the patient.Optional53.0
multiple​BirthIntegerIntegerThe birth order of the patient, in the event that the patient was a part of a multiple birth event.Optional53.0
nameFHIR Human Name Input[]The names of the patient, stored as a PersonName record.Optional53.0
sourceSystemIdStringThe source system ID associated with a patient record.Optional53.0
telecomFHIR 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.Optional53.0

Health Cloud Developer Guide
Health Cloud Data Model
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Health Cloud Platform Events
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Create Patient
REST Reference
Resources
Request Bodies
Action Plan Context Filters Input
Action Plan Template Input
Action Plan Template Item Filters Input
Address Input
Appointed Representative Input
Assessment Question Responses Document Input
Asset Search Criteria Input
Book Slot Chain Input
Build Identity Verification Context Input
Captcha Token Input
Care Request Case Input
Care Request Patient Input
Care Authorization Request Input
Care Diagnosis Input
Care Request Drug Input
Care Request Input
Care Request Item Input
Care Requests List Input
Care Request Reviewer Input
Care Request Subscriber Input
Care Requests Update List Input
Content Document Input
Common Search Criteria Input
Create Visit Request Input
Custom Field Value Input
Digital Verification Input
Digital Verification Input Fields Map
Dispenser Address Input
Document Management Input
Enrollee Product Input
Extract Document Data Input
Template Match Input
Field Value Input
FHIR Address Input
FHIR Codeable Concept Input
FHIR Codeable Concept Or ID Input
FHIR Coding Input
FHIR Contact Point Input
FHIR Dispense Input
FHIR Dosage Input
FHIR Dose
FHIR Dose And Rate
FHIR Human Name Input
FHIR Identifier Input
FHIR Medication Statement
FHIR Medication Resource Input
FHIR Patient Input
FHIR Rate
FHIR Reference Input
FHIR Request
First Reviewer Input
FHIR Unit Of Measure
FHIR Unit Of Measure Or ID
General Practitioner Input
HPI Score Sync Input
Insurance Product Comparison Input
Medicare Product List Input
Scope of Appointment (SOA) Insurance Book Slot Input
Med Statement Input Payload
Medical Director Input
Original Denial Medical Director Input
Patient Contact Party Input
Page Specification Input
Page Specification List Input
Patient Communication Language Input
Patient Input
Post Save Operations Input
Post Transform Data Processing Input
Product Required Attributes Input
Previous Assessment Responses Input
Process Definition Input
Process Detail Input
Program Enrollment Input
Provider Search Criteria Input
Referral Management Input
Slot Input
Guest Referral Input
Record Fields Input
Referral Detail Input
Reopened By Input
Requesting Practitioner Input
Resources Input
Save Transformed Records Input
Servicing Facility Input
Servicing Practitioner Input
Search Input
Selected Search Result Input
Transport Location Input
Transform Extracted Data Input
User Credentials Input
Verification Context Input
Verified Result Input
Verifier Input
Verification Process Field Input
Visited Party Attributes Input
Visitor Attributes Input
Work Type Lead Time Input
Quotas and Allocation Input
Response Bodies
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
Health Cloud FHIR APIs
MuleSoft Direct Integrations
API End-of-Life Policy
Health Cloud Managed Package
Previous Versions