Profile Comparison between http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient vs http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient

Messages

Metadata

Name	Value		Comments
abstract	false
baseDefinition	http://hl7.org/fhir/StructureDefinition/Patient
copyright	Used by permission of HL7 International all rights reserved Creative Commons License		Removed the item 'Used by permission of HL7 International all rights reserved Creative Commons License'
date	2022-08-02	2025-04-22	Values Differ
description	Minimum expectations for a Patient resource when accessed via a International Patient Access API. This profile describes how applications fetch the Patient resource to check the patient identity and access basic demographics and other administrative information about the patient.	The US Core Patient Profile inherits from the FHIR [Patient](https://hl7.org/fhir/R4/patient.html) resource; refer to it for scope and usage definitions. This profile meets the requirements of the [U.S. Core Data for Interoperability (USCDI)](https://www.healthit.gov/isp/united-states-core-data-interoperability-uscdi) *Patient Demographics/Information* Data Class. It sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.	Values Differ
experimental	false
fhirVersion	4.0.1
jurisdiction
jurisdiction / jurisdiction[0]	http://unstats.un.org/unsd/methods/m49/m49.htm#001		Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
jurisdiction / jurisdiction[1]		urn:iso:std:iso:3166#US	Added the item 'urn:iso:std:iso:3166#US'
kind	resource
name	IPAPatient	USCorePatientProfile	Values Differ
publisher	HL7 International / Patient Care	HL7 International / Cross-Group Projects	Values Differ
purpose
status	active
title	IPA-Patient	US Core Patient Profile	Values Differ
type	Patient
url	http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient	http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient	Values Differ
version	1.1.0	10.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	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: ipa-pat-4		0..*	Patient	Information about an individual or animal receiving health care services
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact	Σ 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	Σ 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	?! 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: ?? (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	Example/preferred bindings differ at Patient.language using binding from IPAPatient
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		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		0..*	Resource	Contained, inline Resources
Patient.extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..*	Identifier	An identifier for this patient Constraints: ipa-pat-1 Obligations Actor SHALL:explain Server SHALL:handle Client	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient
Patient.identifier.id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Patient.identifier.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
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known .	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.	Σ This element is included in summaries.	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.
Patient.identifier.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient	Elements differ in definition for mustSupport: 'false' vs 'true' Element minimum cardinalities differ: '0' vs '1'
Patient.identifier.value	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456 Obligations Actor SHALL:populate-if-known Server	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)	Σ 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. SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..1	boolean	Whether this patient's record is in active use Obligations Actor SHALL:populate-if-known Server	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use	Elements differ in definition for mustSupport: 'true' vs 'false'
Patient.name	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..*	HumanName	A name associated with the patient Constraints: ipa-pat-2, ipa-pat-3 Obligations Actor SHALL:populate-if-known Server	S This element must be supported. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: us-core-6	Element minimum cardinalities differ: '0' vs '1'
Patient.name.id						0..1	string	Unique id for inter-element referencing	Added this element
Patient.name.Slices for extension						0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url	Added this element
Patient.name.use					?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name.	Added this element
Patient.name.text					Σ This element is included in summaries.	0..1	string	Text representation of the full name	Added this element
Patient.name.family					S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')	Added this element
Patient.name.given					S This element must be supported. Σ This element is included in summaries. C	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name	Added this element
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	Added this element
Patient.name.suffix					Σ This element is included in summaries.	0..*	string	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name	Added this element
Patient.name.period					Σ This element is included in summaries.	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use	Added this element
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual	Σ This element is included in summaries.	0..*	ContactPoint	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.id						0..1	string	Unique id for inter-element referencing	Added this element
Patient.telecom.Slices for extension						0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url	Added this element
Patient.telecom.system					S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point.	Added this element
Patient.telecom.value					S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details	Added this element
Patient.telecom.use					?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required)	Added this element
Patient.telecom.rank					Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)	Added this element
Patient.telecom.period					Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use	Added this element
Patient.gender	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:populate-if-known Server SHALL:handle Client	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes.	Elements differ in definition for mustSupport: 'true' vs 'false'
Patient.birthDate	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual Obligations Actor SHALL:populate-if-known Server SHALL:handle Client	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean, dateTime	Indicates if the individual is deceased or not	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean, dateTime	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.address	Σ This element is included in summaries.	0..*	Address	An address for the individual	S This element must be supported. Σ This element is included in summaries.	0..*	Address	An address for the individual	Elements differ in definition for mustSupport: 'false' vs 'true'
Patient.address.id						0..1	string	Unique id for inter-element referencing	Added this element
Patient.address.Slices for extension						0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url	Added this element
Patient.address.use					?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home	Added this element
Patient.address.type					Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both	Added this element
Patient.address.text					Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132	Added this element
Patient.address.line					S This element must be supported. Σ This element is included in summaries.	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example US Core: 49 MEADOW ST	Added this element
Patient.address.city					S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN	Added this element
Patient.address.district					Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison	Added this element
Patient.address.state					S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two Letter USPS alphabetic codes. Example US Core: OK	Added this element
Patient.address.postalCode					S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047	Added this element
Patient.address.country					Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)	Added this element
Patient.address.period					Σ This element is included in summaries.	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}	Added this element
Patient.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.
Patient.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
Patient.photo		0..*	Attachment	Image of the patient		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
Patient.contact.id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations		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	?! 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: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient.		0..*	CodeableConcept	The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	A name associated with the contact person		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person		0..1	Address	Address for the contact person
Patient.contact.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.
Patient.contact.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
Patient.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
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health		0..*	BackboneElement	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations		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	?! 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		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: ?? (preferred): A human language. Additional Bindings Purpose ?? Max Binding	S This element must be supported.	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible)	Elements differ in definition for mustSupport: 'false' vs 'true'
Patient.communication.preferred		0..1	boolean	Language preference indicator		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider		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	Σ 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. SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..*	BackboneElement	Link to another patient resource that concerns the same actual person Obligations Actor SHALL:populate-if-known Server SHALL:handle Client	?! 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	Elements differ in definition for mustSupport: 'true' vs 'false'
Patient.link.id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations		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	?! 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	Σ 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: ?? (required): The type of link between this patient resource and another patient resource.	Σ This element is included in summaries.	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