US Quality Core Implementation Guide
0.1.0 - cibuild

US Quality Core Implementation Guide, published by ASTP. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/us-quality-core/ and changes regularly. See the Directory of published versions

## Resource Profile: US Quality Core Patient

Official URL: http://fhir.org/guides/astp/us-quality-core/StructureDefinition/us-quality-core-patient | Version: 0.1.0
Active as of 2026-03-31 | Computable Name: USQualityCorePatient

Profile of Patient for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Usage

See the patterns page for implementation and usage patterns.

### Examples

Basic Patient Example
65+ Female Patient Example
Infant Patient Example

USCDI+ Quality Elements:

- extension:race: (USCDI+ Quality) (USCDI) US Core Race Extension
- extension:ethnicity: (USCDI+ Quality) (USCDI) US Core ethnicity Extension
- extension:tribalAffiliation: (USCDI+ Quality) (USCDI) Tribal Affiliation Extension
- identifier: (USCDI+ Quality) (USCDI) An identifier for this patient
- identifier.system: (USCDI+ Quality) (USCDI) The namespace for the identifier value
- identifier.value: (USCDI+ Quality) (USCDI) The value that is unique within the system.
- name: (USCDI+ Quality) (USCDI) A name associated with the patient
- name.use: (USCDI+ Quality) (USCDI) usual \| official \| temp \| nickname \| anonymous \| old \| maiden
- name.family: (USCDI+ Quality) (USCDI) Family name (often called 'Surname')
- name.given: (USCDI+ Quality) (USCDI) Given names (not always 'first'). Includes middle names
- name.suffix: (USCDI+ Quality) (USCDI) Parts that come after the name
- name.period: (USCDI+ Quality) (USCDI) Time period when name was/is in use
- telecom: (USCDI+ Quality) (USCDI) A contact detail for the individual
- telecom.system: (USCDI+ Quality) (USCDI) phone \| fax \| email \| pager \| url \| sms \| other
- telecom.value: (USCDI+ Quality) (USCDI) The actual contact point details
- telecom.use: (USCDI+ Quality) (USCDI) home \| work \| temp \| old \| mobile - purpose of this contact point
- birthDate: (USCDI+ Quality) (USCDI) The date of birth for the individual
- deceased[x]: (USCDI+ Quality) (USCDI) Indicates if the individual is deceased or not
- address: (USCDI+ Quality) (USCDI) An address for the individual
- address.use: (USCDI+ Quality) (USCDI) home \| work \| temp \| old \| billing - purpose of this address
- address.line: (USCDI+ Quality) (USCDI) Street name, number, direction & P.O. Box etc.
- address.city: (USCDI+ Quality) (USCDI) Name of city, town etc.
- address.state: (USCDI+ Quality) (USCDI) Sub-unit of country (abbreviations ok)
- address.postalCode: (USCDI+ Quality) (USCDI) US Zip Codes
- address.period: (USCDI+ Quality) (USCDI) Time period when address was/is in use
- communication: (USCDI+ Quality) (USCDI) A language which may be used to communicate with the patient about his or her health
- communication.language: (USCDI+ Quality) (USCDI) The language which can be used to communicate with the patient about his or her health

Usages:

- Refer to this Profile: US Quality Core AdverseEvent, US Quality Core AllergyIntolerance, US Quality Core BodyStructure, US Quality Core CarePlan... Show 46 more, US Quality Core CareTeam, US Quality Core Claim, US Quality Core ClaimResponse, US Quality Core Communication, US Quality Core Communication Not Done, US Quality Core CommunicationRequest, US Quality Core Condition Encounter Diagnosis, US Quality Core Condition Problems Health Concerns, US Quality Core Coverage, US Quality Core Device, US Quality Core Device Not Requested, US Quality Core DeviceRequest, US Quality Core DeviceUseStatement, US Quality Core DiagnosticReport Profile for Laboratory Results Reporting, US Quality Core DiagnosticReport Profile for Report and Note Exchange, US Quality Core Encounter, US Quality Core FamilyMemberHistory, US Quality Core Flag, US Quality Core Goal, US Quality Core ImagingStudy, US Quality Core Immunization, US Quality Core ImmunizationEvaluation, US Quality Core Immunization Not Done, US Quality Core ImmunizationRecommendation, US Quality Core MedicationAdministration, US Quality Core MedicationAdministration Not Done, US Quality Core MedicationDispense, US Quality Core MedicationDispense Declined, US Quality Core Medication Not Requested, US Quality Core MedicationRequest, US Quality Core MedicationStatement, US Quality Core NonPatient Observation, US Quality Core NutritionOrder, US Quality Core Observation Clinical Result, US Quality Core Laboratory Result Observation, US Quality Core Observation Screening Assessment, US Quality Core Observation Cancelled, US Quality Core Patient, US Quality Core Procedure, US Quality Core Procedure Not Done, US Quality Core QuestionnaireResponse, US Quality Core RelatedPerson, US Quality Core Service Not Requested, US Quality Core ServiceRequest, US Quality Core Simple Observation and US Quality Core Task Rejected
- Examples for this Profile: Patient/example-2, Patient/example and Patient/infant-example
- CapabilityStatements using this Profile: US Quality Core Client CapabilityStatement and US Quality Core Server CapabilityStatement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 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
extension:race |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:tribalAffiliation |  | 0..* | (Complex) | (USCDI+ Quality) (USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
extension: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
extension: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.
extension: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 | (USCDI+ Quality) (USCDI) An identifier for this patient
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | (USCDI+ Quality) (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI+ Quality) (USCDI) 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 | (USCDI+ Quality) (USCDI) A name associated with the patient Constraints: us-core-6
use | ?!Σ | 0..1 | code | (USCDI+ Quality) (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family | S Σ C | 0..1 | string | (USCDI+ Quality) (USCDI) Family name (often called 'Surname')
given | S Σ C | 0..* | string | (USCDI+ Quality) (USCDI) Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
suffix | Σ | 0..* | string | (USCDI+ Quality) (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+ Quality) (USCDI) Time period when name was/is in use
telecom | Σ | 0..* | ContactPoint | (USCDI+ Quality) (USCDI) A contact detail for the individual
Slices for extension |  |  |  | Content/Rules for all slices
extension:telecom-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
system | S Σ C | 1..1 | code | (USCDI+ Quality) (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | (USCDI+ Quality) (USCDI) The actual contact point details
use | ?!S Σ | 0..1 | code | (USCDI+ Quality) (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
gender | S Σ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 0..1 | date | (USCDI+ Quality) (USCDI) The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | (USCDI+ Quality) (USCDI) Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | (USCDI+ Quality) (USCDI) An address for the individual
Slices for extension |  |  |  | Content/Rules for all slices
extension:address-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use | ?!Σ | 0..1 | code | (USCDI+ Quality) (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 | (USCDI+ Quality) (USCDI) 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 | (USCDI+ Quality) (USCDI) Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | (USCDI+ Quality) (USCDI) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | (USCDI+ Quality) (USCDI) US Zip Codes Example General: 9132
period | Σ | 0..1 | Period | (USCDI+ Quality) (USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
communication |  | 0..* | BackboneElement | (USCDI+ Quality) (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+ Quality) (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(US Quality Core Patient) | 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 | Status | Usage | ValueSet | Version | Source
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom.system | Base | required | ContactPointSystem | 📦4.0.1 | FHIR Std.
Patient.telecom.use | Base | required | ContactPointUse | 📦4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📦4.0.1 | FHIR Std.
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦6.1.0 | US Core v6.1
Patient.communication.​language | Base | extensible | Language codes with language and optionally a region modifier | 📦6.1.0 | US Core v6.1
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

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

This structure is derived from USCorePatientProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services
Slices for extension |  |  |  | Content/Rules for all slices
extension:race |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:tribalAffiliation |  | 0..* | (Complex) | (USCDI+ Quality) (USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
identifier |  | 1..* | Identifier | (USCDI+ Quality) (USCDI) An identifier for this patient
system |  | 1..1 | uri | (USCDI+ Quality) (USCDI) The namespace for the identifier value
value |  | 1..1 | string | (USCDI+ Quality) (USCDI) The value that is unique within the system.
name |  | 1..* | HumanName | (USCDI+ Quality) (USCDI) A name associated with the patient
use | ?!Σ | 0..1 | code | (USCDI+ Quality) (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family |  | 0..1 | string | (USCDI+ Quality) (USCDI) Family name (often called 'Surname')
given |  | 0..* | string | (USCDI+ Quality) (USCDI) Given names (not always 'first'). Includes middle names
suffix | Σ | 0..* | string | (USCDI+ Quality) (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+ Quality) (USCDI) Time period when name was/is in use
telecom |  | 0..* | ContactPoint | (USCDI+ Quality) (USCDI) A contact detail for the individual
Slices for extension |  |  |  | Content/Rules for all slices
extension:telecom-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
system |  | 1..1 | code | (USCDI+ Quality) (USCDI) phone | fax | email | pager | url | sms | other
value |  | 1..1 | string | (USCDI+ Quality) (USCDI) The actual contact point details
use |  | 0..1 | code | (USCDI+ Quality) (USCDI) home | work | temp | old | mobile - purpose of this contact point
birthDate |  | 0..1 | date | (USCDI+ Quality) (USCDI) The date of birth for the individual
deceased[x] |  | 0..1 | boolean, dateTime | (USCDI+ Quality) (USCDI) Indicates if the individual is deceased or not
address |  | 0..* | Address | (USCDI+ Quality) (USCDI) An address for the individual
Slices for extension |  |  |  | Content/Rules for all slices
extension:address-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use | ?!Σ | 0..1 | code | (USCDI+ Quality) (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line |  | 0..* | string | (USCDI+ Quality) (USCDI) Street name, number, direction & P.O. Box etc.
city |  | 0..1 | string | (USCDI+ Quality) (USCDI) Name of city, town etc.
state |  | 0..1 | string | (USCDI+ Quality) (USCDI) Sub-unit of country (abbreviations ok)
postalCode |  | 0..1 | string | (USCDI+ Quality) (USCDI) US Zip Codes
period | Σ | 0..1 | Period | (USCDI+ Quality) (USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
communication |  | 0..* | BackboneElement | (USCDI+ Quality) (USCDI) A language which may be used to communicate with the patient about his or her health
language |  | 1..1 | CodeableConcept | (USCDI+ Quality) (USCDI) The language which can be used to communicate with the patient about his or her health
link |  | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
other |  | 1..1 | Reference(US Quality Core Patient) | The other patient or related person resource that the link refers to
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:race |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:tribalAffiliation |  | 0..* | (Complex) | (USCDI+ Quality) (USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
extension: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
extension: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.
extension: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 | (USCDI+ Quality) (USCDI) An identifier for this patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | (USCDI+ Quality) (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI+ Quality) (USCDI) 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 | (USCDI+ Quality) (USCDI) A name associated with the patient Constraints: us-core-6
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+ Quality) (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 | (USCDI+ Quality) (USCDI) Family name (often called 'Surname')
given | S Σ C | 0..* | string | (USCDI+ Quality) (USCDI) 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 | (USCDI+ Quality) (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+ Quality) (USCDI) Time period when name was/is in use
telecom | Σ | 0..* | ContactPoint | (USCDI+ Quality) (USCDI) A contact detail 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
extension:telecom-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
system | S Σ C | 1..1 | code | (USCDI+ Quality) (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | (USCDI+ Quality) (USCDI) The actual contact point details
use | ?!S Σ | 0..1 | code | (USCDI+ Quality) (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 | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 0..1 | date | (USCDI+ Quality) (USCDI) The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | (USCDI+ Quality) (USCDI) Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | (USCDI+ Quality) (USCDI) 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
extension:address-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use | ?!Σ | 0..1 | code | (USCDI+ Quality) (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 | (USCDI+ Quality) (USCDI) 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 | (USCDI+ Quality) (USCDI) Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | (USCDI+ Quality) (USCDI) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | (USCDI+ Quality) (USCDI) US Zip Codes Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | (USCDI+ Quality) (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 Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | (USCDI+ Quality) (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+ Quality) (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(US Quality Core Patient) | 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 | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom.system | Base | required | ContactPointSystem | 📦4.0.1 | FHIR Std.
Patient.telecom.use | Base | required | ContactPointUse | 📦4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📦4.0.1 | FHIR Std.
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Patient.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦6.1.0 | US Core v6.1
Patient.maritalStatus | Base | extensible | MaritalStatus | 📦4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📦4.0.1 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | extensible | Language codes with language and optionally a region modifier | 📦6.1.0 | US Core v6.1
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

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

This structure is derived from USCorePatientProfile

Summary

Structures

This structure refers to these other structures:

- US Quality Core Patient (http://fhir.org/guides/astp/us-quality-core/StructureDefinition/us-quality-core-patient)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
- http://hl7.org/fhir/StructureDefinition/iso21090-preferred

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
extension:race |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:tribalAffiliation |  | 0..* | (Complex) | (USCDI+ Quality) (USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
extension: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
extension: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.
extension: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 | (USCDI+ Quality) (USCDI) An identifier for this patient
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | (USCDI+ Quality) (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI+ Quality) (USCDI) 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 | (USCDI+ Quality) (USCDI) A name associated with the patient Constraints: us-core-6
use | ?!Σ | 0..1 | code | (USCDI+ Quality) (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family | S Σ C | 0..1 | string | (USCDI+ Quality) (USCDI) Family name (often called 'Surname')
given | S Σ C | 0..* | string | (USCDI+ Quality) (USCDI) Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
suffix | Σ | 0..* | string | (USCDI+ Quality) (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+ Quality) (USCDI) Time period when name was/is in use
telecom | Σ | 0..* | ContactPoint | (USCDI+ Quality) (USCDI) A contact detail for the individual
Slices for extension |  |  |  | Content/Rules for all slices
extension:telecom-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
system | S Σ C | 1..1 | code | (USCDI+ Quality) (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | (USCDI+ Quality) (USCDI) The actual contact point details
use | ?!S Σ | 0..1 | code | (USCDI+ Quality) (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
gender | S Σ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 0..1 | date | (USCDI+ Quality) (USCDI) The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | (USCDI+ Quality) (USCDI) Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | (USCDI+ Quality) (USCDI) An address for the individual
Slices for extension |  |  |  | Content/Rules for all slices
extension:address-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use | ?!Σ | 0..1 | code | (USCDI+ Quality) (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 | (USCDI+ Quality) (USCDI) 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 | (USCDI+ Quality) (USCDI) Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | (USCDI+ Quality) (USCDI) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | (USCDI+ Quality) (USCDI) US Zip Codes Example General: 9132
period | Σ | 0..1 | Period | (USCDI+ Quality) (USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
communication |  | 0..* | BackboneElement | (USCDI+ Quality) (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+ Quality) (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(US Quality Core Patient) | 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 | Status | Usage | ValueSet | Version | Source
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom.system | Base | required | ContactPointSystem | 📦4.0.1 | FHIR Std.
Patient.telecom.use | Base | required | ContactPointUse | 📦4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📦4.0.1 | FHIR Std.
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦6.1.0 | US Core v6.1
Patient.communication.​language | Base | extensible | Language codes with language and optionally a region modifier | 📦6.1.0 | US Core v6.1
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

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

Differential View

This structure is derived from USCorePatientProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services
Slices for extension |  |  |  | Content/Rules for all slices
extension:race |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:tribalAffiliation |  | 0..* | (Complex) | (USCDI+ Quality) (USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
identifier |  | 1..* | Identifier | (USCDI+ Quality) (USCDI) An identifier for this patient
system |  | 1..1 | uri | (USCDI+ Quality) (USCDI) The namespace for the identifier value
value |  | 1..1 | string | (USCDI+ Quality) (USCDI) The value that is unique within the system.
name |  | 1..* | HumanName | (USCDI+ Quality) (USCDI) A name associated with the patient
use | ?!Σ | 0..1 | code | (USCDI+ Quality) (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family |  | 0..1 | string | (USCDI+ Quality) (USCDI) Family name (often called 'Surname')
given |  | 0..* | string | (USCDI+ Quality) (USCDI) Given names (not always 'first'). Includes middle names
suffix | Σ | 0..* | string | (USCDI+ Quality) (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+ Quality) (USCDI) Time period when name was/is in use
telecom |  | 0..* | ContactPoint | (USCDI+ Quality) (USCDI) A contact detail for the individual
Slices for extension |  |  |  | Content/Rules for all slices
extension:telecom-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
system |  | 1..1 | code | (USCDI+ Quality) (USCDI) phone | fax | email | pager | url | sms | other
value |  | 1..1 | string | (USCDI+ Quality) (USCDI) The actual contact point details
use |  | 0..1 | code | (USCDI+ Quality) (USCDI) home | work | temp | old | mobile - purpose of this contact point
birthDate |  | 0..1 | date | (USCDI+ Quality) (USCDI) The date of birth for the individual
deceased[x] |  | 0..1 | boolean, dateTime | (USCDI+ Quality) (USCDI) Indicates if the individual is deceased or not
address |  | 0..* | Address | (USCDI+ Quality) (USCDI) An address for the individual
Slices for extension |  |  |  | Content/Rules for all slices
extension:address-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use | ?!Σ | 0..1 | code | (USCDI+ Quality) (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line |  | 0..* | string | (USCDI+ Quality) (USCDI) Street name, number, direction & P.O. Box etc.
city |  | 0..1 | string | (USCDI+ Quality) (USCDI) Name of city, town etc.
state |  | 0..1 | string | (USCDI+ Quality) (USCDI) Sub-unit of country (abbreviations ok)
postalCode |  | 0..1 | string | (USCDI+ Quality) (USCDI) US Zip Codes
period | Σ | 0..1 | Period | (USCDI+ Quality) (USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
communication |  | 0..* | BackboneElement | (USCDI+ Quality) (USCDI) A language which may be used to communicate with the patient about his or her health
language |  | 1..1 | CodeableConcept | (USCDI+ Quality) (USCDI) The language which can be used to communicate with the patient about his or her health
link |  | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
other |  | 1..1 | Reference(US Quality Core Patient) | The other patient or related person resource that the link refers to
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:race |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity |  | 0..1 | (Complex) | (USCDI+ Quality) (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:tribalAffiliation |  | 0..* | (Complex) | (USCDI+ Quality) (USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
extension: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
extension: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.
extension: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 | (USCDI+ Quality) (USCDI) An identifier for this patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | (USCDI+ Quality) (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI+ Quality) (USCDI) 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 | (USCDI+ Quality) (USCDI) A name associated with the patient Constraints: us-core-6
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+ Quality) (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 | (USCDI+ Quality) (USCDI) Family name (often called 'Surname')
given | S Σ C | 0..* | string | (USCDI+ Quality) (USCDI) 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 | (USCDI+ Quality) (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+ Quality) (USCDI) Time period when name was/is in use
telecom | Σ | 0..* | ContactPoint | (USCDI+ Quality) (USCDI) A contact detail 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
extension:telecom-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
system | S Σ C | 1..1 | code | (USCDI+ Quality) (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | (USCDI+ Quality) (USCDI) The actual contact point details
use | ?!S Σ | 0..1 | code | (USCDI+ Quality) (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 | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 0..1 | date | (USCDI+ Quality) (USCDI) The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | (USCDI+ Quality) (USCDI) Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | (USCDI+ Quality) (USCDI) 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
extension:address-preferred |  | 0..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use | ?!Σ | 0..1 | code | (USCDI+ Quality) (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 | (USCDI+ Quality) (USCDI) 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 | (USCDI+ Quality) (USCDI) Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | (USCDI+ Quality) (USCDI) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | (USCDI+ Quality) (USCDI) US Zip Codes Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | (USCDI+ Quality) (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 Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | (USCDI+ Quality) (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+ Quality) (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(US Quality Core Patient) | 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 | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom.system | Base | required | ContactPointSystem | 📦4.0.1 | FHIR Std.
Patient.telecom.use | Base | required | ContactPointUse | 📦4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📦4.0.1 | FHIR Std.
Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Patient.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦6.1.0 | US Core v6.1
Patient.maritalStatus | Base | extensible | MaritalStatus | 📦4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📦4.0.1 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | extensible | Language codes with language and optionally a region modifier | 📦6.1.0 | US Core v6.1
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

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

This structure is derived from USCorePatientProfile

Summary

Structures

This structure refers to these other structures:

- US Quality Core Patient (http://fhir.org/guides/astp/us-quality-core/StructureDefinition/us-quality-core-patient)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
- http://hl7.org/fhir/StructureDefinition/iso21090-preferred

Other representations of profile: CSV, Excel, Schematron