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	Used by permission of HL7 International, all rights reserved Creative Commons License	Values Differ
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[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[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	8.0.0	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
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		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SOΣC	1..*	Identifier	An identifier for this patient Constraints: ipa-pat-1 Obligations Actor SHALL:explain Server SHALL:handle Client	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known .	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.	Σ	0..1	CodeableConcept	Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient	SΣ	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'
value	SOΣ	1..1	string	The value that is unique within the system. Example General: 123456 Obligations Actor SHALL:populate-if-known Server	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SOΣC	0..1	boolean	Whether this patient's record is in active use Obligations Actor SHALL:populate-if-known Server	?!Σ	0..1	boolean	Whether this patient's record is in active use	Elements differ in definition for mustSupport: 'true' vs 'false'
name	SOΣC	0..*	HumanName	A name associated with the patient Constraints: ipa-pat-2, ipa-pat-3 Obligations Actor SHALL:populate-if-known Server	SΣC	1..*	HumanName	A name associated with the patient Constraints: us-core-6	Element minimum cardinalities differ: '0' vs '1'
id						0..1	string	Unique id for inter-element referencing	Added this element
Slices for extension						0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url	Added this element
use					?!Σ	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name.	Added this element
text					Σ	0..1	string	Text representation of the full name	Added this element
family					SΣC	0..1	string	Family name (often called 'Surname')	Added this element
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	Added this element
prefix					Σ	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
suffix					Σ	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
period					Σ	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use	Added this element
telecom	Σ	0..*	ContactPoint	A contact detail for the individual	Σ	0..*	ContactPoint	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
id						0..1	string	Unique id for inter-element referencing	Added this element
Slices for extension						0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url	Added this element
system					SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point.	Added this element
value					SΣ	1..1	string	The actual contact point details	Added this element
use					?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required)	Added this element
rank					Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)	Added this element
period					Σ	0..1	Period	Time period when the contact point was/is in use	Added this element
gender	SOΣ	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	Σ	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'
birthDate	SOΣ	0..1	date	The date of birth for the individual Obligations Actor SHALL:populate-if-known Server SHALL:handle Client	SΣ	0..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1	boolean, dateTime	Indicates if the individual is deceased or not	?!Σ	0..1	boolean, dateTime	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
address	Σ	0..*	Address	An address for the individual	SΣ	0..*	Address	An address for the individual	Elements differ in definition for mustSupport: 'false' vs 'true'
id						0..1	string	Unique id for inter-element referencing	Added this element
Slices for extension						0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url	Added this element
use					?!Σ	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
type					Σ	0..1	code	postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both	Added this element
text					Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132	Added this element
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 Example US Core: 49 MEADOW ST	Added this element
city					SΣ	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN	Added this element
district					Σ	0..1	string	District name (aka county) Example General: Madison	Added this element
state					SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two Letter USPS alphabetic codes. Example US Core: OK	Added this element
postalCode					SΣ	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047	Added this element
country					Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)	Added this element
period					Σ	0..1	Period	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}	Added this element
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person.		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth		0..1	boolean, integer	Whether patient is part of a multiple birth
photo		0..*	Attachment	Image of the patient		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient.		0..*	CodeableConcept	The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes.		0..1	code	male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health		0..*	BackboneElement	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: ?? (preferred): A human language. Additional Bindings Purpose ?? Max Binding	S	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'
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	?!SOΣC	0..*	BackboneElement	Link to another patient resource that concerns the same actual person Obligations Actor SHALL:populate-if-known Server SHALL:handle Client	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person	Elements differ in definition for mustSupport: 'true' vs 'false'
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