Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm
2.0.0 - STU2 United States of America flag

This page is part of the electronic Long-Term Services and Supports Implementation Guide (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: eLTSS Patient Profile

Official URL: http://hl7.org/fhir/us/eltss/StructureDefinition/Patient-eltss Version: 2.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: Patient_eltss

Patient resource mapping for eLTSS

Implementer mapping guidance

The following aids in finding the location of eLTSS data elements. See R4 FHIR Mapping page for complete guidance, here we are providing a subset of fields for convenience.

eLTSS Grouping eLTSS Data Element Name Data Element Definition (includes examples, expected list of values and usage note where applicable) FHIR R4 Resource Element(s) FHIR R4 Resource Element Cardinality (with US Core Constraints) Additional Mapping Details
Beneficiary Demographics Person Name The name of the person whom the plan is for. CarePlan → subject(Patient)

Patient → name → family
Patient → name → given
Patient → name → text		 CarePlan
...subject(Patient) 1
......name 1..*
.........family 1
.........given 1..*
.........text 0..1		 1) Will use CarePlan → subject to reference the Patient for the care plan being developed. FHIR requires that CarePlan includes a subject.
2) given is used for both first name & MI, so need more than one.
3) family is a string with the person's surname.
4) text is a string that contains the full name of the person.
5) Per US Core 1.0.1, each Patient must have at least one name, and each name must include family and given.
Beneficiary Demographics Person Identifier A string of character(s) used to identify the person whom the plan is for.

This may be the Medicaid ID number where applicable.		 CarePlan → subject(Patient)

Patient → identifier → value		 CarePlan
...subject(Patient) 1
......identifier 1..*
.........value 1
.........system 1		 1) Will use CarePlan → subject to reference the Patient for the care plan being developed. FHIR requires that CarePlan includes a subject.
2) identifier is of type Identifier. value is a text element.
3) Per US Core 1.0.1, each Patient must have at least 1 identifier, and each identifier must include a value and system. system is the namespace for the identifier value.
Beneficiary Demographics Person Identifier Type The type of unique identifier used to identify the person whom the plan is for.
Values include: Medicaid Number, State ID, Medical Record Number, Other (free text)		 CarePlan → subject(Patient)

Patient → identifier → type		 CarePlan
...subject(Patient) 1
......identifier 1..*
.........type 0..1		 1) Will use CarePlan → subject to reference the Patient for the care plan being developed. FHIR requires that CarePlan includes a subject.
2) If we have the identifier, we need to be know the type.
3) type is a CodeableConcept with an extensible value set with values defined here.
Medical Record Number is available in the documented code list. LOINC includes Medicaid Number (45400-9) and Social Security Number (45396-9). State ID is covered by the "SB" (Social Beneficiary) code value documented in the FHIR codeset at http://hl7.org/fhir/identifier-type. "Other" can be handled with the text element that is part of the Codeable Concept.
Beneficiary Demographics Person Date of Birth The birth date of the person whom the plan is for. CarePlan → subject(Patient)

Patient → birthDate		 CarePlan
...subject(Patient) 1
......birthDate 0..1		 1) Will use CarePlan → subject to reference the Patient for the care plan being developed. FHIR requires that CarePlan includes a subject.
2) birthDate is in the form "1951-06-04".
Beneficiary Demographics Person Phone Number The primary phone number of the person whom the plan is for, or his/her legal representative, where applicable. CarePlan → subject(Patient)

Patient → telecom → system
Patient → telecom → value		 CarePlan
...subject(Patient) 1
......telecom 0..*
.........value 0..1
.........system 0..1		 1) Will use CarePlan → subject to reference the Patient for the care plan being developed. FHIR requires that CarePlan includes a subject.
2) telecom is of type ContactPoint which contains elements to populate for the phone number.
3) system is required by FHIR if value is provided, and can be: phone | fax | email | pager | url | sms | other. For the eLTSS phone number, system should be provided as "phone".
4) Per FHIR, phone # should be formatted according to ITU-T E.123, so "(555) 675 5745" or "+22 555 675 5745".
Beneficiary Demographics Person Address The address of the person whom the plan is for. CarePlan → subject(Patient)

Patient → address → line
Patient → address → city
Patient → address → state
Patient → address → postalCode
Patient → address → district
Patient → address → text		 CarePlan
...subject(Patient) 1
......address 0..*
.........line 0..*
.........city 0..1
.........state 0..1
.........postalCode 0..1
.........district 0..1
.........text 0..1		 1) Will use CarePlan → subject to reference the Patient for the care plan being developed. FHIR requires that CarePlan includes a subject.
2) text is the full (not broken out) address.
3) line includes street name, number and suffix (e.g. 123 Main St.).
4) Information such as apt #, floor & room #, etc. also go into line, generally as a separate data element.
5) district covers county.
Beneficiary Demographics Emergency
Contact Name		 The name of the individual or entity identified to contact in case of emergency. CarePlan → subject(Patient)

