Interoperable Digital Identity and Patient Matching
3.0.0-current - STU 3 United States of America flag

Interoperable Digital Identity and Patient Matching, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 3.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-identity-matching-ig/ and changes regularly. See the Directory of published versions

Resource Profile: A Patient resource that includes an Identifier with a value that is a Legal Entity Identifier (LEI)

Official URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/PatientLei Version: 3.0.0-current
Standards status: Trial-use Maturity Level: 2 Computable Name: PatientLei
Other Identifiers: OID:2.16.840.1.113883.4.642.40.81.42.6

A Patient resource that includes an Identifier with a value that is a Legal Entity Identifier (LEI), and may carry the verified LEI (vLEI). This profile is used to represent a patient who has a legal entity identifier, which is typically used for individuals who are associated with legal entities in financial transactions. The profile includes an extension for the verified LEI (vLEI) to indicate that the LEI has been verified and is valid.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile 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 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex 0..1 code Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Patient.Slices for extension.extension:genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by profile:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.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.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI (USCDI) An identifier for this patient
Patient.Slices for identifier.identifier:lei.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.Slices for identifier.identifier:lei.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:lei.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) 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 (USCDI) 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 (USCDI) 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 (USCDI) Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. C 0..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint (USCDI) A contact detail for the individual
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code (USCDI) 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 (USCDI) 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 (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.gender This element must be supported. This element is included in summaries. 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date (USCDI) The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 (USCDI) 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 (USCDI) An address for the individual
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code (USCDI) 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 (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
Patient.communication 0..* BackboneElement (USCDI) 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 (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
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.identifier:lei.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦6.1.0 US Core v6.1
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📦6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile Information about an individual or animal receiving health care services
Patient.Slices for identifier 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by profile:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:lei This element must be supported. 1..* LEI (USCDI) An identifier for this patient

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile 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 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex 0..1 code Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Patient.Slices for extension.extension:genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by profile:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.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.Slices for identifier.identifier:All Slices.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.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI (USCDI) An identifier for this patient
Patient.Slices for identifier.identifier:lei.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:lei.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:lei.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.Slices for identifier.identifier:lei.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.Slices for identifier.identifier:lei.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:lei.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:lei.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:lei.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 (USCDI) 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 (USCDI) 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 (USCDI) Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. C 0..* string (USCDI) 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 (USCDI) 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 (USCDI) Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint (USCDI) 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 (USCDI) 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 (USCDI) 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 (USCDI) 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 must be supported. This element is included in summaries. 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date (USCDI) The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 (USCDI) 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 (USCDI) 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 (USCDI) 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 (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
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 (USCDI) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
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 (USCDI) 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, partner, 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 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.telecom 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 (USCDI) 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 (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
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.identifier:lei.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:lei.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦6.1.0 US Core v6.1
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📦6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCorePatientProfile

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile 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 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex 0..1 code Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Patient.Slices for extension.extension:genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by profile:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.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.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI (USCDI) An identifier for this patient
Patient.Slices for identifier.identifier:lei.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.Slices for identifier.identifier:lei.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:lei.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) 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 (USCDI) 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 (USCDI) 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 (USCDI) Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. C 0..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint (USCDI) A contact detail for the individual
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code (USCDI) 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 (USCDI) 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 (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.gender This element must be supported. This element is included in summaries. 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date (USCDI) The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 (USCDI) 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 (USCDI) An address for the individual
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code (USCDI) 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 (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
Patient.communication 0..* BackboneElement (USCDI) 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 (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
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.identifier:lei.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦6.1.0 US Core v6.1
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📦6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile Information about an individual or animal receiving health care services
Patient.Slices for identifier 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by profile:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:lei This element must be supported. 1..* LEI (USCDI) An identifier for this patient

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile 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 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex 0..1 code Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Patient.Slices for extension.extension:genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by profile:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.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.Slices for identifier.identifier:All Slices.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.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI (USCDI) An identifier for this patient
Patient.Slices for identifier.identifier:lei.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:lei.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:lei.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.Slices for identifier.identifier:lei.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.Slices for identifier.identifier:lei.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:lei.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:lei.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:lei.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 (USCDI) 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 (USCDI) 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 (USCDI) Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. C 0..* string (USCDI) 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 (USCDI) 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 (USCDI) Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint (USCDI) 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 (USCDI) 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 (USCDI) 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 (USCDI) 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 must be supported. This element is included in summaries. 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date (USCDI) The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 (USCDI) 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 (USCDI) 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 (USCDI) 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 (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
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 (USCDI) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
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 (USCDI) 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, partner, 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 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.telecom 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 (USCDI) 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 (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
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.identifier:lei.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:lei.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦6.1.0 US Core v6.1
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📦6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCorePatientProfile

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron