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

• Content
• Detailed Descriptions
• Mappings
• JSON
• History

Resource Profile: VAERS Patient

This StructureDefinition contains the maps for ADERS to us-core-patient.

Usages:

• Use this Profile: VAERS Bundle
• Refer to this Profile: VAERS AdverseEvent, VAERS Immunization[pvac1], VAERS Immunization[pvac2], VAERS Immunization[pvac3]... Show 6 more, VAERS Immunization[pvac4], VAERS Immunization[vac1], VAERS Immunization[vac2], VAERS Immunization[vac3], VAERS Immunization[vac4] and VAERS: abstract
• CapabilityStatements using this Profile: My HealtheVet

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    Filter: Bindings Constraints Obligations
Patient	C	0..*	USCorePatientProfile(5.0.1)	Information about an individual or animal receiving health care services Constraints: us-core-6
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ombCategory	S	0..5	Extension	Extension
extension		0..0
url		1..1	uri	"ombCategory"
value[x]	SC	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. Constraints: vaersp-12-1948, vaersp-12-1949, vaersp-12-1950, vaersp-12-1951, vaersp-12-1952, vaersp-12-1953, vaersp-12-1954
extension:detailed		0..*	Extension	Extended race codes
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed Race (required)
extension:text	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"text"
value[x]	SC	1..1	string	Value of extension Constraints: vaersp-12-1948-1, vaersp-12-1949-1, vaersp-12-1950-1, vaersp-12-1951-1, vaersp-12-1952-1, vaersp-12-1953-1, vaersp-12-1954-1
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
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ombCategory	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"ombCategory"
value[x]	SC	1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required) Constraints: vaersp-12-1955, vaersp-12-1956, vaersp-12-1957, vaersp-12-1958
extension:detailed		0..*	Extension	Extended ethnicity codes
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed ethnicity (required)
extension:text	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"text"
value[x]	SC	1..1	string	Value of extension Constraints: vaersp-12-1955-1, vaersp-12-1956-1, vaersp-12-1957-1, vaersp-12-1958-1
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	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
extension:patient-ageAtVaccination		0..1	(Complex)	Extension URL: http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination
extension		0..0
url		1..1	uri	"http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination"
value[x]	S	0..1	string	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
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.
coding	Σ	0..*	Coding	Code defined by a terminology system
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	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
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣC	0..1	string	Family name (often called 'Surname')
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
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
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)
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
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Σ	0..1	dateTime	Indicates if the individual is deceased or not
address	SΣ	0..*	Address	An address for the individual
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
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
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
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
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)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
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	URI
Patient.extension:race.extension:ombCategory.value[x]	required	OmbRaceCategories http://hl7.org/fhir/us/core/ValueSet/omb-race-category
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:detailed.value[x]	required	DetailedEthnicity http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
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.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
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()
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()
vaersp-12-1948	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#1002-5 "American Indian or Alaska Native" : true
vaersp-12-1949	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2028-9 "Asian" : true
vaersp-12-1950	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-3) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2054-5 "Black or African American" : true
vaersp-12-1951	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-4) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2076-8 "Native Hawaiian or Other Pacific Islander" : true
vaersp-12-1952	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-5) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2106-3 "White" : true
vaersp-12-1953	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-6) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1954	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-7) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2131-1 "Other Race" : true
vaersp-12-1955	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2135-2 "Hispanic or Latino" : true
vaersp-12-1956	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2186-5 "Not Hispanic or Latino" : true
vaersp-12-1957	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-3) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1958	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-4) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#OTH "other" : true
vaersp-12-1948-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value AIAN : true
vaersp-12-1949-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Asian : true
vaersp-12-1950-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value BlkAM : true
vaersp-12-1954-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1953-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1952-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value White : true
vaersp-12-1951-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value NH_OPI : true
vaersp-12-1958-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1957-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1956-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value NHL : true
vaersp-12-1955-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value HispLat : true

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			USCorePatientProfile(5.0.1)
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]	SC	1..1	Coding	Value of extension Constraints: vaersp-12-1948, vaersp-12-1949, vaersp-12-1950, vaersp-12-1951, vaersp-12-1952, vaersp-12-1953, vaersp-12-1954
extension:text		1..1	Extension	Extension
extension		0..0
value[x]	SC	1..1	string	Value of extension Constraints: vaersp-12-1948-1, vaersp-12-1949-1, vaersp-12-1950-1, vaersp-12-1951-1, vaersp-12-1952-1, vaersp-12-1953-1, vaersp-12-1954-1
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]	SC	1..1	Coding	Value of extension Constraints: vaersp-12-1955, vaersp-12-1956, vaersp-12-1957, vaersp-12-1958
extension:text		1..1	Extension	Extension
extension		0..0
value[x]	SC	1..1	string	Value of extension Constraints: vaersp-12-1955-1, vaersp-12-1956-1, vaersp-12-1957-1, vaersp-12-1958-1
extension:patient-ageAtVaccination		0..1	(Complex)	Extension URL: http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination
value[x]	S	0..1	string	Value of extension
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		1..*	HumanName	A name associated with the patient
gender		1..1	code	male | female | other | unknown
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	S	0..1	dateTime	Indicates if the individual is deceased or not
address		0..*	Address	An address for the individual
communication
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
vaersp-12-1948	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#1002-5 "American Indian or Alaska Native" : true
vaersp-12-1949	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2028-9 "Asian" : true
vaersp-12-1950	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-3) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2054-5 "Black or African American" : true
vaersp-12-1951	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-4) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2076-8 "Native Hawaiian or Other Pacific Islander" : true
vaersp-12-1952	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-5) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2106-3 "White" : true
vaersp-12-1953	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-6) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1954	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-7) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2131-1 "Other Race" : true
vaersp-12-1955	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2135-2 "Hispanic or Latino" : true
vaersp-12-1956	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2186-5 "Not Hispanic or Latino" : true
vaersp-12-1957	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-3) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1958	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-4) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#OTH "other" : true
vaersp-12-1948-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value AIAN : true
vaersp-12-1949-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Asian : true
vaersp-12-1958-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1957-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1956-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value NHL : true
vaersp-12-1955-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value HispLat : true
vaersp-12-1950-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value BlkAM : true
vaersp-12-1954-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1953-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1952-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value White : true
vaersp-12-1951-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value NH_OPI : true

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	USCorePatientProfile(5.0.1)	Information about an individual or animal receiving health care services Constraints: us-core-6
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]	SC	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. Constraints: vaersp-12-1948, vaersp-12-1949, vaersp-12-1950, vaersp-12-1951, vaersp-12-1952, vaersp-12-1953, vaersp-12-1954
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]	SC	1..1	string	Value of extension Constraints: vaersp-12-1948-1, vaersp-12-1949-1, vaersp-12-1950-1, vaersp-12-1951-1, vaersp-12-1952-1, vaersp-12-1953-1, vaersp-12-1954-1
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]	SC	1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required) Constraints: vaersp-12-1955, vaersp-12-1956, vaersp-12-1957, vaersp-12-1958
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]	SC	1..1	string	Value of extension Constraints: vaersp-12-1955-1, vaersp-12-1956-1, vaersp-12-1957-1, vaersp-12-1958-1
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	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
extension:patient-ageAtVaccination		0..1	(Complex)	Extension URL: http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination"
value[x]	S	0..1	string	Value of extension
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	Σ	0..1	string	Text representation of the full name
family	SΣC	0..1	string	Family name (often called 'Surname')
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
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	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.
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
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
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Σ	0..1	dateTime	Indicates if the individual is deceased or not
address	SΣ	0..*	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	?!Σ	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"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
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 Constraints: pat-1
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
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	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: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:detailed.value[x]	required	DetailedEthnicity http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
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.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
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 http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
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.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()
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()
vaersp-12-1948	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#1002-5 "American Indian or Alaska Native" : true
vaersp-12-1949	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2028-9 "Asian" : true
vaersp-12-1950	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-3) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2054-5 "Black or African American" : true
vaersp-12-1951	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-4) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2076-8 "Native Hawaiian or Other Pacific Islander" : true
vaersp-12-1952	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-5) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2106-3 "White" : true
vaersp-12-1953	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-6) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1954	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-7) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2131-1 "Other Race" : true
vaersp-12-1955	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2135-2 "Hispanic or Latino" : true
vaersp-12-1956	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2186-5 "Not Hispanic or Latino" : true
vaersp-12-1957	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-3) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1958	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-4) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#OTH "other" : true
vaersp-12-1948-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value AIAN : true
vaersp-12-1949-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Asian : true
vaersp-12-1950-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value BlkAM : true
vaersp-12-1954-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1953-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1952-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value White : true
vaersp-12-1951-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value NH_OPI : true
vaersp-12-1958-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1957-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1956-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value NHL : true
vaersp-12-1955-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value HispLat : true