Patient → contact → relationship
Patient → contact → name → family
Patient → contact → name → given
Patient → contact → name → text		 CarePlan
...subject(Patient) 1
......contact 0..*
.........relationship 1..*
.........name 0..1
............family 0..1
............given 0..*
............text 0..1		 1) Will use CarePlan → subject to reference the Patient for the care plan being developed. FHIR requires that CarePlan includes a subject.
2) Emergency contact is indicated using a relationship value "C".
3) If contact is provided, relationship needs to be provided to indicate this is an emergency contact.
4) given is used for both first name & MI, so need more than one.
5) family is a string with the person's surname.
6) text is a string with the full name of the person.
Beneficiary Demographics Emergency
Contact Relationship		 The relationship (e.g., spouse, neighbor, guardian, daughter) of the individual identified to contact in case of emergency. CarePlan → subject(Patient)

Patient → contact → relationship		 CarePlan
...subject(Patient) 1
......contact 0..*
.........relationship 1..*		 1) Will use CarePlan → subject to reference the Patient for the care plan being developed. FHIR requires that CarePlan includes a subject.
2) Emergency contact is indicated using a relationship value "C".
Other contact codes can be found here: https://www.hl7.org/fhir/v2/0131/index.html
3) The emergency contact would have two relationship data elements, one to indicate that it is an emergency contact and one to indicate the relationship between the patient and the contact (such as "next-of-kin").
4) There are other value sets that could be used to provide more detail, for example daughter or neighbor. Can use the value set http://www.hl7.org/implement/standards/fhir/valueset-relatedperson-relationshiptype.html
Beneficiary Demographics Emergency
Contact Phone Number		 The primary phone number (and extension when applicable) of the individual or entity identified to contact in case of emergency. CarePlan → subject(Patient)

Patient → contact → telecom → system
Patient → contact → telecom → value		 CarePlan
...subject(Patient) 1
......contact 0..*
.........telecom 0..*
............value 0..1
............system 0..1		 1) Will use CarePlan → subject to reference the Patient for the care plan being developed. FHIR requires that CarePlan includes a subject.
2) telecom is of type ContactPoint which contains elements to populate for the phone number.
3) system is required if value is provided, and can be: phone, fax, email, pager, url, sms, or other.
4) Per FHIR, phone # should be formatted according to ITU-T E.123, so "(555) 675 5745" or "+22 555 675 5745".
Beneficiary Demographics Emergency Backup Plan Description of how to address unforeseen events, emergency health events, emergency events, problems with medical equipment and supplies, and unavailable staffing situations for critical services that put the person's health and safety at risk.

This can be included as free text or attachment.		 CarePlan [emergency backup plan]
→ subject(Patient)
CarePlan [emergency backup plan]
→ description
CarePlan [emergency backup plan]
→ partOf(CarePlan) ["main" Care Plan]
 CarePlan
...subject(Patient) 1
...description 0..1
...part of(CarePlan) 0..*
 1) The CarePlan resource containing the emergency backup plan refers to the "main" CarePlan resource, rather than the other way around, by using the emergency backup plan CarePlan → partOf data element to reference the "main" CarePlan data element.
2) FHIR requires that CarePlan includes a subject.
3) description contains the text of the Emergency Backup Plan if provided as text.
4) type indicates the kind of document, but the documented preferred LOINC value set does not include anything corresponding to an emergency backup plan. Therefore we can use the Codeable Concept's text data element to indicate "Emergency Backup Plan". (type is mandatory in FHIR 3.0.1, but optional in the R4 draft.)
Data Requirements Not Specific to eLTSS Dataset Data Elements
This section documents data elements that are mandatory per FHIR XML schemas or US Core requirements, but that do not align with individual eLTSS Dataset data elements.
FHIR Data Element Name
Requirement Source		 Data Element Definition FHIR R4 Resource Element(s) FHIR R4 Resource Element Cardinality (with US Core Constraints) Additional Mapping Details
Patient Administrative Gender
US Core		 The gender that the patient is considered to have for administration and record keeping purposes. Patient → gender Patient
...gender 1		 1) gender is required by US Core and must use the AdministrativeGender value set. Possible values are: male, female, other, and unknown.

Usage:

Formal Views of Profile Content

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

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* USCorePatientProfile Information about an individual or animal receiving health care services
... identifier 1..* Identifier Person Identifier
.... type S 0..1 CodeableConcept Person Identifier Type
... name 1..* HumanName Person Name
.... family 1..1 string (USCDI) Family name (often called 'Surname')
.... given 1..* string (USCDI) Given names (not always 'first'). Includes middle names
... telecom 0..* ContactPoint Person Phone Number
... address 0..* Address Person Address
.... district S 0..1 string District name (aka county)
... contact S 0..* BackboneElement Emergency Contact
.... relationship S 1..* CodeableConcept Emergency Contact Relationship
.... name 0..1 HumanName Emergency Contact Name
..... family 1..1 string Family name (often called 'Surname')
..... given 1..* string Given names (not always 'first'). Includes middle names
.... telecom 0..* ContactPoint Emergency Contact Phone
..... system S 0..1 code phone | fax | email | pager | url | sms | other
..... value S 0..1 string The actual contact point details

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* USCorePatientProfile Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... race 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
.... 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


