Patient Get

Output representation of details of a patient record.

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  "sourceSystemId":"567890",
92  "deceasedDateTime": "2023-02-10T10:40:13.000Z",
93  "salesforceId":"0NBRM0000004CGx4AM",
94  "generalPractitioner": [
95    {
96      "referenceResource": "Practitioner",
97      "referenceId": "PRAC789XYZ",
98      "relationship": "Plastic Surgeon"
99    }
100  ],
101  "managingOrganisation": {
102    "referenceResource": "Organization",
103    "referenceId": "MI9007GBE"
104  }
105}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`active`	Boolean	Indicates whether the patient record is active or not.	Small, 53.0	53.0
`address`	FHIR Address[]	The addresses of the patient, stored as contact point address records.	Small, 53.0	53.0
`birthDate`	String	The date of birth of the patient, recorded in Date format.	Small, 53.0	53.0
`communication`	Patient Communication Language[]	The languages of communication associated with the patient, recorded in the PersonLanguage object.	Small, 53.0	53.0
`contact`	Patient Contact Party[]	The contact party associated with the patient record. Contacts are connected to patients using a ContactContactRelation__c junction record.	Small, 53.0	53.0
`deceasedDateTime`	String	The date and time of the patient’s death.	Small, 53.0	53.0
`gender`	String	The gender of the patient.	Small, 53.0	53.0
`generalPractitioner`	FHIR Reference[]	The practitioner associated with the patient. Practitioners are connected to patients using a ContactContactRelation__c junction record.	Small, 53.0	53.0
`identifier`	FHIR Identifier[]	The identifier information for the patient, stored as Identifier records that reference the patient record using their `Identifier.ParentRecordId` field.	Small, 53.0	53.0
`managingOrganisation`	FHIR Reference[]	The organization that manages the patient recorded. Managing organizations are connected to patients using the AccountContactRelation junction object.	Small, 53.0	53.0
`maritalStatus`	String	The current marital status of the patient.	Small, 53.0	53.0
`message`	String	A message with any errors that can have been encountered while processing the request.	Small, 53.0	53.0
`multipleBirthInteger`	Integer	The birth order of the patient in a multiple-birth event.	Small, 53.0	53.0
`name`	FHIR Human Name[]	The person name of the patient.	Small, 53.0	53.0
`resourceType`	String	Reserved for future use.	Small, 53.0	53.0
`salesforceId`	String	The Salesforce ID of the Person Account record that represents the patient.	Small, 53.0	53.0
`sourceSystemId`	String	The record identifier of the patient’s record in its source system.	Small, 53.0	53.0
`telecom`	FHIR Contact Point[]	The contact details of the patient, including phone numbers and email addresses.	Small, 53.0	53.0