GET Get patient records
GET /Patient
Retrieves a set of resources by using filters.
Parameters
identifier(query, string | integer) Specifies a patient's identifier. Search is performed on 'code' or 'system' and 'code' identifiers.name(query, string) Specifies a server-defined search that matches the string fields in the HumanName - family and given names.gender(query, string) Searches based on gender using 'code' or 'system' and 'code' identifier and must be done along with the 'name' identifier. For example - 'GET [base]/Patient?gender={system|}[code]&name=[string]'.birthdate(query, string) Searches using the patient's date of birth and must be done along with the 'name' identifier. For example - 'GET [base]/Patient?birthdate=[date]&name=[string]'.Accept(header, string)
Allowed values:application/fhir+json.X-CORRELATION-ID(header, string)
Responses
- 200
Media type:
application/fhir+json. Schema:PatientBundle.Example
{ "resourceType": "Bundle", "id": "d29ec2e2-363b-4a1f-91e9-4553f016c241", "meta": { "lastUpdated": "2023-03-24T15:44:21.063+05:30" }, "type": "searchset", "total": 4, "link": [ { "relation": "self", "url": "https://localhost:8092/admin/fhir-r4/v1/Patient?identifier=20000105719994" } ], "entry": [ { "fullUrl": "https://localhost:8092/admin/fhir-r4/v1/Patient/001B000001TdJHrIAN", "search": { "mode": "match" }, "resource": { "resourceType": "Patient", "id": "001B000001TdJHrIAN", "identifier": [ { "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719994" }, { "use": "usual", "system": "urn:oid:1.2.36.146.595.217.0.1", "value": "20000105719990" } ], "active": true, "name": [ { "use": "official", "family": "silva", "given": [ "Peter" ], "text": "Peter silva", "prefix": [ "Dr" ], "suffix": [ "Jr" ], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, { "use": "official", "family": "silva", "given": [ "James" ], "text": "James silva", "prefix": [ "Dr" ], "suffix": [ "Jr" ], "period": { "start": "2001-05-06", "end": "2010-05-16" } } ], "telecom": [ { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "gender": "male", "birthDate": "1974-12-25", "deceased": { "deceasedDateTime": "2023-02-10T10:40:13.000Z" }, "address": [ { "use": "home", "city": "Abc", "line": ["100 TT Apt"], "state": "Bengal", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "use": "work", "city": "Abc", "line": ["100 TT Apt"], "state": "Delhi", "postalCode": "01045", "country": "IND", "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "maritalStatus": { "coding": [ { "code": "A" } ] }, "contact": [ { "relationship": [ { "coding": [ { "display": "Billing contact person" } ] } ], "name": { "use": "official", "family": "silva", "given": [ "Peter" ], "text": "Peter silva", "prefix": [ "Dr" ], "suffix": [ "Jr" ], "period": { "start": "2001-05-06", "end": "2010-05-16" } }, "telecom": [ { "system": "email", "value": "karen@gmail.com", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } }, { "system": "phone", "value": "990000233415", "use": "work", "rank": 2, "period": { "start": "2022-01-10", "end": "2022-01-10" } } ], "address": { "use": "home", "line": ["1003 Healthcare Home"], "city": "Abc", "state": "Bengal", "postalCode": "01045", "period": { "start": "2022-01-10", "end": "2022-01-10" } }, "gender": "male" } ], "managingOrganization": { "reference": "Organization/001B000001T33YsIAJ", "type": "Organization" } } } ] } - 500
Something went wrong.
Media type:
application/fhir+json. Schema:OperationOutcome.Example
{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "text": " Details not found." } } ] } - 503
Error connecting Salesforce.
Media type:
application/fhir+json. Schema:OperationOutcome.Example: same as GET /Patient 500 response.