.... 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.


.... genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Person Identifier Type
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName Person Name
us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
.... use ?!Σ 0..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣC 1..1 string (USCDI) Family name (often called 'Surname')
.... given SΣC 1..* 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
... telecom Σ 0..* ContactPoint Person Phone Number
.... system SΣC 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string (USCDI) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 0..1 date Person Date of Birth
... deceased[x] ?!Σ 0..1 (USCDI) Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address Person Address
.... use ?!Σ 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode SΣ 0..1 string (USCDI) US Zip Codes
Example General: 9132
... contact SC 0..* BackboneElement Emergency Contact
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship S 1..* CodeableConcept Emergency Contact Relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName Emergency Contact Name
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... telecom 0..* ContactPoint Emergency Contact Phone
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... communication 0..* BackboneElement (USCDI) A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL 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-6errorPatient.nameAt 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 & Constraintsdoco
.. Patient 0..* USCorePatientProfile Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... race 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
.... 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


.... 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.


.... genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Person Identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Person Identifier Type
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName Person Name
us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family SΣC 1..1 string (USCDI) Family name (often called 'Surname')
.... given SΣC 1..* 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
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period (USCDI) Time period when name was/is in use
... telecom Σ 0..* ContactPoint Person Phone Number
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string (USCDI) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 0..1 date Person Date of Birth
... deceased[x] ?!Σ 0..1 (USCDI) Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address Person Address
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode SΣ 0..1 string (USCDI) US Zip Codes
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period (USCDI) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact SC 0..* BackboneElement Emergency Contact
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship S 1..* CodeableConcept Emergency Contact Relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName Emergency Contact Name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom 0..* ContactPoint Emergency Contact Phone
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement (USCDI) A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL 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-6errorPatient.nameAt least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
: (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from USCorePatientProfile

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 6 elements

Maturity: 2

Differential View

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* USCorePatientProfile Information about an individual or animal receiving health care services
... identifier 1..* Identifier Person Identifier
.... type S 0..1 CodeableConcept Person Identifier Type
... name 1..* HumanName Person Name
.... family 1..1 string (USCDI) Family name (often called 'Surname')
.... given 1..* string (USCDI) Given names (not always 'first'). Includes middle names
... telecom 0..* ContactPoint Person Phone Number
... address 0..* Address Person Address
.... district S 0..1 string District name (aka county)
... contact S 0..* BackboneElement Emergency Contact
.... relationship S 1..* CodeableConcept Emergency Contact Relationship
.... name 0..1 HumanName Emergency Contact Name
..... family 1..1 string Family name (often called 'Surname')
..... given 1..* string Given names (not always 'first'). Includes middle names
.... telecom 0..* ContactPoint Emergency Contact Phone
..... system S 0..1 code phone | fax | email | pager | url | sms | other
..... value S 0..1 string The actual contact point details

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* USCorePatientProfile Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... race 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
.... 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


.... 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.


.... genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Person Identifier Type
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName Person Name
us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
.... use ?!Σ 0..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣC 1..1 string (USCDI) Family name (often called 'Surname')
.... given SΣC 1..* 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
... telecom Σ 0..* ContactPoint Person Phone Number
.... system SΣC 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string (USCDI) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 0..1 date Person Date of Birth
... deceased[x] ?!Σ 0..1 (USCDI) Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address Person Address
.... use ?!Σ 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode SΣ 0..1 string (USCDI) US Zip Codes
Example General: 9132
... contact SC 0..* BackboneElement Emergency Contact
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship S 1..* CodeableConcept Emergency Contact Relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName Emergency Contact Name
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... telecom 0..* ContactPoint Emergency Contact Phone
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... communication 0..* BackboneElement (USCDI) A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL 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-6errorPatient.nameAt 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 & Constraintsdoco
.. Patient 0..* USCorePatientProfile Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... race 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
.... 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


.... 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.


.... genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Person Identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Person Identifier Type
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName Person Name
us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family SΣC 1..1 string (USCDI) Family name (often called 'Surname')
.... given SΣC 1..* 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
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period (USCDI) Time period when name was/is in use
... telecom Σ 0..* ContactPoint Person Phone Number
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string (USCDI) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 0..1 date Person Date of Birth
... deceased[x] ?!Σ 0..1 (USCDI) Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address Person Address
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode SΣ 0..1 string (USCDI) US Zip Codes
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period (USCDI) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact SC 0..* BackboneElement Emergency Contact
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship S 1..* CodeableConcept Emergency Contact Relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName Emergency Contact Name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom 0..* ContactPoint Emergency Contact Phone
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement (USCDI) A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL 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-6errorPatient.nameAt least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
: (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from USCorePatientProfile

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 6 elements

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron