Profile Comparison between http://hl7.org/fhir/us/core/StructureDefinition/us-core-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
date	2020-06-27	2022-09-30	Values Differ
description	Defines constraints and extensions on the patient resource for the minimal set of data to query and retrieve patient demographic information.	The US Core Patient Profile meets the U.S. Core Data for Interoperability (USCDI) v3 'Patient Demographics' requirements. This profile sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource when using this profile to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.	Values Differ
experimental	false
fhirVersion	4.0.1
jurisdiction
jurisdiction[0]	urn:iso:std:iso:3166#US
kind	resource
name	USCorePatientProfile
publisher	HL7 International - US Realm Steering Committee	HL7 International - Cross-Group Projects	Values Differ
purpose
status	active
title	US Core Patient Profile
type	Patient
url	http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
version	4.0.0	6.1.0-snapshot1	Values Differ

Structure

Name	L Flags	L Card.	L Type	L Description & Constraints	R Flags	R Card.	L Type	L Description & Constraints	Comments
Patient		0..*	Patient	Information about an individual or animal receiving health care services		0..*	Patient	Information about an individual or animal receiving health care services	Elements differ in definition: 'The US Core Patient Profile is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements from the 2015 Edition Common Clinical Data Set.' vs '\-'
id	Σ	0..1	string	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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url		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	SΣ	1..*	Identifier	An identifier for this patient	SΣ	1..*	Identifier	(USCDI) An identifier for this patient	Elements differ in short: 'An identifier for this patient' vs '(USCDI) 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	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	Elements differ in short: 'The namespace for the identifier value' vs '(USCDI) The namespace for the identifier value'
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	Elements differ in short: 'The value that is unique within the system.' vs '(USCDI) The value that is unique within the system.'
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 us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.	SΣC	1..*	HumanName	(USCDI) A name associated with the patient 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.	Elements differ in short: 'A name associated with the patient' vs '(USCDI) A name associated with the 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 | 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.	Elements differ in short: 'usual | official | temp | nickname | anonymous | old | maiden' vs '(USCDI) usual | official | temp | nickname | anonymous | old | maiden'
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')	Elements differ in short: 'Family name (often called 'Surname')' vs '(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	Elements differ in short: 'Given names (not always 'first'). Includes middle names' vs '(USCDI) Given names (not always 'first'). Includes middle names'
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	Elements differ in short: 'Parts that come after the name' vs '(USCDI) Parts that come after 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	Elements differ in short: 'Time period when name was/is in use' vs '(USCDI) Time period when name was/is in use'
telecom	Σ	0..*	ContactPoint	A contact detail for the individual	Σ	0..*	ContactPoint	(USCDI) A contact detail for the individual	Elements differ in short: 'A contact detail for the individual' vs '(USCDI) A contact detail for the individual'
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.	Elements differ in short: 'phone | fax | email | pager | url | sms | other' vs '(USCDI) phone | fax | email | pager | url | sms | other'
value	SΣ	1..1	string	The actual contact point details	SΣ	1..1	string	(USCDI) The actual contact point details	Elements differ in short: 'The actual contact point details' vs '(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)	Elements differ in short: 'home | work | temp | old | mobile - purpose of this contact point' vs '(USCDI) home | work | temp | old | mobile - purpose of this 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
gender	SΣ	1..1	code	male | female | other | unknown Binding: ?? (required)	SΣ	1..1	code	(USCDI) male | female | other | unknown Binding: ?? (required)	Elements differ in short: 'male | female | other | unknown' vs '(USCDI) male | female | other | unknown'
birthDate	SΣ	0..1	date	The date of birth for the individual	SΣ	0..1	date	(USCDI) The date of birth for the individual	Elements differ in short: 'The date of birth for the individual' vs '(USCDI) 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	(USCDI) Indicates if the individual is deceased or not	Elements differ in short: 'Indicates if the individual is deceased or not' vs '(USCDI) Indicates if the individual is deceased or not'
address	SΣ	0..*	Address	An address for the individual	SΣ	0..*	Address	(USCDI) An address for the individual	Elements differ in short: 'An address for the individual' vs '(USCDI) An address for the individual'
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	Elements differ in short: 'home | work | temp | old | billing - purpose of this address' vs '(USCDI) home | work | temp | old | billing - purpose of this address'
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	Elements differ in short: 'Street name, number, direction & P.O. Box etc.' vs '(USCDI) Street name, number, direction & P.O. Box etc.'
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	Elements differ in short: 'Name of city, town etc.' vs '(USCDI) Name of city, town etc.'
district	Σ	0..1	string	District name (aka county) Example General: Madison	Σ	0..1	string	District name (aka 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.	Elements differ in short: 'Sub-unit of country (abbreviations ok)' vs '(USCDI) Sub-unit of country (abbreviations ok)'
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132	SΣ	0..1	string	(USCDI) US Zip Codes Example General: 9132	Elements differ in short: 'US Zip Codes' vs '(USCDI) US Zip Codes'
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 short: 'Time period when address was/is in use' vs '(USCDI) Time period when address was/is in use' 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	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization	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	(USCDI) A language which may be used to communicate with the patient about his or her health	Elements differ in short: 'A language which may be used to communicate with the patient about his or her health' vs '(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) The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible)	Elements differ in short: 'The language which can be used to communicate with the patient about his or her health' vs '(USCDI) The language which can be used to communicate with the patient about his or her health'
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