Publication Build: This will be filled in by the publication tooling

• Content
• Detailed Descriptions
• Mappings
• JSON
• History

Resource Profile: Patient

This StructureDefinition contains the maps for VistA file PATIENT (2) to us-core-patient.

Usage:

• Refer to this Resource Profile: AllergyIntolerance, Appointment, Condition: Encounter Diagnosis, Condition: Problem... Show 36 more, Debt Portal Account, Debt Portal ChargeItem[charges], Debt Portal Invoice, Diagnostic Report Note: Cytopathology DiagnosticReport, Diagnostic Report Note: Electron Microscopy DiagnosticReport, Diagnostic Report Note: Surgical Pathology DiagnosticReport, Document Reference DocumentReference, Encounter: Inpatient Encounter, Encounter: Outpatient, Immunization Immunization, Implantable Device: A Lead, Implantable Device: Dental, Implantable Device: Pacemaker, Implantable Device: Prosthesis, Implantable Device: Transmitter, Implantable Device: V Lead, Lab Observation, Lab Observation: Chem, hem, tox, ria, ser Observation, Lab Observation: Microbiology Bacteriology Observation, Lab Observation: Microbiology Mycobacteriology Observation, Lab Observation: Microbiology Mycology Observation, Lab Observation: Microbiology Observation, Lab Observation: Microbiology Parasitology Observation, Lab Observation: Microbiology Virology Observation, MedRefillRequestMHV Task, MedicationDispense: Original, MedicationDispense: Partial, MedicationRequest: Outpatient, MedicationRequest: Unsigned, Procedure: Outpatient, Procedure: Radiology, Procedure: Surgery Procedure, Smoking Status Observation, Vital Signs, Vital Signs: BP and Vital Signs: SpO2
• CapabilityStatements using this Resource Profile: AMPL GUI, Lighthouse Clinical Health API, Lung Cancer Screening, Medication Dispense Tracking and Lighthouse Patient Health API

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

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

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	USCorePatientProfile(5.0.1)	Information about an individual or animal receiving health care services This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ombCategory	S	0..5	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997. ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: raceCategory FHIR (required): see mapping VF_raceCategory ele-1: All FHIR elements must have a @value or children
extension:detailed		0..*	Extension	Extended race codes ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed Race (required) ele-1: All FHIR elements must have a @value or children
extension:text	S	1..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"text"
value[x]	S	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ombCategory	S	0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required) ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: ethnicityCategory FHIR (required): see mapping VF_ethnicityCategory ele-1: All FHIR elements must have a @value or children
extension:detailed		0..*	Extension	Extended ethnicity codes ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed ethnicity (required) ele-1: All FHIR elements must have a @value or children
extension:text	S	1..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"text"
value[x]	S	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
extension:birthsex		0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:genderIdentity		0..1	(Complex)	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
value[x]	S	1..1	CodeableConcept	Value of extension Binding: genderIdentity FHIR (required): see mapping VF_genderIdentity ele-1: All FHIR elements must have a @value or children
extension:patient-religion		0..1	(Complex)	The patient's professed religious affiliations URL: http://hl7.org/fhir/StructureDefinition/patient-religion ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-religion"
value[x]	S	1..1	CodeableConcept	Value of extension Binding: Religion FHIR (required): see mapping VF_Religion ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	1..*	Identifier	An identifier for this patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	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. ele-1: All FHIR elements must have a @value or children
coding	Σ	0..*	Coding	Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	0..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Required Pattern: MR
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:2.16.840.1.113883.4.349
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	SΣ	1..*	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Text representation of the full name ele-1: All FHIR elements must have a @value or children
family	SΣC	0..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children Required Pattern: LAST
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Required Pattern: FIRST & MIDDLE
suffix	SΣ	0..*	string	Parts that come after the name ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name Required Pattern: SUFFIX
Slices for telecom	Σ	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children
telecom:All Slices				Content/Rules for all slices
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children
telecom:va-home	Σ	0..1	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children Required Pattern: home
telecom:va-work	Σ	0..1	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children Required Pattern: work
telecom:va-mobile	Σ	0..1	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children Required Pattern: mobile
gender	SΣ	1..1	code	male | female | other | unknown Binding: adminGender FHIR (required): see mapping VF_adminGender ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	0..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!SΣC	0..1	dateTime	Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children p-7-285: If not null then source value from (2-.351)
Slices for address	SΣ	0..*	Address	An address for the individual Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children
address:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. ele-1: All FHIR elements must have a @value or children
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
period	SΣ	0..1	Period	Time period when address was/is in use ele-1: All FHIR elements must have a @value or children Example General: {"start":"2010-03-23","end":"2010-07-01"}
address:va-home	SΣ	0..1	Address	An address for the individual ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Required Pattern: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). ele-1: All FHIR elements must have a @value or children Required Pattern: postal
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. ele-1: All FHIR elements must have a @value or children
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children
period	SΣ	0..1	Period	Time period when address was/is in use ele-1: All FHIR elements must have a @value or children Example General: {"start":"2010-03-23","end":"2010-07-01"}
start	SΣC	0..1	dateTime	Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus FHIR (required): see mapping VF_MaritalStatus ele-1: All FHIR elements must have a @value or children
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) ele-1: All FHIR elements must have a @value or children
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	Text alternative for the resource ele-1: All FHIR elements must have a @value or children Required Pattern: Veterans Health Administration
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.extension:race.extension:ombCategory.value[x]	required	OmbRaceCategories http://hl7.org/fhir/us/core/ValueSet/omb-race-category
Patient.extension:race.extension:ombCategory.value[x].code	required	RaceCategory http://va.gov/fhir/ValueSet/raceCategory from this IG
Patient.extension:race.extension:detailed.value[x]	required	DetailedRace http://hl7.org/fhir/us/core/ValueSet/detailed-race
Patient.extension:ethnicity.extension:ombCategory.value[x]	required	OmbEthnicityCategories http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category
Patient.extension:ethnicity.extension:ombCategory.value[x].code	required	EthnicityCategory http://va.gov/fhir/ValueSet/ethnicityCategory from this IG
Patient.extension:ethnicity.extension:detailed.value[x]	required	DetailedEthnicity http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
Patient.extension:genderIdentity.value[x]	required	GenderIdentity http://va.gov/fhir/ValueSet/genderIdentity from this IG
Patient.extension:patient-religion.value[x]	required	Religion http://va.gov/fhir/ValueSet/Religion from this IG
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-home.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-work.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-work.use	required	Pattern: work http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-mobile.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-mobile.use	required	Pattern: mobile http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdminGender http://va.gov/fhir/ValueSet/adminGender from this IG
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.address:va-home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address:va-home.type	required	Pattern: postal http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address:va-home.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatus	required	MaritalStatus http://va.gov/fhir/ValueSet/MaritalStatus from this IG
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
p-7-285	warning	Patient.deceased[x]:deceasedDateTime	If not null then source value from (2-.351) : true
us-core-6	error	Patient	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient			USCorePatientProfile(5.0.1)	This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0)
Slices for extension				Content/Rules for all slices
extension:race		0..1	USCoreRaceExtension(5.0.1)	US Core Race Extension
Slices for extension				Content/Rules for all slices
extension:ombCategory		0..5	Extension	Extension
extension		0..0
value[x]
code	S	0..1	code	Symbol in syntax defined by the system Binding: raceCategory FHIR (required): see mapping VF_raceCategory
extension:text		1..1	Extension	Extension
extension		0..0
value[x]	S	1..1	string	Value of extension
extension:ethnicity		0..1	USCoreEthnicityExtension(5.0.1)	US Core ethnicity Extension
Slices for extension				Content/Rules for all slices
extension:ombCategory		0..1	Extension	Extension
extension		0..0
value[x]
code	S	0..1	code	Symbol in syntax defined by the system Binding: ethnicityCategory FHIR (required): see mapping VF_ethnicityCategory
extension:text		1..1	Extension	Extension
extension		0..0
value[x]	S	1..1	string	Value of extension
extension:genderIdentity		0..1	USCoreGenderIdentityExtension	Extension
value[x]	S	1..1	CodeableConcept	Value of extension Binding: genderIdentity FHIR (required): see mapping VF_genderIdentity
extension:patient-religion		0..1	(Complex)	The patient's professed religious affiliations URL: http://hl7.org/fhir/StructureDefinition/patient-religion
value[x]	S	1..1	CodeableConcept	Value of extension Binding: Religion FHIR (required): see mapping VF_Religion
identifier
type
coding
system	S	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	S	0..1	code	Symbol in syntax defined by the system Required Pattern: MR
system		1..1	uri	The namespace for the identifier value Required Pattern: urn:oid:2.16.840.1.113883.4.349
value		1..1	string	The value that is unique within the system.
name
text	S	0..1	string	Text representation of the full name
family		0..1	string	Family name (often called 'Surname') Required Pattern: LAST
given		0..*	string	Given names (not always 'first'). Includes middle names Required Pattern: FIRST & MIDDLE
suffix	S	0..*	string	Parts that come after the name Required Pattern: SUFFIX
Slices for telecom		0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:$this
telecom:va-home		0..1	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
value		1..1	string	The actual contact point details
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: home
telecom:va-work		0..1	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
value		1..1	string	The actual contact point details
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: work
telecom:va-mobile		0..1	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
value		1..1	string	The actual contact point details
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: mobile
gender		1..1	code	male | female | other | unknown Binding: adminGender FHIR (required): see mapping VF_adminGender
birthDate		0..1	date	The date of birth for the individual
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedDateTime	SC	0..1	dateTime	Indicates if the individual is deceased or not p-7-285: If not null then source value from (2-.351)
Slices for address		0..*	Address	An address for the individual Slice: Unordered, Open by value:$this
address:va-home		0..1	Address	An address for the individual
use	S	0..1	code	home | work | temp | old | billing - purpose of this address Required Pattern: home
type	S	0..1	code	postal | physical | both Required Pattern: postal
line		0..*	string	Street name, number, direction & P.O. Box etc.
city		0..1	string	Name of city, town etc.
state		0..1	string	Sub-unit of country (abbreviations ok)
postalCode		0..1	string	US Zip Codes
country	S	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period
start	S	0..1	dateTime	Starting time with inclusive boundary
end	S	0..1	dateTime	End time with inclusive boundary, if not ongoing
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus FHIR (required): see mapping VF_MaritalStatus
communication
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
managingOrganization
display	S	0..1	string	Text alternative for the resource Required Pattern: Veterans Health Administration
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.extension:race.extension:ombCategory.value[x].code	required	RaceCategory http://va.gov/fhir/ValueSet/raceCategory from this IG
Patient.extension:ethnicity.extension:ombCategory.value[x].code	required	EthnicityCategory http://va.gov/fhir/ValueSet/ethnicityCategory from this IG
Patient.extension:genderIdentity.value[x]	required	GenderIdentity http://va.gov/fhir/ValueSet/genderIdentity from this IG
Patient.extension:patient-religion.value[x]	required	Religion http://va.gov/fhir/ValueSet/Religion from this IG
Patient.gender	required	AdminGender http://va.gov/fhir/ValueSet/adminGender from this IG
Patient.maritalStatus	required	MaritalStatus http://va.gov/fhir/ValueSet/MaritalStatus from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
p-7-285	warning	Patient.deceased[x]:deceasedDateTime	If not null then source value from (2-.351) : true

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	USCorePatientProfile(5.0.1)	Information about an individual or animal receiving health care services This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0) us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ombCategory	S	0..5	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: raceCategory FHIR (required): see mapping VF_raceCategory
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
extension:detailed		0..*	Extension	Extended race codes
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed Race (required)
extension:text	S	1..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"text"
value[x]	S	1..1	string	Value of extension
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ombCategory	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: ethnicityCategory FHIR (required): see mapping VF_ethnicityCategory
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
extension:detailed		0..*	Extension	Extended ethnicity codes
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed ethnicity (required)
extension:text	S	1..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"text"
value[x]	S	1..1	string	Value of extension
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
extension:birthsex		0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
extension:genderIdentity		0..1	(Complex)	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
value[x]	S	1..1	CodeableConcept	Value of extension Binding: genderIdentity FHIR (required): see mapping VF_genderIdentity
extension:patient-religion		0..1	(Complex)	The patient's professed religious affiliations URL: http://hl7.org/fhir/StructureDefinition/patient-religion
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-religion"
value[x]	S	1..1	CodeableConcept	Value of extension Binding: Religion FHIR (required): see mapping VF_Religion
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system Required Pattern: MR
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: urn:oid:2.16.840.1.113883.4.349
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	0..1	string	Text representation of the full name
family	SΣC	0..1	string	Family name (often called 'Surname') Required Pattern: LAST
given	SΣ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 Required Pattern: FIRST & MIDDLE
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name Required Pattern: SUFFIX
period	Σ	0..1	Period	Time period when name was/is in use
Slices for telecom	Σ	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:$this
telecom:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:va-home	Σ	0..1	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) Required Pattern: home
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:va-work	Σ	0..1	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) Required Pattern: work
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:va-mobile	Σ	0..1	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) Required Pattern: mobile
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male | female | other | unknown Binding: adminGender FHIR (required): see mapping VF_adminGender
birthDate	SΣ	0..1	date	The date of birth for the individual
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!SΣC	0..1	dateTime	Indicates if the individual is deceased or not p-7-285: If not null then source value from (2-.351)
Slices for address	SΣ	0..*	Address	An address for the individual Slice: Unordered, Open by value:$this
address:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	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
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
address:va-home	SΣ	0..1	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: postal
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	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
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	0..1	dateTime	Starting time with inclusive boundary
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus FHIR (required): see mapping VF_MaritalStatus
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	0..1	string	Text alternative for the resource Required Pattern: Veterans Health Administration
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	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	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.extension:race.extension:ombCategory.value[x]	required	OmbRaceCategories http://hl7.org/fhir/us/core/ValueSet/omb-race-category
Patient.extension:race.extension:ombCategory.value[x].code	required	RaceCategory http://va.gov/fhir/ValueSet/raceCategory from this IG
Patient.extension:race.extension:detailed.value[x]	required	DetailedRace http://hl7.org/fhir/us/core/ValueSet/detailed-race
Patient.extension:ethnicity.extension:ombCategory.value[x]	required	OmbEthnicityCategories http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category
Patient.extension:ethnicity.extension:ombCategory.value[x].code	required	EthnicityCategory http://va.gov/fhir/ValueSet/ethnicityCategory from this IG
Patient.extension:ethnicity.extension:detailed.value[x]	required	DetailedEthnicity http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
Patient.extension:genderIdentity.value[x]	required	GenderIdentity http://va.gov/fhir/ValueSet/genderIdentity from this IG
Patient.extension:patient-religion.value[x]	required	Religion http://va.gov/fhir/ValueSet/Religion from this IG
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-home.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-work.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-work.use	required	Pattern: work http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-mobile.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-mobile.use	required	Pattern: mobile http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdminGender http://va.gov/fhir/ValueSet/adminGender from this IG
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.address:va-home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address:va-home.type	required	Pattern: postal http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address:va-home.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatus	required	MaritalStatus http://va.gov/fhir/ValueSet/MaritalStatus from this IG
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.managingOrganization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
p-7-285	warning	Patient.deceased[x]:deceasedDateTime	If not null then source value from (2-.351) : true
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6	error	Patient	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from USCorePatientProfile

