In FHIR STU3 standard, Patient resource is designed for, demographics and other administrative information about an individual or animal receiving care
or other health-related services.
Using Patient resource defined in FHIR, many CCDS elements have already been included into this resource, like, Patient Name,
Sex, Date of Birth, Race, Ethnicity, Preferred Language are all contained in this specific resource.
Required or some important fields and parameters would be given in the following tables. And usage on how to operate on this resource would also be listed.
Resource Element Fields
| Name | Description | Type |
|---|---|---|
| identifier | The identifier for this specific patient | Identifier |
| gender | The sex of this specific patient | code (AdministrativeGender) |
| birthDate | The date of birth for the individual | date |
| name | The name of the individual | HumanName |
| race | The race of the individual | Extension (StructureDefinition-us-core-race) |
| ethnicity | The ethnicity information of the individual | Extension (StructureDefinition-us-core-ethnicity) |
| communication | A list of Languages which may be used to communicate with the patient about his or her health | BackboneElement (language: CodeableConcept, preferred: boolean) |
Get Patient by Id
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Patient/{id}
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Patient/232
Search With Parameters
In this API, users are able to search the corresponding resource using certain parameters given. Most available parameters are listed as follow.
| Parameter Name | Description | Type | Required |
|---|---|---|---|
| _id | The Id of the certain resource | string | False |
| active | The status of this patient record. A normal record is active | boolean | False |
| address | Address of the patient | string | False |
| address-city | Address information of the patient concerning the city where the patient is located | string | False |
| address-country | Address information of the patient concerning the country where the patient is located | string | False |
| address-postalcode | Address information of the patient concerning the postal code where the patient is located | string | False |
| address-state | Address information of the patient concerning the state where the patient is located | string | False |
| address-use | Address information of the patient concerning the usage of this address | string | False |
| birthdate | The birth date of the patient | dateTime | False |
| death-date | The decease date of the patient | dateTime | False |
| deceased | Whether the patient is deceased or not | boolean | False |
| The email address of this patient | string | False | |
| family | The family name of the patient | string | False |
| gender | The sex of the patient | string | False |
| given | The given name of the patient | string | False |
| identifier | The unique identifier for the patient | string | False |
| language | Languages spoken by the patient | string | False |
| name | The full name of the patient | string | False |
| phone | Phone number communication of the patient | string | False |
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Patient?{parameter}(&{parameter} ...)
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Patient?birthdate=1980-08-01&family=Bates
{
"resourceType": "Bundle",
"id": "e79408c8-e1d2-43f1-912a-45c71b0ce6e2",
"meta": {
"lastUpdated": "2017-12-19T11:07:14.473-06:00"
},
"type": "searchset",
"total": 3,
"link": [
{
"relation": "self",
"url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Patient?birthdate=1980-08-01&family=Bates"
}
],
"entry": [
{
"fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Patient/66",
"resource": {
"resourceType": "Patient",
"id": "66",
"meta": {
"versionId": "1",
"lastUpdated": "2017-12-13T14:15:25.000-06:00"
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table class=\"hapiPropertyTable\"><tbody/></table></div>"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Patient/298",
"resource": {
"resourceType": "Patient",
"id": "298",
"meta": {
"versionId": "1",
"lastUpdated": "2017-12-15T15:20:07.000-06:00"
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">Jeremy V <b>BATES </b> Jr</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Address</td><td><span>1357, Amber Dr </span><br/><span>Beaverton </span><span>OR </span></td></tr><tr><td>Date of birth</td><td><span>01 August 1980</span></td></tr></tbody></table></div>"
},
"name": [
{
"use": "usual",
"family": "Bates",
"given": [
"Jeremy",
"V"
],
"suffix": [
"Jr"
]
}
],
"telecom": [
{
"system": "phone",
"value": "+1-(555)777-1234",
"use": "mobile"
},
{
"system": "phone",
"value": "+1-(555)723-1544",
"use": "home"
}
],
"gender": "male",
"birthDate": "1980-08-01",
"address": [
{
"use": "home",
"type": "physical",
"line": [
"1357, Amber Dr"
],
"city": "Beaverton",
"state": "OR",
"postalCode": "97006"
}
],
"communication": [
{
"language": {
"coding": [
{
"system": "2.16.840.1.113883.4.642.3.891",
"code": "en",
"display": "English"
}
]
},
"preferred": true
}
],
"managingOrganization": {
"reference": "Organization/299"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Patient/520",
"resource": {
"resourceType": "Patient",
"id": "520",
"meta": {
"versionId": "1",
"lastUpdated": "2017-12-19T10:07:33.000-06:00"
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">Jeremy V <b>BATES </b> Jr</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Address</td><td><span>1357, Amber Dr </span><br/><span>Beaverton </span><span>OR </span></td></tr><tr><td>Date of birth</td><td><span>01 August 1980</span></td></tr></tbody></table></div>"
},
"name": [
{
"use": "usual",
"family": "Bates",
"given": [
"Jeremy",
"V"
],
"suffix": [
"Jr"
]
}
],
"telecom": [
{
"system": "phone",
"value": "+1-(555)777-1234",
"use": "mobile"
},
{
"system": "phone",
"value": "+1-(555)723-1544",
"use": "home"
}
],
"gender": "male",
"birthDate": "1980-08-01",
"address": [
{
"use": "home",
"type": "physical",
"line": [
"1357, Amber Dr"
],
"city": "Beaverton",
"state": "OR",
"postalCode": "97006"
}
],
"communication": [
{
"language": {
"coding": [
{
"system": "2.16.840.1.113883.4.642.3.891",
"code": "en",
"display": "English"
}
]
},
"preferred": true
}
],
"managingOrganization": {
"reference": "Organization/521"
}
},
"search": {
"mode": "match"
}
}
]
}