FHIR R4 Patient Search
This resource conforms to the US-Core Patient StructureDefinition.
Request
GET [base]/fhir/Patient?identifier={system|}[code]&active=[boolean]&email=[string]...
Parameters
| Name | Type | Description | Optional? |
|---|---|---|---|
| _id | string | The patients external UUID | true |
| identifier | token | A patient identifier of SN, SD, or DL | true |
| active | boolean | The patients is active in the EMR | true |
| deceased | boolean | The patients is deceased | true |
| string | The patients email address | true | |
| gender | token | The patients gender code | true |
| birthdate | date | The patients date of birth | true |
| death-date | date | The patients date of death | true |
| organization | string | The patients organization’s unique identifier | true |
Response
{
"id": "6cc8ae9e-8ba7-4d4a-bc46-d1e0fd7d35ef",
"language": "en-US",
"identifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:6cc8ae9e-8ba7-4d4a-bc46-d1e0fd7d35ef"
},
"type": "searchset",
"timestamp": "2020-10-15T20:25:47+00:00",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://api.testing.consolo.services/fhir/Patient?identifier=101111011&name=Blitzenberg&page=1"
}
],
"entry": [
{
"resource": {
"id": "a3a2e697-3035-4d9e-a7d5-73f9f567bdaa",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
"text": {
"status": "generated",
"div": "<div><ul>\n<li>\n<strong>Patient Name</strong><p>Wolf Blitzenberg</p>\n</li>\n<li>\n<strong>Date of Birth</strong><p>1949-01-17</p>\n</li>\n<li>\n<strong>Gender</strong><p>male</p>\n</li>\n<li>\n<strong>Address</strong><p>123 W Main St, Lexington, KY, 40507-1320</p>\n</li>\n<li>\n<strong>Social Security Number</strong><p>***-**-1011</p>\n</li>\n<li>\n<strong>Driver's License Number</strong><p>K452115730420</p>\n</li>\n</ul></div>"
},
"extension": [
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White"
}
},
{
"url": "detailed",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2110-5",
"display": "English"
}
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2135-2",
"display": "Hispanic or Latino"
}
},
{
"url": "detailed",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2182-4",
"display": "Cuban"
}
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "M"
}
],
"identifier": [
{
"use": "secondary",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "DL",
"display": "Driver's license number"
}
],
"text": "Patient Driver's License Number: K452115730420"
},
"value": "K452115730420"
},
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SB",
"display": "Social Security Number"
}
],
"text": "Patient Social Security Number: 101111011"
},
"value": "101111011"
}
],
"active": true,
"name": [
{
"use": "usual",
"text": "Wolf Blitzenberg",
"family": "Blitzenberg",
"given": [
"Wolf"
]
}
],
"telecom": [
{
"system": "phone",
"value": "5555555555",
"use": "home"
},
{
"system": "phone",
"value": "5555555555 (H)",
"use": "home"
},
{
"system": "phone",
"value": "5555555555",
"use": "mobile"
},
{
"system": "email",
"value": "wolf.blitzenberg@odey.com",
"use": "home"
}
],
"gender": "male",
"birthDate": "1949-01-17",
"address": [
{
"use": "home",
"type": "both",
"text": "123 W Main St, Lexington, KY, 40507-1320",
"line": [
"123 W Main St"
],
"city": "Lexington",
"district": "Fayette",
"state": "KY",
"postalCode": "40507-1320",
"country": "USA"
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married"
}
],
"text": "Marital Status: Married"
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en"
}
]
},
"preferred": true
}
],
"managingOrganization": {
"reference": "https://api.testing.consolo.services/fhir/Organization/4ea0c05b-ebab-4353-b957-b6295ad9c6da",
"display": "Consolo Demo"
},
"resourceType": "Patient"
},
"search": {
"mode": "include"
}
}
],
"resourceType": "Bundle"
}