Example Usage Scenarios:

The following are example usage scenarios for this profile:

• Query for Patient demographic information using Medical Record Number (MRN), which is a type of identifier. The MRN is identifiable by identifier.system and may be location specific.
• Query for Patient demographic information using first name, last name, and birthdate.

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Patient Must Have:

1. a patient identifier (e.g., MRN)
2. a patient name

Each Patient Must Support:

1. a birth date
2. an address¹

Additional USCDI Requirements:

These Additional USCDI Requirements elements are not Mandatory or Must Support but are required for ONC Health IT certification testing and are included in the formal definition of the profile and the Patient examples.

1. contact detail (e.g., a telephone number or an email address)
2. a communication language²
3. Interpreter Needed flag²
4. a race²
5. an ethnicity²
6. a tribal affiliation
7. sex³
8. date of death²
9. address use²
10. address period²
11. name use²
12. name period²
13. suffix²

^1,2,3 see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

• ²Notes for Race, Ethnicity, Date of Death, Name to Use, Previous Name, Suffix, Previous Address, Interpreter Needed, and Preferred Language USCDI Data Elements:
  • The Complex Extensions for Race and Ethnicity allow for one or more codes of which: Must Support at least one category code from the OMB Race and Ethnicity Category Value Sets that draw from the Race & Ethnicity - CDC (CDCREC) code system.
    • MAY include additional codes from the detailed ethnicity and detailed race value sets drawn from the Race & Ethnicity - CDC (CDCREC) code system.^§,§
    • SHALL include a text description.^§,§
  • Date of Death is communicated using the Patient.deceasedDateTime element.
    • Although Patient.deceased[x] is marked as 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜, Certifying Systems are not required to support both, but SHALL support at least Patient.deceasedDateTime.^§
  • Systems SHALL represent Previous name by setting Patient.name.use to "old" or providing an end date in Patient.name.period or doing both.^§
  • Systems SHALL represent Suffix using the Patient.name.suffix element.^§
  • Systems SHALL represent Previous Address by setting Patient.address.use to "old" or providing an end date in Patient.address.period or doing both.^§
  • Servers SHOULD and Certifying Systems SHALL use the US Core Interpreter Needed Extension on this profile or the US Core Encounter Profile to communicate whether a patient needs an interpreter.^§,§
    • Although the extension is marked as an Additional USCDI Requirement on both US Core Patient and US Core Encounter Profiles, the Certifying Server system is not required to support the extension on both profiles but SHALL support the extension on at least one.^§ The Certifying Client application SHALL support the extension on both profiles.^§,§
    • Systems SHOULD designate the patient's preferred language in the Patient.communication.preferred element.^§
  • The Patient example demonstrates how these elements are represented
• ¹For new and updated records, Certifying Systems SHALL and non-Certifying Systems SHOULD enable the users who enter patient addresses to follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0, which is required by the USCDI Patient Demographics/Information Data Class^§,§
  • Consult this specification for details about the format for the Address datatypes elements, especially Patient.address.line and Patient.address.city.
  • Note: Both Certifying and non-Certifying systems MAY choose not to use Project US@ for historical records or documents that are not exposed through FHIR-based APIs.^§
• ¹ For Patient.address.state, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD use the ISO 3166 subdivision codes.^§
• ³The US Core Individual Sex Extension represents the U.S. Core Data for Interoperability (USCDI) data element "Sex". Refer to the FHIR R5 Patient Resource for other interoperability considerations with regards to patient sex
• Provenance and the FHIR Extension Target Element can document how individual patient demographic data was captured. See Element Level Provenance on the Basic Provenance page for more information.
• The Patient's Social Security Numbers SHOULD NOT be used as a patient identifier in Patient.identifier.value.^§ There is increasing concern over using Social Security Numbers in healthcare due to the risk of identity theft and related issues. Many payers and providers have purged them from their systems and filtered them out of incoming data.