Summary

Must-Support: 18 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-religion

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.telecom
• The element 1 is sliced based on the value of Patient.deceased[x]
• The element 1 is sliced based on the value of Patient.address

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	USCorePatientProfile(5.0.1)	Information about an individual or animal receiving health care services This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ombCategory	S	0..5	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997. ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: raceCategory FHIR (required): see mapping VF_raceCategory ele-1: All FHIR elements must have a @value or children
extension:detailed		0..*	Extension	Extended race codes ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed Race (required) ele-1: All FHIR elements must have a @value or children
extension:text	S	1..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"text"
value[x]	S	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ombCategory	S	0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required) ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: ethnicityCategory FHIR (required): see mapping VF_ethnicityCategory ele-1: All FHIR elements must have a @value or children
extension:detailed		0..*	Extension	Extended ethnicity codes ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed ethnicity (required) ele-1: All FHIR elements must have a @value or children
extension:text	S	1..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"text"
value[x]	S	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
extension:birthsex		0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:genderIdentity		0..1	(Complex)	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
value[x]	S	1..1	CodeableConcept	Value of extension Binding: genderIdentity FHIR (required): see mapping VF_genderIdentity ele-1: All FHIR elements must have a @value or children
extension:patient-religion		0..1	(Complex)	The patient's professed religious affiliations URL: http://hl7.org/fhir/StructureDefinition/patient-religion ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-religion"
value[x]	S	1..1	CodeableConcept	Value of extension Binding: Religion FHIR (required): see mapping VF_Religion ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	1..*	Identifier	An identifier for this patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	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. ele-1: All FHIR elements must have a @value or children
coding	Σ	0..*	Coding	Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	0..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Required Pattern: MR
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:2.16.840.1.113883.4.349
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	SΣ	1..*	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Text representation of the full name ele-1: All FHIR elements must have a @value or children
family	SΣC	0..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children Required Pattern: LAST
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Required Pattern: FIRST & MIDDLE
suffix	SΣ	0..*	string	Parts that come after the name ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name Required Pattern: SUFFIX
Slices for telecom	Σ	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children
telecom:All Slices				Content/Rules for all slices
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children
telecom:va-home	Σ	0..1	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children Required Pattern: home
telecom:va-work	Σ	0..1	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children Required Pattern: work
telecom:va-mobile	Σ	0..1	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children Required Pattern: mobile
gender	SΣ	1..1	code	male | female | other | unknown Binding: adminGender FHIR (required): see mapping VF_adminGender ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	0..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!SΣC	0..1	dateTime	Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children p-7-285: If not null then source value from (2-.351)
Slices for address	SΣ	0..*	Address	An address for the individual Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children
address:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. ele-1: All FHIR elements must have a @value or children
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
period	SΣ	0..1	Period	Time period when address was/is in use ele-1: All FHIR elements must have a @value or children Example General: {"start":"2010-03-23","end":"2010-07-01"}
address:va-home	SΣ	0..1	Address	An address for the individual ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Required Pattern: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). ele-1: All FHIR elements must have a @value or children Required Pattern: postal
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. ele-1: All FHIR elements must have a @value or children
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children
period	SΣ	0..1	Period	Time period when address was/is in use ele-1: All FHIR elements must have a @value or children Example General: {"start":"2010-03-23","end":"2010-07-01"}
start	SΣC	0..1	dateTime	Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus FHIR (required): see mapping VF_MaritalStatus ele-1: All FHIR elements must have a @value or children
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) ele-1: All FHIR elements must have a @value or children
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	Text alternative for the resource ele-1: All FHIR elements must have a @value or children Required Pattern: Veterans Health Administration
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.extension:race.extension:ombCategory.value[x]	required	OmbRaceCategories http://hl7.org/fhir/us/core/ValueSet/omb-race-category
Patient.extension:race.extension:ombCategory.value[x].code	required	RaceCategory http://va.gov/fhir/ValueSet/raceCategory from this IG
Patient.extension:race.extension:detailed.value[x]	required	DetailedRace http://hl7.org/fhir/us/core/ValueSet/detailed-race
Patient.extension:ethnicity.extension:ombCategory.value[x]	required	OmbEthnicityCategories http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category
Patient.extension:ethnicity.extension:ombCategory.value[x].code	required	EthnicityCategory http://va.gov/fhir/ValueSet/ethnicityCategory from this IG
Patient.extension:ethnicity.extension:detailed.value[x]	required	DetailedEthnicity http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
Patient.extension:genderIdentity.value[x]	required	GenderIdentity http://va.gov/fhir/ValueSet/genderIdentity from this IG
Patient.extension:patient-religion.value[x]	required	Religion http://va.gov/fhir/ValueSet/Religion from this IG
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-home.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-work.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-work.use	required	Pattern: work http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-mobile.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-mobile.use	required	Pattern: mobile http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdminGender http://va.gov/fhir/ValueSet/adminGender from this IG
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.address:va-home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address:va-home.type	required	Pattern: postal http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address:va-home.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatus	required	MaritalStatus http://va.gov/fhir/ValueSet/MaritalStatus from this IG
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
p-7-285	warning	Patient.deceased[x]:deceasedDateTime	If not null then source value from (2-.351) : true
us-core-6	error	Patient	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Differential View

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient			USCorePatientProfile(5.0.1)	This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0)
Slices for extension				Content/Rules for all slices
extension:race		0..1	USCoreRaceExtension(5.0.1)	US Core Race Extension
Slices for extension				Content/Rules for all slices
extension:ombCategory		0..5	Extension	Extension
extension		0..0
value[x]
code	S	0..1	code	Symbol in syntax defined by the system Binding: raceCategory FHIR (required): see mapping VF_raceCategory
extension:text		1..1	Extension	Extension
extension		0..0
value[x]	S	1..1	string	Value of extension
extension:ethnicity		0..1	USCoreEthnicityExtension(5.0.1)	US Core ethnicity Extension
Slices for extension				Content/Rules for all slices
extension:ombCategory		0..1	Extension	Extension
extension		0..0
value[x]
code	S	0..1	code	Symbol in syntax defined by the system Binding: ethnicityCategory FHIR (required): see mapping VF_ethnicityCategory
extension:text		1..1	Extension	Extension
extension		0..0
value[x]	S	1..1	string	Value of extension
extension:genderIdentity		0..1	USCoreGenderIdentityExtension	Extension
value[x]	S	1..1	CodeableConcept	Value of extension Binding: genderIdentity FHIR (required): see mapping VF_genderIdentity
extension:patient-religion		0..1	(Complex)	The patient's professed religious affiliations URL: http://hl7.org/fhir/StructureDefinition/patient-religion
value[x]	S	1..1	CodeableConcept	Value of extension Binding: Religion FHIR (required): see mapping VF_Religion
identifier
type
coding
system	S	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	S	0..1	code	Symbol in syntax defined by the system Required Pattern: MR
system		1..1	uri	The namespace for the identifier value Required Pattern: urn:oid:2.16.840.1.113883.4.349
value		1..1	string	The value that is unique within the system.
name
text	S	0..1	string	Text representation of the full name
family		0..1	string	Family name (often called 'Surname') Required Pattern: LAST
given		0..*	string	Given names (not always 'first'). Includes middle names Required Pattern: FIRST & MIDDLE
suffix	S	0..*	string	Parts that come after the name Required Pattern: SUFFIX
Slices for telecom		0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:$this
telecom:va-home		0..1	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
value		1..1	string	The actual contact point details
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: home
telecom:va-work		0..1	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
value		1..1	string	The actual contact point details
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: work
telecom:va-mobile		0..1	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
value		1..1	string	The actual contact point details
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: mobile
gender		1..1	code	male | female | other | unknown Binding: adminGender FHIR (required): see mapping VF_adminGender
birthDate		0..1	date	The date of birth for the individual
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedDateTime	SC	0..1	dateTime	Indicates if the individual is deceased or not p-7-285: If not null then source value from (2-.351)
Slices for address		0..*	Address	An address for the individual Slice: Unordered, Open by value:$this
address:va-home		0..1	Address	An address for the individual
use	S	0..1	code	home | work | temp | old | billing - purpose of this address Required Pattern: home
type	S	0..1	code	postal | physical | both Required Pattern: postal
line		0..*	string	Street name, number, direction & P.O. Box etc.
city		0..1	string	Name of city, town etc.
state		0..1	string	Sub-unit of country (abbreviations ok)
postalCode		0..1	string	US Zip Codes
country	S	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period
start	S	0..1	dateTime	Starting time with inclusive boundary
end	S	0..1	dateTime	End time with inclusive boundary, if not ongoing
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus FHIR (required): see mapping VF_MaritalStatus
communication
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
managingOrganization
display	S	0..1	string	Text alternative for the resource Required Pattern: Veterans Health Administration
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.extension:race.extension:ombCategory.value[x].code	required	RaceCategory http://va.gov/fhir/ValueSet/raceCategory from this IG
Patient.extension:ethnicity.extension:ombCategory.value[x].code	required	EthnicityCategory http://va.gov/fhir/ValueSet/ethnicityCategory from this IG
Patient.extension:genderIdentity.value[x]	required	GenderIdentity http://va.gov/fhir/ValueSet/genderIdentity from this IG
Patient.extension:patient-religion.value[x]	required	Religion http://va.gov/fhir/ValueSet/Religion from this IG
Patient.gender	required	AdminGender http://va.gov/fhir/ValueSet/adminGender from this IG
Patient.maritalStatus	required	MaritalStatus http://va.gov/fhir/ValueSet/MaritalStatus from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
p-7-285	warning	Patient.deceased[x]:deceasedDateTime	If not null then source value from (2-.351) : true

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	USCorePatientProfile(5.0.1)	Information about an individual or animal receiving health care services This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0) us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ombCategory	S	0..5	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: raceCategory FHIR (required): see mapping VF_raceCategory
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
extension:detailed		0..*	Extension	Extended race codes
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed Race (required)
extension:text	S	1..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"text"
value[x]	S	1..1	string	Value of extension
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ombCategory	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: ethnicityCategory FHIR (required): see mapping VF_ethnicityCategory
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
extension:detailed		0..*	Extension	Extended ethnicity codes
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed ethnicity (required)
extension:text	S	1..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"text"
value[x]	S	1..1	string	Value of extension
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
extension:birthsex		0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
extension:genderIdentity		0..1	(Complex)	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
value[x]	S	1..1	CodeableConcept	Value of extension Binding: genderIdentity FHIR (required): see mapping VF_genderIdentity
extension:patient-religion		0..1	(Complex)	The patient's professed religious affiliations URL: http://hl7.org/fhir/StructureDefinition/patient-religion
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-religion"
value[x]	S	1..1	CodeableConcept	Value of extension Binding: Religion FHIR (required): see mapping VF_Religion
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system Required Pattern: MR
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: urn:oid:2.16.840.1.113883.4.349
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	0..1	string	Text representation of the full name
family	SΣC	0..1	string	Family name (often called 'Surname') Required Pattern: LAST
given	SΣ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 Required Pattern: FIRST & MIDDLE
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name Required Pattern: SUFFIX
period	Σ	0..1	Period	Time period when name was/is in use
Slices for telecom	Σ	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:$this
telecom:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:va-home	Σ	0..1	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) Required Pattern: home
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:va-work	Σ	0..1	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) Required Pattern: work
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:va-mobile	Σ	0..1	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) Required Pattern: mobile
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male | female | other | unknown Binding: adminGender FHIR (required): see mapping VF_adminGender
birthDate	SΣ	0..1	date	The date of birth for the individual
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!SΣC	0..1	dateTime	Indicates if the individual is deceased or not p-7-285: If not null then source value from (2-.351)
Slices for address	SΣ	0..*	Address	An address for the individual Slice: Unordered, Open by value:$this
address:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	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
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
address:va-home	SΣ	0..1	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: postal
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	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
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	0..1	dateTime	Starting time with inclusive boundary
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus FHIR (required): see mapping VF_MaritalStatus
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	0..1	string	Text alternative for the resource Required Pattern: Veterans Health Administration
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	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	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.extension:race.extension:ombCategory.value[x]	required	OmbRaceCategories http://hl7.org/fhir/us/core/ValueSet/omb-race-category
Patient.extension:race.extension:ombCategory.value[x].code	required	RaceCategory http://va.gov/fhir/ValueSet/raceCategory from this IG
Patient.extension:race.extension:detailed.value[x]	required	DetailedRace http://hl7.org/fhir/us/core/ValueSet/detailed-race
Patient.extension:ethnicity.extension:ombCategory.value[x]	required	OmbEthnicityCategories http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category
Patient.extension:ethnicity.extension:ombCategory.value[x].code	required	EthnicityCategory http://va.gov/fhir/ValueSet/ethnicityCategory from this IG
Patient.extension:ethnicity.extension:detailed.value[x]	required	DetailedEthnicity http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
Patient.extension:genderIdentity.value[x]	required	GenderIdentity http://va.gov/fhir/ValueSet/genderIdentity from this IG
Patient.extension:patient-religion.value[x]	required	Religion http://va.gov/fhir/ValueSet/Religion from this IG
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-home.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-work.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-work.use	required	Pattern: work http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:va-mobile.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:va-mobile.use	required	Pattern: mobile http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdminGender http://va.gov/fhir/ValueSet/adminGender from this IG
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.address:va-home.use	required	Pattern: home http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address:va-home.type	required	Pattern: postal http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address:va-home.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatus	required	MaritalStatus http://va.gov/fhir/ValueSet/MaritalStatus from this IG
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.managingOrganization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
p-7-285	warning	Patient.deceased[x]:deceasedDateTime	If not null then source value from (2-.351) : true
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6	error	Patient	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from USCorePatientProfile

Summary

Must-Support: 18 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-religion

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.telecom
• The element 1 is sliced based on the value of Patient.deceased[x]
• The element 1 is sliced based on the value of Patient.address