Skip to main content

​
Overview

Demographics and other administrative information about an individual receiving care or other health-related services. This information is used to categorize individuals for identification, records matching, and other purposes. Each Patient has next elements:
  • a patient identifier (e.g. MRN)
  • a patient name
  • a gender*
Each Patient supports next elements:
  • contact detail (e.g. a telephone number or an email address)
  • a birth date
  • an address
  • a communication language
  • a race
  • an ethnicity
  • a birth sex*

​
Handling Previous Name, Suffix and Previous address

  • Note that Previous Name, Suffix, and Previous address are listed in the USCDI.
    • Suffix is represented using the Patient.name.suffix element.
    • Previous name is represented by setting Patient.name.use to “old” and providing an end date in Patient.name.period element if known
    • Previous address is represented by setting Patient.address.use to “old” and providing an end date in Patient.address.period element if known.
    • The patient example below demonstrates the usage of both of these elements.
Profile specific implementation guidance:
  • Note that Previous Name, Suffix, and Date of Death are listed in the U.S. Core Data for Interoperability.
    • Suffix is represented using the Patient.name.suffix element.
    • Previous name is represented by providing an end date in the Patient.name.period element for a previous name.
    • Date of Death is communicated using the Patient.deceasedDateTime element.
    • The patient example below demonstrates the usage of both of these elements.
  • *The FHIR Specification provides guidance and background for representing patient gender. The American Clinical Laboratory Association (ACLA) has published best practice guidelines for administrative and clinical gender related to laboratory testing and reporting which implementers may find helpful as well.
This resource conforms to USCDI v3 profile for Patient Demographics/Information - refer to US Core Patient Profile. Patient response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version.
USCore Data ElementFHIR Resource Field
First Name/Middle NamePatient.name.given
Patient descriptionPatient.description
Last NamePatient.name.family
Previous NamePatient.name
SuffixPatient.name.suffix
Birth SexUS Core Birth Sex Extension
Date of BirthPatient.birthDate
RaceUS Core Race Extension
EthnicityUS Core Ethnicity Extension
Sexual OrientationUs Core Sexual Orientation Observation Profile
Gender IdentityUs Core Gender Identity Extension
Preferred LanguagePatient.communication
AddressPatient.address
Phone NumberPatient.telecom

​
Must support elements, mandatory and optional search parameters

Patientmust support these elements:
  • us-core-race (Must support in USCDI v3)
  • us-core-ethnicity (Must support in USCDI v3)
  • us-core-tribal-affiliation (Must support in USCDI v3)
  • us-core-sex (Must support in USCDI v3)
  • us-core-genderIdentity (Must support in USCDI v3)
  • identifier
    • system
    • value
  • name
    • family
    • given
    • suffix (Must support in USCDI v3)
  • telecom
    • system
    • value
    • use
  • gender
  • birthDate
  • deceasedDateTime (Must support in USCDI v3)
  • address
    • line
    • city
    • state
    • postalCode
  • communication
    • language
The following search parameters and search parameter combinations SHALL be supported: The syntax used to describe the interactions is described here. SHALL support searching for all Patients for a patient using _id search parameter: GET [base url]/Patient/{id} or GET [base url]/Patient?_id={id} SHALL support searching patient by an identifier such as a MPI using the identifier search parameter: GET [base url]/Patient?identifier={system|}[code] SHALL support searching patient by a server defined search that matches any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text using the name search parameter: GET [base url]/Patient?name=[string] SHALL support searching using the combination of the birthdate and name search parameters: GET [base url]/Patient?birthdate={date}&name=[string] SHALL support searching using the combination of the gender and name search parameters: GET [base url]/Patient?gender={system|}[code]&name=[string] The following search parameter combinations SHOULD be supported (optional): SHOULD support searching using the combination of the birthdate and family search parameters: GET [base url]/Patient?birthdate={date}&family=[string] SHOULD support searching using the combination of the death-date and family search parameters: GET [base]/Patient?death-date=[date]&family=[string] SHOULD support searching using the combination of the family and gender search parameters: GET [base url]/Patient?family=[string]&gender={system|}[code] The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

​
Patient By Id

Get Patient by ID. METHOD GET 
[base url]/Patient/{id}
or 
[base url]/Patient?_id={id}
PARAMS [base url] - FHIR base url {id} - Id for Patient resource HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Patient/c5137fa5-3216-b12a-cbbc-a0c6bef361g7' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

​
Patient by an identifier

Get Patients using patient by an identifier such as a MPI using the identifier search parameter METHOD GET 
GET [base url]/Patient?identifier={system|}[code]
PARAMS [base url] - FHIR base url {system|} - The namespace for the identifier value {code} - patient unique identifier value HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Patient?identifier=http://hospital.smarthealthit.org|1032702' \
--header 'Authorization: Bearer 1239b275-909e-4754-8f73-1e411fd6769e'

​
Patient by HumanName

Get Patients using matches any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text using the name search parameter: METHOD GET 
GET [base url]/Patient?name=[string]
PARAMS [base url] - FHIR base url [string] - family or given name of the patient HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Patient?name=Shaw' \
--header 'Authorization: Bearer 1239b275-909e-4754-8f73-1e411fd6769e'

​
Patient by birthdate and name search parameters

Get Patients using the combination of the birthdate and name search parameters METHOD GET 
GET [base url]/Patient?birthdate={date}&name=[string]
PARAMS [base url] - FHIR base url [string] - family or given name of the patient {date} - birthdate of the patient HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Patient?birthdate=1995-09-24&name=Shaw' \
--header 'Authorization: Bearer 1239b275-909e-4754-8f73-1e411fd6769e'

​
Patient by gender and name search parameters

Get Patients using the combination of gender and name search parameters METHOD GET 
GET [base url]/Patient?gender={system|}[code]&name=[string]
PARAMS [base url] - FHIR base url {system|} - terminology system used to identify patient’s gender {code} - patient’s gender [string] - family or given name of the patient HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Patient?name=Shaw&gender=female' \
--header 'Authorization: Bearer 1239b275-909e-4754-8f73-1e411fd6769e'

​
Patient by birthdate and family search parameters

Get Patients using the combination of birthdate and family search parameters METHOD GET 
GET [base url]/Patient?birthdate={date}&family=[string]
PARAMS [base url] - FHIR base url {date} - patient’s birthdate [string] - patient’s family name HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Patient?family=Shaw&birthdate=2007-03-20' \
--header 'Authorization: Bearer 1239b275-909e-4754-8f73-1e411fd6769e'

​
Patient by death-date and family search parameters

Get Patients using the combination of death-date and family search parameters METHOD GET 
GET [base url]/Patient?death-date={date}&family=[string]
PARAMS [base url] - FHIR base url {date} - patient’s death-date [string] - patient’s family name HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Patient?death-date=Shaw&birthdate=2007-03-20' \
--header 'Authorization: Bearer 1239b275-909e-4754-8f73-1e411fd6769e'

​
Patient by family and gender search parameters

Get Patients using the combination of family and gender search parameters METHOD GET 
GET [base url]/Patient?family=[string]&gender={system|}[code]
PARAMS [base url] - FHIR base url [string] - patient’s family name {system|} - terminology system used to identify patient’s gender {code} - patient’s gender HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Patient?family=Shaw&gender=female' \
--header 'Authorization: Bearer 1239b275-909e-4754-8f73-1e411fd6769e'