| Left: | US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient) |
| Right: | US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient) |
| Error | StructureDefinition.version | Values for version differ: '7.0.0' vs '10.0.0-ballot' |
| Information | StructureDefinition.date | Values for date differ: '2023-10-17' vs '2025-04-22' |
| Information | Patient.language | Example/preferred bindings differ at Patient.language using binding from USCorePatientProfile |
| Information | StructureDefinition.comment | Values for comment differ: 'Applications can assume that a name is current unless it explicitly says that it is temporary or old.' vs 'The [United States Core Data for Interoperability (USCDI)](https://www.healthit.gov/isp/united-states-core-data-interoperability-uscdi) Patient Demographics/Information Data Element, *Name to Use*, is represented by the code 'usual', and, *Previous Name*, by the code 'old'.' |
| Warning | Patient.gender | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Information | Patient.gender | Element minimum cardinalities differ: '1' vs '0' |
| Information | StructureDefinition.comment | Values for comment differ: 'The definition of Address states that 'address is intended to describe postal addresses, not physical locations'. However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).' vs 'The definition of Address states that 'address is intended to describe postal addresses, not physical locations'. However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).' |
| Error | Patient.address.state | Unable to resolve left value set http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state at Patient.address.state |
| Error | Patient.communication.language | Unable to resolve left value set http://hl7.org/fhir/us/core/ValueSet/simple-language at Patient.communication.language |
| Name | Value | Comments | |
|---|---|---|---|
 abstract | false | ||
| baseDefinition | http://hl7.org/fhir/StructureDefinition/Patient | ||
| copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
| |
| date | 2023-10-17 | 2025-04-22 |
|
| description | 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) *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. | 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. |
|
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
 jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | USCorePatientProfile | ||
| publisher | HL7 International / Cross-Group Projects | ||
| purpose | |||
| status | active | ||
| title | US Core Patient Profile | ||
| type | Patient | ||
| url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||
| version | 7.0.0 | 10.0.0-ballot |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Patient | 0..* | Patient | Information about an individual or animal receiving health care services | 0..* | Patient | Information about an individual or animal receiving health care services | |||||||||||
 id | 0..1 | id | Logical id of this artifact | 0..1 | id | Logical id of this artifact | |||||||||||
| meta | 0..1 | Meta | Metadata about the resource | 0..1 | Meta | Metadata about the resource | |||||||||||
| implicitRules | 0..1 | uri | A set of rules under which this content was created | 0..1 | uri | A set of rules under which this content was created | |||||||||||
| language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
|
| ||||||||||
| 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
 modifierExtension | 0..* | Extension | Extensions that cannot be ignored | 0..* | Extension | Extensions that cannot be ignored | |||||||||||
| identifier | 1..* | Identifier | An identifier for this patient | 1..* | Identifier | An identifier for this patient | |||||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | |||||||||||
| type | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||||
| system | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||||||||
| value | 1..1 | string | The value that is unique within the system. Example General: 123456 | 1..1 | string | The value that is unique within the system. Example General: 123456 | |||||||||||
| period | 0..1 | Period | Time period when id is/was valid for use | 0..1 | Period | Time period when id is/was valid for use | |||||||||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||||||||
| active | 0..1 | boolean | Whether this patient's record is in active use | 0..1 | boolean | Whether this patient's record is in active use | |||||||||||
| name | C | 1..* | HumanName | A name associated with the patient Constraints: us-core-6 | C | 1..* | HumanName | A name associated with the patient Constraints: us-core-6 | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| use | 0..1 | code | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. | 0..1 | code | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. | |||||||||||
| text | 0..1 | string | Text representation of the full name | 0..1 | string | Text representation of the full name | |||||||||||
| family | C | 0..1 | string | Family name (often called 'Surname') | C | 0..1 | string | Family name (often called 'Surname') | |||||||||
| given | 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 | C | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |||||||||
| prefix | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||||||||
| suffix | 0..* | string | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | 0..* | string | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||||||||
| period | 0..1 | Period | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use | 0..1 | Period | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use | |||||||||||
| telecom | 0..* | ContactPoint | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual | 0..* | ContactPoint | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| system | C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point. | C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point. | |||||||||
| value | 1..1 | string | The actual contact point details | 1..1 | string | The actual contact point details | |||||||||||
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required) | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required) | |||||||||||
| rank | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||||
| period | 0..1 | Period | Time period when the contact point was/is in use | 0..1 | Period | Time period when the contact point was/is in use | |||||||||||
| gender | 1..1 | code | male | female | other | unknown Binding: ?? (required) | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. |
| ||||||||||
| birthDate | 0..1 | date | The date of birth for the individual | 0..1 | date | The date of birth for the individual | |||||||||||
| deceased[x] | 0..1 | boolean, dateTime | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not | 0..1 | boolean, dateTime | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not | |||||||||||
| address | 0..* | Address | An address for the individual | 0..* | Address | An address for the individual | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| use | 0..1 | code | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home | 0..1 | code | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home | |||||||||||
| type | 0..1 | code | postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both | 0..1 | code | postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both | |||||||||||
| text | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||||
| line | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: 49 MEADOW ST | 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 | |||||||||||
| city | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN | |||||||||||
| district | 0..1 | string | District name (aka county) Example General: Madison | 0..1 | string | District name (aka county) Example General: Madison | |||||||||||
| state | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two Letter USPS alphabetic codes. Example General: OK | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two Letter USPS alphabetic codes. Example US Core: OK |
| ||||||||||
| postalCode | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047 | |||||||||||
| country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||||||||
| period | 0..1 | Period | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | 0..1 | Period | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||||||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person. | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person. | |||||||||||
| multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |||||||||||
| photo | 0..* | Attachment | Image of the patient | 0..* | Attachment | Image of the patient | |||||||||||
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient. | 0..* | CodeableConcept | The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||||||||
| name | 0..1 | HumanName | A name associated with the contact person | 0..1 | HumanName | A name associated with the contact person | |||||||||||
| telecom | 0..* | ContactPoint | A contact detail for the person | 0..* | ContactPoint | A contact detail for the person | |||||||||||
| address | 0..1 | Address | Address for the contact person | 0..1 | Address | Address for the contact person | |||||||||||
| gender | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | |||||||||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | |||||||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||||||
| communication | 0..* | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health | 0..* | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible) | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible) |
| ||||||||||
| preferred | 0..1 | boolean | Language preference indicator | 0..1 | boolean | Language preference indicator | |||||||||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||||||||
| managingOrganization | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |||||||||||
| link | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |||||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| other | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | |||||||||||
| type | 1..1 | code | replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource. | 1..1 | code | replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource. | |||||||||||
| Documentation for this format | |||||||||||||||||