US Public Health Profiles Library
1.0.0 - STU1

US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-common-library-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: US Public Health Patient

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-patient | Version: 1.0.0
Active as of 2023-10-04 | Computable Name: USPublicHealthPatient

This Patient profile represents a US Public Health Patient.

It is based on the US Core Patient profile and further constrains it as follows:

- allows masking of some data elements using the FHIR data-absent-reason extension
- adds Must Support constraints to the following data elements from ONC’s USCDI V2 Patient Demographics Data Class:
  - contact detail (e.g. a telephone number or an email address)
  - a communication language
  - a race
  - an ethnicity
  - a birth sex
- adds the US Public Health Gender Identity extension (this is different to the Gender Identity extension used in US Core due to the issue raised here: https://jira.hl7.org/browse/FHIR-37509)
- adds the following extensions:
  - birthPlace
  - tribalAffiliation
- adds contact

Usage:

- Refer to this Resource Profile: US Public Health Characteristics of Home Environment, US Public Health Composition, US Public Health Condition Encounter Diagnosis, US Public Health Condition Problems and Health Concerns... Show 9 more, US Public Health Disability Status, US Public Health Emergency Outbreak Information, US Public Health Encounter, US Public Health Exposure Contact Information, US Public Health Is Postpartum, US Public Health MedicationAdministration, US Public Health Pregnancy Outcome Observation, US Public Health Pregnancy Status Observation and US Public Health Travel History
- Examples for this Resource Profile: Patient/us-ph-patient-eve-everywoman

### Formal Views of Profile Content

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

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

This structure is derived from USCorePatientProfile

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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 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 |  | 2..* | Extension | Extension Slice: Unordered, Open by value:url
race | S | 1..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ombCategory | S | 0..5 | Extension | American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
url |  | 1..1 | uri | "ombCategory"
value[x] |  | 1..1 | Coding | Value of extension Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
extension:detailed |  | 0..* | Extension | Extended race codes
url |  | 1..1 | uri | "detailed"
value[x] |  | 1..1 | Coding | Value of extension Binding: Detailed Race (required)
extension:text | S | 1..1 | Extension | Race Text
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
dataAbsentReason | S | 0..1 | code | For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
url |  | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
ethnicity | S | 1..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ombCategory | S | 0..1 | Extension | Hispanic or Latino|Not Hispanic or Latino
url |  | 1..1 | uri | "ombCategory"
value[x] |  | 1..1 | Coding | Value of extension Binding: OMB Ethnicity Categories (required)
extension:detailed |  | 0..* | Extension | Extended ethnicity codes
url |  | 1..1 | uri | "detailed"
value[x] |  | 1..1 | Coding | Value of extension Binding: Detailed ethnicity (required)
extension:text | S | 1..1 | Extension | ethnicity Text
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
dataAbsentReason | S | 0..1 | code | For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
url |  | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
genderIdentity |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
individualGenderIdentity | S | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
tribalAffiliation | S | 0..* | (Complex) | Tribal affiliation and membership of the patient URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-tribal-affiliation-extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..* | Identifier | An identifier for this patient
dataAbsentReason |  | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique within the system. Example General: 123456
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 1..* | HumanName | A name associated with the patient
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family | S Σ C | 0..1 | string | Family name (often called 'Surname')
given | S Σ C | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom | S Σ | 1..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices |  |  |  | Content/Rules for all slices
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:phone | S Σ | 0..* | ContactPoint | A contact detail for the individual
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:email | S Σ | 0..* | ContactPoint | A contact detail for the individual
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
birthDate | S Σ | 1..1 | date | The date of birth for the individual
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
deceased[x] | ?!S Σ | 1..1 |  | If patient is deceased, use type dateTime and set to deceased date.
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 1..* | Address | An address for the individual
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line | S Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | S Σ | 0..1 | string | County Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
period | S Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
contact | S C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship | S | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name | S | 1..1 | HumanName | A name associated with the contact person
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
telecom | S | 1..* | ContactPoint | A contact detail for the person
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address | S | 1..1 | Address | Address for the contact person
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
communication | S | 1..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Patient.extension:race.extension:ombCategory.value[x] | required | OmbRaceCategories
Patient.extension:race.extension:detailed.value[x] | required | DetailedRace
Patient.extension:race.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.extension:ethnicity.extension:ombCategory.value[x] | required | OmbEthnicityCategories
Patient.extension:ethnicity.extension:detailed.value[x] | required | DetailedEthnicity
Patient.extension:ethnicity.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.identifier.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.identifier.use | required | IdentifierUse
Patient.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.name.use | required | NameUse
Patient.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.telecom.system | required | ContactPointSystem
Patient.telecom.use | required | ContactPointUse
Patient.telecom:phone.system | required | Fixed Value: phone
Patient.telecom:phone.use | required | ContactPointUse
Patient.telecom:email.system | required | Fixed Value: email
Patient.telecom:email.use | required | ContactPointUse
Patient.gender | required | AdministrativeGender
Patient.gender.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.birthDate.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.address.use | required | AddressUse
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`)
Patient.contact.relationship | extensible | PatientContactRelationship
Patient.contact.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.name.use | required | NameUse
Patient.contact.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.telecom.use | required | ContactPointUse
Patient.contact.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.address.use | required | AddressUse
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.communication.language.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.link.type | required | LinkType

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 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 |  | 2..* | Extension | Extension Slice: Unordered, Open by value:url
race | S | 1..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ombCategory | S | 0..5 | Extension | American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "ombCategory"
value[x] |  | 1..1 | Coding | Value of extension Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
extension:detailed |  | 0..* | Extension | Extended race codes
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "detailed"
value[x] |  | 1..1 | Coding | Value of extension Binding: Detailed Race (required)
extension:text | S | 1..1 | Extension | Race Text
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
dataAbsentReason | S | 0..1 | code | For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
url |  | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
ethnicity | S | 1..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ombCategory | S | 0..1 | Extension | Hispanic or Latino|Not Hispanic or Latino
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "ombCategory"
value[x] |  | 1..1 | Coding | Value of extension Binding: OMB Ethnicity Categories (required)
extension:detailed |  | 0..* | Extension | Extended ethnicity codes
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "detailed"
value[x] |  | 1..1 | Coding | Value of extension Binding: Detailed ethnicity (required)
extension:text | S | 1..1 | Extension | ethnicity Text
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
dataAbsentReason | S | 0..1 | code | For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
url |  | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
genderIdentity |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
individualGenderIdentity | S | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
tribalAffiliation | S | 0..* | (Complex) | Tribal affiliation and membership of the patient URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-tribal-affiliation-extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..* | Identifier | An identifier for this patient
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason |  | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique within the system. Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 1..* | HumanName | A name associated with the patient
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | S Σ C | 0..1 | string | Family name (often called 'Surname')
given | S Σ C | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
Slices for telecom | S Σ | 1..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
telecom:phone | S Σ | 0..* | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
telecom:email | S Σ | 0..* | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
value |  | 0..1 | string | Primitive value for code
birthDate | S Σ | 1..1 | date | The date of birth for the individual
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
value |  | 0..1 | date | Primitive value for date
deceased[x] | ?!S Σ | 1..1 |  | If patient is deceased, use type dateTime and set to deceased date.
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 1..* | Address | An address for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | S Σ | 0..1 | string | County Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | S Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | S C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship | S | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name | S | 1..1 | HumanName | A name associated with the contact person
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | Σ | 0..1 | string | Family name (often called 'Surname')
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | S | 1..* | ContactPoint | A contact detail for the person
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
system | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address | S | 1..1 | Address | Address for the contact person
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication | S | 1..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Patient.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.extension:race.extension:ombCategory.value[x] | required | OmbRaceCategories
Patient.extension:race.extension:detailed.value[x] | required | DetailedRace
Patient.extension:race.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.extension:ethnicity.extension:ombCategory.value[x] | required | OmbEthnicityCategories
Patient.extension:ethnicity.extension:detailed.value[x] | required | DetailedEthnicity
Patient.extension:ethnicity.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.identifier.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.identifier.use | required | IdentifierUse
Patient.identifier.type | extensible | Identifier Type Codes
Patient.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.name.use | required | NameUse
Patient.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.telecom.system | required | ContactPointSystem
Patient.telecom.use | required | ContactPointUse
Patient.telecom:phone.system | required | Fixed Value: phone
Patient.telecom:phone.use | required | ContactPointUse
Patient.telecom:email.system | required | Fixed Value: email
Patient.telecom:email.use | required | ContactPointUse
Patient.gender | required | AdministrativeGender
Patient.gender.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.birthDate.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.address.use | required | AddressUse
Patient.address.type | required | AddressType
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`)
Patient.maritalStatus | extensible | Marital Status Codes
Patient.contact.relationship | extensible | PatientContactRelationship
Patient.contact.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.name.use | required | NameUse
Patient.contact.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.telecom.system | required | ContactPointSystem
Patient.contact.telecom.use | required | ContactPointUse
Patient.contact.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.address.use | required | AddressUse
Patient.contact.address.type | required | AddressType
Patient.contact.gender | required | AdministrativeGender
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.communication.language.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.link.type | required | LinkType

