Patient

Property	Value
Publisher
Name	Patient
URL	http://hl7.org/fhir/StructureDefinition/Patient
Status	active
Description
Abstract	false

Structure

Path	Cardinality	Type	Description
Patient	0..*	Patient	Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Patient.id	0..1	http://hl7.org/fhirpath/System.String	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Patient.meta	0..1	Meta	The 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.
Patient.implicitRules	0..1	uri	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Patient.language	0..1	code	The base language in which the resource is written.
Patient.text	0..1	Narrative	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. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Patient.contained	0..*	Resource	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Patient.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Patient.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Patient.identifier	0..*	Identifier	An identifier for this patient.
Patient.active	0..1	boolean	Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.It is often used to filter patient lists to exclude inactive patientsDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
Patient.name	0..*	HumanName	A name associated with the individual.
Patient.telecom	0..*	ContactPoint	A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
Patient.gender	0..1	code	Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
Patient.birthDate	0..1	date	The date of birth for the individual.
Patient.deceased[x]	0..1	boolean	Indicates if the individual is deceased or not.
Patient.address	0..*	Address	An address for the individual.
Patient.maritalStatus	0..1	CodeableConcept	This field contains a patient's most recent marital (civil) status.
Patient.multipleBirth[x]	0..1	boolean	Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
Patient.photo	0..*	Attachment	Image of the patient.
Patient.contact	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient.
Patient.contact.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Patient.contact.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Patient.contact.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Patient.contact.relationship	0..*	CodeableConcept	The nature of the relationship between the patient and the contact person.
Patient.contact.name	0..1	HumanName	A name associated with the contact person.
Patient.contact.telecom	0..*	ContactPoint	A contact detail for the person, e.g. a telephone number or an email address.
Patient.contact.address	0..1	Address	Address for the contact person.
Patient.contact.gender	0..1	code	Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
Patient.contact.organization	0..1	Reference	Organization on behalf of which the contact is acting or for which the contact is working.
Patient.contact.period	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient.
Patient.communication	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health.
Patient.communication.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Patient.communication.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Patient.communication.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Patient.communication.language	1..1	CodeableConcept	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.
Patient.communication.preferred	0..1	boolean	Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
Patient.generalPractitioner	0..*	Reference	Patient's nominated care provider.
Patient.managingOrganization	0..1	Reference	Organization that is the custodian of the patient record.
Patient.link	0..*	BackboneElement	Link to another patient resource that concerns the same actual patient.
Patient.link.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Patient.link.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Patient.link.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Patient.link.other	1..1	Reference	The other patient resource that the link refers to.
Patient.link.type	1..1	code	The type of link between this patient resource and another patient resource.

Search Parameters

Name	Type	Description	Expression
_text	string	Search on the narrative of the resource
_content	string	Search on the entire content of the resource
_filter	token	Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_has	string	Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_id	token	Logical id of this artifact	Resource.id
_lastUpdated	date	When the resource version last changed	Resource.meta.lastUpdated
_list	string	All resources in nominated list (by id, Type/id, url or one of the magic List types)
_profile	uri	Profiles this resource claims to conform to	Resource.meta.profile
_query	token	A custom search profile that describes a specific defined query operation
_security	token	Security Labels applied to this resource	Resource.meta.security
_source	uri	Identifies where the resource comes from	Resource.meta.source
_tag	token	Tags applied to this resource	Resource.meta.tag
_text	string	Search on the narrative text (html) of the resource
_type	token	Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
active	token	Whether the patient record is active	Patient.active
address	string	Multiple Resources: * Patient: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text* Person: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text* Practitioner: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text* RelatedPerson: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text	Patient.address / Person.address / Practitioner.address / RelatedPerson.address
address-city	string	Multiple Resources: * Patient: A city specified in an address* Person: A city specified in an address* Practitioner: A city specified in an address* RelatedPerson: A city specified in an address	Patient.address.city / Person.address.city / Practitioner.address.city / RelatedPerson.address.city
address-country	string	Multiple Resources: * Patient: A country specified in an address* Person: A country specified in an address* Practitioner: A country specified in an address* RelatedPerson: A country specified in an address	Patient.address.country / Person.address.country / Practitioner.address.country / RelatedPerson.address.country
address-postalcode	string	Multiple Resources: * Patient: A postalCode specified in an address* Person: A postal code specified in an address* Practitioner: A postalCode specified in an address* RelatedPerson: A postal code specified in an address	Patient.address.postalCode / Person.address.postalCode / Practitioner.address.postalCode / RelatedPerson.address.postalCode
address-state	string	Multiple Resources: * Patient: A state specified in an address* Person: A state specified in an address* Practitioner: A state specified in an address* RelatedPerson: A state specified in an address	Patient.address.state / Person.address.state / Practitioner.address.state / RelatedPerson.address.state
address-use	token	Multiple Resources: * Patient: A use code specified in an address* Person: A use code specified in an address* Practitioner: A use code specified in an address* RelatedPerson: A use code specified in an address	Patient.address.use / Person.address.use / Practitioner.address.use / RelatedPerson.address.use
birthdate	date	Multiple Resources: * Patient: The patient's date of birth* Person: The person's date of birth* RelatedPerson: The Related Person's date of birth	Patient.birthDate / Person.birthDate / RelatedPerson.birthDate
death-date	date	The date of death has been provided and satisfies this search value	(Patient.deceased.ofType(dateTime))
deceased	token	This patient has been marked as deceased, or has a death date entered	Patient.deceased.exists() and Patient.deceased != false
email	token	Multiple Resources: * Patient: A value in an email contact* Person: A value in an email contact* Practitioner: A value in an email contact* PractitionerRole: A value in an email contact* RelatedPerson: A value in an email contact	Patient.telecom.where(system='email') / Person.telecom.where(system='email') / Practitioner.telecom.where(system='email') / PractitionerRole.telecom.where(system='email') / RelatedPerson.telecom.where(system='email')
family	string	Multiple Resources: * Patient: A portion of the family name of the patient* Practitioner: A portion of the family name	Patient.name.family / Practitioner.name.family
gender	token	Multiple Resources: * Patient: Gender of the patient* Person: The gender of the person* Practitioner: Gender of the practitioner* RelatedPerson: Gender of the related person	Patient.gender / Person.gender / Practitioner.gender / RelatedPerson.gender
general-practitioner	reference	Patient's nominated general practitioner, not the organization that manages the record	Patient.generalPractitioner
given	string	Multiple Resources: * Patient: A portion of the given name of the patient* Practitioner: A portion of the given name	Patient.name.given / Practitioner.name.given
identifier	token	A patient identifier	Patient.identifier
language	token	Language code (irrespective of use value)	Patient.communication.language
link	reference	All patients linked to the given patient	Patient.link.other
name	string	A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text	Patient.name
organization	reference	The organization that is the custodian of the patient record	Patient.managingOrganization
phone	token	Multiple Resources: * Patient: A value in a phone contact* Person: A value in a phone contact* Practitioner: A value in a phone contact* PractitionerRole: A value in a phone contact* RelatedPerson: A value in a phone contact	Patient.telecom.where(system='phone') / Person.telecom.where(system='phone') / Practitioner.telecom.where(system='phone') / PractitionerRole.telecom.where(system='phone') / RelatedPerson.telecom.where(system='phone')
phonetic	string	Multiple Resources: * Patient: A portion of either family or given name using some kind of phonetic matching algorithm* Person: A portion of name using some kind of phonetic matching algorithm* Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm* RelatedPerson: A portion of name using some kind of phonetic matching algorithm	Patient.name / Person.name / Practitioner.name / RelatedPerson.name
telecom	token	Multiple Resources: * Patient: The value in any kind of telecom details of the patient* Person: The value in any kind of contact* Practitioner: The value in any kind of contact* PractitionerRole: The value in any kind of contact* RelatedPerson: The value in any kind of contact	Patient.telecom / Person.telecom / Practitioner.telecom / PractitionerRole.telecom / RelatedPerson.telecom