This page is part of the electronic Case Reporting (eCR) (v2.1.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples

Resource Profile: US Public Health Patient

This Patient profile represents a US Public Health Patient.

It is based on the US Core Patient profile with further constraints to require and/or allow masking of some data elements, and the addition of the US Public Health Gender Identity extension.

For ONC’s USCDI requirements, it also adds Must Support constraints to the following:

• contact detail (e.g. a telephone number or an email address)
• a communication language
• a race
• an ethnicity
• a birth sex

Usage:

• Refer to this Resource Profile: RR Composition, RR DocumentReference, US Public Health Characteristics of Home Environment, US Public Health Composition... Show 10 more, US Public Health Condition, US Public Health Disability Status, US Public Health Emergency Outbreak Information, US Public Health Encounter, US Public Health Exposure Contact Information, US Public Health MedicationAdministration, US Public Health Postpartum Status, US Public Health Pregnancy Outcome Observation, US Public Health Pregnancy Status Observation and US Public Health Travel History
• Examples for this Resource Profile: Patient/patient-ecr-eve-everywoman

Formal Views of Profile Content

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

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

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile(4.0.0)	US Public Health Patient
Slices for extension				Content/Rules for all slices
extension:race	S	1..1	USCoreRaceExtension(4.0.0)	US Core Race Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
extension:ethnicity	S	1..1	USCoreEthnicityExtension(4.0.0)	US Core ethnicity Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
extension:birthsex	S	0..1	USCoreBirthSexExtension(4.0.0)	Extension
birthPlace	S	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
genderIdentity	S	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension
tribalAffiliation	S	0..*	(Complex)	Tribal affiliation and membership of the patient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-extension
identifier	S	1..*	Identifier	An identifier for this patient
Slices for extension				Content/Rules for all slices
dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
name		1..*	HumanName	A name associated with the patient
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
Slices for telecom	S	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices				Content/Rules for all slices
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
telecom:phone	S	0..*	ContactPoint	A contact detail for the individual
system	S	1..1	code	phone | fax | email | pager | url | sms | other Fixed Value: phone
telecom:email	S	0..*	ContactPoint	A contact detail for the individual
system	S	1..1	code	phone | fax | email | pager | url | sms | other Fixed Value: email
gender	S	1..1	code	male | female | other | unknown
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
birthDate	S	1..1	date	The date of birth for the individual
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
deceased[x]	S	1..1	boolean, dateTime	If patient is deceased, use type dateTime and set to deceased date.
address	S	1..*	Address	An address for the individual
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
district	S	0..1	string	County
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	S	1..1	CodeableConcept	The kind of relationship
name	S	1..1	HumanName	A name associated with the contact person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
telecom	S	1..*	ContactPoint	A contact detail for the person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
address	S	1..1	Address	Address for the contact person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
communication	S	1..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile(4.0.0)	US Public Health Patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
race	S	1..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	American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
url		1..1	uri	"ombCategory"
Slices for value[x]		1..1	Coding	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding		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.
extension:detailed		0..*	Extension	Extended race codes
url		1..1	uri	"detailed"
Slices for value[x]		1..1	Coding	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding		1..1	Coding	Value of extension Binding: Detailed Race (required)
extension:text	S	1..1	Extension	Race Text
url		1..1	uri	"text"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
ethnicity	S	1..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	Hispanic or Latino|Not Hispanic or Latino
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required)
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	ethnicity Text
url		1..1	uri	"text"
value[x]		1..1	string	Value of extension
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
birthsex	S	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
birthPlace	S	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
genderIdentity	S	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension
tribalAffiliation	S	0..*	(Complex)	Tribal affiliation and membership of the patient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
Slices for extension				Content/Rules for all slices
dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
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ΣC	1..*	HumanName	A name associated with the patient us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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
Slices for telecom	SΣ	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices				Content/Rules for all slices
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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)
telecom:phone	SΣ	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. Fixed Value: 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)
telecom:email	SΣ	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. Fixed Value: email
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)
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
birthDate	SΣ	1..1	date	The date of birth for the individual
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
deceased[x]	?!SΣ	1..1		If patient is deceased, use type dateTime and set to deceased date.
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	Address	An address for the individual
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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
district	SΣ	0..1	string	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
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
contact	SC	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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	S	1..1	HumanName	A name associated with the contact person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
telecom	S	1..*	ContactPoint	A contact detail for the person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address	S	1..1	Address	Address for the contact person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
communication	S	1..*	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)
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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 / Code	URI
Patient.extension:race.extension:ombCategory.value[x]:valueCoding	required	OmbRaceCategories http://hl7.org/fhir/us/core/ValueSet/omb-race-category
Patient.extension:race.extension:detailed.value[x]:valueCoding	required	DetailedRace http://hl7.org/fhir/us/core/ValueSet/detailed-race
Patient.extension:race.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
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.extension:ethnicity.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.identifier.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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:phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:email.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.gender.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.birthDate.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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 (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.contact.telecom.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.contact.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.communication.language.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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()
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-8	error	Patient.name	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile(4.0.0)	US Public Health Patient
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		2..*	Extension	Extension Slice: Unordered, Open by value:url
race	S	1..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	American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"ombCategory"
Slices for value[x]		1..1	Coding	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding		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.
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
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"detailed"
Slices for value[x]		1..1	Coding	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding		1..1	Coding	Value of extension Binding: Detailed Race (required)
extension:text	S	1..1	Extension	Race Text
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"text"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
ethnicity	S	1..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	Hispanic or Latino|Not Hispanic or Latino
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required)
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
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed ethnicity (required)
extension:text	S	1..1	Extension	ethnicity Text
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"text"
value[x]		1..1	string	Value of extension
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
birthsex	S	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
birthPlace	S	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
genderIdentity	S	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension
tribalAffiliation	S	0..*	(Complex)	Tribal affiliation and membership of the patient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-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
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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.
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
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ΣC	1..*	HumanName	A name associated with the patient us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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
Slices for telecom	SΣ	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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:phone	SΣ	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. Fixed Value: 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)
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:email	SΣ	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. Fixed Value: email
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)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
value		0..1	string	Primitive value for code
birthDate	SΣ	1..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
value		0..1	date	Primitive value for date
deceased[x]	?!SΣ	1..1		If patient is deceased, use type dateTime and set to deceased date.
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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	SΣ	0..1	string	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	SC	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	S	1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	S	1..1	HumanName	A name associated with the contact person
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	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	S	1..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
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
address	S	1..1	Address	Address for the contact person
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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	Σ	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	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
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	S	1..*	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)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
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 / Code	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.extension:race.extension:ombCategory.value[x]:valueCoding	required	OmbRaceCategories http://hl7.org/fhir/us/core/ValueSet/omb-race-category
Patient.extension:race.extension:detailed.value[x]:valueCoding	required	DetailedRace http://hl7.org/fhir/us/core/ValueSet/detailed-race
Patient.extension:race.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
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.extension:ethnicity.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.identifier.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
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.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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:phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:email.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.gender.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.birthDate.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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 (a valid code from https://www.usps.com/) 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.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.contact.telecom.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.contact.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.contact.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 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.communication.language.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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()
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-8	error	Patient.name	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from USCorePatientProfile

Summary

Mandatory: 9 elements(18 nested mandatory elements)
Must-Support: 47 elements
Fixed: 14 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/data-absent-reason
• http://hl7.org/fhir/StructureDefinition/patient-birthPlace
• http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension
• http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-extension

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.telecom

Differential View

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile(4.0.0)	US Public Health Patient
Slices for extension				Content/Rules for all slices
extension:race	S	1..1	USCoreRaceExtension(4.0.0)	US Core Race Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
extension:ethnicity	S	1..1	USCoreEthnicityExtension(4.0.0)	US Core ethnicity Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
extension:birthsex	S	0..1	USCoreBirthSexExtension(4.0.0)	Extension
birthPlace	S	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
genderIdentity	S	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension
tribalAffiliation	S	0..*	(Complex)	Tribal affiliation and membership of the patient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-extension
identifier	S	1..*	Identifier	An identifier for this patient
Slices for extension				Content/Rules for all slices
dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
name		1..*	HumanName	A name associated with the patient
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
Slices for telecom	S	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices				Content/Rules for all slices
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
telecom:phone	S	0..*	ContactPoint	A contact detail for the individual
system	S	1..1	code	phone | fax | email | pager | url | sms | other Fixed Value: phone
telecom:email	S	0..*	ContactPoint	A contact detail for the individual
system	S	1..1	code	phone | fax | email | pager | url | sms | other Fixed Value: email
gender	S	1..1	code	male | female | other | unknown
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
birthDate	S	1..1	date	The date of birth for the individual
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
deceased[x]	S	1..1	boolean, dateTime	If patient is deceased, use type dateTime and set to deceased date.
address	S	1..*	Address	An address for the individual
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
district	S	0..1	string	County
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	S	1..1	CodeableConcept	The kind of relationship
name	S	1..1	HumanName	A name associated with the contact person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
telecom	S	1..*	ContactPoint	A contact detail for the person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
address	S	1..1	Address	Address for the contact person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
communication	S	1..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]	S	1..1	code	Value of extension Fixed Value: masked
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile(4.0.0)	US Public Health Patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
race	S	1..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	American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
url		1..1	uri	"ombCategory"
Slices for value[x]		1..1	Coding	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding		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.
extension:detailed		0..*	Extension	Extended race codes
url		1..1	uri	"detailed"
Slices for value[x]		1..1	Coding	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding		1..1	Coding	Value of extension Binding: Detailed Race (required)
extension:text	S	1..1	Extension	Race Text
url		1..1	uri	"text"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
ethnicity	S	1..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	Hispanic or Latino|Not Hispanic or Latino
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required)
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	ethnicity Text
url		1..1	uri	"text"
value[x]		1..1	string	Value of extension
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
birthsex	S	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
birthPlace	S	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
genderIdentity	S	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension
tribalAffiliation	S	0..*	(Complex)	Tribal affiliation and membership of the patient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
Slices for extension				Content/Rules for all slices
dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
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ΣC	1..*	HumanName	A name associated with the patient us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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
Slices for telecom	SΣ	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices				Content/Rules for all slices
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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)
telecom:phone	SΣ	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. Fixed Value: 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)
telecom:email	SΣ	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. Fixed Value: email
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)
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
birthDate	SΣ	1..1	date	The date of birth for the individual
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
deceased[x]	?!SΣ	1..1		If patient is deceased, use type dateTime and set to deceased date.
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	Address	An address for the individual
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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
district	SΣ	0..1	string	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
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
contact	SC	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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	S	1..1	HumanName	A name associated with the contact person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
telecom	S	1..*	ContactPoint	A contact detail for the person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address	S	1..1	Address	Address for the contact person
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
communication	S	1..*	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)
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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 / Code	URI
Patient.extension:race.extension:ombCategory.value[x]:valueCoding	required	OmbRaceCategories http://hl7.org/fhir/us/core/ValueSet/omb-race-category
Patient.extension:race.extension:detailed.value[x]:valueCoding	required	DetailedRace http://hl7.org/fhir/us/core/ValueSet/detailed-race
Patient.extension:race.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
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.extension:ethnicity.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.identifier.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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:phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:email.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.gender.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.birthDate.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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 (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.contact.telecom.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.contact.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.communication.language.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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()
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-8	error	Patient.name	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile(4.0.0)	US Public Health Patient
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		2..*	Extension	Extension Slice: Unordered, Open by value:url
race	S	1..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	American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"ombCategory"
Slices for value[x]		1..1	Coding	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding		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.
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
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"detailed"
Slices for value[x]		1..1	Coding	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding		1..1	Coding	Value of extension Binding: Detailed Race (required)
extension:text	S	1..1	Extension	Race Text
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"text"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
ethnicity	S	1..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	Hispanic or Latino|Not Hispanic or Latino
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"ombCategory"
value[x]		1..1	Coding	Value of extension Binding: OMB Ethnicity Categories (required)
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
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"detailed"
value[x]		1..1	Coding	Value of extension Binding: Detailed ethnicity (required)
extension:text	S	1..1	Extension	ethnicity Text
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension: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
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"text"
value[x]		1..1	string	Value of extension
dataAbsentReason	S	0..1	(Complex)	For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
birthsex	S	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
birthPlace	S	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
genderIdentity	S	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension
tribalAffiliation	S	0..*	(Complex)	Tribal affiliation and membership of the patient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-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
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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.
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
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ΣC	1..*	HumanName	A name associated with the patient us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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
Slices for telecom	SΣ	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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:phone	SΣ	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. Fixed Value: 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)
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:email	SΣ	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. Fixed Value: email
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)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
value		0..1	string	Primitive value for code
birthDate	SΣ	1..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
value		0..1	date	Primitive value for date
deceased[x]	?!SΣ	1..1		If patient is deceased, use type dateTime and set to deceased date.
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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	SΣ	0..1	string	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	SC	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	S	1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	S	1..1	HumanName	A name associated with the contact person
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	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	S	1..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
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
address	S	1..1	Address	Address for the contact person
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
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	Σ	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	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
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	S	1..*	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)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason	S	0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	S	1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
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 / Code	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.extension:race.extension:ombCategory.value[x]:valueCoding	required	OmbRaceCategories http://hl7.org/fhir/us/core/ValueSet/omb-race-category
Patient.extension:race.extension:detailed.value[x]:valueCoding	required	DetailedRace http://hl7.org/fhir/us/core/ValueSet/detailed-race
Patient.extension:race.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
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.extension:ethnicity.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.identifier.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
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.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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:phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.telecom:email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom:email.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.gender.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.birthDate.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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 (a valid code from https://www.usps.com/) 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.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.contact.telecom.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.contact.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard
Patient.contact.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.contact.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 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.communication.language.extension:dataAbsentReason.value[x]	required	Fixed Value: masked http://hl7.org/fhir/ValueSet/data-absent-reason 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()
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-8	error	Patient.name	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from USCorePatientProfile

Summary

Mandatory: 9 elements(18 nested mandatory elements)
Must-Support: 47 elements
Fixed: 14 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/data-absent-reason
• http://hl7.org/fhir/StructureDefinition/patient-birthPlace
• http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension
• http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-extension

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.telecom