Get a list of patients
get
/Patient
Retrieves a list of patients that meet supplied query parameters.
Note:- A
422 (Unprocessable Content)status code is returned when more than 1000 patients qualify for the search criteria. - The
name,family, andgivenparameters support the:exactmodifier and search for current names only, based on the name'speriod. - Oracle Cerner does not recommend combining the
familyorgivenparameters with thenameparameter when searching for a patient. Whenever possible, use the:exactmodifier.
Request
Query Parameters
-
_count: integer
Minimum Value:
1The maximum number of results to return.
Example:
_count=15 -
_id: array[string]
Minimum Number of Items:
1The logical resource ID. This parameter is required if no other parameter is used.
Example:
_id=12345 -
_revinclude: string
The Provenance resource entries to be returned as part of the bundle.
- May be provided once with the value of
Provenance:target. Example:_revinclude=Provenance:target. - Requires the OAuth2 token to include the Provenance scope corresponding with the current Patient scope, such as
user/Provenance.read,patient/Provenance.read, orsystem/Provenance.read.
Allowed Values:[ "Provenance:target" ] - May be provided once with the value of
-
address-postalcode: string
The postal code in the address details of the patient. May be provided once with a single value.
Example:
address-postalcode=12345 -
birthdate: array[string]
Collection Format:
multiMinimum Number of Items:1Maximum Number of Items:2The patient's date of birth.
- May be provided once using one of the following prefixes to imply a date range:
ge,le,gt,lt, oreq. - May be provided twice to indicate a date range and must contain one prefix each of
leandge. Example:birthdate=ge2001-03-13&birthdate=le2001-05-01. - Must not be provided with a time component.
- May be provided once using one of the following prefixes to imply a date range:
-
email: string
The patient's email. May be provided once with a single value.
Example:
email=example@example.com -
family: array[string]
Minimum Number of Items:
1Maximum Number of Items:1The start of the family name of the patient. May be provided once with a single value.
The
:exactmodifier is supported and searches for current names based on the name'speriod.Example:
family=Smith -
gender: string
The patient's gender. May be provided once with a single value.
Allowed Values:[ "male", "female", "other", "unknown" ] -
given: array[string]
Minimum Number of Items:
1Maximum Number of Items:1The start of the given name of the patient. May be provided once with a single value.
The
:exactmodifier is supported and searches for current names based on the name'speriod.Searching by the given name requires the
familyparameter.Example:
given=Sally -
identifier: array[string]
Minimum Number of Items:
1Maximum Number of Items:1A patient identifier.
- May be provided once with a single value.
- Requires a code, but the system is optional. If the system is not provided, the search is performed across all systems supported by the Patient resource.
- Searches against the specific system, if it is provided.
- Accepts a Social Security Number (SSN), but the value is not returned in a matching response.
Example:
identifier=urn:oid:1.1.1.1.1.1|1022228 -
name: array[string]
Minimum Number of Items:
1Maximum Number of Items:1The start of the given name or the family name of the patient. May be provided once with a single value.
The
:exactmodifier is supported and searches for current names based on the name'speriod.Example:
name=Riley -
phone: string
The patient's phone number. May be provided once with a single value.
Example:
phone=1234567891
Header Parameters
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.
-
accept(required): string
The media type to be requested. See what the resource's operation produces for what is supported.
Response
Supported Media Types
- application/fhir+json
Default Response
This operation supports the following authorization types:
Example Request:
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?family=smart&given=joe&birthdate=1990-09-15{
"resourceType": "Bundle",
"id": "b8e08a98-849f-4544-9fa8-985aa445e31b",
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?_id=12724067"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12724067",
"resource": {
"resourceType": "Patient",
"id": "12724067",
"meta": {
"versionId": "10",
"lastUpdated": "2020-07-06T21:21:22.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Patient</b></p><p><b>Name</b>: SMART, JOE</p><p><b>Status</b>: Active</p><p><b>DOB</b>: Apr 29, 1976</p><p><b>Administrative Gender</b>: Male</p><p><b>Marital Status</b>: Married</p></div>"
},
"extension": [
{
"id": "59434424",
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4640016",
"code": "485602703",
"display": "Appointment Reminders",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/communication-topic",
"code": "appointment-reminder",
"display": "Appointment Reminder",
"userSelected": false
}
],
"text": "Appointment Reminders"
},
"url": "communication-type"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/23042",
"code": "495085513",
"display": "Fax",
"userSelected": true
},
{
"system": "http://hl7.org/fhir/contact-point-system",
"code": "fax",
"display": "Fax",
"userSelected": false
}
],
"text": "Fax"
},
"url": "contact-method"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/43",
"code": "163",
"display": "Business",
"userSelected": true
},
{
"system": "http://hl7.org/fhir/contact-point-use",
"code": "work",
"display": "Work",
"userSelected": false
}
],
"text": "Business"
},
"url": "contact-type"
},
{
"valueDateTime": "2019-04-13T20:00:00.000Z",
"url": "verified-datetime"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "White",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Non Hispanic or Latino",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "Not Hispanic, Latino, or Spanish Origin",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "446141000124107",
"display": "Identifies as female gender (finding)",
"userSelected": false
}
],
"text": "Identifies as female"
},
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
"code": "557",
"display": "Umkumiut Native Village",
"userSelected": true
}
],
"text": "Umkumiut Native Village"
},
"url": "tribalAffiliation"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
"valueCode": "248153007"
}
],
"identifier": [
{
"id": "CI-490016886-0",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "10",
"display": "MRN",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "6931",
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
},
{
"id": "CI-490058771-1",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "10",
"display": "MRN",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "6978",
"period": {
"end": "2020-07-06T21:21:25.000Z"
}
},
{
"id": "CI-490059574-3",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "670843",
"display": "Messaging",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "U",
"display": "Unspecified identifier",
"userSelected": false
}
],
"text": "Messaging"
},
"_system": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"value": "3C36293A3B964994AD8E6C0305F3330A",
"period": {
"start": "2020-06-30T20:08:26.000Z"
}
},
{
"id": "CI-490058805-4",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "670843",
"display": "Messaging",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "U",
"display": "Unspecified identifier",
"userSelected": false
}
],
"text": "Messaging"
},
"_system": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"value": "43DA797A657B47548F258A9B50EB41F5",
"period": {
"start": "2020-06-12T16:03:32.000Z"
}
},
{
"id": "CI-490059570-5",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236771",
"display": "Federated Person Principal",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "AN",
"display": "Account number",
"userSelected": false
}
],
"text": "Federated Person Principal"
},
"system": "urn:oid:2.16.840.1.113883.3.13.6",
"value": "URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:AN7TD9A62CV8Z53Z",
"period": {
"start": "2020-06-30T20:08:25.000Z"
}
},
{
"id": "CI-490058801-6",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236771",
"display": "Federated Person Principal",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "AN",
"display": "Account number",
"userSelected": false
}
],
"text": "Federated Person Principal"
},
"system": "urn:oid:2.16.840.1.113883.3.13.6",
"value": "URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:KR8KC9MI9EQ8KC23",
"period": {
"start": "2020-06-12T16:03:29.000Z"
}
}
],
"active": true,
"name": [
{
"id": "CI-12724067-0",
"use": "official",
"text": "SMART, JOE",
"family": "SMART",
"given": [
"JOE"
],
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
},
{
"id": "CI-490059796-0",
"use": "old",
"text": "SMART, STEPHEN ALLEN",
"family": "SMART",
"given": [
"STEPHEN",
"ALLEN"
],
"period": {
"end": "2020-07-06T21:21:26.000Z"
}
}
],
"telecom": [
{
"id": "CI-PH-29811920-0",
"extension": [
{
"valueUrl": "(816)888-8886",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
},
{
"valueString": "12345",
"url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
}
],
"system": "phone",
"value": "8168888886",
"use": "home",
"rank": "1",
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
},
{
"id": "CI-EM-29822662-0",
"system": "email",
"value": "joesmart@yopmail.com",
"use": "home",
"rank": "1",
"period": {
"start": "2020-03-30T19:31:11.000Z"
}
}
],
"gender": "male",
"birthDate": "1976-04-29",
"deceasedBoolean": false,
"address": [
{
"id": "CI-24313553-0",
"use": "home",
"text": "12345 Main St\\nKansas city, MO 64116\\nUS",
"line": [
"12345 Main St"
],
"city": "Kansas city",
"district": "Jackson",
"state": "MO",
"postalCode": "64116",
"country": "US",
"period": {
"start": "2019-12-26T15:13:36.000Z"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/38",
"code": "309237",
"display": "Married",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married",
"userSelected": false
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
"code": "151",
"display": "English",
"userSelected": true
},
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English",
"userSelected": false
}
],
"text": "English"
},
"preferred": true
}
],
"generalPractitioner": [
{
"id": "CI-490017023-0",
"reference": "Practitioner/4122622",
"display": "Cerner Test, Physician - Hospitalist Cerner"
}
]
}
}
]
}Headers
-
X-Request-Id: string
Oracle troubleshooting identifier.
-
opc-request-id: string
Oracle troubleshooting identifier.
x-patient-revinclude Response
This operation supports the following authorization types:
Example Request:
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?_id=629928&_revinclude=Provenance:target{
"resourceType": "Bundle",
"id": "65ee4c79-3514-4eab-b606-10ad56fb0d5d",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?_id=629928&_revinclude=Provenance%3Atarget"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/629928",
"resource": {
"resourceType": "Patient",
"id": "629928",
"meta": {
"versionId": "36",
"lastUpdated": "2020-09-17T16:35:12.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Patient</b></p><p><b>Name</b>: England,\n Brad N</p><p><b>Status</b>: Active</p><p><b>DOB</b>: Jan 20, 1999</p>\n <p><b>Administrative Gender</b>: Unknown</p></div>"
},
"identifier": [
{
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
}
],
"active": true,
"name": [
{
"id": "CI-629928-0",
"use": "official",
"text": "England, Brad N",
"family": "England",
"given": [
"Brad",
"N"
],
"period": {
"start": "2004-01-27T00:00:00.000Z"
}
}
],
"telecom": [
{
"id": "CI-PH-46477780-0",
"extension": [
{
"valueUrl": "2232323",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "2232323",
"rank": 1,
"period": {
"start": "2021-01-11T06:00:00.000Z"
}
},
{
"id": "CI-PH-9543543-1",
"extension": [
{
"valueUrl": "1234567890",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
},
{
"valueString": "345",
"url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
}
],
"system": "phone",
"value": "1234567890",
"use": "home",
"rank": 1,
"period": {
"start": "2014-01-20T15:48:39.000Z",
"end": "2014-03-20T15:48:39.000Z"
}
},
{
"id": "CI-PH-9543573-2",
"extension": [
{
"valueUrl": "1234567890",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
},
{
"valueString": "345",
"url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
}
],
"system": "phone",
"value": "1234567890",
"use": "home",
"rank": 1,
"period": {
"start": "2014-01-20T15:48:39.000Z",
"end": "2014-03-20T15:48:39.000Z"
}
}
],
"gender": "unknown",
"birthDate": "1999-01-20",
"contact": [
{
"relationship": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
"code": "83266815",
"display": "Authorized Representative",
"userSelected": true
}
],
"text": "Authorized Representative"
}
],
"name": {
"id": "CI-170778458-0",
"use": "official",
"text": "MARSTON, Dutch",
"family": "MARSTON",
"given": [
"Dutch"
],
"period": {
"start": "2020-08-26T14:44:08.000Z"
}
},
"telecom": [
{
"system": "email",
"value": "kaishwaryaramesh@gmail.com",
"use": "home",
"rank": 1,
"period": {
"start": "2020-10-09T07:29:32.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 2,
"period": {
"start": "2020-08-26T14:45:59.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 3,
"period": {
"start": "2020-08-26T16:47:31.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 4,
"period": {
"start": "2020-08-27T20:27:31.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 5,
"period": {
"start": "2020-08-28T15:24:19.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 6,
"period": {
"start": "2020-08-31T15:16:18.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 7,
"period": {
"start": "2020-09-10T20:41:05.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 8,
"period": {
"start": "2020-09-11T15:52:04.000Z"
}
}
],
"gender": "male",
"period": {
"start": "2020-08-27T20:27:31.000Z"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/ptntdemo-17390433",
"resource": {
"resourceType": "Provenance",
"id": "ptntdemo-17390433",
"meta": {
"versionId": "17390433",
"lastUpdated": "2021-06-03T11:18:59Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p>\n <p><b>Target</b>:</p><ul><li>Patient/629928</li></ul>\n <p><b>Recorded</b>: Jun 3, 2021 6:18 A.M. CDT</p>\n <p><b>Agents</b>:</p><dl><dt>organizationName PrH</dt>\n <dd><b>Agent Type</b>: Author</dd>\n <dd><b>Agent Role</b>: Source</dd></dl><p><b>Entity Source</b>: DocumentReference/S-68607</p></div>"
},
"target": [
{
"reference": "Patient/629928"
}
],
"recorded": "2021-06-03T11:18:59Z",
"agent": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code": "author"
}
],
"text": "Author"
},
"role": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
"code": "SOURCE"
}
],
"text": "Source"
}
],
"who": {
"reference": "Organization/59917604",
"display": "organizationName PrH"
}
}
],
"entity": [
{
"role": "source",
"what": {
"reference": "DocumentReference/S-68607"
}
}
]
},
"search": {
"mode": "include"
}
}
]
}Headers
-
X-Request-Id: string
Oracle troubleshooting identifier.
-
opc-request-id: string
Oracle troubleshooting identifier.