Health eData 1 Sandbox
0.1.0 - CI Build United States of America flag

Health eData 1 Sandbox, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/argonautproject/USCDIV7/ and changes regularly. See the Directory of published versions

Resource Profile: US Core Patient Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient Version: 0.1.0
Active as of 2026-05-14 Maturity Level: 5 Computable Name: USCorePatientProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.50

The US Core Patient Profile inherits from the FHIR Patient resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Patient Demographics/Information Data Class. It sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for the US Core Patient profile:

  • Query for Patient resources belonging to a Patient
  • [Record or update] a Patient Patient

Mandatory and Must Support Data Elements

The following data elements must always be present ([Mandatory] definition) or must be supported if the data is present in the sending system ([Must Support] definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The [Formal Views] below provides the formal summary, definitions, and terminology requirements.

Each Patient Must Have:

  1. an identifier for this patient
  2. the namespace for the identifier value
  3. the value that is unique within the system
  4. a name associated with the patient
  5. a system
  6. the actual contact point details
  7. the language which can be used to communicate with the patient about his or her health

Each Patient Must Support:

  1. family name (often called 'Surname')
  2. given names (not always 'first'). Includes middle names
  3. home work temp old mobile - purpose of this contact point
  4. the date of birth for the individual
  5. an address for the individual
  6. street name, number, direction & P.O. Box etc
  7. name of city, town etc
  8. sub-unit of country (abbreviations ok)
  9. uS Zip Codes
  10. the kind of relationship
  11. a name associated with the contact person
  12. a contact detail for the person

Additional USCDI Requirements:

These [Additional USCDI Requirements] elements are not Mandatory or Must Support but are required for ONC Health IT certification testing and are included in the formal definition of the profile and the Patient examples.

  1. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: US Core Race Extension. (multiple races are supported in the extension)
  2. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
  3. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: Tribal Affiliation Extension
  4. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: Sex Extension
  5. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: Whether the patient needs an interpreter
  6. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: usual official temp nickname anonymous old maiden
  7. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: Parts that come after the name
  8. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: Time period when name was/is in use
  9. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: A contact detail for the individual
  10. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: Indicates if the individual is deceased or not
  11. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: home work temp old billing - purpose of this address
  12. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: Time period when address was/is in use
  13. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: A contact party (e.g., guardian, healthcare agent, friend) for the patient
  14. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: A language which may be used to communicate with the patient about his or her health

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

Liquid Script to Generate StructureDefinition All Nice N Pretty Like

{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}

USCorePatientProfile β€” US Core Patient Profile

The US Core Patient Profile inherits from the FHIR Patient resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Patient Demographics/Information Data Class. It sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

  • URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
  • Version: 0.1.0
  • Status: active
  • Kind: resource
  • Type: Patient
  • Base Definition: http://hl7.org/fhir/StructureDefinition/Patient
  • Derivation: constraint

Elements (differential)

Element Must Support Add'l USCDI Cardinality Type Description
Patient Β  Β  0..* Β  Information about an individual or animal receiving health care services
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
↳extension
slice: race		 Β  βœ… 0..1 Extension
profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race		 US Core Race Extension. (multiple races are supported in the extension)
Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the Race & Ethnicity - CDC (CDCREC) code system. Detailed race concepts are grouped by and pre-mapped to the 5 OMB race categories: - American Indian or Alaska Native - Asian - Black or African American - Native Hawaiian or Other Pacific Islander - White.
↳extension
slice: ethnicity		 Β  βœ… 0..1 Extension
profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity		 US Core ethnicity Extension (multiple ethnicities are supported in the extension)
Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the Race & Ethnicity - CDC (CDCREC) code system. Detailed ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.
↳extension
slice: tribalAffiliation		 Β  βœ… 0..* Extension
profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation		 Tribal Affiliation Extension
A tribe or band with which a person associates whether or not they are an enrolled member.
↳extension
slice: sex		 Β  βœ… 0..1 Extension
profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex		 Sex Extension
The US Core Individual Sex Extension is used to reflect the documentation of a person's sex. It aligns with the C-CDA Sex Observation (LOINC 46098-0).
↳extension
slice: interpreterRequired		 Β  βœ… 0..1 Extension
profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed		 Whether the patient needs an interpreter
This individual needs an interpreter to communicate healthcare information.
↳identifier βœ… Β  1..* Identifier An identifier for this patient
An identifier for this patient.
↳system βœ… Β  1..1 uri The namespace for the identifier value
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
↳value βœ… Β  1..1 string The value that is unique within the system.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
↳name βœ… Β  1..* HumanName A name associated with the patient
A name associated with the individual.
↳use Β  βœ… 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Identifies the purpose for this name.
Binding: http://hl7.org/fhir/ValueSet/name-use\|4.0.1 (required) β€” The use of a human name.
↳family βœ… Β  0..1 string Family name (often called 'Surname')
The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
↳given βœ… Β  0..* string Given names (not always 'first'). Includes middle names
Given name.
↳suffix Β  βœ… 0..* string Parts that come after the name
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
↳period Β  βœ… 0..1 Period Time period when name was/is in use
Indicates the period of time when this name was valid for the named person.
↳telecom Β  βœ… 0..* ContactPoint A contact detail for the individual
A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
↳system βœ… Β  1..1 code phone | fax | email | pager | url | sms | other
Telecommunications form for contact point - what communications system is required to make use of the contact.
Binding: http://hl7.org/fhir/ValueSet/contact-point-system (required) β€” Telecommunications form for contact point.
↳value βœ… Β  1..1 string The actual contact point details
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
↳use βœ… Β  0..1 code home | work | temp | old | mobile - purpose of this contact point
Identifies the purpose for the contact point.
Binding: http://hl7.org/fhir/ValueSet/contact-point-use (required)
↳birthDate βœ… Β  0..1 date The date of birth for the individual
The date of birth for the individual.
↳deceased[x] Β  βœ… 0..1 boolean
dateTime		 Indicates if the individual is deceased or not
Indicates if the individual is deceased or not.
↳address βœ… Β  0..* Address An address for the individual
An address for the individual.
↳use Β  βœ… 0..1 code home | work | temp | old | billing - purpose of this address
The purpose of this address.
Binding: http://hl7.org/fhir/ValueSet/address-use\|4.0.1 (required) β€” The use of an address.
↳line βœ… Β  0..* string Street name, number, direction & P.O. Box etc.
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
↳city βœ… Β  0..1 string Name of city, town etc.
The name of the city, town, suburb, village or other community or delivery center.
↳state βœ… Β  0..1 string Sub-unit of country (abbreviations ok)
Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
Binding: http://terminology.hl7.org/ValueSet/USPS-State (extensible) β€” Two Letter USPS alphabetic codes.
↳postalCode βœ… Β  0..1 string US Zip Codes
A postal code designating a region defined by the postal service.
↳period Β  βœ… 0..1 Period Time period when address was/is in use
Time period when address was/is in use.
↳contact Β  βœ… 0..* BackboneElement A contact party (e.g., guardian, healthcare agent, friend) for the patient
A contact party (e.g. guardian, partner, friend) for the patient.
↳relationship βœ… Β  0..* CodeableConcept The kind of relationship
The nature of the relationship between the patient and the contact person.
Binding: http://hl7.org/fhir/us/core/ValueSet/us-core-patient-contact-relationship (extensible)
↳name βœ… Β  0..1 HumanName A name associated with the contact person
A name associated with the contact person.
↳telecom βœ… Β  0..* ContactPoint A contact detail for the person
A contact detail for the person, e.g. a telephone number or an email address.
↳communication Β  βœ… 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
A language which may be used to communicate with the patient about his or her health.
↳language βœ… Β  1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.
Binding: http://terminology.hl7.org/ValueSet/Languages (extensible)		 


## USCorePatientProfile β€” US Core Patient Profile

The US Core Patient Profile inherits from the FHIR [Patient](https://hl7.org/fhir/R4/patient.html) resource; refer to it for scope and usage definitions. This profile meets the requirements of the [U.S. Core Data for Interoperability (USCDI)](https://www.healthit.gov/isp/united-states-core-data-interoperability-uscdi) *Patient Demographics/Information* Data Class. It sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

- **URL:** `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`
- **Version:** 0.1.0
- **Status:** active
- **Kind:** resource
- **Type:** `Patient`
- **Base Definition:** `http://hl7.org/fhir/StructureDefinition/Patient`
- **Derivation:** constraint


### Elements (differential)

| Element | Must Support | Add'l USCDI | Cardinality | Type | Description |
|---|:---:|:---:|---|---|---|
| `Patient` |  |  | 0..* |  | **Information about an individual or animal receiving health care services**<br/>Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| <span style="padding-left: 1.5em;">↳</span>`extension`<br/><span style="font-size: 0.85em;">slice: `race`</span> |  | βœ… | 0..1 | `Extension`<br/><span style="font-size: 0.85em;">profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race</span> | **US Core Race Extension. (multiple races are supported in the extension)**<br/>Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.  The race codes used to represent these concepts are based upon the [Race & Ethnicity - CDC (CDCREC)](https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238) code system. Detailed race concepts are grouped by and pre-mapped to the 5 OMB race categories:   - American Indian or Alaska Native   - Asian   - Black or African American   - Native Hawaiian or Other Pacific Islander   - White. |
| <span style="padding-left: 1.5em;">↳</span>`extension`<br/><span style="font-size: 0.85em;">slice: `ethnicity`</span> |  | βœ… | 0..1 | `Extension`<br/><span style="font-size: 0.85em;">profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity</span> | **US Core ethnicity Extension (multiple ethnicities are supported in the extension)**<br/>Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.  The ethnicity codes used to represent these concepts are based upon the [Race & Ethnicity - CDC (CDCREC)](https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238) code system. Detailed ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories:   - Hispanic or Latino   - Not Hispanic or Latino. |
| <span style="padding-left: 1.5em;">↳</span>`extension`<br/><span style="font-size: 0.85em;">slice: `tribalAffiliation`</span> |  | βœ… | 0..* | `Extension`<br/><span style="font-size: 0.85em;">profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation</span> | **Tribal Affiliation Extension**<br/>A tribe or band with which a person associates whether or not they are an enrolled member. |
| <span style="padding-left: 1.5em;">↳</span>`extension`<br/><span style="font-size: 0.85em;">slice: `sex`</span> |  | βœ… | 0..1 | `Extension`<br/><span style="font-size: 0.85em;">profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex</span> | **Sex Extension**<br/>The US Core Individual Sex Extension is used to reflect the documentation of a person's sex. It aligns with the C-CDA Sex Observation (LOINC 46098-0). |
| <span style="padding-left: 1.5em;">↳</span>`extension`<br/><span style="font-size: 0.85em;">slice: `interpreterRequired`</span> |  | βœ… | 0..1 | `Extension`<br/><span style="font-size: 0.85em;">profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed</span> | **Whether the patient needs an interpreter**<br/>This individual needs an interpreter to communicate healthcare information. |
| <span style="padding-left: 1.5em;">↳</span>`identifier` | βœ… |  | 1..* | `Identifier` | **An identifier for this patient**<br/>An identifier for this patient. |
| <span style="padding-left: 3.0em;">↳</span>`system` | βœ… |  | 1..1 | `uri` | **The namespace for the identifier value**<br/>Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
| <span style="padding-left: 3.0em;">↳</span>`value` | βœ… |  | 1..1 | `string` | **The value that is unique within the system.**<br/>The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| <span style="padding-left: 1.5em;">↳</span>`name` | βœ… |  | 1..* | `HumanName` | **A name associated with the patient**<br/>A name associated with the individual. |
| <span style="padding-left: 3.0em;">↳</span>`use` |  | βœ… | 0..1 | `code` | **usual \| official \| temp \| nickname \| anonymous \| old \| maiden**<br/>Identifies the purpose for this name.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/name-use\|4.0.1` (required) β€” The use of a human name.</span> |
| <span style="padding-left: 3.0em;">↳</span>`family` | βœ… |  | 0..1 | `string` | **Family name (often called 'Surname')**<br/>The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. |
| <span style="padding-left: 3.0em;">↳</span>`given` | βœ… |  | 0..* | `string` | **Given names (not always 'first'). Includes middle names**<br/>Given name. |
| <span style="padding-left: 3.0em;">↳</span>`suffix` |  | βœ… | 0..* | `string` | **Parts that come after the name**<br/>Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. |
| <span style="padding-left: 3.0em;">↳</span>`period` |  | βœ… | 0..1 | `Period` | **Time period when name was/is in use**<br/>Indicates the period of time when this name was valid for the named person. |
| <span style="padding-left: 1.5em;">↳</span>`telecom` |  | βœ… | 0..* | `ContactPoint` | **A contact detail for the individual**<br/>A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
| <span style="padding-left: 3.0em;">↳</span>`system` | βœ… |  | 1..1 | `code` | **phone \| fax \| email \| pager \| url \| sms \| other**<br/>Telecommunications form for contact point - what communications system is required to make use of the contact.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/contact-point-system` (required) β€” Telecommunications form for contact point.</span> |
| <span style="padding-left: 3.0em;">↳</span>`value` | βœ… |  | 1..1 | `string` | **The actual contact point details**<br/>The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
| <span style="padding-left: 3.0em;">↳</span>`use` | βœ… |  | 0..1 | `code` | **home \| work \| temp \| old \| mobile - purpose of this contact point**<br/>Identifies the purpose for the contact point.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/contact-point-use` (required)</span> |
| <span style="padding-left: 1.5em;">↳</span>`birthDate` | βœ… |  | 0..1 | `date` | **The date of birth for the individual**<br/>The date of birth for the individual. |
| <span style="padding-left: 1.5em;">↳</span>`deceased[x]` |  | βœ… | 0..1 | `boolean`<br/>`dateTime` | **Indicates if the individual is deceased or not**<br/>Indicates if the individual is deceased or not. |
| <span style="padding-left: 1.5em;">↳</span>`address` | βœ… |  | 0..* | `Address` | **An address for the individual**<br/>An address for the individual. |
| <span style="padding-left: 3.0em;">↳</span>`use` |  | βœ… | 0..1 | `code` | **home \| work \| temp \| old \| billing - purpose of this address**<br/>The purpose of this address.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/address-use\|4.0.1` (required) β€” The use of an address.</span> |
| <span style="padding-left: 3.0em;">↳</span>`line` | βœ… |  | 0..* | `string` | **Street name, number, direction & P.O. Box etc.**<br/>This component contains the house number, apartment number, street name, street direction,  P.O. Box number, delivery hints, and similar address information. |
| <span style="padding-left: 3.0em;">↳</span>`city` | βœ… |  | 0..1 | `string` | **Name of city, town etc.**<br/>The name of the city, town, suburb, village or other community or delivery center. |
| <span style="padding-left: 3.0em;">↳</span>`state` | βœ… |  | 0..1 | `string` | **Sub-unit of country (abbreviations ok)**<br/>Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).<br/><span style="font-size: 0.85em;">**Binding:** `http://terminology.hl7.org/ValueSet/USPS-State` (extensible) β€” Two Letter USPS alphabetic codes.</span> |
| <span style="padding-left: 3.0em;">↳</span>`postalCode` | βœ… |  | 0..1 | `string` | **US Zip Codes**<br/>A postal code designating a region defined by the postal service. |
| <span style="padding-left: 3.0em;">↳</span>`period` |  | βœ… | 0..1 | `Period` | **Time period when address was/is in use**<br/>Time period when address was/is in use. |
| <span style="padding-left: 1.5em;">↳</span>`contact` |  | βœ… | 0..* | `BackboneElement` | **A contact party (e.g., guardian, healthcare agent, friend) for the patient**<br/>A contact party (e.g. guardian, partner, friend) for the patient. |
| <span style="padding-left: 3.0em;">↳</span>`relationship` | βœ… |  | 0..* | `CodeableConcept` | **The kind of relationship**<br/>The nature of the relationship between the patient and the contact person.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/us/core/ValueSet/us-core-patient-contact-relationship` (extensible)</span> |
| <span style="padding-left: 3.0em;">↳</span>`name` | βœ… |  | 0..1 | `HumanName` | **A name associated with the contact person**<br/>A name associated with the contact person. |
| <span style="padding-left: 3.0em;">↳</span>`telecom` | βœ… |  | 0..* | `ContactPoint` | **A contact detail for the person**<br/>A contact detail for the person, e.g. a telephone number or an email address. |
| <span style="padding-left: 1.5em;">↳</span>`communication` |  | βœ… | 0..* | `BackboneElement` | **A language which may be used to communicate with the patient about his or her health**<br/>A language which may be used to communicate with the patient about his or her health. |
| <span style="padding-left: 3.0em;">↳</span>`language` | βœ… |  | 1..1 | `CodeableConcept` | **The language which can be used to communicate with the patient about his or her health**<br/>The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.<br/><span style="font-size: 0.85em;">**Binding:** `http://terminology.hl7.org/ValueSet/Languages` (extensible)</span> |

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race C 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique within the system.
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: us-core-6
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element must be supported. This element is included in summaries. C 0..1 string Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. 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
Patient.name.suffix This element is included in summaries. 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.line This element must be supported. This element is included in summaries. 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
Example US Core: 49 MEADOW ST
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Example US Core: OK
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example US Core: 74047
Patient.address.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.contact C 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact party (e.g., guardian, healthcare agent, friend) for the patient
Constraints: pat-1
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship This element must be supported. 0..* CodeableConcept The kind of relationship
Binding: US Core Patient Contact Relationship (extensible)
Patient.contact.name This element must be supported. 0..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Languages (extensible)
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4
Patient.contact.relationship Base extensible US Core Patient Contact Relationship 📦0.1.0 This IG
Patient.communication.​language Base extensible Languages 📦1.0.0 THO v7.4
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.identifier This element must be supported. 1..* Identifier An identifier for this patient
Patient.identifier.system This element must be supported. 1..1 uri The namespace for the identifier value
Patient.identifier.value This element must be supported. 1..1 string The value that is unique within the system.
Patient.name This element must be supported. C 1..* HumanName A name associated with the patient
Constraints: us-core-6
Patient.name.use 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Patient.name.family This element must be supported. C 0..1 string Family name (often called 'Surname')
Patient.name.given This element must be supported. C 0..* string Given names (not always 'first'). Includes middle names
Patient.name.suffix 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
Patient.name.period 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom.system This element must be supported. 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. 1..1 string The actual contact point details
Patient.telecom.use This element must be supported. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.birthDate This element must be supported. 0..1 date The date of birth for the individual
Patient.deceased[x] 0..1 boolean, dateTime 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.address This element must be supported. 0..* Address An address for the individual
Patient.address.use 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Patient.address.line This element must be supported. 0..* string Street name, number, direction & P.O. Box etc.
Example US Core: 49 MEADOW ST
Patient.address.city This element must be supported. 0..1 string Name of city, town etc.
Example US Core: EVERYTOWN
Patient.address.state This element must be supported. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Example US Core: OK
Patient.address.postalCode This element must be supported. 0..1 string US Zip Codes
Example US Core: 74047
Patient.address.period 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Patient.contact 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact party (e.g., guardian, healthcare agent, friend) for the patient
Patient.contact.relationship This element must be supported. 0..* CodeableConcept The kind of relationship
Binding: US Core Patient Contact Relationship (extensible)
Patient.contact.name This element must be supported. 0..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Languages (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4
Patient.contact.relationship Base extensible US Core Patient Contact Relationship 📦0.1.0 This IG
Patient.communication.​language Base extensible Languages 📦1.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
us-core-6 error Patient.name At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race C 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.id 0..1 string Unique id for inter-element referencing
Patient.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type This element is included in summaries. 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.
Patient.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique within the system.
Example General: 123456
Patient.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: us-core-6
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element must be supported. This element is included in summaries. C 0..1 string Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. 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
Patient.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element is included in summaries. 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.id 0..1 string Unique id for inter-element referencing
Patient.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.id 0..1 string Unique id for inter-element referencing
Patient.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line This element must be supported. This element is included in summaries. 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
Example US Core: 49 MEADOW ST
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
Patient.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Example US Core: OK
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example US Core: 74047
Patient.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.address.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact party (e.g., guardian, healthcare agent, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship This element must be supported. 0..* CodeableConcept The kind of relationship
Binding: US Core Patient Contact Relationship (extensible)
Patient.contact.name This element must be supported. 0..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Languages (extensible)
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible US Core Patient Contact Relationship 📦0.1.0 This IG
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Languages 📦1.0.0 THO v7.4
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race C 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique within the system.
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: us-core-6
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element must be supported. This element is included in summaries. C 0..1 string Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. 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
Patient.name.suffix This element is included in summaries. 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.line This element must be supported. This element is included in summaries. 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
Example US Core: 49 MEADOW ST
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Example US Core: OK
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example US Core: 74047
Patient.address.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.contact C 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact party (e.g., guardian, healthcare agent, friend) for the patient
Constraints: pat-1
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship This element must be supported. 0..* CodeableConcept The kind of relationship
Binding: US Core Patient Contact Relationship (extensible)
Patient.contact.name This element must be supported. 0..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Languages (extensible)
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4
Patient.contact.relationship Base extensible US Core Patient Contact Relationship 📦0.1.0 This IG
Patient.communication.​language Base extensible Languages 📦1.0.0 THO v7.4
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

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

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.identifier This element must be supported. 1..* Identifier An identifier for this patient
Patient.identifier.system This element must be supported. 1..1 uri The namespace for the identifier value
Patient.identifier.value This element must be supported. 1..1 string The value that is unique within the system.
Patient.name This element must be supported. C 1..* HumanName A name associated with the patient
Constraints: us-core-6
Patient.name.use 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Patient.name.family This element must be supported. C 0..1 string Family name (often called 'Surname')
Patient.name.given This element must be supported. C 0..* string Given names (not always 'first'). Includes middle names
Patient.name.suffix 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
Patient.name.period 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.system This element must be supported. 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. 1..1 string The actual contact point details
Patient.telecom.use This element must be supported. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.birthDate This element must be supported. 0..1 date The date of birth for the individual
Patient.deceased[x] 0..1 boolean, dateTime 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.address This element must be supported. 0..* Address An address for the individual
Patient.address.use 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Patient.address.line This element must be supported. 0..* string Street name, number, direction & P.O. Box etc.
Example US Core: 49 MEADOW ST
Patient.address.city This element must be supported. 0..1 string Name of city, town etc.
Example US Core: EVERYTOWN
Patient.address.state This element must be supported. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Example US Core: OK
Patient.address.postalCode This element must be supported. 0..1 string US Zip Codes
Example US Core: 74047
Patient.address.period 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Patient.contact 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact party (e.g., guardian, healthcare agent, friend) for the patient
Patient.contact.relationship This element must be supported. 0..* CodeableConcept The kind of relationship
Binding: US Core Patient Contact Relationship (extensible)
Patient.contact.name This element must be supported. 0..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Languages (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4
Patient.contact.relationship Base extensible US Core Patient Contact Relationship 📦0.1.0 This IG
Patient.communication.​language Base extensible Languages 📦1.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
us-core-6 error Patient.name At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race C 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:sex 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex (extensible): Federal Administrative Sex
Patient.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.id 0..1 string Unique id for inter-element referencing
Patient.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type This element is included in summaries. 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.
Patient.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique within the system.
Example General: 123456
Patient.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: us-core-6
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element must be supported. This element is included in summaries. C 0..1 string Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. 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
Patient.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element is included in summaries. 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.id 0..1 string Unique id for inter-element referencing
Patient.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.id 0..1 string Unique id for inter-element referencing
Patient.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line This element must be supported. This element is included in summaries. 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
Example US Core: 49 MEADOW ST
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
Patient.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Example US Core: OK
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example US Core: 74047
Patient.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.address.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact party (e.g., guardian, healthcare agent, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship This element must be supported. 0..* CodeableConcept The kind of relationship
Binding: US Core Patient Contact Relationship (extensible)
Patient.contact.name This element must be supported. 0..1 HumanName A name associated with the contact person
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Languages (extensible)
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible US Core Patient Contact Relationship 📦0.1.0 This IG
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Languages 📦1.0.0 THO v7.4
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

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

 

Other representations of profile: CSV, Excel, Schematron