Changes since version 9.0.0:

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:race	C	0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity		0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation		0..*	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: us-core-6
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries. C	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example US Core: 49 MEADOW ST
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. Example US Core: OK
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Patient.address.period	Σ This element is included in summaries.	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.communication		0..*	BackboneElement	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	S This element must be supported.	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Languages (extensible)
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📦4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📦4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4
Patient.communication.​language	Base	extensible	Languages	📦1.0.0	THO v7.4
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
us-core-6	error	Patient.name	At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.	(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:race		0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity		0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation		0..*	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.identifier	S This element must be supported.	1..*	Identifier	An identifier for this patient
Patient.identifier.system	S This element must be supported.	1..1	uri	The namespace for the identifier value
Patient.identifier.value	S This element must be supported.	1..1	string	The value that is unique within the system.
Patient.name	S This element must be supported. C	1..*	HumanName	A name associated with the patient Constraints: us-core-6
Patient.name.use		0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Patient.name.family	S This element must be supported. C	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. C	0..*	string	Given names (not always 'first'). Includes middle names
Patient.name.suffix		0..*	string	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
Patient.name.period		0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom		0..*	ContactPoint	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.system	S This element must be supported.	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported.	1..1	string	The actual contact point details
Patient.telecom.use	S This element must be supported.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Patient.birthDate	S This element must be supported.	0..1	date	The date of birth for the individual
Patient.deceased[x]		0..1	boolean, dateTime	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.address	S This element must be supported.	0..*	Address	An address for the individual
Patient.address.use		0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Patient.address.line	S This element must be supported.	0..*	string	Street name, number, direction & P.O. Box etc. Example US Core: 49 MEADOW ST
Patient.address.city	S This element must be supported.	0..1	string	Name of city, town etc. Example US Core: EVERYTOWN
Patient.address.state	S This element must be supported.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. Example US Core: OK
Patient.address.postalCode	S This element must be supported.	0..1	string	US Zip Codes Example US Core: 74047
Patient.address.period		0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Patient.communication		0..*	BackboneElement	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.language	S This element must be supported.	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Languages (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.telecom.system	Base	required	ContactPointSystem	📦4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📦4.0.1	FHIR Std.
Patient.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4
Patient.communication.​language	Base	extensible	Languages	📦1.0.0	THO v7.4

Constraints

Id	Grade	Path(s)	Description	Expression
us-core-6	error	Patient.name	At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.	(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race	C	0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity		0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation		0..*	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient
Patient.identifier.id		0..1	string	Unique id for inter-element referencing
Patient.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: us-core-6
Patient.name.id		0..1	string	Unique id for inter-element referencing
Patient.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries. C	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.id		0..1	string	Unique id for inter-element referencing
Patient.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Patient.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.address.id		0..1	string	Unique id for inter-element referencing
Patient.address.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.address.text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example US Core: 49 MEADOW ST
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Patient.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. Example US Core: OK
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Patient.address.country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.address.period	Σ This element is included in summaries.	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
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	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	S This element must be supported.	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Languages (extensible)
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📦4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📦4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4
Patient.maritalStatus	Base	extensible	MaritalStatus	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	extensible	Languages	📦1.0.0	THO v7.4
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
us-core-6	error	Patient.name	At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.	(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:race	C	0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity		0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation		0..*	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: us-core-6
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries. C	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example US Core: 49 MEADOW ST
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. Example US Core: OK
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Patient.address.period	Σ This element is included in summaries.	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.communication		0..*	BackboneElement	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	S This element must be supported.	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Languages (extensible)
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📦4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📦4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4
Patient.communication.​language	Base	extensible	Languages	📦1.0.0	THO v7.4
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
us-core-6	error	Patient.name	At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.	(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:race		0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity		0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation		0..*	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.identifier	S This element must be supported.	1..*	Identifier	An identifier for this patient
Patient.identifier.system	S This element must be supported.	1..1	uri	The namespace for the identifier value
Patient.identifier.value	S This element must be supported.	1..1	string	The value that is unique within the system.
Patient.name	S This element must be supported. C	1..*	HumanName	A name associated with the patient Constraints: us-core-6
Patient.name.use		0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Patient.name.family	S This element must be supported. C	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. C	0..*	string	Given names (not always 'first'). Includes middle names
Patient.name.suffix		0..*	string	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
Patient.name.period		0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom		0..*	ContactPoint	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.system	S This element must be supported.	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported.	1..1	string	The actual contact point details
Patient.telecom.use	S This element must be supported.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Patient.birthDate	S This element must be supported.	0..1	date	The date of birth for the individual
Patient.deceased[x]		0..1	boolean, dateTime	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.address	S This element must be supported.	0..*	Address	An address for the individual
Patient.address.use		0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Patient.address.line	S This element must be supported.	0..*	string	Street name, number, direction & P.O. Box etc. Example US Core: 49 MEADOW ST
Patient.address.city	S This element must be supported.	0..1	string	Name of city, town etc. Example US Core: EVERYTOWN
Patient.address.state	S This element must be supported.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. Example US Core: OK
Patient.address.postalCode	S This element must be supported.	0..1	string	US Zip Codes Example US Core: 74047
Patient.address.period		0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Patient.communication		0..*	BackboneElement	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.language	S This element must be supported.	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Languages (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.telecom.system	Base	required	ContactPointSystem	📦4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📦4.0.1	FHIR Std.
Patient.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4
Patient.communication.​language	Base	extensible	Languages	📦1.0.0	THO v7.4

Constraints

Id	Grade	Path(s)	Description	Expression
us-core-6	error	Patient.name	At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.	(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race	C	0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity		0..1	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation		0..*	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired		0..1	Coding	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient
Patient.identifier.id		0..1	string	Unique id for inter-element referencing
Patient.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: us-core-6
Patient.name.id		0..1	string	Unique id for inter-element referencing
Patient.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries. C	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.id		0..1	string	Unique id for inter-element referencing
Patient.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Patient.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.address.id		0..1	string	Unique id for inter-element referencing
Patient.address.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.address.text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example US Core: 49 MEADOW ST
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Patient.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. Example US Core: OK
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Patient.address.country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.address.period	Σ This element is included in summaries.	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
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	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	S This element must be supported.	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Languages (extensible)
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📦4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📦4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4
Patient.maritalStatus	Base	extensible	MaritalStatus	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	extensible	Languages	📦1.0.0	THO v7.4
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
us-core-6	error	Patient.name	At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.	(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from Patient

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 16 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
• http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
• http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
• http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
• http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed

Maturity: 5

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

• See the Scopes Format section for a description of the SMART scopes syntax.
• See the Search Syntax section for a description of the US Core search syntax.
• See the General Requirements section for additional rules and expectations when a Server requires status parameters.
• See the General Guidance section for additional guidance on searching for multiple patients.

US Core Scopes

Servers providing access to patient data SHALL support these US Core SMART Scopes:

• resource level scopes: <patient|user|system>/Patient.rs ^§

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support both read Patient by id AND Patient search using the _id search parameter

   GET [base]/Patient?_id=[id]' or 'GET [base]/Patient/[id]

   Examples:

   1. GET [base]/Patient/1032702

   2. GET [base]/Patient?_id=1032702

   Implementation Notes: Fetches a US Core Patient Profile resource or a search Bundle containing a US Core Patient Profile resource matching the id (see Parameters for all resources).

2. SHALL support searching a patient by an identifier such as an MPI using the identifier search parameter

   GET [base]/Patient?identifier={system|}[search_code]

   Example:

   1. GET [base]/Patient?identifier=http://hospital.smarthealthit.org|1032702

   Implementation Notes: Fetches a bundle containing any US Core Patient Profile resources matching the identifier, in other words, the [logical reference] of the resource ( see how to search by token).

3. SHALL support searching for a 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]/Patient?name=[name]

   Example:

   1. GET [base]/Patient?name=Shaw

   Implementation Notes: Fetches a bundle of all US Core Patient Profile resources matching the name ( see how to search by string).

4. SHALL support searching using the combination of the birthdate and name search parameters

   GET [base]/Patient?birthdate=[dateTime]&name=[name]

   Example:

   1. GET [base]/Patient?name=Shaw&birthdate=2007-03-20

   Implementation Notes: Fetches a bundle of all US Core Patient Profile resources matching the specified birthdate and name ( see how to search by date and how to search by string).

Optional Search Parameters:

The following search parameters and search parameter combinations SHOULD be supported

1. SHOULD support searching using the combination of the birthdate and family search parameters

   GET [base]/Patient?birthdate=[dateTime]&family=[family]

   Example:

   1. GET [base]/Patient?family=Shaw&birthdate=2007-03-20

   Implementation Notes: Fetches a bundle of all US Core Patient Profile resources matching the specified birthdate and family ( see how to search by date and how to search by string).

2. SHOULD support searching using the combination of the death-date and family search parameters

   GET [base]/Patient?death-date=[dateTime]&family=[family]

   Example:

   1. GET [base]/Patient?family=Shaw&death-date=2022-07-22

   Implementation Notes: Fetches a bundle of all US Core Patient Profile resources matching the specified death-date and family ( see how to search by date and how to search by string).