This structure is derived from USCorePatientProfile

Summary

Mandatory: 9 elements (4 nested mandatory elements)
Must-Support: 42 elements
Fixed Value: 14 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/data-absent-reason
- http://hl7.org/fhir/StructureDefinition/patient-birthPlace
- http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-tribal-affiliation-extension

Slices

This structure defines the following Slices:

- The element Patient.telecom is sliced based on the value of value:system

Differential View

This structure is derived from USCorePatientProfile

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

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 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 |  | 2..* | Extension | Extension Slice: Unordered, Open by value:url
race | S | 1..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ombCategory | S | 0..5 | Extension | American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
url |  | 1..1 | uri | "ombCategory"
value[x] |  | 1..1 | Coding | Value of extension Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
extension:detailed |  | 0..* | Extension | Extended race codes
url |  | 1..1 | uri | "detailed"
value[x] |  | 1..1 | Coding | Value of extension Binding: Detailed Race (required)
extension:text | S | 1..1 | Extension | Race Text
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
dataAbsentReason | S | 0..1 | code | For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
url |  | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
ethnicity | S | 1..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ombCategory | S | 0..1 | Extension | Hispanic or Latino|Not Hispanic or Latino
url |  | 1..1 | uri | "ombCategory"
value[x] |  | 1..1 | Coding | Value of extension Binding: OMB Ethnicity Categories (required)
extension:detailed |  | 0..* | Extension | Extended ethnicity codes
url |  | 1..1 | uri | "detailed"
value[x] |  | 1..1 | Coding | Value of extension Binding: Detailed ethnicity (required)
extension:text | S | 1..1 | Extension | ethnicity Text
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
dataAbsentReason | S | 0..1 | code | For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
url |  | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
genderIdentity |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
individualGenderIdentity | S | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
tribalAffiliation | S | 0..* | (Complex) | Tribal affiliation and membership of the patient URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-tribal-affiliation-extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..* | Identifier | An identifier for this patient
dataAbsentReason |  | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique within the system. Example General: 123456
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 1..* | HumanName | A name associated with the patient
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family | S Σ C | 0..1 | string | Family name (often called 'Surname')
given | S Σ C | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom | S Σ | 1..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices |  |  |  | Content/Rules for all slices
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:phone | S Σ | 0..* | ContactPoint | A contact detail for the individual
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:email | S Σ | 0..* | ContactPoint | A contact detail for the individual
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
birthDate | S Σ | 1..1 | date | The date of birth for the individual
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
deceased[x] | ?!S Σ | 1..1 |  | If patient is deceased, use type dateTime and set to deceased date.
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 1..* | Address | An address for the individual
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line | S Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | S Σ | 0..1 | string | County Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
period | S Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
contact | S C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship | S | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name | S | 1..1 | HumanName | A name associated with the contact person
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
telecom | S | 1..* | ContactPoint | A contact detail for the person
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address | S | 1..1 | Address | Address for the contact person
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
communication | S | 1..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Patient.extension:race.extension:ombCategory.value[x] | required | OmbRaceCategories
Patient.extension:race.extension:detailed.value[x] | required | DetailedRace
Patient.extension:race.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.extension:ethnicity.extension:ombCategory.value[x] | required | OmbEthnicityCategories
Patient.extension:ethnicity.extension:detailed.value[x] | required | DetailedEthnicity
Patient.extension:ethnicity.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.identifier.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.identifier.use | required | IdentifierUse
Patient.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.name.use | required | NameUse
Patient.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.telecom.system | required | ContactPointSystem
Patient.telecom.use | required | ContactPointUse
Patient.telecom:phone.system | required | Fixed Value: phone
Patient.telecom:phone.use | required | ContactPointUse
Patient.telecom:email.system | required | Fixed Value: email
Patient.telecom:email.use | required | ContactPointUse
Patient.gender | required | AdministrativeGender
Patient.gender.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.birthDate.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.address.use | required | AddressUse
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`)
Patient.contact.relationship | extensible | PatientContactRelationship
Patient.contact.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.name.use | required | NameUse
Patient.contact.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.telecom.use | required | ContactPointUse
Patient.contact.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.address.use | required | AddressUse
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.communication.language.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.link.type | required | LinkType

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 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 |  | 2..* | Extension | Extension Slice: Unordered, Open by value:url
race | S | 1..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ombCategory | S | 0..5 | Extension | American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "ombCategory"
value[x] |  | 1..1 | Coding | Value of extension Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
extension:detailed |  | 0..* | Extension | Extended race codes
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "detailed"
value[x] |  | 1..1 | Coding | Value of extension Binding: Detailed Race (required)
extension:text | S | 1..1 | Extension | Race Text
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
dataAbsentReason | S | 0..1 | code | For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
url |  | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
ethnicity | S | 1..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ombCategory | S | 0..1 | Extension | Hispanic or Latino|Not Hispanic or Latino
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "ombCategory"
value[x] |  | 1..1 | Coding | Value of extension Binding: OMB Ethnicity Categories (required)
extension:detailed |  | 0..* | Extension | Extended ethnicity codes
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "detailed"
value[x] |  | 1..1 | Coding | Value of extension Binding: Detailed ethnicity (required)
extension:text | S | 1..1 | Extension | ethnicity Text
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
dataAbsentReason | S | 0..1 | code | For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
url |  | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
genderIdentity |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
individualGenderIdentity | S | 0..* | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
tribalAffiliation | S | 0..* | (Complex) | Tribal affiliation and membership of the patient URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-tribal-affiliation-extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..* | Identifier | An identifier for this patient
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason |  | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique within the system. Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 1..* | HumanName | A name associated with the patient
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | S Σ C | 0..1 | string | Family name (often called 'Surname')
given | S Σ C | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
Slices for telecom | S Σ | 1..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system
telecom:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
telecom:phone | S Σ | 0..* | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
telecom:email | S Σ | 0..* | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
value |  | 0..1 | string | Primitive value for code
birthDate | S Σ | 1..1 | date | The date of birth for the individual
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
value |  | 0..1 | date | Primitive value for date
deceased[x] | ?!S Σ | 1..1 |  | If patient is deceased, use type dateTime and set to deceased date.
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 1..* | Address | An address for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | S Σ | 0..1 | string | County Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | S Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | S C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship | S | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name | S | 1..1 | HumanName | A name associated with the contact person
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | Σ | 0..1 | string | Family name (often called 'Surname')
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | S | 1..* | ContactPoint | A contact detail for the person
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
system | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address | S | 1..1 | Address | Address for the contact person
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication | S | 1..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Patient.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.extension:race.extension:ombCategory.value[x] | required | OmbRaceCategories
Patient.extension:race.extension:detailed.value[x] | required | DetailedRace
Patient.extension:race.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.extension:ethnicity.extension:ombCategory.value[x] | required | OmbEthnicityCategories
Patient.extension:ethnicity.extension:detailed.value[x] | required | DetailedEthnicity
Patient.extension:ethnicity.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.identifier.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.identifier.use | required | IdentifierUse
Patient.identifier.type | extensible | Identifier Type Codes
Patient.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.name.use | required | NameUse
Patient.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.telecom.system | required | ContactPointSystem
Patient.telecom.use | required | ContactPointUse
Patient.telecom:phone.system | required | Fixed Value: phone
Patient.telecom:phone.use | required | ContactPointUse
Patient.telecom:email.system | required | Fixed Value: email
Patient.telecom:email.use | required | ContactPointUse
Patient.gender | required | AdministrativeGender
Patient.gender.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.birthDate.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.address.use | required | AddressUse
Patient.address.type | required | AddressType
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`)
Patient.maritalStatus | extensible | Marital Status Codes
Patient.contact.relationship | extensible | PatientContactRelationship
Patient.contact.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.name.use | required | NameUse
Patient.contact.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.telecom.system | required | ContactPointSystem
Patient.contact.telecom.use | required | ContactPointUse
Patient.contact.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.contact.address.use | required | AddressUse
Patient.contact.address.type | required | AddressType
Patient.contact.gender | required | AdministrativeGender
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.communication.language.extension:dataAbsentReason.value[x] | required | Fixed Value: masked
Patient.link.type | required | LinkType

This structure is derived from USCorePatientProfile

Summary

Mandatory: 9 elements (4 nested mandatory elements)
Must-Support: 42 elements
Fixed Value: 14 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/data-absent-reason
- http://hl7.org/fhir/StructureDefinition/patient-birthPlace
- http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-tribal-affiliation-extension

Slices

This structure defines the following Slices:

- The element Patient.telecom is sliced based on the value of value:system

Other representations of profile: CSV, Excel, Schematron