Profile Comparison between http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patient vs http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-patient

Messages

Metadata

Name	Value		Comments
abstract	false
baseDefinition	http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
copyright
date	2024-10-30T20:41:41+00:00	2025-09-29T23:15:40+00:00	Values Differ
description	This Patient profile represents a US Public Health Patient. It is based on the **US Core Patient** profile with further constraints to require and/or allow masking of some data elements, and the addition of the US Public Health Gender Identity extension. For ONC’s USCDI requirements, it also adds Must Support constraints to the following: * contact detail (e.g. a telephone number or an email address) * a communication language * a race * an ethnicity * a birth sex	This Patient profile represents a US Public Health Patient.	Values Differ
experimental	false
fhirVersion	4.0.1
jurisdiction
jurisdiction[0]	urn:iso:std:iso:3166#US
kind	resource
name	USPublicHealthPatient
publisher	HL7 International / Public Health
purpose
status	active
title	US Public Health Patient
type	Patient
url	http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patient	http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-patient	Values Differ
version	2.1.2	2.0.0-ballot	Values Differ

Structure

Name	L Flags	L Card.	L Type	L Description & Constraints	R Flags	R Card.	R Type	R Description & Constraints	Comments
Patient		0..*	USCorePatientProfile(4.0.0)	US Public Health Patient		0..*	USCorePatientProfile(6.1.0)	US Public Health Patient
id	Σ	0..1	id	Logical id of this artifact	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: ?? (preferred): A human language. Additional Bindings Purpose ?? Max Binding		0..1	code	Language of the resource content Binding: ?? (preferred): A human language. Additional Bindings Purpose ?? Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url		2..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient	SΣ	1..*	Identifier	(USCDI+) Patient Identifier, (USCDI+) Medical Record Number, (USCDI+) Medicare Patient Identifier
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known .	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.	Σ	0..1	CodeableConcept	Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient	SΣ	1..1	uri	(USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456	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	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient	SΣC	1..*	HumanName	(USCDI+) Patient Name
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name.	?!Σ	0..1	code	(USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name	Σ	0..1	string	Text representation of the full name
family	SΣC	0..1	string	Family name (often called 'Surname')	SΣC	0..1	string	(USCDI) Family name (often called 'Surname')
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name	SΣ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
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name	Σ	0..*	string	(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	Time period when name was/is in use	Σ	0..1	Period	(USCDI) Time period when name was/is in use
Slices for telecom	SΣ	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system	SΣ	1..*	ContactPoint	(USCDI) A contact detail for the individual Slice: Unordered, Open by value:system
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point.	SΣC	1..1	code	(USCDI) phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details	SΣ	1..1	string	(USCDI) The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required)	?!SΣ	0..1	code	(USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male | female | other | unknown Binding: ?? (required)	SΣ	1..1	code	(USCDI) male | female | other | unknown Binding: ?? (required)
id		0..1	string	xml:id (or equivalent in JSON)		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url		0..*	Extension	Extension Slice: Unordered, Open by value:url
value		0..1	string	Primitive value for code		0..1	string	Primitive value for code
birthDate	SΣ	1..1	date	The date of birth for the individual	SΣ	1..1	date	(USCDI+) Date of Birth
id		0..1	string	xml:id (or equivalent in JSON)		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url		0..*	Extension	Extension Slice: Unordered, Open by value:url
value		0..1	date	Primitive value for date		0..1	date	Primitive value for date
deceased[x]	?!SΣ	1..1	boolean, dateTime	If patient is deceased, use type dateTime and set to deceased date.	?!SΣ	1..1	boolean, dateTime	If patient is deceased, use type dateTime and set to deceased date.
address	SΣ	1..*	Address	An address for the individual	SΣ	1..*	Address	(USCDI+) Current Address
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home	?!Σ	0..1	code	(USCDI) home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both	Σ	0..1	code	postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street	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	Name of city, town etc. Example General: Erewhon	SΣ	0..1	string	(USCDI) Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	County Example General: Madison	SΣ	0..1	string	County Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two Letter USPS alphabetic codes.	SΣ	0..1	string	(USCDI) Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132	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)	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}	Σ	0..1	Period	(USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}	Elements differ in definition for mustSupport: 'true' vs 'false'
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person.		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth		0..1	boolean, integer	Whether patient is part of a multiple birth
photo		0..*	Attachment	Image of the patient		0..*	Attachment	Image of the patient
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	1..1	CodeableConcept	The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient.	S	1..1	CodeableConcept	(USCDI+) Relationship Type, Parent/Guardian Code Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	S	1..1	HumanName	A name associated with the contact person	S	1..1	HumanName	(USCDI+) Parent/Guardian Name
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name.	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name	Σ	0..1	string	Text representation of the full name
family	Σ	0..1	string	Family name (often called 'Surname')	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name	Σ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use	Σ	0..1	Period	Time period when name was/is in use
telecom	S	1..*	ContactPoint	A contact detail for the person	S	1..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point.	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required): Use of contact point.	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use	Σ	0..1	Period	Time period when the contact point was/is in use
address	S	1..1	Address	Address for the contact person	S	1..1	Address	Parent/Guardian Address
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both	Σ	0..1	code	postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
gender		0..1	code	male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes.		0..1	code	male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	1..*	BackboneElement	A language which may be used to communicate with the patient about his or her health	S	1..*	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		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible)	S	1..1	CodeableConcept	(USCDI+) Preferred Language Binding: ?? (extensible)
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept	Σ	0..1	string	Plain text representation of the concept
preferred		0..1	boolean	Language preference indicator		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource.	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource.
Documentation for this format