This structure is derived from USCorePatientProfile

Summary

Must-Support: 8 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

• http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	USCorePatientProfile(5.0.1)	Information about an individual or animal receiving health care services Constraints: us-core-6
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ombCategory	S	0..5	Extension	Extension
extension		0..0
url		1..1	uri	"ombCategory"
value[x]	SC	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. Constraints: vaersp-12-1948, vaersp-12-1949, vaersp-12-1950, vaersp-12-1951, vaersp-12-1952, vaersp-12-1953, vaersp-12-1954
extension:detailed		0..*	Extension	Extended race codes
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed Race (required)
extension:text	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"text"
value[x]	SC	1..1	string	Value of extension Constraints: vaersp-12-1948-1, vaersp-12-1949-1, vaersp-12-1950-1, vaersp-12-1951-1, vaersp-12-1952-1, vaersp-12-1953-1, vaersp-12-1954-1
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
Slices for extension		1..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ombCategory	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"ombCategory"
value[x]	SC	1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required) Constraints: vaersp-12-1955, vaersp-12-1956, vaersp-12-1957, vaersp-12-1958
extension:detailed		0..*	Extension	Extended ethnicity codes
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed ethnicity (required)
extension:text	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"text"
value[x]	SC	1..1	string	Value of extension Constraints: vaersp-12-1955-1, vaersp-12-1956-1, vaersp-12-1957-1, vaersp-12-1958-1
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	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
extension:patient-ageAtVaccination		0..1	(Complex)	Extension URL: http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination
extension		0..0
url		1..1	uri	"http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination"
value[x]	S	0..1	string	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
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.
coding	Σ	0..*	Coding	Code defined by a terminology system
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	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
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣC	0..1	string	Family name (often called 'Surname')
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
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
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)
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
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Σ	0..1	dateTime	Indicates if the individual is deceased or not
address	SΣ	0..*	Address	An address for the individual
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
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
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
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
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)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
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	URI
Patient.extension:race.extension:ombCategory.value[x]	required	OmbRaceCategories http://hl7.org/fhir/us/core/ValueSet/omb-race-category
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:detailed.value[x]	required	DetailedEthnicity http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
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.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
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()
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()
vaersp-12-1948	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#1002-5 "American Indian or Alaska Native" : true
vaersp-12-1949	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2028-9 "Asian" : true
vaersp-12-1950	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-3) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2054-5 "Black or African American" : true
vaersp-12-1951	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-4) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2076-8 "Native Hawaiian or Other Pacific Islander" : true
vaersp-12-1952	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-5) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2106-3 "White" : true
vaersp-12-1953	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-6) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1954	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-7) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2131-1 "Other Race" : true
vaersp-12-1955	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2135-2 "Hispanic or Latino" : true
vaersp-12-1956	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2186-5 "Not Hispanic or Latino" : true
vaersp-12-1957	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-3) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1958	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-4) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#OTH "other" : true
vaersp-12-1948-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value AIAN : true
vaersp-12-1949-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Asian : true
vaersp-12-1950-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value BlkAM : true
vaersp-12-1954-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1953-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1952-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value White : true
vaersp-12-1951-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value NH_OPI : true
vaersp-12-1958-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1957-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1956-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value NHL : true
vaersp-12-1955-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value HispLat : true

