It is based on the US Core Patient profile with a further constraint for the county (Patient.address.district) where the patient resides.

Patient.gender is the only required "sex" parameter. (Patient.gender is not "gender identity"). Patient.gender is asserted by the patient. As this profile is to be used with at-home test kits, there is no "clinical sex" information on result observations and the receiver would need to keep this in mind when determining the correct sex parameter for clinical use. It should be understood that Patient.gender is not necessarily appropriate to use for interpretation of result observations.

See the following pages for guidance:

• Using OIDs as Identifiers
• Obtaining App Specific Identifiers
• examples and value set Hl7VSUniversalIdType for coding the 'ISO' id type

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

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient			USCorePatientProfile
Slices for extension				Content/Rules for all slices
extension:race		0..1	USCoreRaceExtension	US Core Race Extension. V2: PID-10.1, PID-10.2, PID-10.3, PID-10.7
extension:ethnicity		0..1	USCoreEthnicityExtension	US Core Ethnicity Extension. V2: PID-22.1, PID-22-2, PID-22.3, PID-22.7
identifier		1..*	Identifier	An identifier for this patient: the value that is unique within the system. Unique ID assigned to patient by App provider.
system		1..1	uri	See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: PID-3.4.2
value		1..1	string	Unique ID assigned to patient by App provider. If converting FHIR to V2, must be 100 characters or less. V2: PID-3.1
name		1..*	HumanName	(USCDI) A name associated with the patient
family		0..1	string	Family name (often called 'Surname'). If excluded or not available, use '~^^^^^^S'. V2: PID-5.1
given		0..*	string	Given names (not always 'first'). Includes middle names. If excluded or not available, do not populate. V2: PID-5.2, PID-5.3
telecom		0..*	ContactPoint	A contact detail for the individual V2: PID-13.3, PID-13.4, PID-13.6, PID-13.7
gender		1..1	code	Asserted by the At-Home Test patient. male | female | other | unknown V2: PID-8
birthDate		1..1	date	The date of birth for the individual. V2: PID-7
address		0..*	Address	(USCDI) An address for the individual
line		0..*	string	Street name, number, direction & P.O. Box etc. V2: PID-11.1, PID-11-2
city		0..1	string	Name of city, town etc. V2: PID-11.3
district	S	0..1	string	Patient County. V2: PID-11.9 Binding: County (extensible)
state		0..1	string	Sub-unit of country (abbreviations ok). V2: PID-11.4
postalCode		1..1	string	US Zip Codes. V2: PID-11.5
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.address.district	extensible	PHVS_County_FIPS_6-4 http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.829

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
race		0..1	(Complex)	US Core Race Extension. V2: PID-10.1, PID-10.2, PID-10.3, PID-10.7 URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
ethnicity		0..1	(Complex)	US Core Ethnicity Extension. V2: PID-22.1, PID-22-2, PID-22.3, PID-22.7 URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
tribalAffiliation		0..*	(Complex)	(USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
birthsex		0..1	code	Birth Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
sex		0..1	code	(USCDI) Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
genderIdentity		0..*	CodeableConcept	(USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient: the value that is unique within the system. Unique ID assigned to patient by App provider.
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	See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: PID-3.4.2 Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	Unique ID assigned to patient by App provider. If converting FHIR to V2, must be 100 characters or less. V2: PID-3.1 Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	(USCDI) A name associated with the patient us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
use	?!Σ	0..1	code	(USCDI) 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'). If excluded or not available, use '~^^^^^^S'. V2: PID-5.1
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names. If excluded or not available, do not populate. V2: PID-5.2, PID-5.3 This repeating element order: Given Names appear in the correct order for presenting the name
telecom	Σ	0..*	ContactPoint	A contact detail for the individual V2: PID-13.3, PID-13.4, PID-13.6, PID-13.7
system	SΣC	1..1	code	(USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	(USCDI) The actual contact point details
use	?!SΣ	0..1	code	(USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
gender	SΣ	1..1	code	Asserted by the At-Home Test patient. male | female | other | unknown V2: PID-8 Binding: AdministrativeGender (required)
birthDate	SΣ	1..1	date	The date of birth for the individual. V2: PID-7
deceased[x]	?!Σ	0..1		(USCDI) Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	(USCDI) An address for the individual
use	?!Σ	0..1	code	(USCDI) 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. V2: PID-11.1, PID-11-2 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. V2: PID-11.3 Example General: Erewhon
district	SΣ	0..1	string	Patient County. V2: PID-11.9 Binding: County (extensible) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok). V2: PID-11.4 Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	1..1	string	US Zip Codes. V2: PID-11.5 Example General: 9132
communication		0..*	BackboneElement	(USCDI) 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	(USCDI) The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.district	extensible	PHVS_County_FIPS_6-4 http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.829
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.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
race		0..1	(Complex)	US Core Race Extension. V2: PID-10.1, PID-10.2, PID-10.3, PID-10.7 URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
ethnicity		0..1	(Complex)	US Core Ethnicity Extension. V2: PID-22.1, PID-22-2, PID-22.3, PID-22.7 URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
tribalAffiliation		0..*	(Complex)	(USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
birthsex		0..1	code	Birth Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
sex		0..1	code	(USCDI) Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
genderIdentity		0..*	CodeableConcept	(USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient: the value that is unique within the system. Unique ID assigned to patient by App provider.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: PID-3.4.2 Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	Unique ID assigned to patient by App provider. If converting FHIR to V2, must be 100 characters or less. V2: PID-3.1 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	(USCDI) A name associated with the patient us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	(USCDI) 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'). If excluded or not available, use '~^^^^^^S'. V2: PID-5.1
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names. If excluded or not available, do not populate. V2: PID-5.2, PID-5.3 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	(USCDI) Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	(USCDI) Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the individual V2: PID-13.3, PID-13.4, PID-13.6, PID-13.7
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	(USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	(USCDI) The actual contact point details
use	?!SΣ	0..1	code	(USCDI) 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	Asserted by the At-Home Test patient. male | female | other | unknown V2: PID-8 Binding: AdministrativeGender (required)
birthDate	SΣ	1..1	date	The date of birth for the individual. V2: PID-7
deceased[x]	?!Σ	0..1		(USCDI) Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	(USCDI) An address for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	(USCDI) 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. V2: PID-11.1, PID-11-2 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. V2: PID-11.3 Example General: Erewhon
district	SΣ	0..1	string	Patient County. V2: PID-11.9 Binding: County (extensible) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok). V2: PID-11.4 Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	1..1	string	US Zip Codes. V2: PID-11.5 Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	(USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	(USCDI) 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	(USCDI) The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages 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.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.district	extensible	PHVS_County_FIPS_6-4 http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.829
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.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Differential View

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient			USCorePatientProfile
Slices for extension				Content/Rules for all slices
extension:race		0..1	USCoreRaceExtension	US Core Race Extension. V2: PID-10.1, PID-10.2, PID-10.3, PID-10.7
extension:ethnicity		0..1	USCoreEthnicityExtension	US Core Ethnicity Extension. V2: PID-22.1, PID-22-2, PID-22.3, PID-22.7
identifier		1..*	Identifier	An identifier for this patient: the value that is unique within the system. Unique ID assigned to patient by App provider.
system		1..1	uri	See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: PID-3.4.2
value		1..1	string	Unique ID assigned to patient by App provider. If converting FHIR to V2, must be 100 characters or less. V2: PID-3.1
name		1..*	HumanName	(USCDI) A name associated with the patient
family		0..1	string	Family name (often called 'Surname'). If excluded or not available, use '~^^^^^^S'. V2: PID-5.1
given		0..*	string	Given names (not always 'first'). Includes middle names. If excluded or not available, do not populate. V2: PID-5.2, PID-5.3
telecom		0..*	ContactPoint	A contact detail for the individual V2: PID-13.3, PID-13.4, PID-13.6, PID-13.7
gender		1..1	code	Asserted by the At-Home Test patient. male | female | other | unknown V2: PID-8
birthDate		1..1	date	The date of birth for the individual. V2: PID-7
address		0..*	Address	(USCDI) An address for the individual
line		0..*	string	Street name, number, direction & P.O. Box etc. V2: PID-11.1, PID-11-2
city		0..1	string	Name of city, town etc. V2: PID-11.3
district	S	0..1	string	Patient County. V2: PID-11.9 Binding: County (extensible)
state		0..1	string	Sub-unit of country (abbreviations ok). V2: PID-11.4
postalCode		1..1	string	US Zip Codes. V2: PID-11.5
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.address.district	extensible	PHVS_County_FIPS_6-4 http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.829

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
race		0..1	(Complex)	US Core Race Extension. V2: PID-10.1, PID-10.2, PID-10.3, PID-10.7 URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
ethnicity		0..1	(Complex)	US Core Ethnicity Extension. V2: PID-22.1, PID-22-2, PID-22.3, PID-22.7 URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
tribalAffiliation		0..*	(Complex)	(USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
birthsex		0..1	code	Birth Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
sex		0..1	code	(USCDI) Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
genderIdentity		0..*	CodeableConcept	(USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient: the value that is unique within the system. Unique ID assigned to patient by App provider.
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	See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: PID-3.4.2 Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	Unique ID assigned to patient by App provider. If converting FHIR to V2, must be 100 characters or less. V2: PID-3.1 Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	(USCDI) A name associated with the patient us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
use	?!Σ	0..1	code	(USCDI) 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'). If excluded or not available, use '~^^^^^^S'. V2: PID-5.1
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names. If excluded or not available, do not populate. V2: PID-5.2, PID-5.3 This repeating element order: Given Names appear in the correct order for presenting the name
telecom	Σ	0..*	ContactPoint	A contact detail for the individual V2: PID-13.3, PID-13.4, PID-13.6, PID-13.7
system	SΣC	1..1	code	(USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	(USCDI) The actual contact point details
use	?!SΣ	0..1	code	(USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
gender	SΣ	1..1	code	Asserted by the At-Home Test patient. male | female | other | unknown V2: PID-8 Binding: AdministrativeGender (required)
birthDate	SΣ	1..1	date	The date of birth for the individual. V2: PID-7
deceased[x]	?!Σ	0..1		(USCDI) Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	(USCDI) An address for the individual
use	?!Σ	0..1	code	(USCDI) 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. V2: PID-11.1, PID-11-2 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. V2: PID-11.3 Example General: Erewhon
district	SΣ	0..1	string	Patient County. V2: PID-11.9 Binding: County (extensible) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok). V2: PID-11.4 Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	1..1	string	US Zip Codes. V2: PID-11.5 Example General: 9132
communication		0..*	BackboneElement	(USCDI) 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	(USCDI) The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.district	extensible	PHVS_County_FIPS_6-4 http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.829
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.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
race		0..1	(Complex)	US Core Race Extension. V2: PID-10.1, PID-10.2, PID-10.3, PID-10.7 URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
ethnicity		0..1	(Complex)	US Core Ethnicity Extension. V2: PID-22.1, PID-22-2, PID-22.3, PID-22.7 URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
tribalAffiliation		0..*	(Complex)	(USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
birthsex		0..1	code	Birth Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
sex		0..1	code	(USCDI) Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
genderIdentity		0..*	CodeableConcept	(USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient: the value that is unique within the system. Unique ID assigned to patient by App provider.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: PID-3.4.2 Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	Unique ID assigned to patient by App provider. If converting FHIR to V2, must be 100 characters or less. V2: PID-3.1 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	(USCDI) A name associated with the patient us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	(USCDI) 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'). If excluded or not available, use '~^^^^^^S'. V2: PID-5.1
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names. If excluded or not available, do not populate. V2: PID-5.2, PID-5.3 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	(USCDI) Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	(USCDI) Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the individual V2: PID-13.3, PID-13.4, PID-13.6, PID-13.7
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	(USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	(USCDI) The actual contact point details
use	?!SΣ	0..1	code	(USCDI) 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	Asserted by the At-Home Test patient. male | female | other | unknown V2: PID-8 Binding: AdministrativeGender (required)
birthDate	SΣ	1..1	date	The date of birth for the individual. V2: PID-7
deceased[x]	?!Σ	0..1		(USCDI) Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	(USCDI) An address for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	(USCDI) 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. V2: PID-11.1, PID-11-2 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. V2: PID-11.3 Example General: Erewhon
district	SΣ	0..1	string	Patient County. V2: PID-11.9 Binding: County (extensible) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok). V2: PID-11.4 Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	1..1	string	US Zip Codes. V2: PID-11.5 Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	(USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	(USCDI) 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	(USCDI) The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages 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.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.district	extensible	PHVS_County_FIPS_6-4 http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.829
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.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

This structure is derived from USCorePatientProfile

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 1 element