Patient

Top Previous Next

Demographics and other administrative information about an individual receiving care or other health-related services.

The data in the Patient resource covers the "who" information about the patient: its attributes are focused on the demographic information necessary to support the administrative, financial and logistic procedures.

Response Description

Sample Response{

"resourceType": "Bundle",

"id": "d093982d-f6b2-8f83-a214-70b9e85cbfd9",

"meta": {

"lastUpdated": "2022-12-07T16:01:23Z"

"type": "collection",

"entry": [

{

"fullUrl": "https://pai.pai.healthcare/Patient/DEV-DEV-11913",

"resource": {

"resourceType": "Patient",

"id": "DEV-DEV-11913",

"meta": {

"lastUpdated": "2022-12-06T12:00:00+01:00",

"profile": [

"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"

]

"text": {

"status": "generated",

"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><td>Name</td><td>Cole Andersonian, Sr.</td></tr><tr><td>Account Number</td><td>11913</td></tr><tr><td>Birthdate</td><td>05/28/1917</td></tr><tr><td>Gender</td><td>unknown</td></tr><tr><td>Address:</td><td>251 SUNBURY ROAD<br/>MINERSVILLE, PA 17954</td></tr></tbody></table></div>"

"identifier": [

{

"system": "https://pai.healthcare",

"value": "11913"

}

"active": true,

"name": [

{

"use": "official",

"text": "Cole Andersonian, Sr.",

"family": "Andersonian",

"suffix": [

"Sr."

"given": [

"Cole"

]

{

"use": "old",

"family": "Andersonian",

"given": [

"Cole"

"period": {

"end": "2022-12-06"

}

"telecom": [

{

"system": "phone",

"value": "(570) 544-2020",

"use": "home"

}

"gender": "unknown",

"birthDate": "1917-05-28",

"address": [

{

"use": "old",

"line": [

"251 SUNBURY ROAD"

"city": "Andersonian",

"state": "12/06/22",

"postalCode": "36826",

"country": "US",

"period": {

"start": "2022-09-21",

"end": "2022-09-21"

}

{

"use": "home",

"line": [

"251 SUNBURY ROAD"

"city": "MINERSVILLE",

"state": "PA",

"postalCode": "17954",

"country": "US",

"period": {

"start": "2022-09-21",

"end": "2022-09-21"

}

"communication": [

{

"language": {

"coding": [

{

"system": "urn:ietf:bcp:47",

"code": "en",

"display": "English"

}

"text": "English"

"preferred": true

}

"extension": [

{

"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",

"extension": [

{

"url": "ombCategory",

"valueCoding": {

"system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",

"code": "UNK",

"display": "unknown"

}

{

"url": "text",

"valueString": "unknown"

}

]

{

"extension": [

{

"url": "ombCategory",

"valueCoding": {

"system": "urn:oid:2.16.840.1.113883.6.238",

"code": "2186-5",

"display": "Not Hispanic or Latino"

}

{

"url": "text",

"valueString": "Not Hispanic or Latino"

}

"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"

{

"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",

"valueCode": "M"

}

]

}

]

}

Patient.id

The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality	0..1
Type	string
Comment	The only time that a resource does not have an ID is when it is being submitted to the server using a create operation.

Patient.meta

Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality	0..1
Type	Meta

Patient.text

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

Cardinality	0..1
Type	Narrative
Comment	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Patient.identifier

An identifier for this patient.

Cardinality	0..1
Type	Identifier
Comment	Mandatory, alphanumeric format. Cannot have an underscore (_) character.
Requirements	Patients are almost always assigned specific numerical identifiers.

Patient.identifier.system

The namespace for the identifier value.

Cardinality	1..1
Type	uri
Comment	Identifier.system is always case sensitive.
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Patient.identifier.value

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality	1..1
Type	string
Comment	Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Patient.active

Whether this patient's record is in active use.

Cardinality	0..1
Type	boolean
Comment	If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. Records will not be returned if they have a suspended status.
Requirements	Need to be able to mark a patient record as not to be used because it was created in error.

Patient.name

A name associated with the patient.

Cardinality	1..*
Type	HumanName
Comment	A patient may have multiple names with different uses or applicable periods.
Requirements	Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Patient.name.use

Cardinality	0..1
Type	code NameUse (required)

Patient.name.text

Patient's surname.

Cardinality	0..*
Type	string
Comment	A text representation of the patient's full name.

Patient.name.family

Patient's surname.

Cardinality	1..1
Type	string
Comment	Will not be blank.

Patient.name.suffix

Patient's surname.

Cardinality	0..*
Type	string
Comment	Parts that come after the name.

Patient.name.given

Patient's name.

Cardinality	0..*
Type	string
Comment	Given names (not always 'first'), including middle name or initial. Will not be blank.

Patient.name.period

Indicates the period of time when this name was valid for the named person.

Cardinality	0..*
Type	Period
Requirements	Allows names to be placed in historical context

Patient.telecom

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

Cardinality	0..*
Type	ContactPoint
Comment	A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
Requirements	People have (primary) ways to contact them in some way such as phone, email.

Patient.telecom.system

Telecommunications form for contact point - what communications system is required to make use of the contact.

Cardinality	1..1
Type	code. The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point.

Patient.telecom.value

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Cardinality	1..1
Type	string
Comment	Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements	Need to support legacy numbers that are not in a tightly controlled format.

Patient.telecom.use

Identifies the purpose for the contact point.

Cardinality	0..1
Type	code. The codes SHALL be taken from ContactPointUse
Comment	Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements	Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Patient.gender

The gender that the patient is considered to have for administration and record keeping purposes.

Cardinality	0..1
Type	code AdministrativeGender
Comment	The gender might not match the biological sex as determined by genetics or the individual's preferred identification.
Requirements	Needed for identification of the individual, in combination with (at least) name and birth date.

Patient.birthDate

The date of birth for the individual. The date of birth does not indicate the time of birth.

Cardinality	0..1
Type	date
Comment	Will not be blank, ?, or 01/01/1860, as the latter indicates an unknown birth date.
Requirements	Age of the individual drives many clinical processes.

Patient.deceasedBoolean

Indicates if the individual is deceased or not.

Cardinality	0..1
Type	boolean
Comment	If there's no value in the instance, it means there is no statement on whether or not the individual is deceased.
Requirements	The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

Patient.address

An address for the individual.

Cardinality	0..*
Type	Address
Comment	Patient may have multiple addresses with different uses or applicable periods.
Requirements	May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Patient.address.line

Street name, number, direction & P.O. Box etc.

Cardinality	0..*
Type	string

Patient.address.city

Name of city, town etc.

Cardinality	0..1
Type	string

Patient.address.state

Sub-unit of country (abbreviations ok).

Cardinality	0..1
Type	string. The codes SHALL be taken from USPS Two Letter Alphabetic Codes; other codes may be used where these codes are not suitable Two Letter USPS alphabetic codes.

Patient.address.postalCode

US Zip Codes.

Cardinality	0..1
Type	string

Patient.address.period

Time period when address was/is in use.

Cardinality	0..1
Type	Period

Patient.maritalStatus

A patient's most recent marital (civil) status.

Cardinality	0..1
Type	CodeableConcept MaritalStatus (Extensible)

Patient.communication

A language which may be used to communicate with the patient about his or her health.

Cardinality	0..*
Type	BackboneElement

Patient.communication.language

The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

Cardinality	1..1
Type	CodeableConcept. The codes SHALL be taken from Language codes with language and optionally a region modifier; other codes may be used where these codes are not suitable

Patient.extension:us-core-race

The race codes used are based upon the CDC Race and Ethnicity Code Set Version 1.0.

Cardinality	0..1
Type	Extension(USCoreRaceExtension)

Patient.extension:us-core-ethnicity

The ethnicity codes used are based upon the CDC Race and Ethnicity Code Set Version 1.0.

Cardinality	0..1
Type	Extension(USCoreEthnicityExtension)

Patient.extension:us-core-birthsex

The sex that the patient was assigned at birth.

Cardinality	0..1
Type	Extension(USCoreBirthSexExtension)
Comment	Intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex.

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/Patient?{query string}

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/Patient/{resource id}

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/Patient/_search

•Set the Content-Type header to application/x-www-urlencoded

•The body of the request is a similar query string used in the GET type of request detailed above.

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

Supported Search Parameters

_id

Corresponds to	Patient.id
Search	exact
Example	•https://sandbox.pai.healthcare/preview/fhir/Patient?_id=DEV-DEV-11913 •https://sandbox.pai.healthcare/preview/fhir/Patient/DEV-DEV-11913 Returns the patient resource for the 11913 account in the dev practice.
Notes	If used, no other search parameter can be used.

identifier

Corresponds to

Patient.identifier

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Patient?identifier=11913

Returns the patient resource for the 11913 account in the dev practice.

name

Corresponds to

Patient.name

contains, search is performed separately on family, given, and MI

Example

https://sandbox.pai.healthcare/preview/fhir/Patient?name=John

Returns the patient resources where the first name contains John, the middle initial contains John, or the last name contains John.

birthdate + name

Corresponds to	Patient.birthDate and Patient.name
Search	exact using the format of yyyy-MM-dd
Modifiers	ge - greater than or equal to gt - greater than le - less than or equal to lt - less than
Example	https://sandbox.pai.healthcare/preview/fhir/Patient?birthdate=ge1990-05-20&name=John Returns the patient resources where the first name contains John, the middle initial contains John, or the last name contains John, and the birth date is on or after 05/20/1990

gender + name

Corresponds to

Patient.gender and Patient.name

exact male | female | unknown | other

Example

https://sandbox.pai.healthcare/preview/fhir/Patient?gender=male&name=John

Returns the patient resources where the first name contains John, the middle initial contains John, or the last name contains John, and the gender is male

family

Corresponds to

Patient.name.family

exact or contains

Example

https://sandbox.pai.healthcare/preview/fhir/Patient?family=Doe

Returns the patient resources where the last name equals to Doe.

https://sandbox.pai.healthcare/preview/fhir/Patient?family:contains=Do

Returns the patient resources where the last name contains Do, including Doe, Dollie, McDonald.