Differential View

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			USCorePatientProfile(5.0.1)
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]	SC	1..1	Coding	Value of extension Constraints: vaersp-12-1948, vaersp-12-1949, vaersp-12-1950, vaersp-12-1951, vaersp-12-1952, vaersp-12-1953, vaersp-12-1954
extension:text		1..1	Extension	Extension
extension		0..0
value[x]	SC	1..1	string	Value of extension Constraints: vaersp-12-1948-1, vaersp-12-1949-1, vaersp-12-1950-1, vaersp-12-1951-1, vaersp-12-1952-1, vaersp-12-1953-1, vaersp-12-1954-1
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]	SC	1..1	Coding	Value of extension Constraints: vaersp-12-1955, vaersp-12-1956, vaersp-12-1957, vaersp-12-1958
extension:text		1..1	Extension	Extension
extension		0..0
value[x]	SC	1..1	string	Value of extension Constraints: vaersp-12-1955-1, vaersp-12-1956-1, vaersp-12-1957-1, vaersp-12-1958-1
extension:patient-ageAtVaccination		0..1	(Complex)	Extension URL: http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination
value[x]	S	0..1	string	Value of extension
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		1..*	HumanName	A name associated with the patient
gender		1..1	code	male | female | other | unknown
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	S	0..1	dateTime	Indicates if the individual is deceased or not
address		0..*	Address	An address for the individual
communication
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
vaersp-12-1948	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#1002-5 "American Indian or Alaska Native" : true
vaersp-12-1949	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2028-9 "Asian" : true
vaersp-12-1950	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-3) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2054-5 "Black or African American" : true
vaersp-12-1951	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-4) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2076-8 "Native Hawaiian or Other Pacific Islander" : true
vaersp-12-1952	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-5) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2106-3 "White" : true
vaersp-12-1953	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-6) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1954	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-7) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2131-1 "Other Race" : true
vaersp-12-1955	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2135-2 "Hispanic or Latino" : true
vaersp-12-1956	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2186-5 "Not Hispanic or Latino" : true
vaersp-12-1957	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-3) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1958	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-4) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#OTH "other" : true
vaersp-12-1948-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value AIAN : true
vaersp-12-1949-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Asian : true
vaersp-12-1958-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1957-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1956-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value NHL : true
vaersp-12-1955-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value HispLat : true
vaersp-12-1950-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value BlkAM : true
vaersp-12-1954-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1953-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1952-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value White : true
vaersp-12-1951-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value NH_OPI : true

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	USCorePatientProfile(5.0.1)	Information about an individual or animal receiving health care services Constraints: us-core-6
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]	SC	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. Constraints: vaersp-12-1948, vaersp-12-1949, vaersp-12-1950, vaersp-12-1951, vaersp-12-1952, vaersp-12-1953, vaersp-12-1954
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]	SC	1..1	string	Value of extension Constraints: vaersp-12-1948-1, vaersp-12-1949-1, vaersp-12-1950-1, vaersp-12-1951-1, vaersp-12-1952-1, vaersp-12-1953-1, vaersp-12-1954-1
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]	SC	1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required) Constraints: vaersp-12-1955, vaersp-12-1956, vaersp-12-1957, vaersp-12-1958
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]	SC	1..1	string	Value of extension Constraints: vaersp-12-1955-1, vaersp-12-1956-1, vaersp-12-1957-1, vaersp-12-1958-1
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	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
extension:patient-ageAtVaccination		0..1	(Complex)	Extension URL: http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination"
value[x]	S	0..1	string	Value of extension
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	Σ	0..1	string	Text representation of the full name
family	SΣC	0..1	string	Family name (often called 'Surname')
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
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	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.
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
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
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Σ	0..1	dateTime	Indicates if the individual is deceased or not
address	SΣ	0..*	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	?!Σ	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"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
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 Constraints: pat-1
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
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	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: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:detailed.value[x]	required	DetailedEthnicity http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
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.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
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 http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
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.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()
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()
vaersp-12-1948	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#1002-5 "American Indian or Alaska Native" : true
vaersp-12-1949	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2028-9 "Asian" : true
vaersp-12-1950	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-3) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2054-5 "Black or African American" : true
vaersp-12-1951	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-4) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2076-8 "Native Hawaiian or Other Pacific Islander" : true
vaersp-12-1952	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-5) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2106-3 "White" : true
vaersp-12-1953	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-6) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1954	best practice	Patient.extension:race.extension:ombCategory.value[x]	If (24-7) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2131-1 "Other Race" : true
vaersp-12-1955	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-1) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2135-2 "Hispanic or Latino" : true
vaersp-12-1956	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-2) is not xsi:nil then fixed value urn:oid:2.16.840.1.113883.6.238#2186-5 "Not Hispanic or Latino" : true
vaersp-12-1957	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-3) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" : true
vaersp-12-1958	best practice	Patient.extension:ethnicity.extension:ombCategory.value[x]	If (25-4) is not xsi:nil then fixed value http://terminology.hl7.org/CodeSystem/v3-NullFlavor#OTH "other" : true
vaersp-12-1948-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value AIAN : true
vaersp-12-1949-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Asian : true
vaersp-12-1950-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value BlkAM : true
vaersp-12-1954-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1953-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1952-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value White : true
vaersp-12-1951-1	best practice	Patient.extension:race.extension:text.value[x]	If not xsi:nil then fixed value NH_OPI : true
vaersp-12-1958-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Other : true
vaersp-12-1957-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value Unk : true
vaersp-12-1956-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value NHL : true
vaersp-12-1955-1	best practice	Patient.extension:ethnicity.extension:text.value[x]	If not xsi:nil then fixed value HispLat : true

This structure is derived from USCorePatientProfile

Summary

Must-Support: 8 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

• http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination

Slices

This structure defines the following Slices:

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